EtherPad 技术文档

1. 安装指南

系统要求

• Node.js 版本 >= 18.2.0
• 支持的操作系统：Windows、macOS、Linux

安装步骤

1. 下载 Node.js 运行时环境 从 Node.js 官网 下载并安装最新版本的 Node.js。

2. 安装 pnpm 打开命令行工具，执行以下命令安装 pnpm：

   npm install -g pnpm
   

3. 克隆仓库 使用 Git 克隆项目仓库：

   git clone -b master https://github.com/ether/etherpad.git
   

4. 安装依赖 进入项目目录，执行以下命令安装依赖：

   pnpm i
   

5. 构建项目 执行以下命令构建项目：

   pnpm run build:etherpad
   

6. 启动项目 执行以下命令启动项目：

   pnpm run prod
   

7. 访问项目 在浏览器中访问 http://localhost:9001，查看项目运行情况。

2. 项目的使用说明

基本功能

• 实时协作编辑
• 文档历史版本回溯
• 文档导出与分享

使用流程

1. 创建新文档 在首页点击“创建新文档”按钮，即可创建一个新文档。

2. 邀请协作 在文档编辑页面，点击右上角的“分享”按钮，复制文档链接，发送给协作伙伴。

3. 编辑文档 协作伙伴点击链接后，即可实时看到文档内容，并进行编辑。

4. 查看历史版本 在文档编辑页面，点击“历史”按钮，可以查看文档的历史版本。

5. 导出文档 在文档编辑页面，点击“导出”按钮，可以导出文档为 PDF 或其他格式。

3. 项目API使用文档

接口列表

1. 创建新文档

   • URL：/api/1/createDocument
   • Method：POST
   • 参数：
     • title：文档标题
     • text：文档内容

2. 获取文档内容

   • URL：/api/1/getDocument
   • Method：GET
   • 参数：
     • id：文档ID

3. 更新文档内容

   • URL：/api/1/updateDocument
   • Method：POST
   • 参数：
     • id：文档ID
     • text：更新后的文档内容

4. 删除文档

   • URL：/api/1/deleteDocument
   • Method：DELETE
   • 参数：
     • id：文档ID

4. 项目安装方式

Docker 安装

1. 拉取 Docker 镜像

   docker pull etherpad/etherpad:latest
   

2. 启动容器

   docker run -d -p 9001:9001 etherpad/etherpad:latest
   

3. 访问项目 在浏览器中访问 http://localhost:9001，查看项目运行情况。