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. 打开浏览器并访问: 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.

申请详情