Home

Administration guide

This guide covers deploying and operating Nuclei Security Center (NSC). For endpoint-level details, see the API reference; for design rationale and security boundaries, see Architecture.

docs/admin/ in the repository is the source of truth. GitHub Actions publishes these files to the GitHub wiki on every push to main and on every v* version tag. Edit the Markdown in a pull request; do not edit the wiki in the GitHub UI.

Important

Beta deployments start from an empty Postgres database. Alpha databases are not upgradeable to beta: the schema baseline was frozen at the alpha→beta boundary, so back up any data you need to retain, deploy with a new empty database, and move portable data with template/template-set exports and scan bundles. The backend rejects an unsupported migration history at startup instead of attempting a partial upgrade. From beta onward, schema changes ship as new numbered migrations that apply forward on an existing database.

Chapters

• Deployment — requirements, Docker Compose, published images, production
• Configuration — environment variables
• Authentication — OIDC/BFF, sessions, service accounts, mTLS
• First-run bootstrap
• Operations — targets, templates, policies, schedules, scanner fleet, scan email
• Findings and data — lifecycle, exports, audit, backups, upgrades
• Troubleshooting