Gå til hovedindhold
50% rabat alle planer, tidsbegrænset. Fra $2.48/mo
HedgeDoc

HedgeDoc

HedgeDoc (tidligere CodiMD) er en open-source, real-time samarbejdsbaseret Markdown-editor. Del dokumenter, skriv sammen og præsenter slides, svarende til HackMD eller Google Docs men selvhostet. AGPL-3.0-licenseret med over 7.200 GitHub-stjerner.

Overblik

7.3k

GitHub-stjerner

16

Sidevisninger

Licens AGPL-3.0 Udgave 1.10.8 OS Ubuntu Server 24.04 LTS Min RAM 1 GB IP IPV4,IPV6

Åbn HedgeDoc

  1. Åbn HedgeDoc-webgrænsefladen: https://<SERVER-IP>
  2. En browseradvarsel vises, fordi der bruges et selvsigneret certifikat. Fortsæt til webstedet for at fortsætte.
  3. Klik på 'Log ind' og derefter 'Registrer' for at oprette din konto.

Slutpunkter

  • Hovedapplikation: https://<SERVER-IP>/ (webgrænseflade)
  • Status: https://<SERVER-IP>/status (sundhedstjekside)
  • Metrikker: https://<SERVER-IP>/metrics (systemmetrikker)
  • WebSocket: /socket.io/ (realtidskommunikation)

Registrering

Brugerregistrering er aktiveret som standard.

For at deaktivere registrering af nye brugere, ændre CMD_ALLOW_EMAIL_REGISTER=true to CMD_ALLOW_EMAIL_REGISTER=false in /root/hedgedoc/.env.

Genstart applikationen for at anvende ændringen:

cd /root/hedgedoc
docker compose restart

Databasesikkerhedskopi

Opret en PostgreSQL-sikkerhedskopi:

cd /root/hedgedoc
docker compose exec database pg_dump hedgedoc -U hedgedoc > backup.sql

Vigtige filer og mapper

  • Installationssti: /root/hedgedoc
  • Compose-fil: /root/hedgedoc/docker-compose.yml
  • Miljøfil: /root/hedgedoc/.env
  • Nginx-konfiguration: /etc/nginx/sites-available/hedgedoc
  • SSL-certifikat: /etc/nginx/ssl/hedgedoc.crt
  • SSL-nøgle: /etc/nginx/ssl/hedgedoc.key
  • Upload-volumen: /var/lib/docker/volumes/hedgedoc_uploads/_data
  • Databasevolumen: /var/lib/docker/volumes/hedgedoc_database/_data

Docker-administration

Kontroller containere:

docker ps

Se logs:

cd /root/hedgedoc
docker compose logs -f

Genstart tjenester:

cd /root/hedgedoc
docker compose restart

Stop services: Luk tjenester:

cd /root/hedgedoc
docker compose down

Start tjenester:

cd /root/hedgedoc
docker compose up -d

NGINX-administration

Testkonfiguration:

nginx -t

Genstart NGINX:

systemctl restart nginx

Genindlæs NGINX:

systemctl reload nginx

Tjek NGINX-status:

systemctl status nginx

Aktivering af SSL med et domæne

1. Peg dit domæne mod serverens IP.

2. Rediger Nginx-config og erstat begge server_name _; med dit domæne (server_name <yourdomain.com>) for både HTTP (port 80) og HTTPS (port 443) blokke:

vim /etc/nginx/sites-available/hedgedoc

3. Installer Certbot:

apt install -y certbot python3-certbot-nginx

4. Kør følgende kommando for at generere et gyldigt Let's Encrypt-certifikat:

certbot certonly --nginx --non-interactive --agree-tos --email [email protected] -d yourdomain.com

5. Erstat SSL-stier i Nginx-config:

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. Genindlæs Nginx for at anvende ændringerne:

systemctl reload nginx

7. Rediger /root/hedgedoc/.env fil for at angive dit domænenavn: CMD_DOMAIN=yourdoamin.com

8. Genskab tjenesterne:

cd /root/hedgedoc
docker compose up -d

9. Åbn din browser og gå til: https://yourdomain.com


Mere i Self-hosted

Relaterede apps.

Deploy HedgeDoc now. Fra 2,48 $/md.