HomeBook is a self-hosted web application for organizing household tasks and joint financial planning. Developed for
families, it creates structure, transparency, and collaboration in everyday life. Easily deployable on your own server
via Docker.
Set the domain name (e.g., my-homebook.mydomain.com)
Set the scheme to http
Set the forward hostname to homebook (must be the same as the container name)
Set the forward port to 8080
disable Cache Assets
enable Block Common Exploits
enable Websockets Support
open your domain and you should see the HomeBook Setup.
Installation via CasaOS
coming soon...
Setup
Server Connection Check - the server checks that all required dependencies are installed and that no setup is
currently running.
Admin User - create the first admin user with a username, password, and email address.
Database Setup - configure the database connection and check the connection.
Configuration - configure the application settings, such as the homebook instance name and language.
User Guide
Environment Variables
if all environment variables are set, correctly, the setup will be running automatically.
Variable
Description
DATABASE_HOST
the database host (e.g., my-db.server.com)
DATABASE_PORT
the database port (e.g., 5432)
DATABASE_NAME
the database name (e.g., homebook)
DATABASE_USER
the database user (e.g., db_user)
DATABASE_PASSWORD
the database password (e.g., db_password)
HOMEBOOK_USER_NAME
the admin username (e.g., admin)
HOMEBOOK_USER_PASSWORD
the admin password (e.g., password)
HOMEBOOK_ACCEPT_LICENSES
no value needed. if added, the licenses will be accepted automatically.
Allowed Password Characters
a-z
A-Z
0-9
!@#$%^&*()_+-=[]{}|;':",./<>?~`
Optional Docker Settings
Bind Volume to Host
Create a directory on your host machine to store HomeBook data, e.g., mkdir -p /your/path/homebook.
Execute command to set rights chown -R 21001 /your/path/homebook && chmod -R 770 /your/path/homebook (21001 is the standard homebook user-id for docker, replace if needed).
Modify your Docker Compose file to bind the volume to the host directory: