From d98f11b98e7f9832d0fc2a0806fb92ed4b972b25 Mon Sep 17 00:00:00 2001 From: Eric Callahan Date: Thu, 14 Sep 2023 07:44:54 -0400 Subject: [PATCH] docs: note route_prefix option Signed-off-by: Eric Callahan --- docs/changelog.md | 1 + docs/configuration.md | 11 +++++++++++ 2 files changed, 12 insertions(+) diff --git a/docs/changelog.md b/docs/changelog.md index 119feb4..d15bdb0 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -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 diff --git a/docs/configuration.md b/docs/configuration.md index 4f3bcf6..8fbd86b 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -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: