domizhang/realm repository overview

⁠realm

Docker image for realm⁠, a simple high-performance relay server.

⁠Included version

• realm: v2.9.4
• Base image: alpine:3.23
• Release artifacts are verified with pinned SHA256 checksums during build.

⁠Supported platforms

• linux/amd64
• linux/arm64

⁠Tags

• latest: latest build from the default branch
• 2.9.4: current realm version build
• 2.9: major/minor tag for versioned releases

⁠Quick start

Show the realm help output:

docker run --rm domizhang/realm:latest --help

Run with a config file:

docker run -d \
  --name realm \
  -p 5000:5000/tcp \
  -p 5000:5000/udp \
  -v "$PWD/realm.toml:/etc/realm.toml:ro" \
  domizhang/realm:latest \
  -c /etc/realm.toml

⁠Docker Compose

services:
  realm:
    image: domizhang/realm:latest
    container_name: realm
    restart: unless-stopped
    ports:
      - "5000:5000/tcp"
      - "5000:5000/udp"
    volumes:
      - ./realm.toml:/etc/realm.toml:ro
    command: ["-c", "/etc/realm.toml"]

⁠Build locally

docker build \
  --build-arg VERSION=v2.9.4 \
  -t domizhang/realm:local .

⁠Update policy

The realm version is pinned in VERSION and Dockerfile. To update:

1. Check the upstream realm releases⁠.
2. Update the VERSION file, ARG VERSION defaults, and the per-architecture SHA256 build arguments.
3. Build and test the image.
4. Tag the repository as vX.Y.Z to publish versioned tags.

⁠License

This repository only builds a Docker image. realm is distributed under its upstream license.