unihalle/etherpad-lite

Docker版Etherpad Lite镜像

这是Etherpad Lite实时协作文本编辑器的Docker镜像。该镜像支持MariaDB或MySQL作为数据库后端，并提供docker-compose配置文件，可通过单条命令快速启动Etherpad和数据库服务。

关于Etherpad Lite

来自官方网站：
Etherpad允许你在浏览器中实时协作编辑文档，就像一个多人在线编辑器。你可以与朋友、同学或同事共同撰写文章、新闻稿、待办清单等，所有人同时操作同一文档。

!Etherpad Lite协作编辑演示动画

所有实例通过完善的API开放数据访问，并支持多种主流格式的导入/导出。如果内置功能不足，还可通过大量插件自定义实例以满足需求。你无需自行搭建服务器安装Etherpad，可选择公开实例或按照指南部署自己的实例。

快速启动

首先需要运行MySQL容器：

bash
$ docker network create ep_network
$ docker run -d --network ep_network -e MYSQL_ROOT_PASSWORD=password --name ep_mysql mariadb:10

然后启动Etherpad Lite实例：

bash
$ docker run -d \
    --network ep_network \
    -e ETHERPAD_DB_HOST=ep_mysql \
    -e ETHERPAD_DB_PASSWORD=password \
    -p 9001:9001 \
    unihalle/etherpad-lite

Etherpad会自动在指定MySQL服务器中创建etherpad数据库（若不存在）。现在可通过http://localhost:9001/访问Etherpad Lite。

Docker Compose使用

https://github.com/uni-halle/etherpad-lite-docker%E5%8C%85%E5%90%AB%E9%A2%84%E9%85%8D%E7%BD%AEMariaDB%E5%AE%B9%E5%99%A8%E7%9A%84docker-compose%E6%96%87%E4%BB%B6%EF%BC%9A

1. 安装docker-compose；
2. 克隆仓库并进入etherpad-lite目录；
3. 复制或重命名example.env为.env并调整密码；
4. 执行docker-compose up启动服务。

注意：若希望docker-compose down时不丢失MySQL数据，需将数据存储在卷中并防止删除，详情参考MySQL/MariaDB镜像文档。另外，即使修改环境变量，MariaDB/MySQL镜像可能不会更新数据库凭据。

环境变量配置

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

• ETHERPAD_TITLE：实例标题，默认"Etherpad"；
• ETHERPAD_DEFAULT_PAD_TEXT：新pad打开时的默认文本；
• ETHERPAD_PORT：实例端口，默认9001；
• ETHERPAD_ADMIN_PASSWORD：设置后启用管理员账户，可访问/admin/界面；
• ETHERPAD_ADMIN_USER：管理员用户名，默认"admin"（需设置密码）；
• ETHERPAD_DB_HOST：MySQL数据库主机，默认"mysql"；
• ETHERPAD_DB_PORT：数据库端口，默认3306；
• ETHERPAD_DB_USER：数据库用户，默认root；
• ETHERPAD_DB_PASSWORD：数据库密码（必填）；
• ETHERPAD_DB_NAME：数据库名称，默认"etherpad"（不存在则自动创建）；
• ETHERPAD_DB_CHARSET：字符集，推荐utf8mb4；
• ETHERPAD_API_KEY：API密钥，默认随机生成（需≥20字符）；
• ETHERPAD_SESSION_REQUIRED：用户需登录会话才能访问pad（仅允许组pad），默认关闭。

生成的settings.json文件可在卷/opt/etherpad-lite/var/下访问。