3diy
/
moonraker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: note unixsocket commandline option 

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2023-07-22 06:17:45 -04:00
parent 1fadae885e
commit 821f3c5161
No known key found for this signature in database
GPG Key ID: 5A1EB336DFB4C71B
2 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/changelog.md
View File

@ -19,6 +19,7 @@ The format is based on [Keep a Changelog].
[Spoolman](https://github.com/Donkie/Spoolman) filament manager. [Spoolman](https://github.com/Donkie/Spoolman) filament manager.
- **update_manager**: Added support for update rollbacks - **update_manager**: Added support for update rollbacks
- **update_manager**: Added support for stable `git_repo` updates - **update_manager**: Added support for stable `git_repo` updates
- **server**: Added a `--unixsocket` command line option
### Fixed ### Fixed

17
docs/installation.md
View File

@ -34,7 +34,7 @@ missing one or both, you can simply add the bare sections to `printer.cfg`:
path: ~/printer_data/gcodes path: ~/printer_data/gcodes
``` ```
### Enabling the Unix Socket ### Enabling Klipper's Unix Domain Socket Server
After Klipper is installed it may be necessary to modify its `defaults` file in After Klipper is installed it may be necessary to modify its `defaults` file in
order to enable the Unix Domain Socket. Begin by opening the file in your order to enable the Unix Domain Socket. Begin by opening the file in your
@ -326,7 +326,7 @@ This section is intended for users that need to write their own
installation script. Detailed are the command line arguments installation script. Detailed are the command line arguments
available to Moonraker: available to Moonraker:
``` ```
usage: moonraker.py [-h]p [-d <data path>] [-c <configfile>] [-l <logfile>] [-n] usage: moonraker.py [-h] [-d <data path>] [-c <configfile>] [-l <logfile>] [-u <unixsocket>] [-n] [-v] [-g] [-o]
Moonraker - Klipper API Server Moonraker - Klipper API Server
@ -335,9 +335,11 @@ options:
-d <data path>, --datapath <data path> -d <data path>, --datapath <data path>
Location of Moonraker Data File Path Location of Moonraker Data File Path
-c <configfile>, --configfile <configfile> -c <configfile>, --configfile <configfile>
Location of moonraker configuration file Path to Moonraker's configuration file
-l <logfile>, --logfile <logfile> -l <logfile>, --logfile <logfile>
log file name and location Path to Moonraker's log file
-u <unixsocket>, --unixsocket <unixsocket>
Path to Moonraker's unix domain socket
-n, --nologfile disable logging to a file -n, --nologfile disable logging to a file
-v, --verbose Enable verbose logging -v, --verbose Enable verbose logging
-g, --debug Enable Moonraker debug features -g, --debug Enable Moonraker debug features
@ -348,6 +350,7 @@ The default configuration is:
- `data path`: `$HOME/printer_data` - `data path`: `$HOME/printer_data`
- `config file`: `$HOME/printer_data/config/moonraker.conf` - `config file`: `$HOME/printer_data/config/moonraker.conf`
- `log file`: `$HOME/printer_data/logs/moonraker.log` - `log file`: `$HOME/printer_data/logs/moonraker.log`
- `unix socket`: `$HOME/printer_data/comms/moonraker.sock`
- logging to a file is enabled - logging to a file is enabled
- Verbose logging is disabled - Verbose logging is disabled
- Moonraker's debug features are disabled - Moonraker's debug features are disabled
@ -358,6 +361,12 @@ The default configuration is:
always be included for new installations. This allows Moonraker always be included for new installations. This allows Moonraker
to differentiate between new and legacy installations. to differentiate between new and legacy installations.
!!! Warning
Moonraker's `--unixsocket` option should not be confused with Klipper's
`--api-server` option. The `unixsocket` option for Moonraker specifies
the path where Moonraker will create a unix domain socket that serves its
JSON-RPC API.
If is necessary to run Moonraker without logging to a file the If is necessary to run Moonraker without logging to a file the
`-n` option may be used, for example: `-n` option may be used, for example:
``` ```