kifu/etherpad

Etherpad Lite Docker镜像

这是Etherpad Lite协作文本编辑器的Docker镜像。该镜像的Dockerfile灵感来源于https://registry.hub.docker.com/_/wordpress/镜像和https://registry.hub.docker.com/u/johbo/etherpad-lite/镜像，基于Debian Jessie构建（因Etherpad Lite稳定版暂不支持npm 2，故未使用官方Node镜像）。

镜像概述

Etherpad Lite是一款浏览器端的实时多人协作文本编辑工具，支持多人同时编辑同一文档，并提供丰富的功能扩展能力。本镜像使用MySQL或PostgreSQL作为后端数据库存储文档数据。

核心功能

• 实时协作：多人同时在线编辑同一文档，内容实时同步。
• 数据交互：支持多种格式的导入/导出（如TXT、HTML、Markdown等）。
• API访问：通过完善的API接口可访问所有数据。
• 插件扩展：通过插件自定义功能，满足不同场景需求。

使用场景

• 团队协作撰写文档、报告或会议记录。
• 学生小组共同完成作业或项目。
• 远程团队实时沟通并编辑内容。

配置说明

环境变量

该镜像支持以下环境变量配置：

• ETHERPAD_TITLE：实例标题，默认值为"Etherpad"。
• ETHERPAD_PORT：实例端口，默认值为9001。
• ETHERPAD_ADMIN_PASSWORD：设置后启用管理员账户，可访问/admin/界面。
• ETHERPAD_ADMIN_USER：管理员用户名，默认值为"admin"（需配合密码使用）。
• ETHERPAD_DB_TYPE：数据库类型，默认值为mysql。
• ETHERPAD_DB_HOST：数据库主机名，默认值为mysql。
• ETHERPAD_DB_USER：数据库用户名，默认使用root。
• ETHERPAD_DB_PASSWORD：数据库密码（必填）。
• ETHERPAD_DB_PASSWORD_FILE：通过Docker secrets传递密码（替代ETHERPAD_DB_PASSWORD）。
• ETHERPAD_DB_NAME：数据库名称，默认值为"etherpad"（不存在时自动创建）。
• ETHERPAD_DB_CHARSET：数据库字符集，默认值为utf8mb4。
• ETHERPAD_API_KEY：若APIKEY.txt缺失，用此变量值生成。

部署示例

1. 创建网络

bash
docker network create ep_network

2. 启动MySQL容器

bash
docker run -d --network ep_network -e MYSQL_ROOT_PASSWORD=password --name ep_mysql docker.xuanyuan.run/mysql

3. 启动Etherpad Lite容器

bash
docker run -d \
    --network ep_network \
    -e ETHERPAD_DB_HOST=ep_mysql \
    -e ETHERPAD_DB_PASSWORD=password \
    -p 9001:9001 \
    docker.xuanyuan.run/kifu/etherpad

启动后可通过http://localhost:9001/访问Etherpad Lite实例。生成的settings.json文件位于/opt/etherpad-lite/var/目录（可通过卷挂载持久化）。