Eigener Discord-Bot auf einem VPS hosten

Dieser Leitfaden bietet einen Schritt-für-Schritt-Prozess, um den CrossBan Discord-Bot selbst auf einem Virtual Private Server (VPS). CrossBan ist ein Bot zum Synchronisieren von Banns über mehrere Discord-Server hinweg, gebaut mit TypeScript, Discord.js und PostgreSQL. Er ist mit Docker containerisiert für einfache Bereitstellung.

Dieser Bot ist unter der PolyForm Noncommercial License 1.0.0 lizenziert. Du darfst ihn nicht für kommerzielle Zwecke oder zur Gewinnerzielung verwenden. Self-Hosting ist nur für persönliche oder gemeinnützige Nutzung erlaubt.

Voraussetzungen

Minimale VPS-Anforderungen

• Betriebssystem: Ubuntu 22.04 LTS oder eine ähnliche Linux-Distribution (empfohlen für Docker-Kompatibilität).

• Arbeitsspeicher: Mindestens 2GB, weil Docker dafür bekannt ist, RAM zum Frühstück zu verzehren.

• Speicher: 10GB+ freier Speicherplatz (für Docker-Images, Datenbank und Logs). 20GB+ ist besser.

• CPU: 2 Kerne (ausreichend für moderaten Gebrauch).

Ein Server kostet Geld - du solltest keine kostenlosen Hosting-Lösungen verwenden, weil du dort keine persönliche IP-Adresse bekommst, was zu Problemen mit deinem Bot führen kann.

Normalerweise kosten Server mit diesen Anforderungen etwa 3–5€ / Monat, abhängig vom Hosting-Anbieter.

Ein Server kostet nicht viel und ich würde Venocix empfehlen - eine sehr zuverlässige Hosting-Lösung aus Deutschland.

Server-Vorschlag

Software-Anforderungen

Server-Anforderungen

• Docker: Version 27+ (verwende die neueste Version, damit du sie längere Zeit nicht aktualisieren musst)

• Docker Compose: Version 2.39 (gleiches Denken wie oben)

• Git: Zum Klonen des Repositories.

• SSH-Zugang: Zu deinem VPS für Fernverwaltung.

Lokale Anforderungen

• Ein SSH-Client wie Termius um sicher eine Verbindung zu deinem VPS herzustellen und eine benutzerfreundliche Oberfläche zu haben.

Weitere Anforderungen

• Ein Discord-Bot-Token (erstelle eines im Discord Developer Portal). Mehr dazu später.

---

Bot einrichten

Schritt 1: Bereite deinen VPS vor

1. Verbinde dich mit deinem VPS mit deinem SSH-Client.

2. System aktualisieren:

   sudo apt update && sudo apt upgrade

   Denk daran, dass du aus Sicherheitsgründen das eingegebene Passwort nicht siehst.

3. Docker und Docker Compose installieren: Bitte beziehe dich auf die offiziellen Docker-Dokus für die korrekte Installationsmethode für dein Betriebssystem.

4. Git installieren:

   sudo apt install git

5. Installationen überprüfen:

   docker --version
   docker compose version
   git --version

Schritt 2: Repository klonen und einrichten

1. Repository klonen:

   git clone https://github.com/The-LukeZ/CrossBan.git
   cd CrossBan

2. Umgebungsdatei erstellen:

   • Kopiere die Beispiel-Umgebungsdatei:

     cp .env.example .env

   • Bearbeite .env mit deinen Daten:

     nano .env # öffnet einen einfachen Datei-Editor

     Fülle die Platzhalter aus.

Schritt 3: Lade den Bot auf deine Server ein

1. Gehe zum Discord Developer Portal.

2. Deaktiviere den allgemeinen Installationslink und erlaube nur Guild-Installation.

   

3. Gehe zur Bot-Seite und deaktiviere Public bot und regeneriere das Token deines Bots.

   

   Deaktiviere Public bot, weil sonst jeder deinen Bot einladen kann - das willst du nicht.
4. Unter deiner Bot-Anwendung gehe zu OAuth2 > OAuth2 URL-Generator.

