Install & Deploy
RomM is distributed as a Docker image. Every supported deployment runs the same container, and the differences are in who manages it.
Pick your path
| If you're on… | Start here |
|---|---|
| Linux server/NAS | The canonical reference setup |
| Unraid | Community Apps template or DCM |
| Synology | Container Manager + DSM-specific notes |
| TrueNAS | App Catalog or YAML install |
| Kubernetes | Community charts and gotchas |
If none of those match, start with Docker Compose and adapt as needed.
Foundational pieces
Regardless of host platform, you'll make the same handful of decisions:
- Database: MariaDB (default), MySQL or PostgreSQL
- In-memory store: required for sessions + task queue, embedded or external
- Reverse proxy: Caddy, nginx, Traefik, or NPM. HTTPS is required for OIDC and PWA install.
- Backup & restore: Test it before you need it!
After you're up and running
- Configure metadata providers: Metadata Providers
- Populate the library: Your First Scan
- Add users: Invitations & Registration