Deploy HedgeDoc on Cloudzy VPS

HedgeDoc

HedgeDoc(이전 CodiMD)는 오픈소스 실시간 협업 마크다운 편집기입니다. HackMD나 Google Docs와 유사하게 문서를 공유하고, 함께 작성하고, 슬라이드를 발표할 수 있지만 셀프 호스팅 방식입니다. AGPL-3.0 라이선스, GitHub 별 7,200개 이상.

한눈에 보기

7.3k

GitHub 스타

페이지 조회수

라이선스 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

로그 보기:

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로 지정하세요.

2. Nginx 설정 편집 및 둘 다 교체 server_name _; 도메인으로 (server_name <yourdomain.com>) HTTP (포트 80)와 HTTPS (포트 443) 블록 모두:

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. Nginx 설정의 SSL 경로 교체:

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를 다시 로드합니다: