tozd/etherpad

tozd/etherpad

https://gitlab.com/tozd/docker/etherpad

可用镜像地址：

• https://hub.docker.com/r/tozd/etherpad（Docker Hub）
• https://gitlab.com/tozd/docker/etherpad/container_registry（GitLab Registry）

镜像继承关系

https://gitlab.com/tozd/docker/base ← https://gitlab.com/tozd/docker/dinit ← tozd/etherpad

标签

• latest: 对应Etherpad Lite v1.8.18版本

镜像概述和主要用途

本镜像提供https://github.com/ether/etherpad-lite（轻量级实时协作编辑工具）的Docker化部署方案。Etherpad支持多人实时协作编辑同一文档，所有更改实时同步。该镜像简化了Etherpad的部署流程，支持通过配置文件或环境变量灵活定制，适用于团队协作、会议记录、共同编辑等场景。

核心功能和特性

• 基于可靠基础镜像：构建于tozd/dinit和tozd/base镜像之上，确保基础环境稳定性
• 版本明确：latest标签对应Etherpad Lite v1.8.18，版本可控
• 灵活日志配置：支持日志输出到stdout（便于Docker日志管理）或文件卷
• 标准端口暴露：默认暴露9001/tcp端口，便于网络访问
• 多方式配置：支持挂载自定义配置文件或通过环境变量动态配置

使用场景和适用范围

• 团队实时协作编辑文档
• 多人共同撰写会议记录或报告
• 教学场景中师生实时互动编辑
• 需要快速部署协作编辑工具的临时项目

使用方法和配置说明

镜像获取

从Docker Hub拉取：

bash
docker pull docker.xuanyuan.run/tozd/etherpad

从GitLab Registry拉取：

bash
docker pull ***-gitlab.xuanyuan.run/tozd/docker/etherpad

Docker Run部署示例

bash
docker run -d \
  --name etherpad \
  -p 9001:9001 \  # 映射HTTP端口到主机
  -v /path/to/settings.json:/etherpad/settings.json \  # 挂载自定义配置文件（可选）
  -e LOG_TO_STDOUT=1 \  # 日志输出到stdout（可选）
  tozd/etherpad

Docker Compose配置示例

yaml
version: '3'
services:
  etherpad:
    image: docker.xuanyuan.run/tozd/etherpad
    container_name: etherpad
    ports:
      - "9001:9001"  # 主机端口:容器端口
    volumes:
      # 挂载自定义配置文件（可选）
      - ./settings.json:/etherpad/settings.json
      # 若不使用LOG_TO_STDOUT=1，挂载日志卷（可选）
      # - etherpad_logs:/var/log/etherpad
    environment:
      - LOG_TO_STDOUT=1  # 日志输出到stdout（可选）
    restart: unless-stopped

# 日志卷定义（当LOG_TO_STDOUT未设置时使用）
# volumes:
#   etherpad_logs:

配置详情

卷（Volumes）

• /var/log/etherpad: 日志存储目录。当LOG_TO_STDOUT未设置为1时，Etherpad日志将写入此目录下的文件。

环境变量（Variables）

• LOG_TO_STDOUT: 日志输出控制。设为1时，日志输出到容器stdout（可通过docker logs <容器名>查看）；未设置时，日志写入/var/log/etherpad卷。所有stdout输出为JSON格式。

端口（Ports）

• 9001/tcp: Etherpad服务监听的HTTP端口，需通过-p参数映射到主机端口以对外提供服务。

配置文件定制

可将自定义的settings.json文件挂载到容器内/etherpad/settings.json路径，覆盖默认配置。若未挂载配置文件，首次运行时将使用https://github.com/tozd/etherpad-lite/blob/develop/settings.json.template，并通过环境变量替换模板中的参数（具体环境变量可参考模板内容）。

GitHub镜像

项目提供只读GitHub镜像：https://github.com/tozd/docker-etherpad，方便在GitHub上fork项目。