mintter/sitegw

Mintter Site Gateway (Next.js) Docker镜像文档

概述

Mintter Site Gateway是一个基于Next.js框架构建的站点网关，主要用途是渲染和提供Mintter文档服务。作为Mintter文档系统的前端服务层，该镜像通过Next.js的服务端渲染(SSR)和静态站点生成(SSG)能力，确保文档内容高效加载与优质展示。

核心功能与特性

• 文档渲染：支持Mintter文档格式的解析与渲染，呈现结构化、易读的文档内容
• 文档服务：提供Mintter文档的Web访问服务，处理文档请求并返回渲染后的页面
• Next.js框架优势：利用Next.js的SSR/SSG特性，提升文档加载速度，优化用户体验及搜索引擎友好性
• 轻量化部署：容器化设计，便于快速集成到现有服务架构，简化部署流程

使用场景

• Mintter文档的Web端展示与访问平台
• 企业内部文档门户或知识库构建
• 开源项目文档站点部署
• 需要高效文档渲染与分发的Web应用集成

使用方法与配置说明

基本部署（Docker Run）

通过Docker命令快速启动服务：

bash
docker run -d -p 3000:3000 --name mintter-site-gateway docker.xuanyuan.run/mintter/site-gateway:latest

• -p 3000:3000：映射容器内3000端口（Next.js默认端口）到主机3000端口，用于访问文档服务
• --name mintter-site-gateway：指定容器名称，便于管理和操作

环境变量配置

可通过环境变量调整服务行为（根据实际需求配置）：

• DOCUMENT_SOURCE：文档源地址，指定Mintter文档的存储或获取路径（支持本地目录或远程API地址），默认值：/app/docs
• PORT：服务监听端口，默认值：3000
• NODE_ENV：运行环境，可选值：development/production，默认值：production

示例（自定义文档源和端口）：

bash
docker run -d \
  -p 8080:8080 \
  -e DOCUMENT_SOURCE="https://api.mintter.com/docs" \
  -e PORT=8080 \
  --name mintter-site-gateway \
  docker.xuanyuan.run/mintter/site-gateway:latest

Docker Compose配置

适用于多服务协同部署场景，创建docker-compose.yml：

yaml
version: '3'
services:
  mintter-site-gateway:
    image: docker.xuanyuan.run/mintter/site-gateway:latest
    ports:
      - "3000:3000"
    environment:
      - DOCUMENT_SOURCE="/app/docs"
      - NODE_ENV="production"
    volumes:
      - ./local-docs:/app/docs  # 挂载本地文档目录作为文档源
    restart: unless-stopped

访问服务

部署完成后，通过浏览器访问 http://<主机IP>:<映射端口> 即可查看渲染后的Mintter文档。例如，使用默认配置时访问 http://localhost:3000。