System status

Settings → System status shows whether the services OpsNexus depends on are working. Below the checks, All settings links to every settings page you can open.

The page needs Read only on Organization settings. Among the built-in roles, Organization Admin, DevOps Engineer and Security Engineer have it.

#What the page checks

A banner at the top says All systems operational, or how many services need attention. It also shows how many services were checked and when. Select Check again to run the checks now.

Each service has a card with a status: Healthy, Down, or another state reported by the service.

The Secret store card names the backend in use: HashiCorp Vault or Local encrypted store.

When the local store is in use, the card shows a warning: "Development only. Use Vault in production."

#When a card is red

The card shows the error type in red. Start with the container status:

docker compose ps
docker compose logs --tail=100 api

#Database is down

1. Check the db container: docker compose logs --tail=100 db.
2. Check that POSTGRES_USER, POSTGRES_PASSWORD and POSTGRES_DB in .env match the database. For an external database, check DATABASE_URL.
3. Check free disk space on the host. PostgreSQL stops writing when the disk is full.

While the database is down, most of OpsNexus doesn't work, including sign-in.

#Cache & queue is down

1. Check the redis container: docker compose logs --tail=100 redis.
2. For an external Redis, check REDIS_URL.

Without Redis, live updates stop, background jobs aren't queued, and sign-in rate limiting can't run.

#Secret store is sealed or unreachable

For the bundled Vault:

1. Check the containers: docker compose logs --tail=100 vault vault-init.

2. Vault starts sealed after its container restarts. The one-shot vault-init container unseals it with the key kept in the vault-init volume. Run it again:

   bash

   docker compose run --rm vault-init

For your own Vault:

1. Check VAULT_ADDR and that the API container can reach it.
2. Check the token (VAULT_TOKEN or VAULT_TOKEN_FILE) or the AppRole (VAULT_ROLE_ID and VAULT_SECRET_ID).
3. Unseal Vault, or check its auto-unseal setup.

While the secret store is unavailable, anything that needs a credential fails: integration syncs, cloud syncs, pipelines that use secrets, and notifications.

See Troubleshooting for more problems and fixes.

#Health endpoints and container checks

For load balancers and monitoring:

Neither API endpoint needs authentication.

curl -fsS http://localhost:8080/api/health/ready

The Docker Compose stack has health checks for each container:

docker compose ps shows each container as healthy or unhealthy.

#My profile

Settings → My profile is where each person manages their own account. Everyone with Read only on Dashboards & reports can open it.

• Picture: Add picture, Change picture or Remove. PNG, JPEG or WebP.
• About you: Full name, Job title, Department or team, Phone, Location, Time zone and a short bio. Select Save profile.
• Preferences: Start page after sign-in.
• Account: username, organization and its Account ID, sign-in method, MFA state, when the password was changed, member since and last sign-in. Your email, username and role are managed by an admin in Access control.
• Where you're signed in: every active session with its device, browser and sign-in method. Select Sign out on one session, or Sign out all others.

Password, MFA and API keys are on Password, MFA & SSO.

#Projects

Settings → Projects lists the projects you can open, with counts of pipelines, agents, secrets and members, and your role in each.

• New project: enter a Name, a Key (lowercase letters, digits and -, used in URLs and the API), an optional description and a colour. Creating projects needs Read & modify on Organization settings, or being an organization admin. Each new project starts with the recommended alert rules.
• Open: switch to that project.
• Members: add people or teams with a project role. See Access control.
• Edit: change the name, description or colour. Project admins only.
• Danger zone: delete a project and everything in it. Organization admins only, and you must type the project's name to confirm. The default project can't be deleted.

#Sharing between projects

Organization admins can choose which kinds of things may be shared with every project: Build agents, Secrets & variables, Notification channels, rules & summaries and Plugins. Turning a kind off asks you to pick a project, moves the shared items into it, and stops new shared items from being created.

#Appearance

Settings → Appearance changes the colours of the interface.

1. Pick one of the Templates: Default light, Midnight dark, Ocean, Forest and others.
2. Under Customize, adjust the Primary color, Sidebar, Page background, Cards and Text colours, and the Mode: Follow system, Light or Dark.
3. Check the text contrast line. It turns red below 4.5:1.
4. Select Save for me, or Save as org default to set the organization's default theme. The org default needs Read & modify on Organization settings.

Select Reset to go back to the default theme.

#Related pages

• Configuration
• Environment variables
• Backup & restore
• Architecture