Etherpad-Lite是一个现代化的实时协作文档编辑器，支持数千用户同时在线编辑，让团队协作变得更加高效便捷。💪 无论你是技术新手还是资深开发者，这份完整指南都将帮助你快速掌握Etherpad-Lite的安装、配置和使用技巧。
项目地址: https://gitcode.com/gh_mirrors/et/etherpad-lite 🚀 快速安装Etherpad-Lite
Docker Compose一键部署（推荐）
使用Docker Compose是最简单的安装方式，只需创建一个docker-compose.yml文件：
version: '3'
services:
etherpad:
image: etherpad/etherpad:latest
ports:
- "9001:9001"
environment:
- DB_TYPE=postgres
- DB_HOST=postgres
- DB_USER=admin
- DB_PASS=admin
- DB_NAME=etherpad
depends_on:
- postgres
postgres:
image: postgres:15-alpine
environment:
POSTGRES_DB: etherpad
POSTGRES_PASSWORD: admin
POSTGRES_USER: admin
运行命令：docker-compose up -d，然后访问 http://localhost:9001 即可使用！
传统安装方式
如果你更喜欢传统安装方式：
- 确保Node.js版本 ≥ 18.18.2
- 安装pnpm：
npm install -g pnpm - 克隆仓库：
git clone https://gitcode.com/gh_mirrors/et/etherpad-lite - 安装依赖：
pnpm install - 构建项目：
pnpm run build:etherpad - 启动服务：
pnpm run prod
🎨 功能丰富的协作体验
Etherpad-Lite提供真正的实时协作体验，支持：
- ✍️ 多人同时编辑文档
- 🎨 丰富的文本格式化选项
- 💬 实时聊天和评论功能
- 📊 完整的版本历史记录
- 🌍 多语言界面支持
🔧 个性化配置指南
修改基本设置
编辑 settings.json 文件来自定义你的Etherpad实例：
{
"title": "我的协作平台",
"ip": "0.0.0.0",
"port": 9001,
"dbType": "postgres",
"dbSettings": {
"host": "localhost",
"port": 5432,
"database": "etherpad",
"user": "admin",
"password": "admin"
}
}
安装推荐插件
通过管理界面或命令行安装功能增强插件：
pnpm run plugins i ep_align ep_comments_page ep_font_color ep_headings2 ep_markdown
🎯 主题定制与界面管理
Etherpad-Lite支持完全自定义的界面主题。访问 http://localhost:9001/p/test#skinvariantsbuilder 可以实时预览和创建个性化的界面样式。
🔒 安全配置建议
启用身份验证
在 settings.json 中配置用户认证：
{
"users": {
"admin": {
"password": "hashed_password_here",
"is_admin": true
}
}
}
推荐的安全插件
安装 ep_hash_auth 插件来增强安全性，支持密码哈希存储和外部用户目录管理。
📊 生产环境部署建议
数据库选择
对于生产环境，建议使用：
- PostgreSQL（推荐）
- MySQL
- 避免使用dirtyDB（仅用于开发测试）
性能优化配置
{
"maxAge": 21600000,
"minify": true,
"suppressErrorsInPadText": true,
"requireSession": true
}
🚀 进阶功能探索
HTTP API集成
Etherpad提供完整的REST API，支持通过编程方式管理文档、用户和群组。API文档位于 /api/openapi.json。
插件开发
基于强大的插件框架，你可以开发自定义功能来扩展Etherpad的能力。参考 插件开发文档 开始你的插件开发之旅。
💡 实用技巧与小贴士
- 使用
bin/debugRun.sh进行调试 - 快速开发时使用
bin/fastRun.sh跳过依赖更新 - 多语言支持涵盖105种语言，翻译覆盖率达98%
- 通过管理界面（
/admin）可以实时修改配置
🌟 总结
Etherpad-Lite作为一个开源、自托管的实时协作平台，为团队提供了强大而灵活的文档协作解决方案。通过本指南，你应该已经掌握了从安装部署到个性化配置的完整流程。
无论是小型团队内部使用，还是作为大型应用的嵌入组件，Etherpad-Lite都能提供稳定可靠的实时协作体验。现在就开始你的Etherpad之旅吧！🎉
提示：更多详细文档请查看项目中的 官方文档 目录，包含API文档、插件开发指南等丰富资源。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
