A home for Homebook.
On your own machine.

01 · Get started

Install with one command.

Use Node.js 24 or newer and a running Docker installation on the computer that will host Homebook. Keep this computer running when your household needs access.

The installer downloads the released server image, walks you through access and optional model connections, and opens protected first-owner setup. You do not need a source checkout.

02 · Choose who can connect

Give your home a reliable address.

The installer offers public browser access or a private Tailscale connection. Household sign-in and permissions still apply with either choice.

Browser access from anywhere

Choose Tailscale Funnel for an automatically assigned HTTPS address. People you invite do not need Tailscale.

npx homebook@latest init --access internet --tunnel tailscale

For a domain you own, choose the guided Cloudflare Tunnel setup. Configure a permanent tunnel and keep its connector running after reboots.

npx homebook@latest init --access internet --tunnel cloudflare

Use a permanent HTTPS address. Temporary trycloudflare.com addresses are not supported. See the Cloudflare Tunnel guide.

A private household network

npx homebook@latest init --access tailscale

Install and connect Tailscale first. Each invited person also needs network access through your tailnet or device sharing. A Homebook invitation does not grant Tailscale access.

03 · Optional connections

Choose your model services.

Basic note search works without a paid AI provider. The installer can guide you through a conversation model and a separate fast-answer connection, or you can configure them later.

Enter provider credentials only in the installer’s protected prompts or the application’s settings. Model providers bill your accounts separately. Household members do not need their own keys.

After setup, test the saved connections in Assistant settings. Connection tests may incur provider usage charges. Local models need a compatible server and appropriate tool support.

04 · Make it yours

Create your home. Invite your people.

Complete first-owner setup in the browser opened by the installer. Add a few instructions, review who they should be shared with, then invite family or helpers from the app.

Test an invitation on a second device using the connection your helpers will use. Keep installer keys and recovery details private.

Keep it running

Check, open, and maintain your installation.

npx homebook@latest status
npx homebook@latest doctor
npx homebook@latest open

If you selected a custom installation directory, pass the same --directory <path> to each command.

Stop and start

npx homebook@latest stop
npx homebook@latest start

Back up before you upgrade

You are responsible for backups and updates. Homebook runs as one Node process with a durable SQLite volume; horizontal scaling is not supported.

For a simple consistent backup, stop Homebook, snapshot the entire data volume, then start it again. Keep the matching encryption key in a separate secure backup. Copying only the SQLite database file while it is being written can lose data.

Record the current application version and test restoring into an isolated installation before upgrading. Running an older image does not undo a database migration. Never delete the data volume to fix an interrupted setup.

Alternative · Preview

Host in your own Railway account.

npx homebook@latest init --mode cloud

This preview flow needs Node.js 24+ but no local Docker. Hosting and model usage are billed to your accounts. Live Railway provisioning and backup/restore acceptance remain pending.

A Railway installation through the CLI is self-hosted: you manage its costs, backups, and updates. For Homebook managed by us, request access to the hosted pilot.