NiaDocs
3.2.0
Menu

Nia documentation · 3.2.0

Get started

Pick an installation method, create the first administrator and prepare nia-todo for normal use.

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

  1. Start nia-todo and retrieve the installation’s one-time setup token from the service log or persistent token file.
  2. Open http://YOUR-SERVER:8753/setup and enter the token.
  3. Set the separate administrator password.
  4. Create the first user account. It receives administrator rights.
  5. Sign in at http://YOUR-SERVER:8753/ and open /admin to 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:

  1. Put the instance behind HTTPS and a reverse proxy.
  2. Set the exact Public base URL in /admin, for example https://todo.example.com.
  3. Verify the allowed origins and trusted proxy list.
  4. Configure and test SMTP if you need invitations, password resets or email verification.
  5. Create a manual backup and verify where it is stored.
  6. Install the preferred native app or PWA from your own instance.

Keep the data volume persistent. Replacing a container without its volume creates a new, empty instance.