From 5064a66c3e5eb211d6c857186ac1d8ab217b3ae1 Mon Sep 17 00:00:00 2001 From: hygienic-books Date: Tue, 5 Jul 2022 17:56:07 +0200 Subject: [PATCH] docs(debug): Explain UFS_LOGLEVEL env var --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 5ea9905..858f74a 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,14 @@ dnf -y install dbus-glib-devel dbus-devel This script assumes write access to `firewalld` direct rules file `/etc/firewalld/direct.xml` or whereever else you've configured this file to live. Typically that means you're going to want to run UFS as `root`. +UFS understands the environment variable `UFS_LOGLEVEL` to set its log verbosity. `UFS_LOGLEVEL` defaults to `INFO`, for more verbosity change it to `DEBUG`, for less change it to either `WARNING` or even just `ERROR`. The example systemd `.service` file in ['examples' directory](examples) makes use of the following decleration: + +``` +Environment='...' 'UFS_LOGLEVEL=INFO' +``` + +Since `UFS_LOGLEVEL=INFO` is default anyway this particular example is redundant and serves as starting point for you. + # Config structure Package configuration happens via a `config.ini` file that follows INI-style syntax. Copy [examples/config.ini.example](examples/config.ini.example) to `config.ini` to get started: