Quick Start

Get from zero to managing containers in 5 minutes.

1. Install

git clone https://github.com/ops-atlas/ops-dashboard.git
cd ops-dashboard
cp .env.example .env

Edit .env — set POSTGRES_PASSWORD, JWT_SECRET, and ENCRYPTION_KEY (generate secrets with openssl rand -base64 32). Then start the stack:

docker compose up -d

Wait about 30 seconds for all services to start. See Installation for full details.

2. Run the Setup Wizard

Open http://localhost:3000. You will be redirected to the setup wizard.

Add your first environment:

• Code: qa (or whatever matches your setup)
• Name: QA
• Host: your Docker host address
• SSH User: the user with Docker access
• Compose Directory: where your compose files live

Click through the remaining steps (registry and license are optional) and submit.

See Setup Wizard for detailed guidance on each step.

3. View Your Containers

After setup, log in and you will land on the Dashboard. It shows all running containers grouped by environment. Each container displays:

• Status (running, stopped, restarting)
• Uptime
• Image name and tag
• CPU and memory usage

Click any container to see its logs, inspect configuration, or manage environment variables.

4. Deploy a Service

Navigate to Deployments and select an environment. Choose a service and:

1. Select the image tag to deploy
2. Review environment variables
3. Click Deploy

The deployment runs in real-time with live log streaming via SSE. If something goes wrong, use the Rollback button to revert to the previous version.

See Deployments for rolling deploy strategies and health check configuration.

5. Set Up Monitoring

Container metrics (CPU, memory, network) are collected automatically every 30 seconds. To get notified when something goes wrong:

1. Go to Settings > Alerting
2. Add a notification channel (Slack, Discord, or Microsoft Teams webhook URL)
3. Configure alert rules — e.g., notify when a container stops or CPU exceeds 90%

See Alerting for channel setup and rule configuration.

TIP

Monitoring and alerting are available on Pro and Enterprise editions. Community edition shows real-time metrics on the dashboard but does not support alert notifications.

What's Next

• Configuration — Tune connection timeouts, monitoring intervals, and more
• Environments — Add more environments and hosts
• Registry — Connect your private Docker registry
• Database Tools — Compare schemas across environments
• Redis — Manage Redis instances per environment