ekzhang/rustpad

Rustpad 镜像文档

镜像概述

Rustpad 是一款基于 Rust 构建的高效轻量型开源协作文本编辑器，专注于提供实时多人协作编辑能力。该镜像封装了 Rustpad 的完整运行环境，可快速部署用于团队实时协作编辑文本内容。

核心功能与特性

• 实时协作：支持多人同时编辑同一文档，内容变更实时同步
• 轻量高效：资源占用低，启动速度快，适合低配置环境部署
• 开源免费：源代码完全开放，可自由定制和二次开发
• 跨平台访问：基于 Web 界面，无需安装客户端，通过浏览器即可使用
• 简单易用：直观的用户界面，无需复杂配置即可快速上手

使用场景与适用范围

• 团队协作：多人共同编辑文档、代码片段、会议记录等
• 教育教学：师生实时协作编辑作业、代码示例或教学笔记
• 小型项目：快速搭建临时协作编辑环境，无需复杂基础设施
• 个人使用：轻量级文本编辑工具，支持简单的云端协作需求

使用方法与配置说明

基本 Docker 部署

通过以下命令快速启动 Rustpad 容器：

bash
docker run -d -p 8080:8080 --name rustpad docker.xuanyuan.run/ekzhang/rustpad

参数说明：

• -d：后台运行容器
• -p 8080:8080：将容器的 8080 端口映射到主机的 8080 端口
• --name rustpad：为容器指定名称

启动后，通过 http://localhost:8080 访问 Rustpad 服务。

Docker Compose 配置示例

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  rustpad:
    image: docker.xuanyuan.run/ekzhang/rustpad
    ports:
      - "8080:8080"
    restart: always
    # 如需持久化数据，可添加 volumes 配置（具体路径需参考官方文档）
    # volumes:
    #   - ./rustpad-data:/app/data

执行 docker-compose up -d 启动服务。

高级配置

更多配置选项（如自定义端口、数据持久化、身份验证等）请参考官方 GitHub 仓库：
https://github.com/ekzhang/rustpad/

注意事项

• 默认配置下无访问控制，生产环境使用时建议配置反向代理和身份验证
• 确保主机端口（示例中为 8080）未被其他服务占用
• 容器重启后未持久化的数据可能丢失，重要数据需配置数据卷挂载