Blazing fast and lightweight PostGIS, MBtiles and PMtiles tile server, tile generation, and mbtiles tooling.
Go to file
dependabot[bot] 37609dd303
chore(deps): Bump dependabot/fetch-metadata from 2.0.0 to 2.1.0 (#1316)
Bumps
[dependabot/fetch-metadata](https://github.com/dependabot/fetch-metadata)
from 2.0.0 to 2.1.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/dependabot/fetch-metadata/releases">dependabot/fetch-metadata's
releases</a>.</em></p>
<blockquote>
<h2>v2.1.0</h2>
<h2>What's Changed</h2>
<ul>
<li>Relax <code>engine-strict=true</code> by <a
href="https://github.com/jeffwidman"><code>@​jeffwidman</code></a> in <a
href="https://redirect.github.com/dependabot/fetch-metadata/pull/510">dependabot/fetch-metadata#510</a></li>
<li>Handle branch names containing hyphen separators by <a
href="https://github.com/tspencer244"><code>@​tspencer244</code></a> in
<a
href="https://redirect.github.com/dependabot/fetch-metadata/pull/450">dependabot/fetch-metadata#450</a></li>
<li>Switch to monthly release cadence by <a
href="https://github.com/jeffwidman"><code>@​jeffwidman</code></a> in <a
href="https://redirect.github.com/dependabot/fetch-metadata/pull/509">dependabot/fetch-metadata#509</a></li>
<li>v2.1.0 by <a
href="https://github.com/fetch-metadata-action-automation"><code>@​fetch-metadata-action-automation</code></a>
in <a
href="https://redirect.github.com/dependabot/fetch-metadata/pull/518">dependabot/fetch-metadata#518</a></li>
</ul>
<h2>New Contributors</h2>
<ul>
<li><a
href="https://github.com/tspencer244"><code>@​tspencer244</code></a>
made their first contribution in <a
href="https://redirect.github.com/dependabot/fetch-metadata/pull/450">dependabot/fetch-metadata#450</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/dependabot/fetch-metadata/compare/v2.0.0...v2.1.0">https://github.com/dependabot/fetch-metadata/compare/v2.0.0...v2.1.0</a></p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="5e5f99653a"><code>5e5f996</code></a>
Merge pull request <a
href="https://redirect.github.com/dependabot/fetch-metadata/issues/518">#518</a>
from dependabot/bump-to-v2.1.0</li>
<li><a
href="63415e5037"><code>63415e5</code></a>
v2.1.0</li>
<li><a
href="76b7fe974e"><code>76b7fe9</code></a>
Merge pull request <a
href="https://redirect.github.com/dependabot/fetch-metadata/issues/509">#509</a>
from dependabot/switch-to-monthly-release-cadence</li>
<li><a
href="7c323d50f1"><code>7c323d5</code></a>
Switch to monthly release cadence</li>
<li><a
href="5c7b450d4f"><code>5c7b450</code></a>
Merge pull request <a
href="https://redirect.github.com/dependabot/fetch-metadata/issues/450">#450</a>
from HealthengineAU/handle-branches-with-hyphens</li>
<li><a
href="a44a9dfd95"><code>a44a9df</code></a>
Handle branch names containing hyphen separators</li>
<li><a
href="518993c026"><code>518993c</code></a>
Relax <code>engine-strict=true</code> (<a
href="https://redirect.github.com/dependabot/fetch-metadata/issues/510">#510</a>)</li>
<li>See full diff in <a
href="https://github.com/dependabot/fetch-metadata/compare/v2.0.0...v2.1.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=dependabot/fetch-metadata&package-manager=github_actions&previous-version=2.0.0&new-version=2.1.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

You can trigger a rebase of this PR by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

> **Note**
> Automatic rebases have been disabled on this pull request as it has
been open for over 30 days.

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-05-25 01:24:25 -04:00
.cargo-husky/hooks Use --locked with cargo install (#1216) 2024-02-27 15:40:20 +08:00
.github chore(deps): Bump dependabot/fetch-metadata from 2.0.0 to 2.1.0 (#1316) 2024-05-25 01:24:25 -04:00
debian Implement tile caching (#1105) 2023-12-30 22:48:23 -05:00
demo chore(deps-dev): Bump vite from 4.5.2 to 4.5.3 in /demo/frontend (#1285) 2024-04-09 16:00:36 -04:00
docs Update documentation for running with Docker Compose (#1283) 2024-03-30 17:11:47 +00:00
martin Fix a few CI issues and bump deps (#1341) 2024-05-17 01:05:19 -04:00
martin-tile-utils Fix typos (#1225) 2024-03-03 02:54:01 -05:00
mbtiles Fix a few CI issues and bump deps (#1341) 2024-05-17 01:05:19 -04:00
tests Fix CI: use new nginx and postgis actions (#1351) 2024-05-24 22:41:26 -04:00
.dockerignore Add AWS Lambda support (#1127) 2024-02-01 18:56:40 +00:00
.gitignore Add AWS Lambda support (#1127) 2024-02-01 18:56:40 +00:00
Cargo.lock Bump all dependencies, fix CI (#1353) 2024-05-25 01:17:26 -04:00
Cargo.toml Bump all dependencies, fix CI (#1353) 2024-05-25 01:17:26 -04:00
CHANGELOG.md fix spaces 2023-10-12 16:10:24 -04:00
CODE_OF_CONDUCT.md feat: clean up readme and code of conduct (#382) 2022-08-11 07:06:12 -04:00
docker-compose.yml Update documentation for running with Docker Compose (#1283) 2024-03-30 17:11:47 +00:00
justfile Use --locked with cargo install (#1216) 2024-02-27 15:40:20 +08:00
LICENSE-APACHE Clean up licensing per on-boarding (#364) 2022-07-06 08:25:45 -04:00
LICENSE-MIT Clean up licensing per on-boarding (#364) 2022-07-06 08:25:45 -04:00
logo.png docs: ✏️ add notes on debugging 2019-02-04 20:22:04 +03:00
README.md doc links 2023-12-25 01:49:39 -05:00
rustfmt.toml Minor refactor and cleanup (#716) 2023-06-15 18:36:41 -04:00
SECURITY_POLICY.txt Create SECURITY_POLICY.txt (#489) 2023-02-04 19:06:17 -05:00

Martin

Book docs.rs docs GitHub crates.io version Security audit CI build

Martin is a tile server able to generate and serve vector tiles on the fly from large PostGIS databases, PMTile (local or remote), 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.

Additionally, there are several tools 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 for complete documentation.

Installation

See installation instructions 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.

Platform AMD-64 ARM-64
Linux .tar.gz (gnu)
.tar.gz (musl)
.deb
.tar.gz (musl)
macOS .tar.gz .tar.gz
Windows .zip

If you are using macOS and Homebrew you can install martin and mbtiles using Homebrew tap.

brew tap maplibre/martin
brew install martin

Running Martin Service

See running instructions in the Martin book.

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

Docker Example

See Docker instructions in the Martin book.

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

API

See API documentation 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

Re-use Martin as a library

Martin can be used as a standalone server, or as a library in your own Rust application. When used as a library, you can use the following features:

  • postgres - enable PostgreSQL/PostGIS tile sources
  • pmtiles - enable PMTile tile sources
  • mbtiles - enable MBTile tile sources
  • fonts - enable font sources
  • sprites - enable sprite sources

Documentation

See Martin book for complete documentation.

License

Licensed under either of

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.