mirror of https://github.com/maplibre/martin.git synced 2024-12-20 21:31:49 +03:00

A lot of book content cleanup, making it a bit shorter and "logical"
(whatever that even means)

To try, run `just mdbook`

2023-06-02 01:16:41 -04:00

5.4 KiB

Executable File

Raw Blame History

Martin

Martin is a tile server able to generate and serve vector tiles on the fly from large PostGIS databases, PMTile, and MBTile files, allowing multiple tile sources to be dynamically combined into one. Martin optimizes for speed and heavy traffic, and is written in Rust.

See Martin book for complete documentation.

Prerequisites

If using Martin with PostgreSQL database, you must install PostGIS with at least v3.0+, v3.1+ recommended.

Binary Distributions

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.

brew tap maplibre/martin https://github.com/maplibre/martin.git
brew install maplibre/martin/martin

Martin is also available as a Docker image. You could either share a configuration file from the host with the container via the -v param, or you can let Martin auto-discover all sources e.g. by passing DATABASE_URL or specifying the .mbtiles/.pmtiles files.

export PGPASSWORD=postgres  # secret!
docker run -p 3000:3000 \
           -e PGPASSWORD \
           -e DATABASE_URL=postgresql://user@host:port/db \
           -v /path/to/config/dir:/config \
           ghcr.io/maplibre/martin --config /config/config.yaml

Usage

Martin supports any number of PostgreSQL/PostGIS database connections with geospatial-enabled tables and tile-producing SQL functions, as well as PMTile and MBTile files as tile sources.

Martin can auto-discover tables and functions using a connection string. A PG connection string can also be passed via the DATABASE_URL environment variable.

Each tile source will have a TileJSON endpoint.

Examples

# publish all tables and functions from a single database
export DATABASE_URL=postgresql://user:password@host:port/database
martin

# same as above, but passing connection string via CLI, together with a directory of .mbtiles/.pmtiles files  
martin postgresql://user:password@host:port/database path/to/dir

# publish all discovered tables/funcs from two DBs
# and generate config file with all detected sources
martin postgres://... postgres://...  --save-config config.yaml

# use configuration file instead of auto-discovery
martin --config config.yaml

API

Martin data is available via the HTTP GET endpoints:

URL	Description
`/`	Status text, that will eventually show web UI
`/catalog`	List of all sources
`/{sourceID}`	Source TileJSON
`/{sourceID}/{z}/{x}/{y}`	Map Tiles
`/{source1},...,{sourceN}`	Composite Source TileJSON
`/{source1},...,{sourceN}/{z}/{x}/{y}`	Composite Source Tiles
`/health`	Martin server health check: returns 200 `OK`

Documentation