Deploy BookOrbit
Self-hosted ebook, comic and audiobook library with web readers and sync
BookOrbit
Just deployed
/data
Just deployed
/var/lib/postgresql/data
Deploy and Host BookOrbit on Railway
BookOrbit is an open-source, self-hosted library and reading platform for ebooks, PDFs, comics and audiobooks. It organises your files with metadata from 12 providers, has built-in web readers and an audiobook player, tracks reading progress and statistics, and syncs with Kobo, KOReader, OPDS apps and its own iPhone app.
About Hosting BookOrbit
This template runs BookOrbit 3.8.0 from the official image, pinned by version and digest and built from our GitHub repository, next to Railway's Postgres 18 (pgvector included) on the private network. Everything BookOrbit keeps sits on a Railway volume at /data: book files in /data/books, covers, uploads and caches, so they survive redeploys and updates. The setup token, login-token secret and encryption keys are generated per deploy, so there is nothing to fill in. After deploying, open the URL, paste SETUP_BOOTSTRAP_TOKEN from the service's Variables tab, create the owner account, then add a library on /data/books and upload books from the browser.
Common Use Cases
- A private web library for your ebooks, PDFs, comics and audiobooks, readable in any browser
- Syncing reading progress and highlights between Kobo, KOReader, OPDS apps and the BookOrbit iPhone app
- Sharing one library with family or friends, with separate accounts, shelves and reading stats
Dependencies for BookOrbit Hosting
- BookOrbit web service, built from aalfath/bookorbit-railway-template on the official image
ghcr.io/bookorbit/bookorbit:3.8.0 - PostgreSQL 18 with the pgvector extension (Railway's Postgres)
Deployment Dependencies
- BookOrbit source and releases: https://github.com/bookorbit/bookorbit/releases
- Installation guide and variable reference: https://bookorbit.app/installation
- Template repository and changelog: https://github.com/aalfath/bookorbit-railway-template
Implementation Details
- Health check:
GET /api/v1/health(checks the database, no login). Database migrations run on every start. - The setup endpoint refuses requests without
SETUP_BOOTSTRAP_TOKEN, so nobody else can claim a fresh instance. Public sign-up is off by default. - The library folder picker is limited to
/data/bookson the volume.TRUST_PROXYincludes Railway's edge proxy, so cookies are marked secure and login rate limits see real client IPs. - Optional features (SMTP and Send-to-Kindle, OIDC sign-in, metadata provider keys) are set in the admin settings; their stored credentials are encrypted with the generated keys. Keep those keys unchanged.
- Updates: when a new BookOrbit release is merged into the template repository, Railway shows an update notice on your project and you choose when to apply it. Read the repository's
CHANGELOG.mdfirst. If you add a custom domain, setAPP_URLto it.
Why Deploy BookOrbit on Railway?
Railway is a singular platform to deploy your infrastructure stack. Railway will host your infrastructure so you don't have to deal with configuration, while allowing you to vertically and horizontally scale it.
By deploying BookOrbit on Railway, you are one step closer to supporting a complete full-stack application with minimal burden. Host your servers, databases, AI agents, and more on Railway.
Template Content
