Run your own RMS Radar
One service, one cache directory, no database. Choose the container for the shortest path, or install the package your distro already understands.
Docker (recommended)
The image includes the web server, the daily gateway refresher, and the VOACAP engine. It runs as an unprivileged user and keeps everything in one volume.
Quick start
mkdir -p rms-radar && cd rms-radar
cat > compose.yaml <<'YAML'
name: rms-radar
services:
rms-radar:
image: ghcr.io/ben-kuhn/rms-radar:latest
container_name: rms-radar
restart: unless-stopped
ports:
- "127.0.0.1:8079:8079"
volumes:
- rms-radar-data:/data
environment:
TZ: UTC
RMSRADAR_SERVICE_CODES: "PUBLIC,MERCURY,VARDEFM,MODEM73,DATA2G,IONHF,XARA"
read_only: true
tmpfs:
- /tmp:size=64m
security_opt:
- no-new-privileges:true
cap_drop:
- ALL
volumes:
rms-radar-data:
YAML
docker compose up -d
curl -fsS http://127.0.0.1:8079/api/health
Then open http://127.0.0.1:8079. The default publish is loopback-only; put a reverse proxy in front for remote access.
Configuration
| Variable | Default | Purpose |
|---|---|---|
RMSRADAR_SERVICE_CODES | PUBLIC,MERCURY,VARDEFM,MODEM73,DATA2G,IONHF,XARA | Codes to fetch (no wildcard). |
RMSRADAR_ADMIN_TOKEN | unset | Enables service-code editing; required in the X-RMS-Radar-Admin header. |
RMSRADAR_REFRESH | 24h | Automatic refresh interval. |
RMSRADAR_CACHE_DIR | /data | Gateway cache, tiles, conditions, and service-code selection. |
RMSRADAR_LISTEN | 0.0.0.0:8079 | Container-internal listen address. |
RMSRADAR_VOACAP_EXECUTABLE | /usr/bin/voacapl | VOACAP engine included in the image. |
Find the full flag list in the repository’s SELF-HOSTING.md. Flags can be appended after the image name.
Reverse proxy
Keep the container bound to loopback and terminate TLS at Caddy, Nginx, or Cloudflare Tunnel. A Caddy example:
rmsradar.example.com {
reverse_proxy 127.0.0.1:8079
}
If you expose it directly, change the port mapping to "8079:8079" and add firewall rules. RMS Radar has no user authentication; a reverse proxy should provide access control.
Updates, data, and backup
docker compose pull
docker compose up -d
# backup the named volume
docker run --rm -v rms-radar_rms-radar-data:/data -v "$PWD":/backup \
alpine tar czf /backup/rms-radar-data.tgz -C /data .
The data is disposable but contains the gateway cache and tiles, which make startup/offline use faster. The volume name follows the Compose project name; check with docker volume ls.
Frequency display: channel frequencies are radio dial frequencies. HF values are shown 1.5 kHz below Winlink's USB center frequency with 100 Hz precision; VHF/UHF values are unchanged.
Service codes and admin editing
Servers do not allow service-code editing by default. To enable it, set an admin token and enter the same token in the UI:
RMSRADAR_ADMIN_TOKEN=change-me docker compose up -d
curl -X POST http://127.0.0.1:8079/api/servicecodes/config \
-H 'Content-Type: application/json' \
-H 'X-RMS-Radar-Admin: change-me' \
-d '{"codes":["PUBLIC","MERCURY","VARDEFM","MODEM73","DATA2G","IONHF","XARA"]}'
Winlink does not publish private group codes. Add one only if your group has given it to you.
VOACAP
The Docker image already includes voacapl and its ITSHFBC data. The /api/config response shows "voacap":true when it is available. No extra container or download is required.
Bare-metal packages
All server packages run the same CGO-free web binary and use a systemd unit with DynamicUser, a StateDirectory, and a read-only system filesystem.
Debian / Ubuntu
sudo apt install ./rms-radar_1.0.9_amd64.deb
sudo systemctl enable --now rms-radar
curl -fsS http://127.0.0.1:8079/api/health
Edit /etc/systemd/system/rms-radar.service.d/override.conf or the packaged unit to change the bind address, service codes, or admin token:
[Service]
Environment=RMSRADAR_SERVICE_CODES=PUBLIC,MERCURY,VARDEFM,MODEM73,DATA2G,IONHF,XARA
Environment=RMSRADAR_ADMIN_TOKEN=change-me
ExecStart=
ExecStart=/usr/bin/rms-radar -d -listen 127.0.0.1:8079 -cache-dir /var/lib/rms-radar
Fedora / RHEL
sudo dnf install ./rms-radar-1.0.9-1.*.rpm
sudo systemctl enable --now rms-radar
Arch Linux
Install the released .pkg.tar.zst, or build the PKGBUILD from the repository:
sudo pacman -U rms-radar-1.0.9-1-x86_64.pkg.tar.zst
sudo systemctl enable --now rms-radar
NixOS
The nix-ham-packages overlay provides the package and a module:
services.rms-radar = {
enable = true;
listenAddress = "127.0.0.1";
port = 8079;
serviceCodes = [ "PUBLIC" "MERCURY" "VARDEFM" "MODEM73" "DATA2G" "IONHF" "XARA" ];
voacapl = pkgs.voacapl;
};
Standalone binary
tar xzf rms-radar-web-1.0.9-linux-amd64.tar.gz
./rms-radar-web-1.0.9-linux-amd64 -d \
-listen 127.0.0.1:8079 \
-cache-dir /var/lib/rms-radar
Use the packaged systemd unit in contrib/systemd/ as a starting point, or run the binary under your own service manager.
Configuration essentials
| Flag / env | Default | Notes |
|---|---|---|
-listen / RMSRADAR_LISTEN | 127.0.0.1:8079 | Use 0.0.0.0:8079 only behind a trusted proxy/firewall. |
-service-codes / RMSRADAR_SERVICE_CODES | the seven known codes | Winlink accepts explicit codes only. |
-refresh / RMSRADAR_REFRESH | 24h | The UI Refresh button is rate-limited to once every five minutes. |
-cache-dir / RMSRADAR_CACHE_DIR | ./data | Gateway cache, tiles, conditions, and the saved service-code selection. |
-admin-token / RMSRADAR_ADMIN_TOKEN | unset | Enables service-code changes on servers. |
-voacap-url / RMSRADAR_VOACAP_URL | unset | Use a remote VOACAP-compatible API instead of a local engine. |
-voacap-executable / RMSRADAR_VOACAP_EXECUTABLE | auto-detect | Path to voacapl or voacapw. |
-tile-url / RMSRADAR_TILE_URL | OpenStreetMap | Proxied and disk-cached; respect the upstream tile policy. |
Security
- Binds to
127.0.0.1by default. Use a reverse proxy or VPN for remote access. - No user accounts. The read APIs are public; ranking is capped and time-limited; tile requests are rate-limited per client.
- Service-code editing is disabled on servers unless an admin token is configured; desktop editing is same-origin and loopback-only.
- Downloaded VOACAP bundles are checksum- and minisign-verified. Docker installs the engine from Debian packages.
- The container runs non-root with a read-only root filesystem, no capabilities, and a dedicated data volume.
API and live reference
The running instance exposes /api/health, /api/gateways, /api/servicecodes, /api/conditions, POST /api/rank, POST /api/refresh, and GET /api/config. The public live map is available as a reference deployment.
RMS Radar is unofficial and is not affiliated with the Winlink Development Team or ARSFI. Winlink and the Winlink logo are trademarks of their respective owners.