Skip to content

Getting Started

github-actions[bot] edited this page Jul 28, 2026 · 2 revisions

Getting Started

Docker Compose

services:
  mirrorproxy:
    image: kudang/mirrorproxy:latest
    restart: unless-stopped
    ports: ["3000:3000"]
    volumes: ["mirrorproxy-data:/data"]
volumes:
  mirrorproxy-data:

Run docker compose up -d, check http://127.0.0.1:3000/healthz, then sign in at /admin. If no initial password was supplied, read the generated password from the container log. Keep the /data volume during upgrades; it contains SQLite, cache data, and writable GeoIP databases.

For source builds, run bash scripts/fetch-geoip.sh followed by cargo run -p mirrorproxy-server -- serve.

中文 · Full deployment guide

Clone this wiki locally