From f753263c603eccfed9db02ccb8d9e2df94195ee9 Mon Sep 17 00:00:00 2001 From: Arksine Date: Fri, 1 Jan 2021 11:47:03 -0500 Subject: [PATCH] docs: document the "-n" command line option Signed-off-by: Eric Callahan --- docs/installation.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 7bdd833..2e83c39 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -110,7 +110,7 @@ Now you may install a client, such as The configuration and log file paths may be specified via the command line. ``` -usage: moonraker.py [-h] [-c ] [-l ] +usage: moonraker.py [-h] [-c ] [-l ] [-n] Moonraker - Klipper API Server @@ -120,14 +120,26 @@ optional arguments: Location of moonraker configuration file -l , --logfile log file name and location + -n, --nologfile disable logging to a file ``` The default configuration is: -- config file - `~/moonraker.conf` -- log file - `/tmp/moonraker.log` +- config file path- `~/moonraker.conf` +- log file path - `/tmp/moonraker.log` +- logging to a file is enabled -It is recommended to use the defaults, however one may change these -arguments by editing `/etc/default/moonraker`. +If one needs to start moonraker without generating a log file, the +'-n' option may be used, for example: +``` +~/moonraker-env/bin/python ~/moonraker/moonraker/moonraker.py -n -c /path/to/moonraker.conf +``` +In general it is not recommended to install moonraker with this option. +While moonraker will still log to stdout, all requests for support must +be accompanied by moonraker.log. + +These options may be changed by editing +`/etc/systemd/system/moonraker.service`. The `install-moonraker.sh` script +may also be used to modify the config file location. ## Prerequisites (Klipper Configuration)