From aab8da4c7c20685befffc24f351f5d4d01758dd8 Mon Sep 17 00:00:00 2001 From: Andrey Meshkov Date: Tue, 5 Feb 2019 14:15:22 +0300 Subject: [PATCH] Added logging description to README --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 6523c26e..d6379ae5 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,18 @@ You can register AdGuard Home as a system service on Windows, Linux/(systemd | U * `AdGuardHome -s restart` - restarts the service. * `AdGuardHome -s status` - shows the current service status. +### Logging + +By default, the log is written to `stderr` when you run AdGuard Home as a console application. + +If you run it as a service/daemon, the log output depends on the platform: + +* Linux: the log is written to syslog. +* MacOS: the log is written to `/var/log/AdGuardHome.*.log` files. +* Windows: the log is written to the Windows event log. + +You can redefine this behavior in AdGuard Home configuration file (see below). + ### Command-line arguments Here is a list of all available command-line arguments. @@ -130,6 +142,8 @@ Options: -h, --help print this help ``` +Please note, that the command-line arguments override settings from the configuration file. + ### Running without superuser You can run AdGuard Home without superuser privileges, but you need to either grant the binary a capability (on Linux) or instruct it to use a different port (all platforms).