# Martin Tile Server Documentation

> Martin is a fast tile server that serves vector and raster tiles from PostGIS, PMTiles, MBTiles, COG, GeoJSON and DuckDB, along with sprites, fonts and styles.

Martin is a tile server and a set of tools able to generate vector tiles on the fly from large
PostgreSQL databases, and serve tiles from PMTiles, MBTiles, Cloud Optimized GeoTIFF, GeoJSON and
DuckDB files. It can combine multiple tile sources into one, and also serves sprites, fonts and
MapLibre styles. It is written in Rust and optimized for speed and heavy traffic.
The `martin-cp` tool generates tiles in bulk, and the `mbtiles` tool inspects, copies, diffs,
patches and validates MBTiles archives.

## Getting Started

- [Introduction](<https://maplibre.org/martin/index.md>): What Martin is and what it can do
- [Martin Quick Start Guide](<https://maplibre.org/martin/quick-start/index.md>): Choosing a quick start guide
- [On Linux](<https://maplibre.org/martin/quick-start-linux/index.md>): Serving a first tileset on Linux
- [On macOS](<https://maplibre.org/martin/quick-start-macos/index.md>): Serving a first tileset on macOS
- [On Windows](<https://maplibre.org/martin/quick-start-windows/index.md>): Serving a first tileset on Windows
- [View with QGIS](<https://maplibre.org/martin/quick-start-qgis/index.md>): Viewing Martin tiles in QGIS
- [Installation](<https://maplibre.org/martin/installation/index.md>): Installing Martin from binaries, package managers, Docker or source

## Running

- [Usage](<https://maplibre.org/martin/run/index.md>): How Martin discovers sources from the command line and configuration file
- [Command Line Interface](<https://maplibre.org/martin/run-with-cli/index.md>): Command line arguments and options
- [Environment Variables](<https://maplibre.org/martin/env-vars/index.md>): Environment variables understood by Martin
- [Docker](<https://maplibre.org/martin/run-with-docker/index.md>): Running Martin in Docker
- [Docker Compose](<https://maplibre.org/martin/run-with-docker-compose/index.md>): Running Martin and PostGIS with Docker Compose
- [AWS Lambda](<https://maplibre.org/martin/run-with-lambda/index.md>): Running Martin on AWS Lambda
- [Reverse Proxies](<https://maplibre.org/martin/run-with-reverse-proxy/index.md>): Putting Martin behind a reverse proxy
- [NGINX](<https://maplibre.org/martin/run-with-nginx/index.md>): NGINX reverse proxy and caching setup
- [Apache](<https://maplibre.org/martin/run-with-apache/index.md>): Apache reverse proxy setup
- [Troubleshooting](<https://maplibre.org/martin/troubleshooting/index.md>): Diagnosing common problems

## Configuration

- [Configuration](<https://maplibre.org/martin/config-file/index.md>): The configuration file format and global options
- [Tile Sources](<https://maplibre.org/martin/sources-tiles/index.md>): Overview of the supported tile sources
- [MBTiles and PMTiles File Sources](<https://maplibre.org/martin/sources-files/index.md>): Serving tiles from MBTiles and PMTiles files
- [MBTiles File Sources](<https://maplibre.org/martin/sources-mbtiles/index.md>): MBTiles file source options
- [PMTiles File Sources](<https://maplibre.org/martin/sources-pmtiles/index.md>): PMTiles file source options, including remote and S3 archives
- [PostgreSQL Connections](<https://maplibre.org/martin/pg-connections/index.md>): PostgreSQL connection settings and auto-publishing
- [PostgreSQL Table Sources](<https://maplibre.org/martin/sources-pg-tables/index.md>): Serving PostGIS tables and views as vector tiles
- [PostgreSQL Function Sources](<https://maplibre.org/martin/sources-pg-functions/index.md>): Serving tiles generated by PostgreSQL functions
- [Table Source Layers](<https://maplibre.org/martin/sources-pg-layers/index.md>): Splitting a PostgreSQL table source into layers for martin cp --mode bulk
- [Cloud Optimized GeoTIFF File Sources](<https://maplibre.org/martin/sources-cog-files/index.md>): Serving raster tiles from Cloud Optimized GeoTIFF files
- [GeoJSON Sources](<https://maplibre.org/martin/sources-geojson/index.md>): Serving GeoJSON files as vector tiles
- [DuckDB Sources](<https://maplibre.org/martin/sources-duckdb/index.md>): Serving tiles from DuckDB databases and GeoParquet files
- [Passthrough Sources](<https://maplibre.org/martin/sources-passthrough/index.md>): Proxying tiles from an upstream HTTP tile server
- [Composite Sources](<https://maplibre.org/martin/sources-composite/index.md>): Combining multiple sources into one tile
- [Tile Grids](<https://maplibre.org/martin/tile-grids/index.md>): Tile grids and tile matrix sets
- [Postprocessing](<https://maplibre.org/martin/postprocessing/index.md>): Transforming tiles after they are read from a source
- [MVT/MLT Conversion](<https://maplibre.org/martin/postprocessing/mlt/index.md>): Converting between MVT and MapLibre Tiles (MLT)
- [Hillshade](<https://maplibre.org/martin/postprocessing/hillshade/index.md>): Generating hillshade tiles from elevation data
- [Contours](<https://maplibre.org/martin/postprocessing/contour/index.md>): Generating contour lines from elevation data
- [Sprites](<https://maplibre.org/martin/sources-sprites/index.md>): Serving sprites generated from SVG icons
- [Style Sources](<https://maplibre.org/martin/sources-styles/index.md>): Serving MapLibre styles
- [Server-side raster tile rendering](<https://maplibre.org/martin/sources-styles/rendering/index.md>): Rendering styles to raster tiles on the server
- [Fonts](<https://maplibre.org/martin/sources-fonts/index.md>): Serving font glyphs generated from font files

## API and Usage

- [Available API Endpoints](<https://maplibre.org/martin/using/index.md>): HTTP API endpoints served by Martin
- [Guides](<https://maplibre.org/martin/using-guides/index.md>): Overview of the available guides
- [Self-hosting a basemap from scratch](<https://maplibre.org/martin/recipe-basemap-selfhosted/index.md>): Self-hosting a fully styled basemap from scratch
- [Map renderer specific](<https://maplibre.org/martin/using-with-renderer/index.md>): Using Martin with map renderers
- [MapLibre](<https://maplibre.org/martin/using-with-maplibre/index.md>): Displaying Martin tiles with MapLibre
- [Leaflet](<https://maplibre.org/martin/using-with-leaflet/index.md>): Displaying Martin tiles with Leaflet
- [deck.gl](<https://maplibre.org/martin/using-with-deck-gl/index.md>): Displaying Martin tiles with deck.gl
- [Mapbox](<https://maplibre.org/martin/using-with-mapbox/index.md>): Displaying Martin tiles with Mapbox
- [OpenLayers](<https://maplibre.org/martin/using-with-openlayers/index.md>): Displaying Martin tiles with OpenLayers
- [Tile source specific](<https://maplibre.org/martin/using-with-data/index.md>): Guides specific to a tile source
- [Using Hosted PostgreSQL](<https://maplibre.org/martin/recipes/index.md>): Connecting to hosted PostgreSQL providers
- [Setting up a basemap and overlaying data](<https://maplibre.org/martin/recipe-basemap-postgis/index.md>): Generating a basemap and overlaying points from PostGIS
- [Using PostgreSQL with SSL Certificates](<https://maplibre.org/martin/pg-ssl-certificates/index.md>): Connecting to PostgreSQL with SSL certificates

## Tools

- [Bulk Tile Generation](<https://maplibre.org/martin/martin-cp/index.md>): Generating tiles in bulk with martin-cp
- [Generating Tilesets](<https://maplibre.org/martin/martin-generate/index.md>): Generating a whole tileset in bulk mode
- [Working with MBTiles archives](<https://maplibre.org/martin/mbtiles/index.md>): Working with MBTiles archives using the mbtiles CLI
- [MBTiles Schemas](<https://maplibre.org/martin/mbtiles-schema/index.md>): The flat, flat-with-hash and normalized MBTiles schemas
- [Accessing Metadata](<https://maplibre.org/martin/mbtiles-meta/index.md>): Reading and writing MBTiles metadata
- [Copying MBTiles](<https://maplibre.org/martin/mbtiles-copy/index.md>): Copying and merging MBTiles archives
- [Diffing/Patching MBTiles](<https://maplibre.org/martin/mbtiles-diff/index.md>): Diffing and patching MBTiles archives
- [Validating MBTiles](<https://maplibre.org/martin/mbtiles-validation/index.md>): Validating the integrity of MBTiles archives

## Development

- [Development](<https://maplibre.org/martin/development/index.md>): Developing Martin
- [Getting involved](<https://maplibre.org/martin/getting-involved/index.md>): How to contribute
- [Provided Tools](<https://maplibre.org/martin/tools/index.md>): Tools provided alongside the Martin server
- [Martin as a library](<https://maplibre.org/martin/martin-as-a-library/index.md>): Embedding martin-core in a Rust application
- [Serving](<https://maplibre.org/martin/architecture/index.md>): How the tile server is put together and answers requests
- [Sources](<https://maplibre.org/martin/architecture-sources/index.md>): How each tile source works and how sources reload at runtime
- [Generation](<https://maplibre.org/martin/architecture-generate/index.md>): How martin cp's bulk mode scans, sorts, encodes and writes tiles with bounded memory

## Optional

- [Migration Guide](<https://maplibre.org/martin/migration-guide/index.md>): Migrating between major versions
- [Changelog](<https://maplibre.org/martin/changelog/index.md>): Release history