docs: document allowed services

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2022-12-31 11:25:15 -05:00
parent 690f841768
commit 225ec588eb
No known key found for this signature in database
GPG Key ID: 5A1EB336DFB4C71B
5 changed files with 39 additions and 17 deletions

View File

@ -43,7 +43,7 @@ to see if any action is necessary on their part. The date of the most
recent change is included.
Users:\
[user_changes.md](https://moonraker.readthedocs.io/en/latest/user_changes/) - July 27th 2022
[user_changes.md](https://moonraker.readthedocs.io/en/latest/user_changes/) - January 2nd 2023
Developers:\
[api_changes.md](https://moonraker.readthedocs.io/en/latest/api_changes/) - March 4th 2022

View File

@ -163,6 +163,25 @@ supervisord_config_path:
Alternatively it may be possible to enable the `systemd-logind` service,
consult with your distributions's documentation.
#### Allowed Services
The `machine` component uses the configured provider to manage services
on the system (ie: restart a service). Moonraker is authorized to manage
the `moonraker` and `klipper` services, including those that match common
multi-instance patterns, such as `moonraker-1`, `klipper_2`, and `moonraker1`.
Moonraker may be authorized to manage additional services by modifying
`<data_folder>/moonraker.asvc`. By default this file includes the
following services:
- `klipper_mcu`
- `webcamd`
- `MoonCord`
- `KlipperScreen`
- `moonraker-telegam-bot`
- `sonar`
- `crowsnest`
#### Reboot / Shutdown from Klipper
It is possible to call the `shutdown_machine` and `reboot_machine`
@ -552,22 +571,19 @@ restart_klipper_when_powered: False
restart_delay: 1.
# If "restart_klipper_when_powered" is set, this option specifies the amount
# of time (in seconds) to delay the restart. Default is 1 second.
bound_service:
# Can be set to any service Moonraker is authorized to manage with the
# exception of the moonraker service itself. See the tip below this section
# for details on what services are authorized. When a bound service has
# been set the service will be started when the device powers on and stopped
# when the device powers off. The default is no service is bound to the
# device.
bound_services:
# A newline separated list of services that are "bound" to the state of this
# device. When the device is powered on all bound services will be started.
# When the device is powered off all bound services are stopped.
#
# The items in this list are limited to those specified in the allow list,
# see the [machine] configuration documentation for details. Additionally,
# the Moonraker service can not be bound to a power device. Note that
# service names are case sensitive.
#
# The default is no services are bound to the device.
```
!!! Tip
Moonraker is authorized to manage the `klipper`, `klipper_mcu`,
`webcamd`, `MoonCord`, `KlipperScreen`, and `moonraker-telegram-bot`
services. It can also manage multiple instances of a service, ie:
`klipper_1`, `klipper_2`. Keep in mind that service names are case
sensitive.
!!! Note
If a device has been bound to the `klipper` service and the
`restart_klipper_when_powered` option is set to `True`, the restart

View File

@ -2,7 +2,7 @@
Moonraker is a Python 3 based web server that exposes APIs with which
client applications may use to interact with the 3D printing firmware
[Klipper](https://github.com/KevinOConnor/klipper). Communcation between
[Klipper](https://github.com/Klipper3d/klipper). Communcation between
the Klippy host and Moonraker is done over a Unix Domain Socket. Tornado
is used to provide Moonraker's server functionality.

View File

@ -208,7 +208,8 @@ structure using the default data path of `$HOME/printer_data`.
│   └── moonraker.log
├── systemd
│ └── moonraker.env
└── moonraker.secrets (optional)
├── moonraker.secrets (optional)
└── moonraker.asvc
```
If it is not desirible for the files and folders to exist in these specific

View File

@ -2,6 +2,11 @@
This file will track changes that require user intervention,
such as a configuration change or a reinstallation.
### January 2nd 2023
- The `bound_service` option for `[power]` devices has been deprecated in
favor of `bound_services`. Currently this change does not generate a
warning as it can be reliably resolved internally.
### October 14th 2022
- The systemd service file is now versioned. Moonraker can now detect when
the file is out of date and automate corrections as necessary.