Deploy HedgeDoc on Cloudzy VPS

HedgeDoc

HedgeDoc（旧CodiMD）は、オープンソースのリアルタイム共同Markdownエディタです。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 を再読み込みします: