HomeBranch handbook
Documentation
Find your way around HomeBranch, whether you want a library without server upkeep or plan to run the open-source stack yourself. Cloud readers can explore the hosted service; self-hosters can start with deployment and configuration.
Managed hosting
HomeBranch Cloud
Explore plans and start a private hosted library.
Your infrastructure
Self-host HomeBranch
Deploy the stack on your server and keep control of your setup.
Guides and references
Deploy
Getting started
Set up the HomeBranch services with Docker Compose, or explore other installation options.
Follow the deployment guide →Configure
Configuration
Reference environment variables, service connections, authentication, and runtime settings.
View configuration →Integrate
API reference
Explore authentication, library, reading position, and OPDS endpoints.
Browse API endpoints →Learn
Guides
Host your own ebook library, connect e-reader apps over OPDS, sync reading progress and send books to a Kindle.
Browse the guides →Stay current
Releases
Review changes and upgrade notes before updating your HomeBranch installation.
Read release notes →