Skip to content

Quick Start

Get up and running with Oath Bringer in 5 minutes.

Step 1: Create Admin Account

After installation, open your browser and navigate to:

http://your-server:3000

You'll be prompted to create the initial admin account:

  1. Enter your email address
  2. Choose a secure password
  3. Click "Create Admin Account"

Security

Store your admin credentials securely. The admin account has full access to all features.

Step 2: Add Your First Host

  1. Navigate to DashboardHosts
  2. Click Add Host
  3. Enter host details:
  4. Name: A friendly name (e.g., "Production Server 1")
  5. Hostname/IP: The host's address
  6. SSH Port: Usually 22
  7. SSH User: Your SSH username

  8. Click Add Host

Step 3: Install Agent on Host

SSH into your target host and run:

curl -fsSL https://oath-bringer.com/install-agent.sh | bash

Or manually:

# Download agent
wget https://github.com/lloydtheandroid/oath-bringer/releases/latest/download/agent-linux-amd64

# Install
sudo mv agent-linux-amd64 /usr/local/bin/oath-agent
sudo chmod +x /usr/local/bin/oath-agent

# Configure
sudo oath-agent configure --server https://your-oath-bringer-url

# Start
sudo systemctl enable --now oath-bringer-agent

Step 4: Verify Connection

Back in the Oath Bringer dashboard:

  1. Go to Hosts
  2. Your host should show as Connected (green indicator)
  3. Click on the host to view details

Step 5: Explore Features

View System Metrics

Click on any connected host to see:

  • CPU usage
  • Memory usage
  • Disk usage
  • Network statistics
  • Running processes

Manage VMs

If your host has libvirt installed:

  1. Navigate to HostVirtual Machines
  2. View existing VMs or create new ones
  3. Start, stop, or snapshot VMs

Manage Containers

For Docker/Podman hosts:

  1. Navigate to HostContainers
  2. View running containers
  3. Start, stop, or view logs

AI Operations

Try the AI assistant:

  1. Go to AI Ops in the sidebar
  2. Type a natural language command like:
  3. "Show me hosts with high CPU usage"
  4. "List all running containers"
  5. "What's the disk usage on production-1?"

Next Steps

  • User Guide


    Learn all features in depth

    User Guide

  • Administration


    Set up users, roles, and security

    Admin Guide

  • API Reference


    Integrate with the Oath Bringer API

    API Docs