RiftPanel Documentation

The modern, all-in-one platform to deploy, manage, and monetize game servers. This guide covers everything from installation to advanced configuration.

# Requirements

# Installation

Quick Install (Recommended)

The interactive installer handles Docker, database setup, and admin account creation automatically.

curl -sSL https://riftpanel.net/install.sh | sudo bash

Unattended Install

Skip the interactive wizard by passing parameters directly.

curl -sSL https://riftpanel.net/install.sh | sudo bash -s -- \
  --email [email protected] \
  --password YourSecurePassword \
  --domain panel.example.com \
  --yes

Manual Install (Docker Compose)

If you prefer manual control, create a docker-compose.yml:

services:
  riftpanel:
    image: lucasvicente1/riftpanel:latest
    ports:
      - "${PANEL_PORT:-8080}:8080"
    environment:
      - RIFTPANEL_DB_HOST=postgres
      - RIFTPANEL_DB_PORT=5432
      - RIFTPANEL_DB_NAME=riftpanel
      - RIFTPANEL_DB_USER=riftpanel
      - RIFTPANEL_DB_PASSWORD=${DB_PASSWORD}
      - RIFTPANEL_JWT_SECRET=${JWT_SECRET}
      - RIFTPANEL_LICENSE_KEY=${LICENSE_KEY}
    depends_on:
      postgres:
        condition: service_healthy
    restart: unless-stopped

  postgres:
    image: postgres:15-alpine
    environment:
      POSTGRES_DB: riftpanel
      POSTGRES_USER: riftpanel
      POSTGRES_PASSWORD: ${DB_PASSWORD}
    volumes:
      - postgres_data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U riftpanel"]
      interval: 5s
    restart: unless-stopped

  update-agent:
    image: lucasvicente1/riftpanel-updater:latest
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - .:/app
    restart: unless-stopped

volumes:
  postgres_data:

# First Steps

1. Access the panel — Navigate to your domain or IP:8080. Log in with the admin credentials set during installation.
2. Add a node — Go to Admin > Nodes and add your first game server node. Install Wings using the provided script.
3. Create allocations — Assign port ranges to the node (e.g. 25565-25600 for Minecraft).
4. Deploy a server — Create a game server from the dashboard. Choose an egg, select a node, and configure resources.
5. Activate your license — Go to Settings > License and enter your key. The Free tier works without one.

# Environment Variables

All variables use the RIFTPANEL_ prefix. Set them in a .env file or directly in docker-compose.yml.

# Reverse Proxy (Nginx)

Recommended production setup with Nginx, SSL via Certbot, and WebSocket support.

server {
    listen 80;
    server_name panel.example.com;
    return 301 https://$host$request_uri;
}

server {
    listen 443 ssl http2;
    server_name panel.example.com;

    ssl_certificate     /etc/letsencrypt/live/panel.example.com/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/panel.example.com/privkey.pem;

    # Security headers
    add_header X-Frame-Options DENY;
    add_header X-Content-Type-Options nosniff;
    add_header Strict-Transport-Security "max-age=31536000" always;

    client_max_body_size 256m;

    location / {
        proxy_pass http://127.0.0.1:8080;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;

        # WebSocket
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_read_timeout 86400s;
    }
}

# SSL / HTTPS

Install Certbot and generate a free SSL certificate from Let's Encrypt.

sudo apt install certbot python3-certbot-nginx -y
sudo certbot --nginx -d panel.example.com

# Roles & Permissions

RiftPanel has 4 user roles with hierarchical access control.

Sub-user Permissions (per server)

# Nodes & Wings

Nodes are the machines where game server containers run. Each node requires the Wings daemon and the Rift Agent for metrics.

curl -sSL https://riftpanel.net/install-wings.sh | sudo bash

# Servers

Game servers are Docker containers managed through Wings. Each server uses an egg (game template) that defines startup commands, configs, and variables.

• Real-time console via xterm.js with WebSocket
• File manager with built-in Monaco code editor
• Automatic and manual backups
• Scheduled tasks, restarts, and power actions
• Live CPU, RAM, disk, and network metrics
• Custom subdomains via Cloudflare integration
• 40+ egg templates in the built-in marketplace

# Modules

31 game-aware modules extend server capabilities. Admins enable/disable modules globally from the admin panel.

Free Modules (15)

Startup Config, Environment Vars, Task Scheduler, Resource Alerts, Console Logs, File Search, Resource Monitor, Trash Bin, Idle Stop, Smart Restart, MC Plugin Manager, MC Version Changer, MC Config Editor, Rust Plugin Installer, PZ Mod Installer.

Pro Modules (16)

MC Networks (Proxy), MC Player Analytics, MC Crash Analyzer, MC World Manager, MC MOTD Editor, MC Modpack Installer, MC Whitelist Manager, Hytale Player Tracking, Hytale World Manager, Hytale Profiler, Hytale Asset Manager, Player Analytics, Crash Detector, Audit Log.

# Billing & Store

The Business plan unlocks the built-in hosting store with Stripe-powered billing, automatic provisioning, and client management.

• Stripe-powered recurring invoicing and payment collection
• Automatic server provisioning on checkout
• Client self-service portal with product store
• Auto-suspend overdue services, auto-terminate abandoned
• Customizable landing page and branding
• Coupons, email templates, and hosting analytics

# Licensing

RiftPanel uses a license key to gate features by plan. The Free tier works without a key.

# Updates

One-click (Admin Dashboard)

When a new version is available, a notification appears in the admin dashboard. Click "Update" and the update agent handles pulling the new image and recreating containers.

Manual Update

cd /opt/riftpanel
docker compose pull
docker compose up -d --force-recreate

# Migrate from Pterodactyl

RiftPanel includes a built-in migration tool to import servers, users, nodes, and eggs from Pterodactyl.

1. Go to Admin > Migration
2. Enter your Pterodactyl panel URL and API key
3. Select what to import: users, nodes, eggs, servers
4. Existing Wings nodes work as-is — no reinstallation needed

# Troubleshooting