The Client to access the HomeBook API
$ dotnet add package HomeBook.Client
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.
services:
homebook:
image: lkcode/homebook:latest
container_name: homebook
restart: unless-stopped
volumes:
- homebook-data:/var/lib/homebook
volumes:
homebook-data:my-homebook.mydomain.com)httphomebook (must be the same as the container name)8080Cache AssetsBlock Common ExploitsWebsockets Supportopen your domain and you should see the HomeBook Setup.
coming soon...
if all environment variables are set, correctly, the setup will be running automatically.
| Variable | Description |
|---|---|
DATABASE_PROVIDER | the database provider (one of POSTGRESQL,SQLITE or MYSQL) |
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) |
DATABASE_FILE | the database file path (e.g. for sqlite, /var/lib/homebook/homebook.db) |
HOMEBOOK_USER_NAME | the admin username (e.g., admin) |
HOMEBOOK_USER_PASSWORD | the admin password (e.g., password) |
HOMEBOOK_CONFIGURATION_ACCEPT_LICENSES | no value needed. if added, the licenses will be accepted automatically. |
HOMEBOOK_CONFIGURATION_NAME | the name of the homebook instance (e.g., My HomeBook) |
HOMEBOOK_CONFIGURATION_DEFAULT_LOCALE | the default ui locale (see languages) |
a-z
A-Z
0-9
!@#$%^&*()_+-=[]{}|;':",./<>?~`
mkdir -p /your/path/homebook.chown -R 21001 /your/path/homebook && chmod -R 770 /your/path/homebook (21001 is the
standard homebook user-id for docker, replace if needed).services:
homebook:
...
volumes:
- /host/path/homebook:/var/lib/homebooknotice: use the ENV VALUE in the environment variable HOMEBOOK_CONFIGURATION_DEFAULT_LOCALE
| Language | ENV VALUE |
|---|---|
| English | en-EN |
| German | de-DE |
we plan to support more languages in the future. For translations, we plan to use a community-driven approach via Weblate.