Nia documentation · Latest
Documentation
Install and run Nia, organize Tasks, Shopping and Recipes, and configure shared access, personal memory and optional BrainDump.nia-todo becomes Nia. The familiar Tasks module is now part of a shared app alongside Shopping and Recipes. Accounts, themes, sharing and synchronization connect the modules; each keeps its own content and workflows.
Existing technical names such as the nia-todo package, container, service and repository stay the same. The rename does not require moving your database or changing client IDs.
Use Nia
Choose modules in your account’s Modules settings. This preference synchronizes across devices and always leaves at least one module enabled. Tasks workspaces are personal; Shopping lists and cookbooks do not belong to them.
- Tasks: Projects, sections, recurring tasks, subtasks, reminders and attachments.
- Shopping: Shared lists, sections, stores, Quick Add and purchased items.
- Recipes: Cookbooks, recipe imports, portions, step ingredients, cooking mode and transfers to Shopping.
- Sharing and households: Personal or household ownership, direct invitations and management permissions.
- Memory: Personal destination learning across entry, moves, BrainDump and recipe transfers, without an AI model.
- Apps and PWA: Web and native clients, offline availability and synchronization limits.
Install and configure
Most installations need one persistent data directory and an HTTPS reverse proxy. Match the documentation and native clients to your server version.
- Get started: Choose an installation method and prepare your instance.
- Docker or Debian and Ubuntu: Install the server and web app.
- First-run setup: Complete the protected setup sequence and create your account.
- HTTPS and reverse proxy: Public URL, trusted proxies and browser access.
- Administration: Users, modules, mail, quotas and instance settings.
- Security, 2FA and OIDC: Passkeys, MFA policy and single sign-on.
- BrainDump: Optional Tasks/Shopping extraction and recipe text import or refinement using your providers.
Operate and integrate
- Backup and restore: Protect all modules, images, attachments and runtime configuration.
- Updates: Upgrade safely and retain a recoverable pre-upgrade backup.
- Troubleshooting: Logs, access, synchronization and import problems.
- API reference: Authentication, Tasks, Shopping, Recipes, sharing, households, memory and WebSocket synchronization.
- Documentation versions: Version selection, stable links and release promotion.
These guides describe the product from a user and administrator perspective. Developer architecture, tests and release instructions remain in the application repository.