Skip to content

Quick Start

Get Ops Atlas running in under 5 minutes.

Prerequisites

  • Docker 20.10+ and Docker Compose 2.0+
  • 2GB RAM minimum
  • Port 3000 available

Step 1: Start Ops Atlas

bash
# Create a directory
mkdir ops-atlas && cd ops-atlas

# Download docker-compose.yml
curl -o docker-compose.yml https://raw.githubusercontent.com/ops-atlas/ops-atlas/main/docker-compose.yml

# Start services
docker-compose up -d

Step 2: Access the Dashboard

Open http://localhost:3000 in your browser.

Default credentials:

  • Username: admin
  • Password: admin

WARNING

Change the default password immediately after first login!

Step 3: Connect Your First Service

  1. Click ServicesAdd Service
  2. Choose connection type:
    • Docker: Auto-discover containers
    • HTTP: Monitor any HTTP endpoint
    • TCP: Check port availability
  3. Configure health checks
  4. Save

Step 4: Set Up Alerts (Optional)

  1. Go to SettingsIntegrations
  2. Connect Slack or Discord
  3. Create alert rules in AlertsRules

What's Next?

Troubleshooting

Container won't start?

bash
# Check logs
docker-compose logs -f ops-atlas

# Verify ports
docker-compose ps

Can't access dashboard?

  1. Verify port 3000 is not in use: lsof -i :3000
  2. Check Docker network: docker network ls
  3. Try http://127.0.0.1:3000 instead of localhost

Need help?

Released under the MIT License.