Self-hosting overview
Self-hosting is in beta. These docs describe server version 0.5.1. The newest published Docker images are older, so some settings described here only apply from the next release.
You can run the OpenBeacon server on your own hardware instead of using our hosted server. Your family's locations are end-to-end encrypted on their phones, so your server stores them without being able to read them, just like ours.
What you run
| Part | What it does |
|---|---|
| Backend | The API the app talks to. Docker image lspsoftware/openbeacon-backend. |
| Scheduled job runner | Deletes accounts at the end of their grace period and clears expired email codes. Docker image lspsoftware/openbeacon-scheduled-jobs. Every installation needs exactly one. |
| PostgreSQL | Stores accounts, groups and encrypted locations. |
| Redis | A Redis-compatible cache, such as Dragonfly, used for rate limits and signed map addresses. |
| S3-compatible storage | Holds profile and group pictures. |
| Cloudflare R2 | Holds the map tiles file. |
Both images are tagged with each released server version and with latest-stable.
What's optional
- Email for sign-up codes, password resets and security alerts. Without it, users can't reset a forgotten password. See Email.
- Google sign-in.