Nexmap documentation

Administrators

Deploying, configuring and running a Nexmap server.

Installation: container image, Coolify, first start
Configuration: every environment variable and flag of nexmapd
Security: TLS, the encryption key, the first administrator, accounts and tokens
Backup and restore: what to back up, SQLite and PostgreSQL, restoring, upgrades

Users

Working with Nexmap in the browser.

Concepts: products, structure, requirements, tasks, constraints, defects, tests, roles
Getting started: creating a product, settings, team, structure
Backlog: requirements, tasks, constraints, defects, boards and sprints
Testing: test cases, campaigns, recording results

CLI users

Developers, CI pipelines and AI agents working with the nexmap command line client.

Setup: installing, logging in, connecting a repository, configuration, commands
Scripting: output formats, exit codes, raw API calls
CI integration: recording automated test results with nexmap utest
AI agents: agent guide, MCP server, what agents may change

API

REST API: authentication, response format, endpoints

Contributing

The source repository holds the material for contributors that this documentation leaves out:

docs/spec/, the specification: what Nexmap shall do, with requirement identifiers. It describes targets, not necessarily the current behaviour;
docs/decisions/, the design decisions and their reasoning;
CONTRIBUTING.md: building, testing, and how this documentation is organised and published.