mirror of
https://github.com/maplibre/martin.git
synced 2024-12-19 12:51:37 +03:00
4814d3369c
Fix #979 with [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) and [markdown-link-check](https://github.com/actions-marketplace-validations/gaurav-nelson_github-action-markdown-link-check) ## Link check - [x] Add link check to just clippy - [x] Add relative links check with [markdown-link-check](https://github.com/actions-marketplace-validations/gaurav-nelson_github-action-markdown-link-check) - [x] Ignore `CHANGELOG.md` - [x] Ignore `localhost` and `127.0.0.1` - [x] Ignore `http://opensource.org` - [x] Add to justfile ## Lintting - [x] Add markdown linting - [x] Add markdown lint to just fmt - [x] Ignore `CHANGELOG.md`? - [x] Ignore [Line Length](https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md013.md) - [x] Ignore [First line in a file should be a top-level heading](https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md041.md) - [x] Ignore [Inline HTML](https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md033.md) - [x] Ignore [Images should have alternate text](https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md045.md) - [x] Ignore [Heading levels should only increment by one level at a time](https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md001.md) - [x] Rename lint config file. - [x] Add to justfile --------- Co-authored-by: Yuri Astrakhan <YuriAstrakhan@gmail.com>
127 lines
7.6 KiB
Markdown
Executable File
127 lines
7.6 KiB
Markdown
Executable File
[](https://maplibre.org/martin/)
|
|
|
|
[](https://maplibre.org/martin)
|
|
[](https://docs.rs/martin)
|
|
[](https://slack.openstreetmap.us/)
|
|
[](https://github.com/maplibre/martin)
|
|
[](https://crates.io/crates/martin)
|
|
[](https://github.com/maplibre/martin/security)
|
|
[](https://github.com/maplibre/martin/actions)
|
|
[](https://slack.openstreetmap.us/)
|
|
|
|
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).
|
|
|
|
Additionally, there are [several tools](https://maplibre.org/martin/tools.html) for generating tiles in bulk from any Martin-supported sources (similar to `tilelive-copy`), copying tiles between MBTiles files, creating deltas (patches) and applying them, and validating MBTiles files.
|
|
|
|
See [Martin book](https://maplibre.org/martin/) for complete documentation.
|
|
|
|
## Installation
|
|
|
|
_See [installation instructions](https://maplibre.org/martin/installation.html) in the Martin book._
|
|
|
|
**Prerequisites:** If using Martin with PostgreSQL database, you must install PostGIS with at least v3.0+, v3.1+ recommended.
|
|
|
|
You can download martin from [GitHub releases page](https://github.com/maplibre/martin/releases).
|
|
|
|
| Platform | AMD-64 | ARM-64 |
|
|
|----------|--------------------------------------------------------------------------------------------------|-------------------------------------|
|
|
| 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] | |
|
|
|
|
[rl-linux-x64]: https://github.com/maplibre/martin/releases/latest/download/martin-x86_64-unknown-linux-gnu.tar.gz
|
|
[rl-linux-x64-musl]: https://github.com/maplibre/martin/releases/latest/download/martin-x86_64-unknown-linux-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-aarch64-unknown-linux-musl.tar.gz
|
|
[rl-macos-x64]: https://github.com/maplibre/martin/releases/latest/download/martin-x86_64-apple-darwin.tar.gz
|
|
[rl-macos-a64]: https://github.com/maplibre/martin/releases/latest/download/martin-aarch64-apple-darwin.tar.gz
|
|
[rl-win64-zip]: https://github.com/maplibre/martin/releases/latest/download/martin-x86_64-pc-windows-msvc.zip
|
|
|
|
If you are using macOS and [Homebrew](https://brew.sh/) you can install `martin` and `mbtiles` using Homebrew tap.
|
|
|
|
```shell
|
|
brew tap maplibre/martin
|
|
brew install martin
|
|
```
|
|
|
|
## Running Martin Service
|
|
|
|
_See [running instructions](https://maplibre.org/martin/run.html) in the Martin book._
|
|
|
|
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.
|
|
|
|
Martin can auto-discover tables and functions using a [connection string](https://maplibre.org/martin/pg-connections.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
|
|
|
|
```shell
|
|
# 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
|
|
```
|
|
|
|
#### 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
|
|
|
|
_See [API documentation](https://maplibre.org/martin/using.html) in the Martin book._
|
|
|
|
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 |
|
|
| `/sprite/{spriteID}[@2x].{json,png}` | Sprites (low and high DPI, index/png) |
|
|
| `/font/{font}/{start}-{end}` | Font source |
|
|
| `/font/{font1},…,{fontN}/{start}-{end}` | Composite Font source |
|
|
| `/health` | Martin server health check: returns 200 `OK` |
|
|
|
|
## Documentation
|
|
|
|
See [Martin book](https://maplibre.org/martin/) for complete documentation.
|
|
|
|
## License
|
|
|
|
Licensed under either of
|
|
|
|
* 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>)
|
|
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.
|