gramax/editor

Gramax编辑器Docker镜像

镜像概述和主要用途

Gramax编辑器Docker镜像是一款用于创建、编辑和发布文档的应用程序镜像，支持从Docker 20.10版本开始部署。该镜像通过Docker Compose实现便捷部署，包含两个核心服务：editor（主服务，提供文档编辑功能）和git-proxy（Git代理服务，用于绕过跨域资源共享限制，实现与远程Git仓库的交互）。适用于团队文档协作、技术文档管理等场景。

维护者：Gramax团队（***）
获取帮助：Gramax 群组（[]

核心功能和特性

• 文档处理：提供直观界面用于创建、编辑和发布各类文档
• Git集成：通过git-proxy服务实现与远程Git仓库的交互，支持文档版本控制
• 跨域支持：git-proxy服务解决浏览器跨域限制，确保Git操作正常进行
• 灵活部署：支持通过Docker Compose快速部署或自定义配置满足特定需求
• 高可用性：默认配置容器异常时自动重启（unless-stopped策略）

使用场景和适用范围

• 团队协作文档：多人共同编辑和维护项目文档
• 技术文档管理：创建和发布软件项目的技术文档、API文档等
• 版本化文档：通过Git集成实现文档版本控制和历史追踪
• 跨域环境部署：在需要与远程Git仓库交互的跨域环境中使用

使用方法和配置说明

部署准备

支持通过Docker Compose部署，可选择以下两种方式配置：

1. 使用现成的Docker Compose文件

通过命令下载官方配置文件：

bash
curl -LO https://gram.ax/editor-docker-compose.yaml

2. 创建自定义配置文件

如需根据需求自定义部署，可创建docker-compose.yaml文件，基础配置示例如下：

yaml
version: "3.8"

services:
  editor:
    image: docker.io/gramax/editor:latest
    container_name: editor
    restart: unless-stopped
    ports:
      - ${PORT:-3000}:80
    environment:
      - GIT_PROXY_SERVICE_URL=${GIT_PROXY_SERVICE_URL:-http://localhost:3001}

  git-proxy:
    image: docker.io/gramax/git-proxy:latest
    container_name: git_proxy
    restart: unless-stopped
    ports:
      - ${GIT_PROXY_PORT:-3001}:80
    environment:
      - ALLOWED_GRAMAX_URLS=${ALLOWED_GRAMAX_URLS:-}

服务说明

• editor：Gramax编辑器主服务，通过Web浏览器访问，默认端口3000。负责文档的创建、编辑和发布功能，需连接git-proxy服务以实现Git仓库交互。

• git-proxy：Git代理服务，默认端口3001。接收编辑器的请求并转发至远程Git仓库，用于绕过浏览器跨域资源共享（CORS）限制，确保Git相关操作正常执行。

环境变量配置

操作命令

启动服务

配置环境变量后，运行以下命令启动服务：

bash
docker compose up

停止服务

停止并移除容器：

bash
docker compose down

更新服务

更新镜像并重启服务：

bash
docker compose pull && docker compose up