tried to document the --base-path option better

maplibre · Jul 14, 2024 · f9deef6 · f9deef6
1 parent 51a8237
commit f9deef6
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 3 deletions.
diff --git a/docs/src/config-file.md b/docs/src/config-file.md
@@ -26,7 +26,10 @@ keep_alive: 75
 # The socket address to bind [default: 0.0.0.0:3000]
 listen_addresses: '0.0.0.0:3000'
 
-# Set TileJSON URL path prefix, ignoring X-Rewrite-URL header. Must begin with a `/`
+# Set TileJSON URL path prefix. This overides the default of respecting the X-Rewrite-URL header.
+# Only modifies the JSON (TileJSON) returned, martins' API-URLs remain unchanged. If you need to rewrite URLs, please use a reverse proxy.
+# Must begin with a `/`.
+# Examples: `/`, `/tiles`
 base_path: /tiles
 
 # Number of web server workers

diff --git a/docs/src/run-with-cli.md b/docs/src/run-with-cli.md
@@ -33,7 +33,10 @@ Options:
           The socket address to bind. [DEFAULT: 0.0.0.0:3000]
 
       --base-path <BASE_PATH>
-          Set TileJSON URL path prefix, ignoring X-Rewrite-URL header. Must begin with a `/`. Examples: `/`, `/tiles`
+          Set TileJSON URL path prefix. This overides the default of respecting the X-Rewrite-URL header.
+          Only modifies the JSON (TileJSON) returned, martins' API-URLs remain unchanged. If you need to rewrite URLs, please use a reverse proxy.
+          Must begin with a `/`.
+          Examples: `/`, `/tiles`
           
   -W, --workers <WORKERS>
           Number of web server workers

diff --git a/martin/src/args/srv.rs b/martin/src/args/srv.rs
@@ -11,7 +11,10 @@ pub struct SrvArgs {
     pub keep_alive: Option<u64>,
     #[arg(help = format!("The socket address to bind. [DEFAULT: {LISTEN_ADDRESSES_DEFAULT}]"), short, long)]
     pub listen_addresses: Option<String>,
-    /// Set TileJSON URL path prefix, ignoring X-Rewrite-URL header. Must begin with a `/`. Examples: `/`, `/tiles`
+    /// Set TileJSON URL path prefix. This overides the default of respecting the X-Rewrite-URL header.
+    /// Only modifies the JSON (TileJSON) returned, martins' API-URLs remain unchanged. If you need to rewrite URLs, please use a reverse proxy.
+    /// Must begin with a `/`.
+    /// Examples: `/`, `/tiles`
     #[arg(long)]
     pub base_path: Option<String>,
     /// Number of web server workers