Skip to content

Commit

Permalink
chore(docs): tried to document the --base-path option better (#1420)
Browse files Browse the repository at this point in the history
As noted, the option could likely be more explicite in what it does

Resolves #1415
  • Loading branch information
CommanderStorm authored Jul 15, 2024
1 parent 5127bc8 commit 387f0f3
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
5 changes: 4 additions & 1 deletion docs/src/config-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 4 additions & 1 deletion docs/src/run-with-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 4 additions & 1 deletion martin/src/args/srv.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 387f0f3

Please sign in to comment.