Martin is a tile server able to generate vector tiles from large PostGIS databases on the fly, or serve tiles from PMTile and MBTile files. Martin optimizes for speed and heavy traffic, and is written in Rust.
* Requirements * Installation * Usage * API * Using with MapLibre * Using with Leaflet * Using with deck.gl * Using with Mapbox * Source List * Composite Sources * Composite Source TileJSON * Composite Source Tiles * Table Sources * Table Source TileJSON * Table Source Tiles * Function Sources * Function Source TileJSON * Function Source Tiles * MBTile and PMTile Sources * Command-line Interface * Environment Variables * Configuration File * PostgreSQL Connection String * PostgreSQL SSL Connections * Using with Docker * Using with Docker Compose * Using with Nginx * Rewriting URLs * Caching tiles * Building from Source * Debugging * Development * Other useful commands * Recipes * Using with DigitalOcean PostgreSQL * Using with Heroku PostgreSQL
Martin requires PostGIS 3.0+. PostGIS 3.1+ is recommended.
You can download martin from GitHub releases page.
| Platform | Downloads (latest) | |----------|------------------------| | Linux | 64-bit | | macOS | 64-bit | | Windows | 64-bit |
If you are using macOS and Homebrew you can install martin using Homebrew tap.
shell
brew tap urbica/tap
brew install martin
You can also use official Docker image
shell
export PGPASSWORD=postgres # secret!
docker run \
-p 3000:3000 \
-e PGPASSWORD \
-e DATABASE_URL=postgresql://postgres@localhost/db \
ghcr.io/maplibre/martin
Use docker -v param to share configuration file or its directory with the container:
shell
export PGPASSWORD=postgres # secret!
docker run -v /path/to/config/dir:/config \
-p 3000:3000 \
-e PGPASSWORD \
-e DATABASE_URL=postgresql://postgres@localhost/db \
ghcr.io/maplibre/martin --config /config/config.yaml
Martin requires at least one PostgreSQL connection string or a tile source file as a command-line argument. A PG connection string can also be passed via the DATABASE_URL environment variable.
shell
martin postgresql://postgres@localhost/db
Martin provides TileJSON endpoint for each geospatial-enabled table in your database.
When started, Martin will go through all spatial tables and functions with an appropriate signature in the database. These tables and functions will be available as the HTTP endpoints, which you can use to query Mapbox vector tiles.
| Method | URL | Description |
|--------|----------------------------------------|---------------------------------------------------------|
| GET | / | Status text, that will eventually show web UI |
| GET | /catalog | List of all sources |
| GET | /{sourceID} | Source TileJSON |
| GET | /{sourceID}/{z}/{x}/{y} | Source Tiles |
| GET | /{sourceID1},...,{nameN} | Composite Source TileJSON |
| GET | /{sourceID1},...,{nameN}/{z}/{x}/{y} | Composite Source Tiles |
| GET | /health | Martin server health check: returns 200 OK |
MapLibre is an Open-source JavaScript library for showing maps on a website. MapLibre can accept MVT vector tiles generated by Martin, and applies a style to them to draw a map using Web GL.
You can add a layer to the map and specify Martin TileJSON endpoint as a vector source URL. You should also specify a source-layer property. For Table Sources it is {table_name} by default.
js
map.addLayer({
id: 'points',
type: 'circle',
source: {
type: 'vector',
url: 'http://localhost:3000/points'
},
'source-layer': 'points',
paint: {
'circle-color': 'red'
},
});
js
map.addSource('rpc', {
type: 'vector',
url: `http://localhost:3000/function_zxy_query`
});
map.addLayer({
id: 'points',
type: 'circle',
source: 'rpc',
'source-layer': 'function_zxy_query',
paint: {
'circle-color': 'blue'
},
});
You can also combine multiple sources into one source with Composite Sources. Each source in a composite source can be accessed with its {source_name} as a source-layer property.
``js
map.addSource('points', {
type: 'vector',
url:http://0.0.0.0:3000/points1,points2`
});
map.addLayer({ id: 'red_points', type: 'circle', source: 'points', 'source-layer': 'points1', paint: { 'circle-color': 'red' } });
map.addLayer({ id: 'blue_points', type: 'circle', source: 'points', 'source-layer': 'points2', paint: { 'circle-color': 'blue' } }); ```
Leaflet is the leading open-source JavaScript library for mobile-friendly interactive maps.
You can add vector tiles using Leaflet.VectorGrid plugin. You must initialize a VectorGrid.Protobuf with a URL template, just like in L.TileLayers. The difference is that you should define the styling for all the features.
js
L.vectorGrid
.protobuf('http://localhost:3000/points/{z}/{x}/{y}', {
vectorTileLayerStyles: {
'points': {
color: 'red',
fill: true
}
}
})
.addTo(map);
deck.gl is a WebGL-powered framework for visual exploratory data analysis of large datasets.
You can add vector tiles using MVTLayer. MVTLayer data property defines the remote data for the MVT layer. It can be
String: Either a URL template or a TileJSON URL.Array: an array of URL templates. It allows to balance the requests across different tile endpoints. For example, if you define an array with 4 urls and 16 tiles need to be loaded, each endpoint is responsible to server 16/4 tiles.JSON: A valid TileJSON object.```js const pointsLayer = new MVTLayer({ data: 'http://localhost:3000/points', // 'http://localhost:3000/table_source/{z}/{x}/{y}' pointRadiusUnits: 'pixels', getRadius: 5, getFillColor: [230, 0, 0] });
const deckgl = new DeckGL({ container: 'map', mapStyle: 'https://basemaps.cartocdn.com/gl/dark-matter-gl-style/style.json', initialViewState: { latitude: 0, longitude: 0, zoom: 1 }, layers: [pointsLayer] }); ```
Mapbox GL JS is a JavaScript library for interactive, customizable vector maps on the web. Mapbox GL JS v1.x was open source, and it was forked as MapLibre (see above), so using Martin with Mapbox is similar to MapLibre. Mapbox GL JS can accept MVT vector tiles generated by Martin, and applies a style to them to draw a map using Web GL.
You can add a layer to the map and specify Martin TileJSON endpoint as a vector source URL. You should also specify a source-layer property. For Table Sources it is {table_name} by default.
js
map.addLayer({
id: 'points',
type: 'circle',
source: {
type: 'vector',
url: 'http://localhost:3000/points'
},
'source-layer': 'points',
paint: {
'circle-color': 'red'
}
});
A list of all available sources is available in a catalogue:
shell
curl localhost:3000/catalog | jq
yaml
[
{
"id": "function_zxy_query",
"name": "public.function_zxy_query"
},
{
"id": "points1",
"name": "public.points1.geom"
},
...
]
Composite Sources allows combining multiple sources into one. Composite Source consists of multiple sources separated by comma {source1},...,{sourceN}
Each source in a composite source can be accessed with its {source_name} as a source-layer property.
Composite Source TileJSON endpoint is available at /{source1},...,{sourceN}.
For example, composite source combining points and lines sources will be available at /points,lines
shell
curl localhost:3000/points,lines | jq
Composite Source tiles endpoint is available at /{source1},...,{sourceN}/{z}/{x}/{y}
For example, composite source combining points and lines sources will be available at /points,lines/{z}/{x}/{y}
shell
curl localhost:3000/points,lines/0/0/0
Table Source is a database table which can be used to query vector tiles. When started, Martin will go through all spatial tables in the database and build a list of table sources. A table should have at least one geometry column with non-zero SRID. All other table columns will be represented as properties of a vector tile feature.
Table Source TileJSON endpoint is available at /{table_name}.
For example, points table will be available at /points, unless there is another source with the same name, or if the table has multiple geometry columns, in which case it will be available at /points.1, /points.2, etc.
shell
curl localhost:3000/points | jq
Table Source tiles endpoint is available at /{table_name}/{z}/{x}/{y}
For example, points table will be available at /points/{z}/{x}/{y}
shell
curl localhost:3000/points/0/0/0
In case if you have multiple geometry columns in that table and want to access a particular geometry column in vector tile, you should also specify the geometry column in the table source name
shell
curl localhost:3000/points.geom/0/0/0
Function Source is a database function which can be used to query vector tiles. When started, Martin will look for the functions with a suitable signature. A function that takes z integer (or zoom integer), x integer, y integer, and an optional query json and returns bytea, can be used as a Function Source. Alternatively the function could return a record with a single bytea field, or a record with two fields of types bytea and text, where the text field is an etag key (i.e. md5 hash).
| Argument | Type | Description | |----------------------------|---------|-------------------------| | z (or zoom) | integer | Tile zoom parameter | | x | integer | Tile x parameter | | y | integer | Tile y parameter | | query (optional, any name) | json | Query string parameters |
For example, if you have a table table_source in WGS84 (4326 SRID), then you can use this function as a Function Source:
```sql, ignore CREATE OR REPLACE FUNCTION functionzxyquery(z integer, x integer, y integer) RETURNS bytea AS $$ DECLARE mvt bytea; BEGIN SELECT INTO mvt STAsMVT(tile, 'functionzxyquery', 4096, 'geom') FROM ( SELECT STAsMVTGeom(STTransform(STCurveToLine(geom), 3857), STTileEnvelope(z, x, y), 4096, 64, true) AS geom FROM tablesource WHERE geom && STTransform(STTileEnvelope(z, x, y), 4326) ) as tile WHERE geom IS NOT NULL;
RETURN mvt; END $$ LANGUAGE plpgsql IMMUTABLE STRICT PARALLEL SAFE; ```
```sql, ignore CREATE OR REPLACE FUNCTION functionzxyquery(z integer, x integer, y integer, queryparams json) RETURNS bytea AS $$ DECLARE mvt bytea; BEGIN SELECT INTO mvt STAsMVT(tile, 'functionzxyquery', 4096, 'geom') FROM ( SELECT STAsMVTGeom(STTransform(STCurveToLine(geom), 3857), STTileEnvelope(z, x, y), 4096, 64, true) AS geom FROM tablesource WHERE geom && STTransform(ST_TileEnvelope(z, x, y), 4326) ) as tile WHERE geom IS NOT NULL;
RETURN mvt; END $$ LANGUAGE plpgsql IMMUTABLE STRICT PARALLEL SAFE; ```
The query_params argument is a JSON representation of the tile request query params. For example, if user requested a tile with urlencoded params:
shell
curl \
--data-urlencode 'arrayParam=[1, 2, 3]' \
--data-urlencode 'numberParam=42' \
--data-urlencode 'stringParam=value' \
--data-urlencode 'booleanParam=true' \
--data-urlencode 'objectParam={"answer" : 42}' \
--get localhost:3000/function_zxy_query/0/0/0
then query_params will be parsed as:
json
{
"arrayParam": [1, 2, 3],
"numberParam": 42,
"stringParam": "value",
"booleanParam": true,
"objectParam": { "answer": 42 }
}
You can access this params using json operators:
sql, ignore
...WHERE answer = (query_params->'objectParam'->>'answer')::int;
Function Source TileJSON endpoint is available at /{function_name}
For example, points function will be available at /points
shell
curl localhost:3000/points | jq
Function Source tiles endpoint is available at /{function_name}/{z}/{x}/{y}
For example, points function will be available at /points/{z}/{x}/{y}
shell
curl localhost:3000/points/0/0/0
Martin can serve any type of tiles from PMTile and MBTile files. To serve a file from CLI, simply put the path to the file or the directory with *.mbtiles or *.pmtiles files. For example:
shell
martin /path/to/mbtiles/file.mbtiles /path/to/directory
You may also want to generate a config file using the --save-config my-config.yaml, and later edit it and use it with --config my-config.yaml option.
You can configure Martin using command-line interface. See martin --help or cargo run -- --help for more information.
```shell Usage: martin [OPTIONS] [CONNECTION]...
Arguments: [CONNECTION]... Connection strings, e.g. postgres://... or /path/to/files
Options:
-c, --config
You can also configure Martin using environment variables, but only if the configuration file is not used. See configuration section on how to use environment variables with config files. See also SSL configuration section below.
| Environment var
Config File key | Example | Description |
|------------------------------------------|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| DATABASE_URL
connection_string | postgresql://postgres@localhost/db | Postgres database connection |
| DEFAULT_SRID
default_srid | 4326 | If a PostgreSQL table has a geometry column with SRID=0, use this value instead |
| PGSSLCERT
ssl_cert | ./postgresql.crt | A file with a client SSL certificate. docs |
| PGSSLKEY
ssl_key | ./postgresql.key | A file with the key for the client SSL certificate. docs |
| PGSSLROOTCERT
ssl_root_cert | ./root.crt | A file with trusted root certificate(s). The file should contain a sequence of PEM-formatted CA certificates. docs
This env var used to be called CA_ROOT_FILE, but support for it will be removed soon. |
If you don't want to expose all of your tables and functions, you can list your sources in a configuration file. To start Martin with a configuration file you need to pass a path to a file with a --config argument. Config files may contain environment variables, which will be expanded before parsing. For example, to use MY_DATABASE_URL in your config file: connection_string: ${MY_DATABASE_URL}, or with a default connection_string: ${MY_DATABASE_URL:-postgresql://postgres@localhost/db}
shell
martin --config config.yaml
You may wish to auto-generate a config file with --save-config argument. This will generate a config yaml file with all of your configuration, which you can edit to remove any sources you don't want to expose.
```yaml
keep_alive: 75
listen_addresses: '0.0.0.0:3000'
worker_processes: 8
postgres: # Database connection string. You can use env vars too, for example: # $DATABASEURL # ${DATABASEURL:-postgresql://postgres@localhost/db} connection_string: 'postgresql://postgres@localhost:5432/db'
# Same as PGSSLCERT for psql sslcert: './postgresql.crt' # Same as PGSSLKEY for psql sslkey: './postgresql.key' # Same as PGSSLROOTCERT for psql sslrootcert: './root.crt'
# If a spatial table has SRID 0, then this SRID will be used as a fallback default_srid: 4326
# Maximum connections pool size [default: 20] pool_size: 20
# Limit the number of table geo features included in a tile. Unlimited by default. maxfeaturecount: 1000
# Control the automatic generation of bounds for spatial tables [default: false] # If enabled, it will spend some time on startup to compute geometry bounds. disable_bounds: false
# Enable automatic discovery of tables and functions. You may set this to false to disable.
autopublish:
# Optionally limit to just these schemas
fromschemas:
- public
- myschema
# Here we enable both tables and functions auto discovery.
# You can also enable just one of them by not mentioning the other,
# or setting it to false. Setting one to true disables the other one as well.
# E.g. tables: false enables just the functions auto-discovery.
tables:
# Optionally set a custom source ID based on the table name
idformat: 'table.{schema}.{table}.{column}'
# Add more schemas to the ones listed above
fromschemas: myotherschema
functions:
idformat: '{schema}.{function}'
# Associative arrays of table sources tables: tablesourceid: # ID of the MVT layer (optional, defaults to table name) layerid: tablesource
# Table schema (required)
schema: public
# Table name (required)
table: table_source
# Geometry SRID (required)
srid: 4326
# Geometry column name (required)
geometry_column: geom
# Feature id column name
id_column: ~
# An integer specifying the minimum zoom level
minzoom: 0
# An integer specifying the maximum zoom level. MUST be >= minzoom
maxzoom: 30
# The maximum extent of available map tiles. Bounds MUST define an area
# covered by all zoom levels. The bounds are represented in WGS:84
# latitude and longitude values, in the order left, bottom, right, top.
# Values may be integers or floating point numbers.
bounds: [ -180.0, -90.0, 180.0, 90.0 ]
# Tile extent in tile coordinate space
extent: 4096
# Buffer distance in tile coordinate space to optionally clip geometries
buffer: 64
# Boolean to control if geometries should be clipped or encoded as is
clip_geom: true
# Geometry type
geometry_type: GEOMETRY
# List of columns, that should be encoded as tile properties (required)
properties:
gid: int4
# Associative arrays of function sources functions: functionsourceid: # Schema name (required) schema: public
# Function name (required)
function: function_zxy_query
# An integer specifying the minimum zoom level
minzoom: 0
# An integer specifying the maximum zoom level. MUST be >= minzoom
maxzoom: 30
# The maximum extent of available map tiles. Bounds MUST define an area
# covered by all zoom levels. The bounds are represented in WGS:84
# latitude and longitude values, in the order left, bottom, right, top.
# Values may be integers or floating point numbers.
bounds: [ -180.0, -90.0, 180.0, 90.0 ]
pmtiles: paths: # scan this whole dir, matching all *.pmtiles files - /dir-path # specific pmtiles file will be published as pmtiles2 source - /path/to/pmtiles.pmtiles sources: # named source matching source name to a single file pm-src1: /path/to/pmtiles1.pmtiles
mbtiles: paths: # scan this whole dir, matching all *.mbtiles files - /dir-path # specific mbtiles file will be published as mbtiles2 source - /path/to/mbtiles.mbtiles sources: # named source matching source name to a single file mb-src1: /path/to/mbtiles1.mbtiles ```
Martin supports many of the PostgreSQL connection string settings such as host, port, user, password, dbname, sslmode, connect_timeout, keepalives, keepalives_idle, etc. See the PostgreSQL docs for more details.
`
Martin supports PostgreSQL sslmode including disable, prefer, require, verify-ca and verify-full modes as described in the PostgreSQL docs. Certificates can be provided in the configuration file, or can be set using the same env vars as used for psql. When set as env vars, they apply to all PostgreSQL connections. See environment vars section for more details.
By default, sslmode is set to prefer which means that SSL is used if the server supports it, but the connection is not aborted if the server does not support it. This is the default behavior of psql and is the most compatible option. Use the sslmode param to set a different sslmode, e.g. postgresql://user:password@host/db?sslmode=require.
You can use official Docker image ghcr.io/maplibre/martin
shell
docker run \
-p 3000:3000 \
-e DATABASE_URL=postgresql://postgres@localhost/db \
ghcr.io/maplibre/martin
If you are running PostgreSQL instance on localhost, you have to change network settings to allow the Docker container to access the localhost network.
For Linux, add the --net=host flag to access the localhost PostgreSQL service.
shell
docker run \
--net=host \
-p 3000:3000 \
-e DATABASE_URL=postgresql://postgres@localhost/db \
ghcr.io/maplibre/martin
For macOS, use host.docker.internal as hostname to access the localhost PostgreSQL service.
shell
docker run \
-p 3000:3000 \
-e DATABASE_URL=postgresql://postgres@host.docker.internal/db \
ghcr.io/maplibre/martin
For Windows, use docker.for.win.localhost as hostname to access the localhost PostgreSQL service.
shell
docker run \
-p 3000:3000 \
-e DATABASE_URL=postgresql://postgres@docker.for.win.localhost/db \
ghcr.io/maplibre/martin
You can use example docker-compose.yml file as a reference
```yml version: '3'
services: martin: image: ghcr.io/maplibre/martin:v0.7.0 restart: unless-stopped ports: - "3000:3000" environment: - DATABASEURL=postgresql://postgres:password@db/db dependson: - db
db: image: postgis/postgis:14-3.3-alpine restart: unless-stopped environment: - POSTGRESDB=db - POSTGRESUSER=postgres - POSTGRESPASSWORD=password volumes: - ./pgdata:/var/lib/postgresql/data ```
First, you need to start db service
shell
docker-compose up -d db
Then, after db service is ready to accept connections, you can start martin
shell
docker-compose up -d martin
By default, Martin will be available at localhost:3000
You can run Martin behind Nginx proxy, so you can cache frequently accessed tiles and reduce unnecessary pressure on the database.
```yml version: '3'
services: nginx: image: nginx:alpine restart: unless-stopped ports: - "80:80" volumes: - ./cache:/var/cache/nginx - ./nginx.conf:/etc/nginx/nginx.conf:ro depends_on: - martin
martin: image: maplibre/martin:v0.7.0 restart: unless-stopped environment: - DATABASEURL=postgresql://postgres:password@db/db dependson: - db
db: image: postgis/postgis:14-3.3-alpine restart: unless-stopped environment: - POSTGRESDB=db - POSTGRESUSER=postgres - POSTGRESPASSWORD=password volumes: - ./pgdata:/var/lib/postgresql/data ```
You can find an example Nginx configuration file here.
If you are running Martin behind Nginx proxy, you may want to rewrite the request URL to properly handle tile URLs in TileJSON endpoints.
```nginx
location ~ /tiles/(?
proxy_pass http://martin:3000/$fwd_path$is_args$args;
} ```
You can also use Nginx to cache tiles. In the example, the maximum cache size is set to 10GB, and caching time is set to 1 hour for responses with codes 200, 204, and 302 and 1 minute for responses with code 404.
```nginx http { ... proxycachepath /var/cache/nginx/ levels=1:2 maxsize=10g usetemppath=off keyszone=tiles_cache:10m;
server {
...
location ~ /tiles/(?
proxy_cache tiles_cache;
proxy_cache_lock on;
proxy_cache_revalidate on;
# Set caching time for responses
proxy_cache_valid 200 204 302 1h;
proxy_cache_valid 404 1m;
proxy_cache_use_stale error timeout http_500 http_502 http_503 http_504;
add_header X-Cache-Status $upstream_cache_status;
proxy_pass http://martin:3000/$fwd_path$is_args$args;
}
} } ```
You can find an example Nginx configuration file here.
You can clone the repository and build Martin using cargo package manager.
shell
git clone git@github.com:maplibre/martin.git
cd martin
cargo build --release
The binary will be available at ./target/release/martin.
shell
cd ./target/release/
./martin postgresql://postgres@localhost/db
Log levels are controlled on a per-module basis, and by default all logging is disabled except for errors. Logging is controlled via the RUST_LOG environment variable. The value of this environment variable is a comma-separated list of logging directives.
This will enable debug logging for all modules:
shell
export RUST_LOG=debug
martin postgresql://postgres@localhost/db
While this will only enable verbose logging for the actix_web module and enable debug logging for the martin and tokio_postgres modules:
shell
export RUST_LOG=actix_web=info,martin=debug,tokio_postgres=debug
martin postgresql://postgres@localhost/db
just to see available commands:shell, ignore
❯ git clone git@github.com:maplibre/martin.git
❯ cd martin
❯ just
Available recipes:
run *ARGS # Start Martin server and a test database
debug-page *ARGS # Start Martin server and open a test page
psql *ARGS # Run PSQL utility against the test database
clean # Perform cargo clean to delete all build files
start # Start a test database
start-legacy # Start a legacy test database
stop # Stop the test database
bench # Run benchmark tests
test # Run all tests using a test database
test-legacy # Run all tests using tde oldest supported version of the database
test-unit *ARGS # Run Rust unit and doc tests (cargo test)
test-int # Run integration tests
bless # Run integration tests and save its output as the new expected output
coverage FORMAT='html' # Run code coverage on tests and save its output in the coverage directory. Parameter could be html or lcov.
docker-build # Build martin docker image
docker-run *ARGS # Build and run martin docker image
git *ARGS # Do any git command, ensuring that the testing environment is set up. Accepts the same arguments as git.
lint # Run cargo fmt and cargo clippy
```shell Start db service just debug-page
Run Martin server DATABASE_URL=postgresql://postgres@localhost/db cargo run ```
Open tests/debug.html for debugging. By default, Martin will be available at localhost:3000
Make your changes, and check if all the tests are running
shell
DATABASE_URL=postgresql://postgres@localhost/db cargo test
You can also run benchmarks with
shell
DATABASE_URL=postgresql://postgres@localhost/db cargo bench
An HTML report displaying the results of the benchmark will be generated under target/criterion/report/index.html
You can use Martin with Managed PostgreSQL from DigitalOcean with PostGIS extension
First, you need to download the CA certificate and get your cluster connection string from the dashboard. After that, you can use the connection string and the CA certificate to connect to the database
shell
martin --ca-root-file ./ca-certificate.crt postgresql://user:password@host:port/db?sslmode=require
You can use Martin with Managed PostgreSQL from Heroku with PostGIS extension
shell
heroku pg:psql -a APP_NAME -c 'create extension postgis'
Use the same environment variables as Heroku suggests for psql.
```shell export DATABASEURL=$(heroku config:get DATABASEURL -a APP_NAME) export PGSSLCERT=DIRECTORY/PREFIXpostgresql.crt export PGSSLKEY=DIRECTORY/PREFIXpostgresql.key export PGSSLROOTCERT=DIRECTORY/PREFIXroot.crt
martin ```
You may also be able to validate SSL certificate with an explicit sslmode, e.g.
shell
export DATABASE_URL="$(heroku config:get DATABASE_URL -a APP_NAME)?sslmode=verify-ca"