etherpad/etherpad

Etherpad：Web实时协作编辑器

!https://github.com/ether/etherpad-lite/raw/6085/merge/doc/images/etherpad_demo.gif "Etherpad使用演示"

概述

Etherpad是一款Web实时协作编辑器，可扩展支持数千名并发实时用户，提供完整的数据导出功能，并能在您自己的服务器上运行，完全由您掌控数据。

核心功能与特性

• 实时协作：多人同时编辑，实时显示各方更改
• 高可扩展性：支持数千并发用户（扩展测试）
• 数据导出：提供完整数据导出能力（https://github.com/ether/etherpad-lite/wiki/Understanding-Etherpad's-Full-Data-Export-capabilities%EF%BC%89
• 自托管控制：运行在自有服务器，确保数据安全与隐私
• 插件生态：丰富的插件系统，支持功能高度自定义

使用场景

适用于团队协作编辑、文档共同创作、实时会议记录、多人协作撰稿等场景，尤其适合需要数据私有化和自主管理的组织或个人。

试用体验

• Wikimedia提供公共实例：https://etherpad.wikimedia.org
• 其他公共实例：https://github.com/ether/etherpad-lite/wiki/Sites-That-Run-Etherpad#sites-that-run-etherpad

项目状态

目前正在寻找维护者，并提供部分资金支持。如有兴趣，请联系John McLear。

代码质量

https://github.com/ether/etherpad-lite/actions/workflows/codeql-analysis.yml/badge.svg?color=%2344b492](https://github.com/ether/etherpad-lite/actions/workflows/codeql-analysis.yml) https://github.com/ether/etherpad-lite/actions/workflows/lint-package-lock.yml/badge.svg?color=%2344b492](https://github.com/ether/etherpad-lite/actions/workflows/lint-package-lock.yml)

测试状态

https://github.com/ether/etherpad-lite/actions/workflows/backend-tests.yml/badge.svg?color=%2344b492](https://github.com/ether/etherpad-lite/actions/workflows/backend-tests.yml) https://github.com/ether/etherpad-lite/actions/workflows/load-test.yml/badge.svg?color=%2344b492](https://github.com/ether/etherpad-lite/actions/workflows/load-test.yml) https://github.com/ether/etherpad-lite/actions/workflows/rate-limit.yml/badge.svg?color=%2344b492](https://github.com/ether/etherpad-lite/actions/workflows/rate-limit.yml) https://github.com/ether/etherpad-lite/actions/workflows/dockerfile.yml/badge.svg?color=%2344b492](https://github.com/ether/etherpad-lite/actions/workflows/dockerfile.yml) https://github.com/ether/etherpad-lite/actions/workflows/frontend-admin-tests.yml/badge.svg?color=%2344b492](https://github.com/ether/etherpad-lite/actions/workflows/frontend-admin-tests.yml) https://github.com/ether/etherpad-lite/actions/workflows/frontend-tests.yml/badge.svg?color=%2344b492](https://github.com/ether/etherpad-lite/actions/workflows/frontend-tests.yml) https://saucelabs.com/buildstatus/etherpad.svg](https://saucelabs.com/u/etherpad) https://github.com/ether/etherpad-lite/actions/workflows/windows.yml/badge.svg?color=%2344b492](https://github.com/ether/etherpad-lite/actions/workflows/windows.yml)

社区参与

https://img.shields.io/docker/pulls/etherpad/etherpad?color=%2344b492](https://hub.docker.com/r/etherpad/etherpad) https://img.shields.io/***/741309013593030667?color=%2344b492]([] https://img.shields.io/endpoint?url=https%3A%2F%2Fstatic.etherpad.org%2Fshields.json&color=%2344b492 "Etherpad插件"]([] !https://img.shields.io/static/v1?label=Languages&message=105&color=%2344b492 !https://img.shields.io/static/v1?label=Languages&message=98%25&color=%2344b492

Docker部署指南

基本运行命令

bash
docker run -d -p 9001:9001 --name etherpad etherpad/etherpad

Docker Compose配置示例

yaml
version: '3'
services:
  etherpad:
    image: etherpad/etherpad
    container_name: etherpad
    ports:
      - "9001:9001"
    volumes:
      - ./etherpad_data:/opt/etherpad-lite/var
    environment:
      - NODE_ENV=production
      - DB_TYPE=sqlite
      - DB_FILENAME=/opt/etherpad-lite/var/dirty.db
    restart: unless-stopped

