docs: document allowed services
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
parent
690f841768
commit
225ec588eb
|
@ -43,7 +43,7 @@ to see if any action is necessary on their part. The date of the most
|
||||||
recent change is included.
|
recent change is included.
|
||||||
|
|
||||||
Users:\
|
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:\
|
Developers:\
|
||||||
[api_changes.md](https://moonraker.readthedocs.io/en/latest/api_changes/) - March 4th 2022
|
[api_changes.md](https://moonraker.readthedocs.io/en/latest/api_changes/) - March 4th 2022
|
||||||
|
|
|
@ -163,6 +163,25 @@ supervisord_config_path:
|
||||||
Alternatively it may be possible to enable the `systemd-logind` service,
|
Alternatively it may be possible to enable the `systemd-logind` service,
|
||||||
consult with your distributions's documentation.
|
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
|
#### Reboot / Shutdown from Klipper
|
||||||
|
|
||||||
It is possible to call the `shutdown_machine` and `reboot_machine`
|
It is possible to call the `shutdown_machine` and `reboot_machine`
|
||||||
|
@ -552,22 +571,19 @@ restart_klipper_when_powered: False
|
||||||
restart_delay: 1.
|
restart_delay: 1.
|
||||||
# If "restart_klipper_when_powered" is set, this option specifies the amount
|
# If "restart_klipper_when_powered" is set, this option specifies the amount
|
||||||
# of time (in seconds) to delay the restart. Default is 1 second.
|
# of time (in seconds) to delay the restart. Default is 1 second.
|
||||||
bound_service:
|
bound_services:
|
||||||
# Can be set to any service Moonraker is authorized to manage with the
|
# A newline separated list of services that are "bound" to the state of this
|
||||||
# exception of the moonraker service itself. See the tip below this section
|
# device. When the device is powered on all bound services will be started.
|
||||||
# for details on what services are authorized. When a bound service has
|
# When the device is powered off all bound services are stopped.
|
||||||
# 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
|
# The items in this list are limited to those specified in the allow list,
|
||||||
# device.
|
# 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
|
!!! Note
|
||||||
If a device has been bound to the `klipper` service and the
|
If a device has been bound to the `klipper` service and the
|
||||||
`restart_klipper_when_powered` option is set to `True`, the restart
|
`restart_klipper_when_powered` option is set to `True`, the restart
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
Moonraker is a Python 3 based web server that exposes APIs with which
|
Moonraker is a Python 3 based web server that exposes APIs with which
|
||||||
client applications may use to interact with the 3D printing firmware
|
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
|
the Klippy host and Moonraker is done over a Unix Domain Socket. Tornado
|
||||||
is used to provide Moonraker's server functionality.
|
is used to provide Moonraker's server functionality.
|
||||||
|
|
||||||
|
|
|
@ -208,7 +208,8 @@ structure using the default data path of `$HOME/printer_data`.
|
||||||
│ └── moonraker.log
|
│ └── moonraker.log
|
||||||
├── systemd
|
├── systemd
|
||||||
│ └── moonraker.env
|
│ └── 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
|
If it is not desirible for the files and folders to exist in these specific
|
||||||
|
|
|
@ -2,6 +2,11 @@
|
||||||
This file will track changes that require user intervention,
|
This file will track changes that require user intervention,
|
||||||
such as a configuration change or a reinstallation.
|
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
|
### October 14th 2022
|
||||||
- The systemd service file is now versioned. Moonraker can now detect when
|
- The systemd service file is now versioned. Moonraker can now detect when
|
||||||
the file is out of date and automate corrections as necessary.
|
the file is out of date and automate corrections as necessary.
|
||||||
|
|
Loading…
Reference in New Issue