molgenis/ssr-catalogue

镜像概述

本镜像是一个专为目录应用（如产品目录、内容目录、文档目录等）设计的Node.js服务器端渲染（SSR）解决方案。基于稳定版本的Node.js环境构建，集成SSR引擎，旨在为目录类应用提供高效的服务器端HTML生成能力，解决客户端渲染模式下首屏加载慢、SEO不友好等问题。

核心功能与特性

核心功能

• 服务器端渲染引擎：内置Node.js SSR渲染逻辑，支持目录数据的服务端HTML生成，直接返回完整页面内容至客户端
• 目录数据适配：针对目录类数据结构（层级结构、分类列表、详情关联等）优化的渲染逻辑，减少数据处理开销
• Node.js运行时：基于官方Node.js镜像构建，确保运行环境一致性和稳定性
• 轻量高效：优化依赖管理，减小镜像体积，提升启动速度

特性

• SEO优化：服务端生成的HTML内容可被搜索引擎直接抓取，提升目录内容的搜索可见性
• 首屏加速：客户端无需等待JavaScript加载完成即可展示页面，降低首屏加载时间
• 灵活配置：支持通过环境变量自定义关键参数，适配不同目录应用场景
• 日志输出：标准输出流日志记录，便于容器编排平台集成监控

使用场景

本镜像适用于需要高效展示结构化目录内容的Web应用，典型场景包括：

• 电商平台产品目录：如电商网站的商品分类目录、产品列表页
• 文档/知识库目录：企业内部文档系统、在线知识库的章节/条目目录
• 内容管理系统（CMS）：CMS平台中的内容分类目录、栏目导航页
• 资源目录系统：如文件资源、数字资产的分类展示目录

使用方法

基本部署

Docker Run 命令

bash
docker run -d \
  -p 3000:3000 \
  --name catalogue-ssr \
  [镜像名称]:[标签]

Docker Compose 配置示例

yaml
version: '3'
services:
  catalogue-ssr:
    image: [镜像名称]:[标签]
    ports:
      - "3000:3000"
    environment:
      - PORT=3000
      - API_BASE_URL=http://backend-api:8080/catalogue
    restart: unless-stopped

环境变量配置

环境变量使用示例

bash
docker run -d \
  -p 8080:8080 \
  -e PORT=8080 \
  -e API_BASE_URL=https://api.example.com/catalogue \
  -e RENDER_CACHE_TTL=600 \
  --name catalogue-ssr \
  [镜像名称]:[标签]

数据接口要求

目录应用需提供符合以下规范的API接口，供SSR服务获取目录数据：

目录列表接口

• 路径：${API_BASE_URL}/list
• 方法：GET
• 响应格式：

  json
  {
    "code": 200,
    "data": {
      "categories": [
        { "id": "cat1", "name": "分类1", "items": [...] },
        { "id": "cat2", "name": "分类2", "items": [...] }
      ]
    }
  }
  

目录详情接口

• 路径：${API_BASE_URL}/detail/{id}
• 方法：GET
• 响应格式：

  json
  {
    "code": 200,
    "data": {
      "id": "item1",
      "title": "目录项标题",
      "content": "...",
      "related": [...]
    }
  }
  

持久化与扩展

日志持久化

如需保存日志文件，可挂载日志目录：

bash
docker run -d \
  -p 3000:3000 \
  -v ./ssr-logs:/app/logs \
  -e LOG_PATH=/app/logs/ssr.log \
  --name catalogue-ssr \
  [镜像名称]:[标签]

集群部署

在高并发场景下，可通过容器编排工具（如Kubernetes、Docker Swarm）部署多实例，并配合负载均衡：

yaml
# docker-compose 集群示例（需配合负载均衡）
version: '3'
services:
  ssr-instance-1:
    image: [镜像名称]:[标签]
    environment:
      - PORT=3000
      - API_BASE_URL=http://backend-api:8080/catalogue
  ssr-instance-2:
    image: [镜像名称]:[标签]
    environment:
      - PORT=3000
      - API_BASE_URL=http://backend-api:8080/catalogue

注意事项

1. 数据接口依赖：确保目录数据API服务稳定可用，建议配置健康检查机制
2. 缓存策略：根据目录数据更新频率调整RENDER_CACHE_TTL参数，避免缓存过期数据
3. 资源配置：根据目录数据规模和访问量调整容器CPU/内存资源，建议最低配置：1核CPU，512MB内存
4. 安全加固：生产环境建议通过反向代理（如Nginx）暴露服务，配置HTTPS和请求限流
5. 版本兼容：使用前确认Node.js版本兼容性（建议Node.js 14+环境）