martin 1.6.0

Blazing fast and lightweight tile server with PostGIS, MBTiles, and PMTiles support
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

use std::time::Duration;

use clap::ValueEnum;
use serde::{Deserialize, Serialize};

use crate::config::file::srv::{KEEP_ALIVE_DEFAULT, LISTEN_ADDRESSES_DEFAULT, SrvConfig};

#[allow(
    clippy::doc_markdown,
    reason = "for command line arguments, formatting `TileJSON` is awkward"
)]
#[derive(clap::Args, Debug, PartialEq, Default)]
#[command(about, version)]
pub struct SrvArgs {
    #[arg(help = format!("Connection keep alive timeout. [DEFAULT: {KEEP_ALIVE_DEFAULT}]"), short, long)]
    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 URL path prefix for all API routes.
    ///
    /// When set, Martin will serve all endpoints under this path prefix (e.g., `/tiles/health`, `/tiles/catalog`).
    /// This allows Martin to be served under a subpath when behind a reverse proxy.
    /// Must begin with a `/`.
    ///
    /// Examples: `/tiles`, `/api/v1/tiles`
    #[arg(long)]
    pub route_prefix: Option<String>,
    /// Set TileJSON URL path prefix.
    ///
    /// This overrides 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, hide = true)]
    pub base_path: Option<String>,
    /// Number of web server workers
    #[arg(short = 'W', long)]
    pub workers: Option<usize>,
    /// Martin server preferred tile encoding. [DEFAULT: gzip]
    ///
    /// If the client accepts multiple compression formats, and the tile source is not pre-compressed, which compression should be used.
    /// `gzip` is faster, but `brotli` is smaller, and may be faster with caching.
    #[arg(long)]
    pub preferred_encoding: Option<PreferredEncoding>,
    /// Control Martin web UI. [DEFAULT: disabled]
    #[arg(short = 'u', long = "webui")]
    #[cfg(all(feature = "webui", not(docsrs)))]
    pub web_ui: Option<WebUiMode>,
    /// If set, the version of the tileset (as specified in the MBTiles or PMTiles metadata)
    /// will be embedded in the TileJSON `tiles` URL, with the set identifier.
    /// For example, if the value of this option is `version`, and the tileset version is `1.0.0`,
    /// the TileJSON `tiles` URL will be like `.../{z}/{x}/{y}?version=1.0.0`.
    #[arg(long)]
    #[cfg(feature = "_tiles")]
    pub tilejson_url_version_param: Option<String>,
    /// Main cache size (in MB)
    #[arg(short = 'C', long)]
    pub cache_size: Option<u64>,
    /// Maximum lifetime for cache entries (e.g. "1h", "30m", "1d")
    #[arg(long, value_parser = parse_duration)]
    pub cache_expiry: Option<Duration>,
    /// Maximum idle time before cache entries are evicted (e.g. "15m", "1h")
    #[arg(long, value_parser = parse_duration)]
    pub cache_idle_timeout: Option<Duration>,
}

fn parse_duration(s: &str) -> Result<Duration, String> {
    use humantime_serde::re::humantime;
    humantime::parse_duration(s).map_err(|e| e.to_string())
}

#[cfg(all(feature = "webui", not(docsrs)))]
#[derive(PartialEq, Eq, Debug, Clone, Copy, Default, Serialize, Deserialize, ValueEnum)]
#[serde(rename_all = "lowercase")]
pub enum WebUiMode {
    /// Disable Web UI interface. ***This is the default, but once implemented, the default will be enabled for localhost.***
    #[default]
    #[serde(alias = "false")]
    Disable,
    // /// Enable Web UI interface on connections from the localhost
    // #[default]
    // #[serde(alias = "true")]
    // Enable,
    /// Enable Web UI interface on all connections
    #[serde(alias = "enable-for-all")]
    #[clap(alias("enable-for-all"))]
    EnableForAll,
}

#[derive(PartialEq, Eq, Debug, Clone, Copy, Serialize, Deserialize, ValueEnum)]
#[serde(rename_all = "lowercase")]
pub enum PreferredEncoding {
    #[serde(alias = "br")]
    #[clap(alias("br"))]
    Brotli,
    Gzip,
}

impl SrvArgs {
    pub(crate) fn merge_into_config(self, srv_config: &mut SrvConfig) {
        // Override config values with the ones from the command line
        if self.keep_alive.is_some() {
            srv_config.keep_alive = self.keep_alive;
        }
        if self.listen_addresses.is_some() {
            srv_config.listen_addresses = self.listen_addresses;
        }
        if self.route_prefix.is_some() {
            srv_config.route_prefix = self.route_prefix;
        }
        if self.base_path.is_some() {
            srv_config.base_path = self.base_path;
        }
        if self.workers.is_some() {
            srv_config.worker_processes = self.workers;
        }
        if self.preferred_encoding.is_some() {
            srv_config.preferred_encoding = self.preferred_encoding;
        }
        #[cfg(all(feature = "webui", not(docsrs)))]
        if self.web_ui.is_some() {
            srv_config.web_ui = self.web_ui;
        }
        #[cfg(feature = "_tiles")]
        if self.tilejson_url_version_param.is_some() {
            srv_config.tilejson_url_version_param = self.tilejson_url_version_param;
        }
    }
}