Quick Start

Get SlimRMM running in minutes with this quick start guide.

Prerequisites

• Docker and Docker Compose installed
• A Linux server (Ubuntu 22.04 recommended)
• Domain name pointing to your server (optional but recommended)

1. Clone and Configure

# Clone the repository
git clone https://github.com/slimrmm/slimrmm.git
cd slimrmm

# Copy environment template
cp .env.example .env

Edit .env with your settings:

# Required: Generate secure keys
SECRET_KEY=$(python3 -c "import secrets; print(secrets.token_urlsafe(32))")
AGENT_INSTALL_KEY=$(python3 -c "import secrets; print(secrets.token_hex(16))")

# Database (PostgreSQL recommended for production)
DATABASE_URL=postgresql+asyncpg://rmm:your_password@postgres:5432/rmm

# Redis
REDIS_URL=redis://redis:6379/0

# Frontend URL (for CORS and email links)
FRONTEND_URL=https://your-domain.com

2. Start Services

# Start all services
docker-compose up -d

# Check status
docker-compose ps

# View logs
docker-compose logs -f backend

3. Create Admin User

# Access the backend container
docker-compose exec backend python -c "
from app.core.database import get_db_sync
from app.services.auth_service import create_user
from app.models.user import User

db = next(get_db_sync())
user = create_user(
    db,
    username='admin',
    email='admin@example.com',
    password='your_secure_password',
    is_admin=True
)
print(f'Created admin user: {user.username}')
"

4. Access the Dashboard

Open your browser and navigate to:

• Local: http://localhost:5173
• Production: https://your-domain.com

Log in with the admin credentials you created.

5. Install Your First Agent

Create Enrollment Token (Optional)

In the dashboard:

1. Navigate to Admin → Enrollment Tokens
2. Click Create Token
3. Copy the token for agent installation

Install Agent on Linux

# Download agent
curl -L -o slimrmm-agent https://your-server.com/api/v1/download/agent/linux-amd64

# Make executable
chmod +x slimrmm-agent

# Install with enrollment token (auto-approved)
sudo ./slimrmm-agent --install \
  --server https://your-server.com \
  --token YOUR_ENROLLMENT_TOKEN

# Or install without token (requires manual approval)
sudo ./slimrmm-agent --install \
  --server https://your-server.com

Install Agent on Windows

# Download agent
Invoke-WebRequest -Uri "https://your-server.com/api/v1/download/agent/windows-amd64" -OutFile "slimrmm-agent.exe"

# Install (run as Administrator)
.\slimrmm-agent.exe --install --server https://your-server.com --token YOUR_ENROLLMENT_TOKEN

Install Agent on macOS

# Download agent
curl -L -o slimrmm-agent https://your-server.com/api/v1/download/agent/darwin-arm64

# Make executable
chmod +x slimrmm-agent

# Install
sudo ./slimrmm-agent --install \
  --server https://your-server.com \
  --token YOUR_ENROLLMENT_TOKEN

6. Verify Connection

In the dashboard:

1. Navigate to Agents
2. Your new agent should appear
3. If no enrollment token was used, click Approve to activate

What's Next?

• Full Installation Guide - Detailed setup instructions
• Agent Configuration - Advanced agent settings
• Monitoring Setup - Configure alerts and monitoring
• Security Best Practices - Harden your installation

Troubleshooting

Agent Not Connecting

# Check agent status
sudo systemctl status slimrmm-agent

# View agent logs
sudo journalctl -u slimrmm-agent -f

# Verify server connectivity
curl -I https://your-server.com/health

Database Connection Issues

# Check PostgreSQL is running
docker-compose ps postgres

# View database logs
docker-compose logs postgres

Permission Denied

Ensure the agent runs as root or has appropriate permissions:

sudo ./slimrmm-agent --install ...