Nia documentation · Latest
Get started
Pick an installation method, create the first administrator and prepare Nia for normal use.Nia brings Tasks, Shopping and Recipes into one self-hosted app. Choose an installation method below and use documentation matching your server version.
Existing nia-todo package names, image names, service names and data paths remain valid. The visible product name changes to Nia; you do not need to rename a volume or move a database for the new name.
Before you begin
You need a server or VM that can run Docker, or a supported Debian/Ubuntu system. For production use, also prepare a hostname such as todo.example.com and an HTTPS reverse proxy.
Your deployment must provide:
- one reachable TCP port (default:
8753) - persistent storage for the database and runtime files
- HTTPS for passkeys, secure browser features and native integrations
Choose an installation
Docker
Choose Docker when you already use Compose, Portainer, Kubernetes-style tooling or another container platform. Updates are performed by pulling and recreating the container.
Debian or Ubuntu package
Choose the full server package for a traditional systemd installation. It includes service units, a daily backup timer, command-line recovery tools and supported in-app server updates.
Complete the initial setup
- Start Nia and retrieve the installation’s one-time setup token from the service log or persistent token file.
- Open
http://YOUR-SERVER:8753/setupand enter the token. - Set the separate administrator password.
- Create the first user account. It receives administrator rights.
- Sign in at
http://YOUR-SERVER:8753/and open/adminto configure the instance.
The full first-run setup guide lists the token location for every installation method, the enforced step order, how to resume after an interruption, and when the token becomes unusable.
Production checklist
Before inviting users:
- Put the instance behind HTTPS and a reverse proxy.
- Set the exact Public base URL in
/admin, for examplehttps://todo.example.com. - Verify the allowed origins and trusted proxy list.
- Configure and test SMTP if you need invitations, password resets or email verification.
- Create a manual backup and verify where it is stored.
- Install the preferred native app or PWA from your own instance.
- Open Tasks, Shopping and Recipes as needed, and check sharing with a second account before inviting a household.
Users choose their visible modules in Settings → Modules. This preference belongs to the account and synchronizes between devices; it is not a household or workspace setting. At least one module stays enabled. Hiding a module does not delete its content or change anyone’s permissions.
Keep the data volume persistent. Replacing a container without its volume creates a new, empty instance.