Introduction
What OpsNexus is, what each module does, who it is for and how these docs are organized.
On this page
OpsNexus is a self-hosted DevOps control room. It brings your CI/CD pipelines, build agents, cloud accounts and costs, Kubernetes clusters, servers, monitoring, secrets and audit trail into one web app that you run on your own infrastructure.
It runs as a set of Docker containers (web app, API, background workers, PostgreSQL, Redis and HashiCorp Vault). Your data and your credentials stay on your servers.
Who it is for
- DevOps and platform engineers who run pipelines, build agents, cloud accounts and Kubernetes clusters, and want one place to see and operate them.
- Developers who need to trigger builds, read logs and download artifacts without access to every underlying tool.
- Security engineers who review scanner findings, secret usage and the audit log.
- Administrators who manage users, roles, single sign-on, backups and the health of the platform itself.
Access to every module is controlled by roles, so each group sees only what it needs. See Access control.
Modules
The modules below follow the groups in the app's sidebar.
Everyday pages
| Sidebar label | What it does |
|---|---|
| Overview | The home dashboard: a summary of what is connected and running. |
| Dashboards | Build your own dashboards from widgets. |
| Reports | Generate and schedule reports. |
| Audit logs | Every sign-in, change, deployment and secret access, hash-chained and exportable as CSV. |
Build & deploy
| Sidebar label | What it does |
|---|---|
| CI/CD | OpsNexus pipelines plus pipelines imported from Jenkins, GitLab, Azure DevOps, Argo CD and GitHub Actions. Sub-pages: Overview, Pipelines, Builds, Deployments, Integrations and Pipeline syntax. |
| Build agents | Agents on Linux, Windows and macOS (or in Docker) that report host health and run pipeline jobs. |
| Plugins | Reusable pipeline steps, such as notifications, HTTP requests and reports. |
| Artifacts | Files archived by pipeline runs, such as build outputs and reports. |
| Marketplace | A catalog of DevOps tools you can deploy to Kubernetes or export for Docker. |
Infrastructure
| Sidebar label | What it does |
|---|---|
| Cloud | AWS, Azure, Google Cloud and Oracle Cloud accounts, their resources, and Cost & budgets. |
| Infra designer | Draw infrastructure on a canvas, generate Terraform, and plan and apply it through your build agents. |
| Servers & SSH | A browser SSH terminal and Remote Desktop (RDP) for your servers. Credentials never reach the browser. |
| Kubernetes | Clusters on Amazon EKS, Azure AKS, Google GKE and Oracle OKE. |
| Monitoring & alerts | Server metrics, alerts and alert rules. |
| Domains & SEO | HTTP, HTTPS, TCP and DNS checks for your domains, TLS certificate and registration details, plus SEO reports. |
| Notifications | Channels (Slack, Microsoft Teams, Google Chat, email and webhooks), rules and summaries for events across OpsNexus. |
Settings
| Sidebar label | What it does |
|---|---|
| My profile | Your name, picture and sign-in sessions. |
| Projects | Split work into isolated projects and manage who belongs to each. |
| Access control | Users, roles and permissions, and teams and groups. |
| Security | Findings from security scanners such as Trivy, SonarQube, OWASP Dependency-Check, Checkov and Gitleaks. |
| Secrets & variables | Credentials stored in Vault and per-environment variables. |
| Password, MFA & SSO | Your password, two-step sign-in and API keys, plus the organization's password policy and single sign-on. |
| Appearance | Theme templates and colours. |
| Backup & restore | Back up and restore the platform's configuration and data. |
| VS Code | Connect the OpsNexus VS Code extension. |
| System status | Health of the database, cache and queue, secret store and background workers. |
Note
You only see the sidebar entries your role allows. If a page is missing, ask an administrator for at least read access to that module.
How these docs are organized
| Section | Read it when you want to |
|---|---|
| Getting started | Install OpsNexus, learn the core concepts, configure it, run it in production and upgrade it. |
| CI/CD | Create pipelines, write pipeline syntax, connect integrations and install build agents. |
| Infrastructure | Connect cloud accounts, track cost and budgets, use the Infra designer, Kubernetes, servers and SSH and monitoring. |
| Administration | Manage access, SSO and MFA, secrets, audit logs and backups. |
| Reference | Look up the API, environment variables, architecture, troubleshooting and the changelog. |
Next steps
- Follow the Quick start to run OpsNexus with Docker Compose.
- Read Concepts to understand projects, roles, agents and secrets.
- Before you go live, work through Running in production.