Etherpad：一个用于网络的实时协作编辑器

Etherpad演示动画

关于

Etherpad是一个实时协作编辑器，可扩展至同时支持数千名实时用户。它提供完整的数据导出功能，并在您的服务器上运行，由您控制。

试用

维基媒体提供了一个公共Etherpad实例供您试用，或者您可以使用其他公共Etherpad实例来体验更多功能。

项目状态

我们正在寻找维护者，并有一些可用资金。如果您能提供帮助，请联系John McLear。

代码质量

测试

参与度

翻译覆盖率

安装

Docker-Compose

services:
  app:
    user: "0:0"
    image: etherpad/etherpad:latest
    tty: true
    stdin_open: true
    volumes:
      - plugins:/opt/etherpad-lite/src/plugin_packages
      - etherpad-var:/opt/etherpad-lite/var
    depends_on:
      - postgres
    environment:
      NODE_ENV: production
      ADMIN_PASSWORD: ${DOCKER_COMPOSE_APP_ADMIN_PASSWORD:-admin}
      DB_CHARSET: ${DOCKER_COMPOSE_APP_DB_CHARSET:-utf8mb4}
      DB_HOST: postgres
      DB_NAME: ${DOCKER_COMPOSE_POSTGRES_DATABASE:-etherpad}
      DB_PASS: ${DOCKER_COMPOSE_POSTGRES_PASSWORD:-admin}
      DB_PORT: ${DOCKER_COMPOSE_POSTGRES_PORT:-5432}
      DB_TYPE: "postgres"
      DB_USER: ${DOCKER_COMPOSE_POSTGRES_USER:-admin}
      # 目前，环境变量DEFAULT_PAD_TEXT不能为空或未设置；在最新版本的etherpad中似乎是必需的
      DEFAULT_PAD_TEXT: ${DOCKER_COMPOSE_APP_DEFAULT_PAD_TEXT:- }
      DISABLE_IP_LOGGING: ${DOCKER_COMPOSE_APP_DISABLE_IP_LOGGING:-false}
      SOFFICE: ${DOCKER_COMPOSE_APP_SOFFICE:-null}
      TRUST_PROXY: ${DOCKER_COMPOSE_APP_TRUST_PROXY:-true}
    restart: always
    ports:
      - "${DOCKER_COMPOSE_APP_PORT_PUBLISHED:-9001}:${DOCKER_COMPOSE_APP_PORT_TARGET:-9001}"

  postgres:
    image: postgres:15-alpine
    environment:
      POSTGRES_DB: ${DOCKER_COMPOSE_POSTGRES_DATABASE:-etherpad}
      POSTGRES_PASSWORD: ${DOCKER_COMPOSE_POSTGRES_PASSWORD:-admin}
      POSTGRES_PORT: ${DOCKER_COMPOSE_POSTGRES_PORT:-5432}
      POSTGRES_USER: ${DOCKER_COMPOSE_POSTGRES_USER:-admin}
      PGDATA: /var/lib/postgresql/data/pgdata
    restart: always
    # 除非您想从主机访问此数据库实例，否则不需要暴露端口。
    # 当其他postgres docker容器在同一端口上运行时要小心
    # ports:
    #   - "5432:5432"
    volumes:
      - postgres_data:/var/lib/postgresql/data/pgdata

volumes:
  postgres_data:
  plugins:
  etherpad-var:

要求

Node.js >= 18.18.2。

Windows、macOS、Linux

从nodejs.org下载最新的Node.js运行时。
安装pnpm：npm install -g pnpm（可能需要管理员权限）。
克隆仓库：git clone -b master
运行pnpm i
运行pnpm run build:etherpad
运行pnpm run prod
在浏览器中访问http://localhost:9001。

Docker容器

在这里查找有关在容器中运行Etherpad的信息。

插件

Etherpad可通过插件进行高度自定义。

基本安装

全功能

可用插件

有关可用插件的列表，请参阅插件网站。

插件安装

您可以从管理网页界面安装插件（例如，http://127.0.0.1:9001/admin/plugins）。

或者，您可以从命令行安装插件：

cd /path/to/etherpad-lite
pnpm run plugins i ep_${plugin_name}

另请参阅插件维基文章。

后续步骤

调整设置

您可以在 settings.json 中修改设置。如果需要处理多个设置文件，可以使用 -s|--settings 选项向 bin/run.sh 传递设置文件的路径：这允许您从同一安装中运行多个 Etherpad 实例。同样，可以使用 --credentials 提供设置覆盖文件，使用 --apikey 提供不同的 APIKEY.txt 文件，使用 --sessionkey 提供非默认的 SESSIONKEY.txt。每个配置参数也可以通过环境变量设置，使用语法 "${ENV_VAR}" 或 "${ENV_VAR:default_value}"。详情请参阅 settings.json.template。一旦您可以访问 /admin 部分，就可以通过网页浏览器修改设置。