Deploy HedgeDoc on Cloudzy VPS

HedgeDoc

HedgeDoc (เดิมคือ CodiMD) เป็นโปรแกรมแก้ไข Markdown แบบโอเพนซอร์สที่ทำงานร่วมกันแบบเรียลไทม์ แชร์เอกสาร เขียนร่วมกัน และนำเสนอสไลด์ คล้ายกับ HackMD หรือ Google Docs แต่โฮสต์ด้วยตนเอง ใช้ลิขสิทธิ์ AGPL-3.0 พร้อมดาว GitHub มากกว่า 7,200 ดวง

ภาพรวม

7.3k

GitHub stars

การดูหน้า

สัญญาอนุญาต AGPL-3.0 เวอร์ชัน 1.10.8 OS Ubuntu Server 24.04 LTS Min RAM 1 GB IP IPV4,IPV6

เข้าถึง HedgeDoc

เปิดอินเทอร์เฟซเว็บ HedgeDoc: https://<SERVER-IP>
คำเตือนเบราว์เซอร์จะปรากฏขึ้นเนื่องจากใช้ใบรับรองที่ลงนามเอง ดำเนินการต่อไปยังเว็บไซต์เพื่อดำเนินการต่อ
คลิก 'ลงชื่อเข้าใช้' จากนั้น 'ลงทะเบียน' เพื่อสร้างบัญชีของคุณ

จุดปลายทาง

แอปพลิเคชันหลัก: https://<SERVER-IP>/ (อินเทอร์เฟซเว็บ)
สถานะ: https://<SERVER-IP>/status (หน้าตรวจสอบสุขภาพ)
เมตริก: https://<SERVER-IP>/metrics (เมตริกระบบ)
WebSocket: /socket.io/ (การสื่อสารแบบเรียลไทม์)

การลงทะเบียน

การลงทะเบียนผู้ใช้เปิดใช้งานโดยค่าเริ่มต้น

หากต้องการปิดใช้งานการลงทะเบียนผู้ใช้ใหม่ ให้เปลี่ยน CMD_ALLOW_EMAIL_REGISTER=true to CMD_ALLOW_EMAIL_REGISTER=false in /root/hedgedoc/.env.

รีสตาร์ทแอปพลิเคชันเพื่อใช้การเปลี่ยนแปลง:

cd /root/hedgedoc
docker compose restart

การสำรองข้อมูลฐานข้อมูล

สร้างการสำรองข้อมูล PostgreSQL:

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

ไฟล์และไดเรกทอรีที่สำคัญ

เส้นทางการติดตั้ง: /root/hedgedoc
ไฟล์ Compose: /root/hedgedoc/docker-compose.yml
ไฟล์สภาพแวดล้อม: /root/hedgedoc/.env
การตั้งค่า Nginx: /etc/nginx/sites-available/hedgedoc
ใบรับรอง SSL: /etc/nginx/ssl/hedgedoc.crt
คีย์ SSL: /etc/nginx/ssl/hedgedoc.key
ปริมาณการอัปโหลด: /var/lib/docker/volumes/hedgedoc_uploads/_data
โวลุ่มฐานข้อมูล: /var/lib/docker/volumes/hedgedoc_database/_data

การจัดการ Docker

ตรวจสอบคอนเทนเนอร์

docker ps

ดู logs:

cd /root/hedgedoc
docker compose logs -f

รีสตาร์ทบริการ:

cd /root/hedgedoc
docker compose restart

หยุดบริการ:

cd /root/hedgedoc
docker compose down

เริ่มบริการ:

cd /root/hedgedoc
docker compose up -d

การจัดการ NGINX

การตั้งค่าการทดสอบ:

nginx -t

รีสตาร์ท NGINX:

systemctl restart nginx

โหลด NGINX ใหม่:

systemctl reload nginx

ตรวจสอบสถานะ NGINX:

systemctl status nginx

เปิดใช้งาน SSL กับโดเมน

1. ชี้โดเมนของคุณไปยัง IP ของ server

2. แก้ไข config ของ Nginx และเปลี่ยนทั้งคู่ server_name _; กับโดเมนของคุณ (server_name <yourdomain.com>) สำหรับทั้ง HTTP (port 80) และ HTTPS (port 443) blocks:

vim /etc/nginx/sites-available/hedgedoc

3. ติดตั้ง Certbot:

apt install -y certbot python3-certbot-nginx

4. รันคำสั่งต่อไปนี้เพื่อสร้างใบรับรอง Let's Encrypt ที่ถูกต้อง:

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

5. แทนที่ SSL paths ใน 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. โหลด Nginx ใหม่เพื่อใช้การเปลี่ยนแปลง: