Etherpad-lite 项目 Docker 部署完全指南

前言

Etherpad-lite 是一个基于 Web 的实时协作编辑器，允许多个用户同时编辑文档。使用 Docker 部署 Etherpad-lite 可以简化安装过程，提高可移植性。本文将详细介绍如何使用 Docker 部署和管理 Etherpad-lite 实例。

获取官方 Docker 镜像

Etherpad-lite 提供了官方 Docker 镜像，可以直接拉取使用：

# 获取最新版本
docker pull etherpad/etherpad

# 获取特定版本
docker pull etherpad/etherpad:1.8.0

构建个性化容器

使用 Docker Compose 部署

项目提供了 docker-compose 文件，简化部署流程：

1. 首先复制环境变量模板文件：

   cp .env.default .env
   

2. 编辑 .env 文件，根据需求调整配置

3. 启动容器：

   docker compose up -d
   

开发模式与生产模式

• 开发模式：默认会安装开发依赖项，便于调试
• 生产模式：不安装开发依赖，优化资源加载速度

要切换到生产模式，需要修改 docker-compose 文件中的 target 属性和 NODE_ENV 环境变量。

插件管理

在构建时可以通过 ETHERAPD_PLUGINS 参数指定要安装的插件：

args:
  ETHERPAD_PLUGINS: >-
    ep_image_upload
    ep_embedded_hyperlinks2
    ep_headings2
    ep_align

自定义配置

配置文件定制

编辑 <BASEDIR>/settings.json.docker 文件可以自定义配置。构建镜像时，该文件会被复制到容器内并重命名为 settings.json。

配置参数也可以通过环境变量设置，语法为：

• ${ENV_VAR}：必须的环境变量
• ${ENV_VAR:default_value}：带默认值的环境变量

导出功能配置

Etherpad-lite 支持将文档导出为 DOC/PDF/ODT 格式，需要安装额外的软件：

使用 Abiword

1. 构建时设置 INSTALL_ABIWORD 变量
2. 在配置中指定 Abiword 路径：

   "abiword": "/usr/bin/abiword"
   

   或通过环境变量：

   -e ABIWORD=/usr/bin/abiword
   

使用 LibreOffice

1. 构建时设置 INSTALL_SOFFICE 变量
2. 在配置中指定 LibreOffice 路径：

   "soffice": "/usr/bin/soffice"
   

   或通过环境变量：

   -e SOFFICE=/usr/bin/soffice
   

运行实例

构建并运行自定义镜像的基本命令：

# 构建镜像
docker build --tag yourname/etherpad .

# 运行容器
docker run --detach --publish 9001:9001 yourname/etherpad

访问地址：http://<服务器IP>:9001

配置详解

基本配置

变量名	描述	默认值
TITLE	实例名称	"Etherpad"
IP	绑定IP	"0.0.0.0"
PORT	绑定端口	9001
ADMIN_PASSWORD	admin用户密码	无
USER_PASSWORD	默认用户密码	无

数据库配置

支持多种数据库类型，包括 MySQL、PostgreSQL、SQLite 等：

变量名	描述
DB_TYPE	数据库类型
DB_HOST	数据库主机
DB_PORT	数据库端口
DB_NAME	数据库名称
DB_USER	数据库用户
DB_PASS	数据库密码

高级配置

变量名	描述	默认值
TRUST_PROXY	是否使用反向代理	false
MINIFY	是否压缩资源	true
REQUIRE_AUTHENTICATION	是否需要认证	false
EXPOSE_VERSION	是否显示版本信息	false

实用示例

使用 PostgreSQL 数据库

docker run -d \
  --name etherpad \
  -p 9001:9001 \
  -e 'DB_TYPE=postgres' \
  -e 'DB_HOST=db.example.com' \
  -e 'DB_PORT=5432' \
  -e 'DB_NAME=etherpad' \
  -e 'DB_USER=etherpad' \
  -e 'DB_PASS=password' \
  etherpad/etherpad

启用管理员账户

docker run -d \
  --name etherpad \
  -p 9001:9001 \
  -e 'ADMIN_PASSWORD=admin123' \
  etherpad/etherpad

使用持久化存储

docker run -d \
  -v etherpad_data:/opt/etherpad-lite/var \
  -p 9001:9001 \
  etherpad/etherpad

总结

通过 Docker 部署 Etherpad-lite 可以快速搭建一个功能完善的实时协作平台。本文介绍了从基础部署到高级配置的各个方面，包括数据库集成、插件管理、导出功能配置等。根据实际需求选择合适的配置方式，可以构建出满足不同场景需求的 Etherpad-lite 实例。