Skip to content

Quickstart

This guide walks you through setting up Warden from scratch after installation.

When you first open Warden, you’ll see the setup page.

Enter your credentials:

  • Username — lowercase, alphanumeric, dots, dashes, and underscores (max 32 characters)
  • Password — minimum 8 characters, at least one digit and one special character
  • Timezone — used for displaying dates throughout the dashboard (defaults to UTC)

This creates the first user with the Admin role.

  1. From the dashboard, click Add Monitor
  2. Enter a name (e.g., “Production API”)
  3. Enter the URL to monitor (e.g., https://api.example.com/health)
  4. Select a group (the Default group is pre-created)
  5. Set the interval (e.g., 60 seconds)
  6. Click Create

Warden runs the first check immediately. Within seconds, you’ll see the monitor’s status on the dashboard.

  1. Go to Settings → Notifications
  2. Click Add Integration
  3. Choose Slack or Webhook
  4. Enter a name and your webhook URL
  5. Click Send Test to verify delivery
  6. Click Add Integration to save

Warden will now notify you when monitors go down, recover, or experience high latency.

  1. Go to Settings → Status Pages
  2. Configure a page with a slug (e.g., status) and title
  3. Toggle Public if you want it accessible without login
  4. Toggle Enabled to make it live
  5. Save

Your status page is now available at https://your-warden-instance.com/status/status.

  1. Go to Settings → Users
  2. Click Create User
  3. Enter a username, password, and select a role:
    • Editor — can manage monitors, incidents, and notifications
    • Viewer — read-only dashboard access
    • Status Viewer — can only see assigned status pages

Share the credentials with your team member so they can log in.

  • Monitors — configure advanced settings like custom headers, retries, and accepted status codes
  • Groups — organize monitors into logical groups
  • Incidents — track and communicate service disruptions
  • Notifications — fine-tune alerting with thresholds, cooldowns, and daily digests
  • Roles & Permissions — understand the four-role RBAC system
  • Settings — explore all configuration options