更多详细配置请参考https://github.com/ether/etherpad-lite/blob/6085/merge/doc/docker.adoc

插件系统

Etherpad通过插件实现高度自定义功能。

!https://github.com/ether/etherpad-lite/raw/6085/merge/doc/images/etherpad_basic.png "基础安装"

!https://github.com/ether/etherpad-lite/raw/6085/merge/doc/images/etherpad_full_features.png "可添加众多插件"

可用插件

查看完整插件列表：Etherpad插件网站

插件安装方法

通过管理界面安装

访问Etherpad管理界面（如：[***]

通过命令行安装

bash
cd /path/to/etherpad-lite
# --no-save 和 --legacy-peer-deps 参数用于解决npm兼容性问题
npm install --no-save --legacy-peer-deps ep_${插件名称}

推荐插件组合

运行以下命令安装演示中展示的完整功能插件：

bash
npm install --no-save --legacy-peer-deps \
  ep_align \
  ep_comments_page \
  ep_embedded_hyperlinks2 \
  ep_font_color \
  ep_headings2 \
  ep_markdown \
  ep_webrtc

身份认证推荐插件

• https://github.com/ether/ep_openid_connect#readme%EF%BC%9AOpenID Connect认证
• https://github.com/ether/ep_guest#readme%EF%BC%9A%E8%AE%BF%E5%AE%A2%E8%B4%A6%E6%88%B7%E7%AE%A1%E7%90%86%EF%BC%88%E5%A6%82%E5%8F%AA%E8%AF%BB%E6%9D%83%E9%99%90%EF%BC%89
• https://github.com/ether/ep_user_displayname#readme%EF%BC%9A%E7%94%A8%E6%88%B7%E6%98%BE%E7%A4%BA%E5%90%8D%E8%87%AA%E5%8A%A8%E5%A1%AB%E5%85%85
• https://github.com/ether/ep_stable_authorid#readme%EF%BC%9A%E7%94%A8%E6%88%B7%E8%BA%AB%E4%BB%BD%E4%B8%8E%E5%B1%9E%E6%80%A7%E5%85%B3%E8%81%94

配置与优化

设置调整

Etherpad核心配置文件为settings.json，支持通过命令行参数指定不同配置文件：

bash
src/bin/run.sh --settings /path/to/custom-settings.json

主要配置参数：

• --credentials：指定设置覆盖文件
• --apikey：指定API密钥文件
• --sessionkey：指定会话密钥文件

所有配置参数均可通过环境变量设置，格式为${ENV_VAR}或${ENV_VAR:default_value}。

安全加固

生产环境建议：

1. 使用专用数据库（如MySQL）替代默认的dirtyDB
2. 安装https://www.npmjs.com/package/ep_hash_auth%E5%AD%98%E5%82%A8%E5%AF%86%E7%A0%81%E5%93%88%E5%B8%8C
3. 配置HTTPS加密传输

皮肤自定义

访问以下地址进行皮肤可视化定制：

http://127.0.0.1:9001/p/test#skinvariantsbuilder

!https://github.com/ether/etherpad-lite/raw/6085/merge/doc/images/etherpad_skin_variants.gif "皮肤变体"

开发资源

HTTP API

Etherpad提供https://github.com/ether/etherpad-lite/wiki/HTTP-API%E7%94%A8%E4%BA%8E%E7%AE%A1%E7%90%86%E6%96%87%E6%A1%A3%E3%80%81%E7%94%A8%E6%88%B7%E5%92%8C%E7%BB%84%EF%BC%8C%E6%8E%A8%E8%8D%90%E4%BD%BF%E7%94%A8https://github.com/ether/etherpad-lite/wiki/HTTP-API-client-libraries%E8%BF%9B%E8%A1%8C%E4%BA%A4%E4%BA%92%E3%80%82API%E7%9A%84OpenAPI%E5%AE%9A%E4%B9%89%E5%8F%AF%E9%80%9A%E8%BF%87%60/api/openapi.json%60%E8%AE%BF%E9%97%AE%E3%80%82

jQuery插件

通过https://github.com/ether/etherpad-lite-jquery-plugin%E5%8F%AF%E8%BD%BB%E6%9D%BE%E5%B0%86Etherpad%E5%B5%8C%E5%85%A5%E7%BD%91%E7%AB%99%E3%80%82

许可证

http://www.apache.org/licenses/LICENSE-2.0.html