Skip to content

Quick Start

Get Komandorr up and running in 5 minutes.

Step 1: Install Komandorr

docker run -d \
  --name komandorr \
  -p 3000:3000 \
  -v $(pwd)/data:/app/data \
  cyb3rgh05t/komandorr:latest

curl -o docker-compose.yml https://raw.githubusercontent.com/cyb3rgh05t/komandorr/main/docker-compose.yml
docker-compose up -d

Step 2: Access the Dashboard

  1. Open your browser to http://localhost:3000
  2. Login with default credentials:
  3. Username: admin
  4. Password: admin

Security

Change the default password immediately in Settings!

Step 3: Add Your First Service

  1. Navigate to Services page
  2. Click Add Service button
  3. Fill in the details:
Name: My Website
URL: https://example.com
Type: Website
Group: Production
Check Interval: 60 seconds
  1. Click Save

Step 4: Monitor Status

Your service will appear on the Dashboard with real-time status:

  • Green - Service is up
  • Red - Service is down
  • Gray - No data yet

Step 5: View Metrics

Click on a service card to view:

  • Response time history
  • Uptime percentage
  • Recent status changes
  • Detailed logs

Optional: Configure Plex Integration

To monitor your Plex Media Server and manage invites:

  1. Get your Plex token from Plex.tv
  2. Navigate to Settings
  3. Enter your Plex server URL and token
  4. Enable VOD Streams monitoring
  5. Install PlexAPI for invite functionality:
cd backend
pip install plexapi

Create Plex Invites (New in v2.3.0!)

  1. Navigate to Invites page
  2. Click Create Invite
  3. Configure:
  4. Select libraries (Movies, TV Shows, Music, or All)
  5. Set usage limit (1-100 or unlimited)
  6. Set expiration date (optional)
  7. Configure permissions (Sync, Channels, Plex Home)
  8. Copy the invite link and share it

Manage Plex Users

  1. Navigate to User Accounts page
  2. View all invited users with:
  3. Profile pictures from Plex
  4. Library access and permissions
  5. User expiration dates
  6. Manage users:
  7. Edit user expiration dates
  8. Refresh user info from Plex
  9. Remove users from server

Optional: Enable Traffic Monitoring

  1. Install the traffic agent on your server:
pip install -r traffic/requirements.txt
python traffic/traffic_agent.py
  1. Configure the agent endpoint in Settings
  2. View traffic graphs on the Traffic page

Next Steps

Need Help?