Skip to content
merran
GitHubInstall

Merran documentation Get started

First-run setup

On a fresh installation, Merran prints a setup code in its server log. For Compose:

Terminal window
docker compose logs merran

For a standalone container:

Terminal window
docker logs merran

The code prevents someone who merely finds the address from claiming an unconfigured server. Copy it from your own logs.

Open Merran at your server’s address, enter the setup code, and follow the setup form to create your account and household. The first account is the server administrator.

Your household holds the shared recipes, plan, pantry, and shopping lists. Merran can host multiple households, and a person can belong to more than one.

  • This server controls server-wide configuration and optional modules.
  • Household controls the household’s preferences and shared setup.
  • Personal settings apply to your account.

Start with the core meal workflow. You can configure AI providers, stores, nutrition, and voice later as needed. Some features require an enabled module, external credentials, or another service.

Next: your first week.

© 2026 Kyle Johnson. Documentation: CC BY 4.0. Merran: AGPL-3.0-or-later.