嗨,大家好,我是小华同学,关注我们获得"最新、最全、最优质"开源项目和高效工作学习方法
Etherpad 是一款现代的实时协作文档编辑器,能够支持成千上万的同时在线用户进行文档编辑。它提供了完整的数据导出功能,并可以在您自己的服务器上运行,完全由您掌控。Etherpad 以其强大的功能和灵活性,成为了团队协作和文档共享的理想选择。
功能特点
实时协作
Etherpad 的核心功能是实时协作,这意味着您可以与团队成员同时编辑同一个文档,并实时看到每个人的编辑内容。这种实时性使得沟通更加高效,文档更新更加迅速。
数据导出
Etherpad 提供了完整的数据导出功能,您可以将文档导出为多种格式,如 HTML、Plain Text、PDF 等,方便文档的分享和存档。
自主控制
Etherpad 可以在您自己的服务器上运行,这意味着您可以完全控制自己的数据,不用担心数据安全和隐私问题。
可扩展性
Etherpad 能够扩展到支持成千上万的同时在线用户,这对于大型企业和团队来说尤为重要。
插件系统
Etherpad 拥有一个强大的插件系统,通过安装不同的插件,您可以扩展 Etherpad 的功能,使其更加符合您的需求。
Etherpad 的优势:
- 简单易用: Etherpad 的界面简洁直观,易于使用。
- 高度可定制: 您可以通过插件和自定义设置来扩展 Etherpad 的功能。
- 开源免费: Etherpad 是一个开源项目,完全免费使用。
安装指南
Docker-Compose 安装
使用 Docker-Compose 可以轻松地部署 Etherpad。以下是一个基本的 Docker-Compose 示例配置:
ruby
services:
app:
user: "0:0"
image: etherpad/etherpad:latest
tty: true
stdin_open: true
volumes:
- plugins:/opt/etherpad-lite/src/plugin_packages
- etherpad-var:/opt/etherpad-lite/var
depends_on:
- postgres
environment:
NODE_ENV: production
ADMIN_PASSWORD: ${DOCKER_COMPOSE_APP_ADMIN_PASSWORD:-admin}
DB_CHARSET: ${DOCKER_COMPOSE_APP_DB_CHARSET:-utf8mb4}
DB_HOST: postgres
DB_NAME: ${DOCKER_COMPOSE_POSTGRES_DATABASE:-etherpad}
DB_PASS: ${DOCKER_COMPOSE_POSTGRES_PASSWORD:-admin}
DB_PORT: ${DOCKER_COMPOSE_POSTGRES_PORT:-5432}
DB_TYPE: "postgres"
DB_USER: ${DOCKER_COMPOSE_POSTGRES_USER:-admin}
restart: always
ports:
- "${DOCKER_COMPOSE_APP_PORT_PUBLISHED:-9001}:${DOCKER_COMPOSE_APP_PORT_TARGET:-9001}"
postgres:
image: postgres:15-alpine
environment:
POSTGRES_DB: ${DOCKER_COMPOSE_POSTGRES_DATABASE:-etherpad}
POSTGRES_PASSWORD: ${DOCKER_COMPOSE_POSTGRES_PASSWORD:-admin}
POSTGRES_PORT: ${DOCKER_COMPOSE_POSTGRES_PORT:-5432}
POSTGRES_USER: ${DOCKER_COMPOSE_POSTGRES_USER:-admin}
PGDATA: /var/lib/postgresql/data/pgdata
restart: always
volumes:
- postgres_data:/var/lib/postgresql/data/pgdata
volumes:
postgres_data:
plugins:
etherpad-var:
系统要求
- Node.js >= 18.18.2。
适用于 Windows, macOS, Linux
- 从 nodejs.org 下载最新的 Node.js 运行时。
- 安装 pnpm:
npm install -g pnpm
(可能需要管理员权限)。 - 克隆仓库:
git clone -b master
。 - 运行
pnpm i
。 - 运行
pnpm run build:etherpad
。 - 运行
pnpm run prod
。 - 在浏览器中访问
http://localhost:9001
。
Docker 容器
有关在容器中运行 Etherpad 的更多信息,请访问 Docker 安装文档。
插件系统
Etherpad 通过插件系统提供了高度的可定制性。以下是一些插件的安装和使用示例:
可用插件
您可以在 插件网站 上找到所有可用的插件。
插件安装
您可以通过管理员 Web 界面(例如 http://127.0.0.1:9001/admin/plugins)安装插件。
或者,您也可以通过命令行安装插件:
bash
cd /path/to/etherpad-lite
pnpm run plugins i ep_${plugin_name}
更多信息,请查看 插件维基文章。
推荐插件
以下是一些推荐的插件,它们可以为您的 Etherpad 带来丰富的功能:
arduino
pnpm run plugins i \
ep_align \
ep_comments_page \
ep_embedded_hyperlinks2 \
ep_font_color \
ep_headings2 \
ep_markdown \
ep_webrtc
升级 Etherpad
在 Etherpad 文件夹中运行以下命令来升级:
- 停止任何正在运行的 Etherpad(手动、systemd ...)。
- 获取当前版本:
css
git -P tag --contains
- 列出可用版本:
css
git -P tag --list "v*" --merged
- 选择版本:
r
git checkout v2.2.5
git switch -c v2.2.5
- 升级 Etherpad:
arduino
./bin/run.sh
- 停止(使用 CTRL-C)。 7. 重新启动您的 Etherpad 服务。
应用场景
- 团队协作: 用于团队会议记录、项目文档、产品需求文档等。
- 教育: 用于课堂笔记、学生协作项目、在线研讨会等。
- 个人使用: 用于个人笔记、写作、草稿等。
界面效果
总结
Etherpad 是一个功能强大且易于使用的实时协作文档编辑器,适用于各种场景。它可以帮助您提高工作效率,促进团队合作,并使文档编辑更加轻松愉快。
项目地址
arduino
https://github.com/ether/etherpad-lite