Repolode
dietrichmax

dietrichmax/docker-staticmaps

Self-hostable REST API that renders static map images with markers, polygons, circles, polylines and text overlays.

Open-source alternative to:Google Static Maps APIMapbox Static Images API

Stars
130
Forks
8
Open issues
2
Last commit
yesterday

What is it?

Docker Static Maps API is a self-hostable service that generates static map images through a REST endpoint. Callers specify size, center, zoom and basemap in a query string, and can add markers, polygons, circles, polylines and text overlays to the rendered image.

It supports several basemaps, including OpenStreetMap, Esri and Carto, as well as custom tile servers. An optional hillshade overlay built from Terrarium-encoded raster DEM tiles is also available. Tiles and rendered images are cached, and the API applies per-IP rate limiting with optional API key authentication.

The service runs as a Docker container on port 3000 and includes an interactive playground in the browser for trying out requests.

Key features

  • 01Renders markers, polygons, circles, polylines and text overlays on static maps
  • 02Supports OpenStreetMap, Esri and Carto basemaps plus custom tile servers
  • 03Offers an optional hillshade overlay from Terrarium-encoded DEM tiles
  • 04Caches tiles and generated images
  • 05Applies per-IP rate limiting and optional API key authentication
  • 06Ships as a Docker image with a browser-based playground

Use cases

  • Embedding map previews in emails, reports or notifications without loading a JavaScript map
  • Generating location images for dashboards or server-side rendered pages
  • Producing map thumbnails for listings that show a route, area or set of points
  • Running a private static map service on your own infrastructure

Quick start

  1. 1

    Run the API with Docker

    docker run -p '3000:3000/tcp' mxdcodes/docker-staticmaps:latest
  2. 2

    Request a sample map image

    curl "http://localhost:3000/api/staticmaps?width=1000&height=1000&center=-18.2871,147.6992&zoom=9&basemap=satellite"
  3. 3

    Open the interactive playground in a browser

Things to know

  • The source code is licensed under AGPL-3.0+, which has strong copyleft requirements if you modify and host it.

In collections

Topics

FAQ

What is docker-staticmaps?
Self-hostable REST API that renders static map images with markers, polygons, circles, polylines and text overlays. Docker Static Maps API is a self-hostable service that generates static map images through a REST endpoint. Callers specify size, center, zoom and basemap in a query string, and can add markers, polygons, circles, polylines and text overlays to the rendered image.
Is docker-staticmaps free to use? What license does it have?
docker-staticmaps is open source under the Other license. Check the license terms before using it in commercial products.
Is docker-staticmaps still maintained?
Actively maintained. The last commit to docker-staticmaps was on Nov 6, 2026.
What can I use docker-staticmaps for?
Embedding map previews in emails, reports or notifications without loading a JavaScript map Generating location images for dashboards or server-side rendered pages Producing map thumbnails for listings that show a route, area or set of points Running a private static map service on your own infrastructure
How do I install docker-staticmaps?
Run the API with Docker: docker run -p '3000:3000/tcp' mxdcodes/docker-staticmaps:latest Request a sample map image: curl "http://localhost:3000/api/staticmaps?width=1000&height=1000&center=-18.2871,147.6992&zoom=9&basemap=satellite" Open the interactive playground in a browser
Where can I get docker-staticmaps?
The source code and installation instructions are on GitHub: https://github.com/dietrichmax/docker-staticmaps

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects