versatiles/versatiles-frontend repository overview

⁠Docker Image: versatiles/versatiles-frontend

A production‑ready Docker image that runs a VersaTiles server⁠ bundled with the developer front‑end⁠.

⁠Quick Start

Pull the image and display its built‑in help:

docker run -it --rm versatiles/versatiles-frontend --help

⁠Usage

To serve a VersaTiles container together with the web front‑end using the latest image:

1. Navigate to the directory that contains an osm.versatiles (or any other *.versatiles) file.
2. Start the server with:

docker run \
  -p 8080:8080 \
  -v "$(pwd)":/data:ro \
  versatiles/versatiles-frontend:alpine \
  osm.versatiles

Open http://localhost:8080/⁠ in your browser. You should see something like this: screenshot⁠.

⁠Command Breakdown

• docker run — Launches the container.
• -p 8080:8080 — Maps port 8080 inside the container to 8080 on the host.
• -v "$(pwd)":/data:ro — Binds the current directory to /data inside the container (read‑only).
• versatiles/versatiles-frontend:alpine — Specifies the Docker image (see other tags⁠).

Everything after the image name is passed to versatiles server:

• 'osm.versatiles' — Serves the mounted osm.versatiles file (adjust the path if your file is named differently).

⁠Image Variants

This image is available in three variants:

Variant	Version	Size	Signal Handling
alpine			✅ Includes tini⁠ for proper signal handling
debian			✅ Includes tini⁠ for proper signal handling
scratch			⚠️ No tini included. Use docker run --init if you need signal handling

Signal Handling: The Alpine and Debian variants include tini as the init system, ensuring server containers respond correctly to termination signals (e.g., Ctrl-C in interactive mode) and shut down gracefully in under 1 second.

For the scratch variant, if you need proper signal handling, use Docker's --init flag:

docker run --init -p 8080:8080 -v "$(pwd)":/data versatiles/versatiles-frontend:scratch osm.versatiles

⁠Resources

• Server — versatiles‑rs⁠ (Rust)
• Dockerfiles — versatiles‑docker⁠
• Front‑end — versatiles‑frontend⁠ · latest release⁠
• Tile data — https://download.versatiles.org⁠

⁠About This Image

This image is built from the versatiles-frontend⁠ directory in the versatiles‑docker⁠ repository.

⁠License

MIT