Etherpad

A modern really-real-time collaborative document editor.

Access Etherpad

  • User interface: https://<SERVER_IP>
  • Admin interface: https://<SERVER_IP>/admin
  • Admin credentials: Username admin, password stored in .env として ADMIN_PASSWORD

Add Users via Admin Settings

1. Visit: https://<SERVER_IP>/admin

2. Go to Settings.

3. A JSON configuration file will be displayed.

4. Locate the users section:

  "users": {
    "admin": {
      // 1) "password" can be replaced with "hash" if you install ep_hash_auth
      // 2) please note that if password is null, the user will not be created
      "password": "${ADMIN_PASSWORD:null}",
      "is_admin": true
    },
    "user": {
      // 1) "password" can be replaced with "hash" if you install ep_hash_auth
      // 2) please note that if password is null, the user will not be created
      "password": "test",
      "is_admin": false
    }
  },

5. Add a new user (follow valid JSON syntax):

  "users": {
    "admin": {
      // 1) "password" can be replaced with "hash" if you install ep_hash_auth
      // 2) please note that if password is null, the user will not be created
      "password": "${ADMIN_PASSWORD:null}",
      "is_admin": true
    },
    "user": {
      // 1) "password" can be replaced with "hash" if you install ep_hash_auth
      // 2) please note that if password is null, the user will not be created
      "password": "test",
      "is_admin": false
    },
    "newuser": {
      "password": "strongpassword",
      "is_admin": false
    }
  },

6. Click Save Settings.

7. Click Restart Etherpad.

重要なファイルとディレクトリ

  • アプリケーションのインストール: /root/etherpad
  • Docker Compose ファイル: /root/etherpad/docker-compose.yml
  • 環境変数: /root/etherpad/.env
  • PostgreSQL database data: /var/lib/docker/volumes/etherpad_postgres_data/_data
  • Etherpad runtime data: /var/lib/docker/volumes/etherpad_etherpad-var/_data
  • Plugins directory: /var/lib/docker/volumes/etherpad_plugins/_data
  • Nginxの設定: /etc/nginx/sites-available/etherpad
  • SSL証明書: /etc/nginx/ssl/

サービス管理

リストコンテナ:

docker ps

コンテナを再起動する:

docker compose -f /root/etherpad/docker-compose.yml restart

Follow Etherpad logs:

docker compose -f /root/etherpad/docker-compose.yml logs -f

Nginxを再起動:

systemctl restart nginx

ドメインでのSSLの有効化

1. ドメインをサーバーのIPアドレスに設定してください。

2. Nginx設定を編集し、両方を置換する server_name <IP>; あなたのドメインで (<your-domain>HTTP(ポート80)およびHTTPS(ポート443)ブロックの両方に対して:

vim /etc/nginx/sites-available/etherpad

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/apache2/sites-available/etherpad
# Before:
    # ssl_certificate /etc/nginx/ssl/fullchain.pem;
    # ssl_certificate_key /etc/nginx/ssl/privkey.pem;
# After:
    # ssl_certificate /etc/letsencrypt/live/yourdomain.com/fullchain.pem;
    # ssl_certificate_key /etc/letsencrypt/live/yourdomain.com/privkey.pem;

6. 変更を適用するために Nginx を再起動します:

systemctl restart nginx

7. ブラウザを開き、次のURLにアクセスしてください: https://yourdomain.com

注記

  • Etherpad is served behind an Nginx reverse proxy for SSL termination and improved security.
  • A self-signed certificate may trigger browser warnings; this is expected unless Let’s Encrypt is used.
  • Some browsers may display errors or cause Etherpad to function incorrectly.
  • Etherpad has been tested and confirmed working on Firefox, which is recommended for best compatibility.

申請内容