5. Wähle Scopes: bot, applications.commands.

6. Wähle Berechtigungen: Mitglieder bannen, Audit-Log ansehen, Nachrichten senden, Slash-Befehle verwenden.

7. Benutze die generierte URL, um den Bot in deine Server einzuladen.

Schritt 4: Bot konfigurieren und starten

1. Bot bauen und starten:

   • Verwende die Docker Compose Datei:

     pnpm run docker:build

   • Dies baut die Docker-Images, startet den Bot und die PostgreSQL-Datenbank und führt sie im Detached-Modus aus (damit sie im Hintergrund laufen, selbst wenn du die Verbindung zum Server trennst).

2. Setup überprüfen:

   • Container-Status prüfen:

     docker compose ps

   • Logs ansehen:

     docker compose logs -f

   • Der Bot sollte in deinen Discord-Servern online erscheinen. Führe /config in Discord aus, um Einstellungen zu konfigurieren.

3. Erstkonfiguration in Discord:

   • Benutze Slash-Befehle wie /config sources-of-truth um vertrauenswürdige Nutzer festzulegen.

   • Konfiguriere Bannsynchronisationseinstellungen pro Server.

Schritt 4: Überwachung und Wartung

Logs

• Echtzeit-Logs ansehen:

  docker compose logs

Updates

• Ziehe den neuesten Code:

  # Gehe in das Verzeichnis, in dem der Code liegt
  cd CrossBan
  # Ziehe den neuesten Code
  git pull origin main

• Neustarten:

  pnpm run docker:restart

Hinweis für Entwickler

Ja, es wäre besser, das Image auch neu zu bauen, aber solange sich daran nichts ändert, funktioniert es auch nur durch Neustarten des Bots. Weitere Dokumentation wird hinzugefügt, wenn das nötig wird.

Backups

• Sichere das Datenbank-Volume:

  docker compose exec postgres pg_dump -U {POSTGRES_USER} {POSTGRES_DB} > backup.sql

  Denk daran, die Werte einzusetzen, die du in deiner .env Datei!

• Speichere backup.sql sicher (z. B. außerhalb des VPS).

Bot stoppen

pnpm run docker:down

Neustarten

pnpm run docker:restart

---

Fehlerbehebung

Häufige Probleme

• Bot startet nicht: Prüfe .env auf Fehler. Stelle sicher, dass BOT_TOKEN gültig ist und die Berechtigungen korrekt sind.

• Datenbankverbindung fehlgeschlagen: Überprüfe DATABASE_URL und dass PostgreSQL läuft (docker compose ps).

• Berechtigungsfehler: Stelle sicher, dass der Bot Mitglieder bannen und Audit-Log ansehen in allen Servern hat.

• Container stürzt ab: Verwende docker compose logs zur Diagnose. Häufige Ursachen: ungültige Umgebungsvariablen oder Port-Konflikte. Wenn ein Container in einer Neustart-Schleife steckt (Container starten neu, wenn sie fehlschlagen), stoppe die Container mit pnpm run docker:down und öffne ein GitHub-Issue, damit wir das gemeinsam lösen können.

Datenbank-Probleme

• Wenn PostgreSQL nicht startet, lösche das Volume und starte neu:

  docker compose down -v
  docker compose up -d --build

Dies löscht alle Daten; verwende es nur, wenn nötig.

Leistung

• Für stark frequentierte Server erhöhe die VPS-Ressourcen.

Sicherheitsüberlegungen

• Umgebungsvariablen: Niemals .env zu Git committen (Das ist standardmäßig durch die .gitignore Datei gewährleistet).

• Updates: Halte Docker und das System aktuell, um Sicherheitslücken zu schließen.

• Zugriff: Beschränke SSH-Zugänge mit schlüsselbasierter Authentifikation. (Für fortgeschrittene Nutzer)

Weitere Ressourcen

• Discord.js Dokumentation

• Docker Compose Dokus

• PostgreSQL Dokus

• Das Repository: CrossBan auf GitHub

Wenn du auf Probleme stößt, prüfe die Issues des Repositories oder Logs für weitere Details. Viel Erfolg beim Hosten!