HELIX Panel Dokumentation

Voraussetzungen

Bevor du HELIX Panel installierst, stelle sicher dass dein System die folgenden Anforderungen erfüllt:

Panel Server

PHP Extensions

apt install php8.2-{cli,fpm,mysql,gd,mbstring,xml,curl,zip,bcmath,intl}

Node Server (Daemon)

Installation

Nach dem Lizenzkauf

Nach erfolgreichem Kauf erhältst du:

• Download-Zugang im Kundenportal unter helix-server.com/client/downloads
• Lizenzschlüssel für die Aktivierung
• Installationsskript mit deinem persönlichen Token
• Support-Zugang über das Ticket-System

Automatische Installation (Empfohlen)

Nach dem Login im Kundenportal findest du dein personalisiertes Installationsskript:

Bash Kopieren
# Dein persönliches Installationsskript (nur nach Login sichtbar)
bash <(curl -s https://helix-server.com/install.sh?token=DEIN_TOKEN)

Das Skript führt dich durch alle Schritte und installiert automatisch:

• PHP 8.2 mit allen benötigten Extensions
• MySQL/MariaDB Datenbank
• Nginx Webserver
• Composer Dependencies
• SSL Zertifikat (Let's Encrypt)
• Automatische Lizenz-Aktivierung

Manuelle Installation

# Ubuntu/Debian
apt update && apt upgrade -y
apt install -y nginx mysql-server php8.2-fpm \
    php8.2-{cli,mysql,gd,mbstring,xml,curl,zip,bcmath,intl} \
    composer git unzip

cd /var/www
# Lade helix-panel.zip aus dem Kundenportal herunter
unzip helix-panel.zip -d helix
cd helix
composer install --no-dev --optimize-autoloader

CREATE DATABASE helix_panel;
CREATE USER 'helix'@'localhost' IDENTIFIED BY 'SICHERES_PASSWORT';
GRANT ALL PRIVILEGES ON helix_panel.* TO 'helix'@'localhost';
FLUSH PRIVILEGES;

cp config.example.php config.php
nano config.php

php cli/migrate.php

server {
    listen 80;
    listen [::]:80;
    server_name panel.example.com;
    root /var/www/helix/public;
    index index.php;

    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }

    location ~ \.php$ {
        fastcgi_pass unix:/var/run/php/php8.2-fpm.sock;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include fastcgi_params;
    }
}

chown -R www-data:www-data /var/www/helix
chmod -R 755 /var/www/helix
chmod -R 775 /var/www/helix/storage

Konfiguration

Die Hauptkonfiguration befindet sich in config.php:

PHP Kopieren
<?php
return [
    // Datenbank
    'db' => [
        'host' => 'localhost',
        'port' => 3306,
        'database' => 'helix_panel',
        'username' => 'helix',
        'password' => 'DEIN_PASSWORT',
    ],

    // Lizenz
    'license' => [
        'key' => 'HELIX-XXXX-XXXX-XXXX-XXXX',
    ],

    // App
    'app' => [
        'name' => 'HELIX Panel',
        'url' => 'https://panel.example.com',
        'timezone' => 'Europe/Berlin',
        'locale' => 'de',
        'debug' => false,
    ],

    // Mail
    'mail' => [
        'driver' => 'smtp',
        'host' => 'smtp.example.com',
        'port' => 587,
        'username' => 'noreply@example.com',
        'password' => 'MAIL_PASSWORT',
        'encryption' => 'tls',
        'from_address' => 'noreply@example.com',
        'from_name' => 'HELIX Panel',
    ],
];

Umgebungsvariablen

Daemon Installation

Der HELIX Daemon läuft auf deinen Node-Servern und verwaltet Docker Container sowie Webspaces.

Bash Kopieren
# Docker installieren
curl -fsSL https://get.docker.com | sh
systemctl enable docker

# Go installieren (optional, nur für Source-Lizenz)
wget https://go.dev/dl/go1.21.5.linux-amd64.tar.gz
tar -C /usr/local -xzf go1.21.5.linux-amd64.tar.gz
export PATH=$PATH:/usr/local/go/bin

# Daemon aus dem Kundenportal herunterladen
mkdir -p /opt/helix-daemon
cd /opt/helix-daemon

# Download von: https://helix-server.com/client/downloads
# Datei: daemon-linux-amd64 (oder daemon-linux-arm64 für ARM)
chmod +x daemon-linux-amd64

# Konfiguration
cat > config.json <<EOF
{
    "panel_url": "https://panel.example.com",
    "daemon_token": "DEIN_DAEMON_TOKEN",
    "daemon_port": 8443,
    "webspace_enabled": true,
    "docker_socket": "/var/run/docker.sock"
}
EOF

# Systemd Service
cat > /etc/systemd/system/helix-daemon.service <<EOF
[Unit]
Description=HELIX Daemon
After=docker.service

[Service]
WorkingDirectory=/opt/helix-daemon
ExecStart=/opt/helix-daemon/daemon-linux-amd64
Restart=always
RestartSec=5

[Install]
WantedBy=multi-user.target
EOF

systemctl daemon-reload
systemctl enable helix-daemon
systemctl start helix-daemon

PowerShell Kopieren
# Docker Desktop installieren (manuell von docker.com)

# Daemon aus dem Kundenportal herunterladen
mkdir C:\helix-daemon
cd C:\helix-daemon

# Download von: https://helix-server.com/client/downloads
# Datei: daemon-windows-amd64.exe
# Speichere als: daemon.exe

# Konfiguration erstellen
@"
{
    "panel_url": "https://panel.example.com",
    "daemon_token": "DEIN_DAEMON_TOKEN",
    "daemon_port": 8443,
    "webspace_enabled": false,
    "docker_socket": "npipe:////./pipe/docker_engine"
}
"@ | Out-File -FilePath "config.json" -Encoding UTF8

# Als Windows Service installieren
.\daemon.exe install
.\daemon.exe start

API Referenz

Die HELIX Panel API ermöglicht die vollständige Kontrolle über alle Ressourcen.

Authentifizierung

Alle API-Anfragen erfordern einen API-Key im Header:

Authorization: Bearer YOUR_API_KEY

API-Keys können unter Einstellungen → API Keys erstellt werden.

Basis-URL

https://panel.example.com/api/v1

Server Endpoints

Listet alle Server des authentifizierten Benutzers auf.

Response Kopieren
{
    "success": true,
    "data": [
        {
            "id": 1,
            "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "name": "Minecraft Server",
            "status": "running",
            "node_id": 1,
            "memory": 4096,
            "disk": 10240,
            "cpu": 200,
            "created_at": "2025-01-15T10:30:00Z"
        }
    ]
}

Steuert den Power-Status eines Servers.

Request Body Kopieren
{
    "action": "start" | "stop" | "restart" | "kill"
}

Webspace Endpoints

Listet alle Webspaces auf.

Erstellt einen neuen Webspace.

Request Body Kopieren
{
    "domain": "example.com",
    "user_id": 1,
    "node_id": 1,
    "php_version": "8.2",
    "disk_limit": 10240,
    "ssl_enabled": true
}

Erstellt eine neue Datenbank für den Webspace.

Erstellt ein neues E-Mail-Postfach.

Installiert ein Let's Encrypt SSL-Zertifikat.

Plugin Entwicklung

HELIX Panel unterstützt ein flexibles Plugin-System mit über 40 Hooks.

Plugin Struktur

plugins/
└── MeinPlugin/
    ├── plugin.json        # Plugin-Manifest
    ├── MeinPlugin.php     # Hauptklasse
    ├── views/             # Optional: Views
    ├── assets/            # Optional: CSS/JS
    └── migrations/        # Optional: DB Migrations

plugin.json

JSON Kopieren
{
    "name": "MeinPlugin",
    "description": "Beschreibung meines Plugins",
    "version": "1.0.0",
    "author": "Dein Name",
    "main": "MeinPlugin.php",
    "hooks": [
        "server.created",
        "user.registered",
        "invoice.paid"
    ]
}

Plugin Klasse

PHP Kopieren
<?php
class MeinPlugin extends Plugin {

    public function onEnable(): void {
        // Plugin aktiviert
        $this->registerHook('server.created', [$this, 'onServerCreated']);
        $this->registerHook('invoice.paid', [$this, 'onInvoicePaid']);
    }

    public function onDisable(): void {
        // Plugin deaktiviert
    }

    public function onServerCreated(Server $server): void {
        // Server wurde erstellt
        Logger::info("Neuer Server: " . $server->name);
    }

    public function onInvoicePaid(Invoice $invoice): void {
        // Rechnung wurde bezahlt
        $this->sendDiscordNotification($invoice);
    }
}

Verfügbare Hooks