Quick Start Guide

This guide will help you launch RUSEON Core, log into the Web Dashboard, add your first IP camera, and start viewing ultra-low latency live streams.

---

1. Launch RUSEON Core (Docker)

Run the following command to start RUSEON Core with persistent data and recording volumes:

docker run -d \
  --name ruseon \
  --restart unless-stopped \
  -p 8080:8080 \
  -p 8555:8555/udp \
  -p 50051:50051 \
  -v ruseon_data:/app/data \
  -v ruseon_recordings:/app/recordings \
  ghcr.io/rusegal/ruseon-core:latest

---

2. Retrieve Initial Admin Credentials

Upon the very first boot, RUSEON Core automatically generates a secure initial administrator password and writes it to the server logs:

# View the initial admin credentials in container logs
docker logs ruseon | grep "Password:"

Output format:

==================================================
INITIAL ADMIN CREDENTIALS:
Username: admin
Password: <16-character-random-password>
Please change this password after first login!
==================================================

---

3. Access the Web Dashboard

Open your browser and navigate to:

👉 http://localhost:8080

Log in using admin and the password retrieved from step 2.

---

4. Add Your First IP Camera

1. In the Web UI, click the Add Camera button.
2. Fill in the camera details:
   • ID: cam-entrance (unique alphanumeric identifier).
   • RTSP URL: rtsp://username:password@192.168.1.100:554/live.
   • Transport: TCP (recommended for zero packet loss).
   • Recording: Toggle Record to archive video in fMP4.
3. Click Save & Connect.

---

5. View Live Stream & Archive

• Live View: View the camera stream via WebRTC (sub-500ms latency on port 8555/UDP) or WebSocket WebCodecs.
• Archive Timeline: Inspect recorded fMP4 video segments, scrub through history, and export clips without transcoding.

---

6. Automation via REST API

You can also automate camera onboarding programmatically:

# 1. Authenticate and receive JWT token
TOKEN=$(curl -s -X POST http://localhost:8080/api/login \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"YOUR_GENERATED_PASSWORD"}' | jq -r .token)

# 2. Add camera via REST API
curl -X POST http://localhost:8080/api/cameras \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "cam-entrance",
    "url": "rtsp://admin:pass@192.168.1.100:554/stream1",
    "transport": "tcp",
    "record": true
  }'

Related Documentation

• Adding Your First Camera Guide
• Installation Guide
• Docker Compose Deployment
• REST API Reference