Skip to content

Commit

Permalink
docs: note route_prefix option
Browse files Browse the repository at this point in the history
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
  • Loading branch information
Arksine committed Sep 20, 2023
1 parent ae1d3b0 commit d98f11b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ The format is based on [Keep a Changelog].
- **update_manager**: Added support for stable `git_repo` updates
- **server**: Added a `--unixsocket` command line option
- **server**: Command line options may also be specified as env variables
- **server**: Added a `route_prefix` option

### Fixed

Expand Down
11 changes: 11 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,17 @@ klippy_uds_address: /tmp/klippy_uds
# klippy_uds_address: {data_path}/comms/klippy.sock
#
# Default is /tmp/klippy_uds.
route_prefix:
# A prefix prepended to the path for each HTTP endpoint. For example
# if the route_prefix is set to moonraker/printer1, then the server info
# endpoint is available at:
# http://myprinter.local/moonraker/printer1/server/info
#
# This is primarily useful for installations that feature multiple instances
# of Moonraker, as it allows a reverse proxy identify the correct instance based
# on the path and redirect requests without a rewrite. Note that frontends must feature
# support for HTTP endpoints with a route prefix to communicate with Moonraker when
# this option is set. The default is no route prefix.
max_upload_size: 1024
# The maximum size allowed for a file upload (in MiB). Default is 1024 MiB.
max_websocket_connections:
Expand Down

0 comments on commit d98f11b

Please sign in to comment.