Wie man HedgeDoc auf einem VPS selbst hostet (Vollständiger Leitfaden)

Einführung

HedgeDoc ist ein kollaborativer Markdown-Editor, der es mehreren Benutzern ermöglicht, Dokumente in Echtzeit zu bearbeiten. Er wird oft für Notizen und Dokumentationen innerhalb von Teams verwendet. Das Selbst-Hosting von HedgeDoc auf einem Virtual Private Server (VPS) gibt Ihnen die vollständige Kontrolle über Ihre Daten und gewährleistet Privatsphäre. In diesem Leitfaden zeigen wir Ihnen die Schritte zur Installation von HedgeDoc auf einem VPS mit Docker.

Voraussetzungen

1. Ein VPS: Wählen Sie einen geeigneten VPS-Anbieter. Hier ist ein schneller Vergleich einiger beliebter Optionen:

Für detaillierte Vergleiche verschiedener VPS-Anbieter lesen Sie unseren VPS-Vergleich.

2. SSH-Zugriff: Stellen Sie sicher, dass Sie über SSH auf Ihren VPS zugreifen können.

3. Docker und Docker Compose: Stellen Sie sicher, dass sowohl Docker als auch Docker Compose auf Ihrem VPS installiert sind. Sie können sie mit den folgenden Befehlen installieren:

   sudo apt update
   sudo apt install -y docker.io docker-compose

Schritt 1: Einrichten der HedgeDoc-Umgebung

1. Erstellen Sie ein Verzeichnis für HedgeDoc:

   mkdir ~/hedgedoc
   cd ~/hedgedoc

2. Erstellen Sie eine docker-compose.yml-Datei im hedgedoc-Verzeichnis. Fügen Sie die folgende Konfiguration hinzu, um HedgeDoc mit PostgreSQL als Datenbank einzurichten:

   version: '3.1'
   
   services:
     hedgedoc:
       image: hedgedoc/hedgedoc:latest
       environment:
         - CMD_URI=https://your-domain.com
         - DB_TYPE=postgres
         - DB_HOST=db
         - DB_PORT=5432
         - DB_USER=hedgedoc
         - DB_PASS=hedgedoc_password
         - DB_NAME=hedgedoc
       ports:
         - '3000:3000'
       depends_on:
         - db
   
     db:
       image: postgres:latest
       environment:
         - POSTGRES_USER=hedgedoc
         - POSTGRES_PASSWORD=hedgedoc_password
         - POSTGRES_DB=hedgedoc
       volumes:
         - db_data:/var/lib/postgresql/data
   
   volumes:
     db_data:

3. Ersetzen Sie your-domain.com durch die tatsächliche Domain, die Sie verwenden werden, um auf HedgeDoc zuzugreifen.

Schritt 2: HedgeDoc ausführen

1. Starten Sie die HedgeDoc-Anwendung mit Docker Compose:

   docker-compose up -d

2. Überprüfen Sie, ob HedgeDoc korrekt läuft, indem Sie die Protokolle überprüfen:

   docker-compose logs -f

3. Standardmäßig wird HedgeDoc unter http://your-server-ip:3000 zugänglich sein. Sie sollten einen Reverse Proxy für eine Produktionsumgebung einrichten.

Schritt 3: Einrichten eines Reverse Proxy mit Nginx

1. Installieren Sie Nginx:

   sudo apt install -y nginx

2. Erstellen Sie eine neue Konfigurationsdatei für HedgeDoc:

   sudo nano /etc/nginx/sites-available/hedgedoc

3. Fügen Sie die folgende Konfiguration hinzu:

   server {
       listen 80;
       server_name your-domain.com;
   
       location / {
           proxy_pass http://localhost:3000;
           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;
       }
   }

4. Aktivieren Sie die Konfiguration:

   sudo ln -s /etc/nginx/sites-available/hedgedoc /etc/nginx/sites-enabled/
   sudo nginx -t
   sudo systemctl restart nginx

Schritt 4: HedgeDoc mit SSL sichern

1. Um Ihre HedgeDoc-Instanz zu sichern, können Sie Let’s Encrypt verwenden. Installieren Sie Certbot:

   sudo apt install -y certbot python3-certbot-nginx

2. Führen Sie Certbot aus, um SSL für Ihre Domain zu erhalten:

   sudo certbot --nginx -d your-domain.com

Häufig gestellte Fragen

1. Was sind die Vorteile des Selbst-Hostings von HedgeDoc?

Das Selbst-Hosting von HedgeDoc gewährt Ihnen unübertroffene Kontrolle über Ihre Daten und Privatsphäre. Im Gegensatz zu cloudbasierten Optionen verwalten Sie beim Selbst-Hosting sicherheitsrelevante Updates und Anpassungen gemäß Ihren Bedürfnissen. Dieses Setup ist entscheidend für Entwickler und Homelabber, die eine Einhaltung bestimmter Datenverarbeitungsprozesse benötigen oder HedgeDoc nahtlos in umfangreichere Systeme integrieren möchten.

2. Kann ich HedgeDoc auf einem VPS mit niedrigen Spezifikationen betreiben?

Ja, HedgeDoc kann effizient auf einem VPS mit niedrigen Spezifikationen betrieben werden, sofern er die Systemanforderungen erfüllt. Für grundlegende Operationen genügt ein VPS mit 2 GB RAM und minimalem Speicherplatz. Für größere Instanzen oder die Zusammenarbeit mit mehreren Benutzern sollten Sie jedoch einen VPS mit mindestens 4 GB RAM und 50 GB Speicherplatz in Betracht ziehen, um eine reibungslose Leistung sicherzustellen. Die Preisstruktur von Anbietern wie Contabo und Hetzner kann diesen Bedarf erschwinglich decken.

3. Wie aktualisiere ich meine HedgeDoc-Installation?

Das Aktualisieren von HedgeDoc ist aufgrund des Docker-Setups unkompliziert. Sie können das neueste Image abrufen und die Container neu starten. Hier ist der Befehl dazu:

docker-compose pull
docker-compose up -d

Nachdem Sie diese Befehle ausgeführt haben, sollten Sie regelmäßig die HedgeDoc-Release-Notizen auf Änderungen oder erforderliche Migrationen überprüfen, um einen nahtlosen Betrieb sicherzustellen. Sie können die HedgeDoc-Dokumentation für spezifische Details zu Versionsupdates konsultieren.

Fazit

Das Selbst-Hosting von HedgeDoc auf einem VPS ermöglicht es Ihnen, von einem leistungsstarken Markdown-Editor zu profitieren, während Sie die Kontrolle über Ihre Umgebung behalten. Mit den oben skizzierten Einrichtungsschritten sollten Sie nun in der Lage sein, HedgeDoc effektiv zu installieren, zu konfigurieren und zu sichern. Genießen Sie die Zusammenarbeit in Echtzeit, ohne Kompromisse bei der Privatsphäre oder der Datenintegrität eingehen zu müssen.