Etherpad Lite 安装与配置完全指南

Etherpad Lite 安装与配置完全指南

etherpad-lite Etherpad: A modern really-real-time collaborative document editor. 项目地址: https://gitcode.com/gh_mirrors/et/etherpad-lite

项目基础介绍与主要编程语言

Etherpad Lite 是一个现代的实时协同文档编辑器，支持数千名用户同时在线编辑。它提供了完整的数据导出功能，并且可以在您的服务器上运行，由您全权控制。项目采用 JavaScript 为主要编程语言，特别适合于实时Web应用的开发。其设计高度可定制化，通过插件系统增强功能。

关键技术和框架

• Node.js: 作为后端运行环境，支持非阻塞I/O，适用于构建高性能的网络应用。
• EasySync: 自家研发的同步算法，确保文档编辑的实时性和一致性。
• MySQL/PostgreSQL 支持: 提供数据库选项以存储编辑历史等信息。
• 插件架构: 强大的社区支持，可通过众多插件扩展功能，如用户认证、文档样式调整等。

准备工作与详细安装步骤

系统要求

• Node.js: 至少版本18.2.0（推荐从nodejs.org下载最新稳定版）。
• PNPM: 包管理工具，用于依赖管理和脚本执行（通过命令npm install -g pnpm安装）。
• Git: 用于克隆项目源代码。

步骤一：获取项目源代码

首先，确保已安装Git，然后在终端中执行以下命令来克隆项目：

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

步骤二：安装依赖

接下来，安装必要的软件包，通过PNPM进行：

pnpm install

步骤三：编译与配置

执行编译脚本来准备应用程序：

pnpm run build:etherpad

配置文件默认为settings.json，在此文件中可以设定服务器端口、数据库连接等。对于初学者，默认设置通常足够启动和测试。

步骤四：数据库配置

如果您选择使用SQLite（默认），则无需额外配置。对于更高级的生产环境，推荐使用MySQL或PostgreSQL。在settings.json中相应地修改DB_TYPE及其它数据库配置。

步骤五：启动服务

在准备好所有配置后，可以启动Etherpad服务：

pnpm run prod

这会启动Etherpad服务在默认端口9001上。

访问界面

打开浏览器，访问http://localhost:9001，你应该能看到Etherpad Lite的登录或创建新文档的界面。

高级配置与插件安装（可选）

• 环境变量与配置覆盖：可以通过环境变量或在启动命令中指定设置文件（使用-s|--settings参数）来覆盖默认配置。
• 安装插件：通过管理员界面或命令行（例如，pnpm run plugins i ep_align）安装插件，增强功能。

至此，您已经成功搭建并配置了Etherpad Lite。随着对项目更加深入的了解，您可以进一步定制皮肤、优化性能和安全设置，以及利用其强大的插件系统打造个性化的协作编辑体验。

etherpad-lite Etherpad: A modern really-real-time collaborative document editor. 项目地址: https://gitcode.com/gh_mirrors/et/etherpad-lite