Getting Started

Installation

How to install and set up Tileserver RS

Installation

There are several ways to install and run Tileserver RS.

The easiest way to get started is using Docker:

docker pull ghcr.io/vinayakkulkarni/tileserver-rs:latest

docker run -p 8080:8080 \
  -v /path/to/your/tiles:/data:ro \
  -v /path/to/config.toml:/app/config.toml:ro \
  ghcr.io/vinayakkulkarni/tileserver-rs:latest

Using Docker Compose

Create a compose.yml file:

services:
  tileserver:
    image: ghcr.io/vinayakkulkarni/tileserver-rs:latest
    ports:
      - "8080:8080"
    volumes:
      - ./data:/data:ro
      - ./config.toml:/app/config.toml:ro
    environment:
      - RUST_LOG=info

Then run:

docker compose up -d

Building from Source

Prerequisites

  • Rust 1.75 or later
  • Node.js 22 or later (for the frontend)
  • Bun (package manager)

Build Steps

  1. Clone the repository:
git clone https://github.com/vinayakkulkarni/tileserver-rs.git
cd tileserver-rs
  1. Build the Rust backend:
cargo build --release
  1. Build the frontend:
bun install
bun run build:client
  1. Run the server:
./target/release/tileserver-rs --config config.toml

Next Steps