HedgeDoc aufrufen
- Öffnen Sie die HedgeDoc-Weboberfläche:
https://<SERVER-IP> - Eine Browserwarnung erscheint, da ein selbstsigniertes Zertifikat verwendet wird. Fahren Sie mit der Website fort, um fortzufahren.
- Klicken Sie auf 'Anmelden', dann auf 'Registrieren', um Ihr Konto zu erstellen.
Endpunkte
- Hauptanwendung:
https://<SERVER-IP>/(Weboberfläche) - Status:
https://<SERVER-IP>/status(Statusprüfungsseite) - Metriken:
https://<SERVER-IP>/metrics(Systemmetriken) - WebSocket:
/socket.io/(Echtzeitkommunikation)
Registrierung
Die Benutzerregistrierung ist standardmäßig aktiviert.
Um die Registrierung neuer Benutzer zu deaktivieren, ändern Sie CMD_ALLOW_EMAIL_REGISTER=true to CMD_ALLOW_EMAIL_REGISTER=false in /root/hedgedoc/.env.
Starten Sie die Anwendung neu, um die Änderung zu übernehmen:
cd /root/hedgedoc
docker compose restart
Datenbank-Sicherung
Erstellen Sie eine PostgreSQL-Sicherung:
cd /root/hedgedoc
docker compose exec database pg_dump hedgedoc -U hedgedoc > backup.sql
Wichtige Dateien und Verzeichnisse
- Installationspfad:
/root/hedgedoc - Compose-Datei:
/root/hedgedoc/docker-compose.yml - Umgebungsdatei:
/root/hedgedoc/.env - Nginx Konfiguration:
/etc/nginx/sites-available/hedgedoc - SSL-Zertifikat:
/etc/nginx/ssl/hedgedoc.crt - SSL-Schlüssel:
/etc/nginx/ssl/hedgedoc.key - Upload-Volume:
/var/lib/docker/volumes/hedgedoc_uploads/_data - Datenbankvolume:
/var/lib/docker/volumes/hedgedoc_database/_data
Docker-Verwaltung
Container prüfen:
docker ps
Logs ansehen:
cd /root/hedgedoc
docker compose logs -f
Dienste neu starten:
cd /root/hedgedoc
docker compose restart
Dienste stoppen:
cd /root/hedgedoc
docker compose down
Dienste starten:
cd /root/hedgedoc
docker compose up -d
NGINX-Verwaltung
Testkonfiguration:
nginx -t
NGINX neu starten:
systemctl restart nginx
NGINX neu laden:
systemctl reload nginx
NGINX-Status prüfen:
systemctl status nginx
SSL mit einer Domain aktivieren
1. Richten Sie Ihre Domain auf die Server-IP aus.
2. Nginx-Konfiguration bearbeiten und beide ersetzen server_name _; mit Ihrer Domain (server_name <yourdomain.com>) für beide Blöcke HTTP (Port 80) und HTTPS (Port 443):
vim /etc/nginx/sites-available/hedgedoc
3. Certbot installieren:
apt install -y certbot python3-certbot-nginx
4. Führen Sie den folgenden Befehl aus, um ein gültiges Let's Encrypt-Zertifikat zu generieren:
certbot certonly --nginx --non-interactive --agree-tos --email [email protected] -d yourdomain.com
5. SSL-Pfade in der Nginx-Konfiguration ersetzen:
vim /etc/nginx/sites-available/hedgedoc
# Before:
# ssl_certificate /etc/nginx/ssl/hedgedoc.crt;
# ssl_certificate_key /etc/nginx/ssl/hedgedoc.key;
# After:
# ssl_certificate /etc/letsencrypt/live/yourdomain.com/fullchain.pem;
# ssl_certificate_key /etc/letsencrypt/live/yourdomain.com/privkey.pem;
6. Laden Sie Nginx neu, um die Änderungen anzuwenden:
systemctl reload nginx
7. Bearbeiten Sie die /root/hedgedoc/.env Datei, um deinen Domainnamen festzulegen: CMD_DOMAIN=yourdoamin.com
8. Dienste neu erstellen:
cd /root/hedgedoc
docker compose up -d
9. Öffnen Sie Ihren Browser und besuchen Sie: https://yourdomain.com
