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

docs: clarify update_manage documentation 

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2023-02-27 06:09:56 -05:00
parent 452aa9a931
commit 523c1ce423
No known key found for this signature in database
GPG Key ID: 5A1EB336DFB4C71B
1 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/configuration.md
View File

@ -1457,9 +1457,8 @@ info_tags:
semantic version format, `vX.Y.Z`, where X, Y, and Z are all unsigned
integer values. For example, a repos first tag might be `v0.0.1`.
Moonraker can still update repos without tags, however as of 2/8/2023
the common front ends disable update controls when version information
is not reported by Moonraker.
Moonraker can update repos without tags, however front ends may disable
update controls when version information is not reported by Moonraker.
```ini
# moonraker.conf
@ -1468,17 +1467,15 @@ info_tags:
# systemd service
[update_manager extension_name]
type: git_repo
# Can be git_repo or zip. This value is set depending on how an extension
# chooses to deploy updates, see its documentation for details This
# parameter must be provided.
# Currently must be git_repo. This value is set depending on how an
# extension chooses to deploy updates, see its documentation for details.
# This parameter must be provided.
channel: dev
# The update channel. The available value differs depending on the
# "type" option.
# type: git_repo - May be dev or beta. The dev channel will update to
# the latest pushed commit, whereas the beta channel
# will update to the latest tagged commit.
# type: zip - May be be stable or beta. When beta is specified
# "pre-release" updates are available.
# The default is dev.
path:
# The absolute path to the client's files on disk. This parameter must be
@ -1513,14 +1510,6 @@ enable_node_updates:
# to package-lock.json. Note that if your project does not have a
# package-lock.json in its root directory then the plugin will fail to load.
# Default is False.
host_repo:
# The GitHub repo in which zipped releases are hosted. Note that this does
# not need to match the repository in the "origin" option, as it is possible
# to use a central GitHub repository to host multiple extension builds. As
# an example, Moonraker's repo hosts builds for both Moonraker and Klipper.
# This option defaults to the repo extracted from the "origin" option,
# however if the origin is not hosted on GitHub then this parameter must
# be provided.
is_system_service: True
# This should be set to False for repos that are not installed as a service
# or do not need to restart a service after updates. This option sets the
@ -1539,11 +1528,18 @@ managed_services:
# <name> - The name configured in the extension's section header.
# If the section header is [update_manager KlipperScreen]
# then KlipperScreen would be a valid value.
# klipper - The klipper service will be restarted after an update
# moonraker - The moonraker service will be restarted after an update
# klipper - The Klipper service associated with this instance of
# Moonraker will be restarted after an update.
# moonraker - The Moonraker service will be restarted after an update.
#
# NOTE: Moonraker will resolve the service names for the "klipper" and
# "moonraker" services if they are not the default values. Specific names
# such as "klipper-1" or "moonraker_2" should not be entered in this option.
#
# When this option is specified it overrides the "is_system_service" option.
# Thus it is not required to specify both, only one or the other. The
# default depends on "is_system_service" as explained above.
# default is no managed services if "is_system_service" is set to False,
# otherwise the default is the service named in the section header.
refresh_interval:
# This overrides the refresh_interval set in the primary [update_manager]
# section.
@ -1558,6 +1554,12 @@ info_tags:
# The default is an empty list.
```
!!! Note
If this application requires a restart after an update it may be necessary
to grant Moonraker permission to manage its service. See the
[allowed services](#allowed-services) section for details on which
services Moonraker is allowed to manage and how to add additional services.
### `[mqtt]`
Enables an MQTT Client. When configured most of Moonraker's APIs are available