unillett/etherpad

Etherpad Docker镜像文档

镜像概述

本镜像为https://github.com/ether/etherpad-lite%E5%BA%94%E7%94%A8%E6%8F%90%E4%BE%9BDocker%E9%85%8D%E7%BD%AE%EF%BC%8C%E6%94%AF%E6%8C%81%E5%BF%AB%E9%80%9F%E9%83%A8%E7%BD%B2%E5%92%8C%E7%AE%A1%E7%90%86%E8%BF%99%E6%AC%BE%E5%AE%9E%E6%97%B6%E5%8D%8F%E4%BD%9C%E7%BC%96%E8%BE%91%E5%B7%A5%E5%85%B7%E3%80%82%E9%80%82%E7%94%A8%E4%BA%8E%E5%BC%80%E5%8F%91%E3%80%81%E6%B5%8B%E8%AF%95%E5%8F%8A%E7%94%9F%E4%BA%A7%E7%8E%AF%E5%A2%83%EF%BC%8C%E6%8F%90%E4%BE%9B%E7%81%B5%E6%B4%BB%E7%9A%84%E9%85%8D%E7%BD%AE%E9%80%89%E9%A1%B9%E5%92%8C%E8%87%AA%E5%8A%A8%E5%8C%96%E6%9B%B4%E6%96%B0%E6%9C%BA%E5%88%B6%E3%80%82

核心功能与特性

• 支持开发、 staging 和生产多环境部署
• 提供环境变量和配置文件自定义
• 基于GitHub Actions的自动化镜像构建与版本更新
• 生成多版本Docker镜像标签（含不可变标签）
• 集成Helm图表支持Kubernetes部署

使用场景

• 本地开发环境搭建Etherpad实例
• 生产环境部署高可用协作编辑平台
• 需要版本控制和自动化更新的企业级应用
• Kubernetes集群中的协作工具部署

使用方法

开发环境部署

前提条件

需先安装Docker。

配置环境文件

复制并重命名环境示例文件：

bash
cp example.env .env

默认值适用于本地开发，如有需要可修改。

复制并重命名开发环境覆盖配置文件：

bash
cp docker-compose.override.yml.dev docker-compose.override.yml

默认值适用于本地开发，如有需要可修改。

构建与运行

构建并启动所有容器：

bash
docker compose up  # 添加 -d 参数可后台运行并静默日志

访问应用

• 主应用：http://localhost:9001
• 管理界面：http://localhost:9001/admin
  • 默认账号：admin / admin

生产环境部署

配置环境文件

复制并重命名环境示例文件：

bash
cp example.env .env

必须替换默认值，因其不适用于生产环境。

复制并重命名生产环境覆盖配置文件：

bash
cp docker-compose.override.yml.prod docker-compose.override.yml

默认值适用于生产环境，如有需要可修改。对于staging环境，可使用docker-compose.override.yml.stage文件。

构建与运行

构建并后台启动所有容器：

bash
docker compose up -d

反向代理配置

需配置反向代理将URL映射到9001端口，示例可参考https://github.com/ether/etherpad-lite/wiki/How-to-put-Etherpad-Lite-behind-a-reverse-Proxy%E3%80%82

应用更新

本应用使用自定义构建的Etherpad Docker镜像，通过https://github.com/unil-lettres/etherpad/blob/main/.github/workflows/docker.yml%E6%9E%84%E5%BB%BA%E5%B9%B6%E6%8E%A8%E9%80%81%E5%88%B0https://hub.docker.com/repository/docker/unillett/etherpad/general%E3%80%82

更新步骤

1. 当https://github.com/ether/etherpad-lite/tags%E5%8F%91%E5%B8%83%E6%97%B6%EF%BC%8C%E6%9B%B4%E6%96%B0https://github.com/unil-lettres/etherpad/blob/main/VERSION%E6%96%87%E4%BB%B6%E4%B8%AD%E7%9A%84%E7%89%88%E6%9C%AC%E5%8F%B7
2. 将更改推送到仓库后，工作流会自动构建新镜像并推送到Docker Hub

自定义构建版本

如需触发重建或标记自定义镜像版本，可在VERSION文件中添加修订后缀（如-rev1）。该后缀在获取Etherpad源代码时会被忽略，但可用于区分工作流中的构建和Docker镜像标签。

Docker镜像标签规则

GitHub Actions工作流基于以下事件生成镜像标签：

• 推送到development分支：stage-latest、stage-<sha>-<timestamp>（不可变）
• 推送到main分支：latest
• 推送Git标签：vX.Y.Z（不可变，基于VERSION文件）

定时任务

• 每周cron任务生成更新的staging镜像：stage-<sha>-<timestamp>（不可变）
• 每周cron任务生成更新的生产候选镜像：vX.Y.Z-<sha>-<timestamp>（不可变，基于VERSION文件）

所有不可变标签均提交至https://github.com/unil-lettres/k8s%E3%80%82

Helm部署

本项目的Helm图表位于https://github.com/unil-lettres/k8s%E7%9A%84%60palett%60%E7%9B%AE%E5%BD%95%E3%80%82

注意：自定义镜像中构建的插件不会在Kubernetes上自动安装。由于k8s挂载卷会替换镜像中的/opt/etherpad-lite/src/plugin_packages和/opt/etherpad-lite/var目录，需通过应用的/admin界面手动安装插件。