martin/README.md

121 lines
7.1 KiB
Markdown
Raw Normal View History

# Martin
2017-10-09 14:29:03 +03:00
[![Book](https://img.shields.io/badge/docs-Book-informational)](https://maplibre.org/martin)
[![docs.rs docs](https://docs.rs/martin/badge.svg)](https://docs.rs/martin)
[![Slack chat](https://img.shields.io/badge/Chat-on%20Slack-blueviolet)](https://slack.openstreetmap.us/)
[![GitHub](https://img.shields.io/badge/github-maplibre/martin-8da0cb?logo=github)](https://github.com/maplibre/martin)
[![crates.io version](https://img.shields.io/crates/v/martin.svg)](https://crates.io/crates/martin)
[![Security audit](https://github.com/maplibre/martin/workflows/Security%20audit/badge.svg)](https://github.com/maplibre/martin/security)
[![CI build](https://github.com/maplibre/martin/workflows/CI/badge.svg)](https://github.com/maplibre/martin/actions)
2023-08-21 10:07:37 +03:00
[![](https://img.shields.io/badge/Slack-%23maplibre--martin-2EB67D?logo=slack)](https://slack.openstreetmap.us/)
2017-10-15 14:48:23 +03:00
2023-06-01 23:15:05 +03:00
Martin is a tile server able to generate and serve [vector tiles](https://github.com/mapbox/vector-tile-spec) on the fly from large [PostGIS](https://github.com/postgis/postgis) databases, [PMTile](https://protomaps.com/blog/pmtiles-v3-whats-new), and [MBTile](https://github.com/mapbox/mbtiles-spec) files, allowing multiple tile sources to be dynamically combined into one. Martin optimizes for speed and heavy traffic, and is written in [Rust](https://github.com/rust-lang/rust).
2023-02-17 04:46:07 +03:00
See [Martin book](https://maplibre.org/martin/) for complete documentation.
2023-02-17 04:46:07 +03:00
![Martin](https://raw.githubusercontent.com/maplibre/martin/main/logo.png)
2023-02-17 04:46:07 +03:00
2023-06-03 00:00:19 +03:00
## Installation
_See [installation instructions](https://maplibre.org/martin/installation.html) in the Martin book._
2023-02-17 04:46:07 +03:00
2023-06-03 00:00:19 +03:00
**Prerequisites:** If using Martin with PostgreSQL database, you must install PostGIS with at least v3.0+, v3.1+ recommended.
2023-02-17 04:46:07 +03:00
You can download martin from [GitHub releases page](https://github.com/maplibre/martin/releases).
| Platform | AMD-64 | ARM-64 |
|----------|--------------------------------------------------------------------------------------------------|-------------------------------------|
2023-10-02 19:57:54 +03:00
| Linux | [.tar.gz][rl-linux-x64] (gnu)<br>[.tar.gz][rl-linux-x64-musl] (musl)<br>[.deb][rl-linux-x64-deb] | [.tar.gz][rl-linux-a64-musl] (musl) |
| macOS | [.tar.gz][rl-macos-x64] | [.tar.gz][rl-macos-a64] |
| Windows | [.zip][rl-win64-zip] | |
2023-10-02 02:55:26 +03:00
[rl-linux-x64]: https://github.com/maplibre/martin/releases/latest/download/martin-Linux-x86_64.tar.gz
[rl-linux-x64-musl]: https://github.com/maplibre/martin/releases/latest/download/martin-Linux-x86_64-musl.tar.gz
[rl-linux-x64-deb]: https://github.com/maplibre/martin/releases/latest/download/martin-Debian-x86_64.deb
[rl-linux-a64-musl]: https://github.com/maplibre/martin/releases/latest/download/martin-Linux-aarch64-musl.tar.gz
[rl-macos-x64]: https://github.com/maplibre/martin/releases/latest/download/martin-Darwin-x86_64.tar.gz
[rl-macos-a64]: https://github.com/maplibre/martin/releases/latest/download/martin-Darwin-aarch64.tar.gz
2023-02-17 04:46:07 +03:00
[rl-win64-zip]: https://github.com/maplibre/martin/releases/latest/download/martin-Windows-x86_64.zip
If you are using macOS and [Homebrew](https://brew.sh/) you can install `martin` and `mbtiles` using Homebrew tap.
2023-02-17 04:46:07 +03:00
```shell
brew tap maplibre/martin
brew install martin
2023-02-17 04:46:07 +03:00
```
2023-06-03 00:00:19 +03:00
## Running Martin Service
_See [running instructions](https://maplibre.org/martin/run.html) in the Martin book._
2023-02-17 04:46:07 +03:00
2023-06-01 23:15:05 +03:00
Martin supports any number of PostgreSQL/PostGIS database connections with [geospatial-enabled](https://postgis.net/docs/using_postgis_dbmanagement.html#geometry_columns) tables and tile-producing SQL functions, as well as [PMTile](https://protomaps.com/blog/pmtiles-v3-whats-new) and [MBTile](https://github.com/mapbox/mbtiles-spec) files as tile sources.
2023-02-17 04:46:07 +03:00
2023-06-01 23:15:05 +03:00
Martin can auto-discover tables and functions using a [connection string](https://maplibre.org/martin/PostgreSQL-Connection-String.html). A PG connection string can also be passed via the `DATABASE_URL` environment variable.
Each tile source will have a [TileJSON](https://github.com/mapbox/tilejson-spec) endpoint.
#### Examples
2023-02-17 04:46:07 +03:00
```shell
2023-06-01 23:15:05 +03:00
# publish all tables and functions from a single database
export DATABASE_URL="postgresql://user:password@host:port/database"
2023-06-01 23:15:05 +03:00
martin
2023-02-17 04:46:07 +03:00
2023-09-26 10:41:40 +03:00
# same as above, but passing connection string via CLI, together with a directory of .mbtiles/.pmtiles files
2023-06-01 23:15:05 +03:00
martin postgresql://user:password@host:port/database path/to/dir
2023-02-17 04:46:07 +03:00
2023-06-01 23:15:05 +03:00
# publish all discovered tables/funcs from two DBs
# and generate config file with all detected sources
martin postgres://... postgres://... --save-config config.yaml
2023-02-17 04:46:07 +03:00
2023-06-01 23:15:05 +03:00
# use configuration file instead of auto-discovery
martin --config config.yaml
2023-02-17 04:46:07 +03:00
```
2023-06-03 00:00:19 +03:00
#### Docker Example
_See [Docker instructions](https://maplibre.org/martin/run-with-docker.html) in the Martin book._
Martin is also available as a [Docker image](https://ghcr.io/maplibre/martin). 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.
```shell
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
```
## API
2023-06-03 00:00:19 +03:00
_See [API documentation](https://maplibre.org/martin/using.html) in the Martin book._
2023-02-17 04:46:07 +03:00
2023-06-01 23:15:05 +03:00
Martin data is available via the HTTP `GET` endpoints:
2023-06-03 00:00:19 +03:00
| 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 |
Add dynamic sprites support (#715) Dynamically create image sprites for MapLibre rendering, given a directory with images. ### TODO * [x] Work with @flother to merge these PRs * [x] https://github.com/flother/spreet/pull/59 (must have) * [x] https://github.com/flother/spreet/pull/57 * [x] https://github.com/flother/spreet/pull/56 * [ ] https://github.com/flother/spreet/pull/62 (not required but nice to have, can upgrade later without any code changes) * [x] Add docs to the book * [x] Add CLI param, e.g. `--sprite <dir_path>` * [x] Don't output `.sprites` in auto-genned config when not in use ### API Per [MapLibre sprites API](https://maplibre.org/maplibre-style-spec/sprite/), we need to support the following: * `/sprite/<sprite_id>.json` metadata about the sprite file - all coming from a single directory * `/sprite/<sprite_id>.png` all images combined into a single PNG * `/sprite/<sprite_id>@2x.json` same but for high DPI devices * `/sprite/<sprite_id>@2x.png` Multiple sprite_id values can be combined into one sprite with the same pattern as for tile joining: `/sprite/<sprite_id1>,<sprite_id2>,...,<sprite_idN>[.json|.png|@2x.json|@2x.png]`. No ID renaming is done, so identical names will override one another. ### Configuration [Config file](https://maplibre.org/martin/config-file.html) and possibly CLI should have a simple option to serve sprites. The configuration may look similar to how mbtiles and pmtiles are configured: ```yaml # Publish sprite images sprites: paths: # scan this whole dir, matching all image files, and publishing it as "my_images" sprite source - /path/to/my_images sources: # named source matching source name to a directory my_sprites: /path/to/some_dir ``` Implement #705
2023-06-16 15:19:47 +03:00
| `/sprite/{spriteID}[@2x].{json,png}` | Sprites (low and high DPI, index/png) |
2023-06-03 00:00:19 +03:00
| `/health` | Martin server health check: returns 200 `OK` |
## Documentation
See [Martin book](https://maplibre.org/martin/) for complete documentation.
2023-07-25 23:20:41 +03:00
## License
Licensed under either of
2023-07-27 19:21:58 +03:00
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
2023-07-25 23:20:41 +03:00
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the
Apache-2.0 license, shall be dual licensed as above, without any
additional terms or conditions.