Sign inSign up

offaro/offaro-server

By offaro

•Updated 2 months ago

Offline APRS Radio Operation, OffARO. The optional server component. URL: https://offaro.io

Image
0

1.6K

offaro/offaro-server repository overview

⁠OffARO Server

The optional server for OffARO⁠ — a small relay that keeps a live Event in sync across several operators (positions, drawings, the Event log, tracked stations), in real time.

Content is end-to-end encrypted by the clients, so the server stores only opaque ciphertext and never sees the Event password. Running one does not let you read anyone's data.

⁠Quick start

docker run -d --name offaro-server \
  -p 17777:17777 \
  -v offaro-data:/data \
  -e OFFARO_NAME="My OffARO Server" \
  offaro/offaro-server:latest

The SQLite database lives under /data — keep it on a named volume so Events survive a restart. OffARO clients add the server by host:port (default 17777) or discover it automatically on the LAN.

Compose example, desktop-app installers, and full docs: https://github.com/OffARO/OffARO-Server⁠

Tags

  • latest, 0.1.0, 0.1 — multi-arch (amd64 + arm64)

Common configuration (environment)

┌──────────────────────┬───────────────────────────────────────────┬─────────────────┐
│       Variable       │                  Purpose                  │     Default     │
├──────────────────────┼───────────────────────────────────────────┼─────────────────┤
│ OFFARO_NAME          │ Name clients see on the LAN               │ OffARO Server   │
├──────────────────────┼───────────────────────────────────────────┼─────────────────┤
│ OFFARO_PORT          │ Listen port                               │ 17777           │
├──────────────────────┼───────────────────────────────────────────┼─────────────────┤
│ OFFARO_TRANSPORT_PSK │ Extra transport encryption (optional)     │ (none)
├──────────────────────┼───────────────────────────────────────────┼─────────────────┤
│ OFFARO_STATS_TOKEN   │ Bearer token to expose /stats remotely    │ (loopback o
├──────────────────────┼───────────────────────────────────────────┼─────────────────┤
│ OFFARO_TRUST_PROXY   │ Honour X-Forwarded-For behind a TLS proxy │ false
├──────────────────────┼───────────────────────────────────────────┼─────────────────┤
│ OFFARO_ANNOUNCE      │ Advertise on the LAN via mDNS             │ true
└──────────────────────┴───────────────────────────────────────────┴─────────────────┘

TLS

The server speaks plain HTTP/WS; terminate TLS with a reverse proxy (see the Compose example in the GitHub repo). Event content is end-to-end encrypted regardless of the transport.

Releases: https://github.com/OffARO/OffARO-Server⁠

Tag summary

Content type

Image

Digest

sha256:6d330bae4…

Size

84.8 MB

Last updated

2 months ago

docker pull offaro/offaro-server