nerc/docs

镜像概述

该镜像提供包含用户文档的静态页面资源，旨在简化用户文档的部署与访问流程。通过容器化方式，可快速搭建文档服务，适用于各类需要便捷托管用户文档的场景。

核心功能与特性

• 轻量级架构：基于静态页面实现，资源占用低，部署高效
• 无后端依赖：无需复杂后端服务支持，直接通过HTTP协议提供文档访问
• 快速部署：单一容器即可运行，简化部署流程，降低维护成本
• 高效访问：静态资源加载速度快，提升用户文档浏览体验

使用场景与适用范围

• 开发团队：快速部署项目用户手册、API文档
• 产品团队：托管产品使用指南、功能说明文档
• 开源项目：展示项目文档、安装教程、使用示例
• 企业内部：部署内部系统操作手册、流程规范文档

使用方法与配置说明

基本部署（docker run）

通过以下命令快速启动文档服务：

bash
docker run -d -p 80:80 --name user-docs [镜像名称]

• -p 80:80：将容器80端口映射到主机80端口（可根据需求修改主机端口，如-p 8080:80）
• --name user-docs：指定容器名称为user-docs（可自定义）

自定义文档内容

如需替换默认文档，可通过挂载本地文档目录实现：

bash
docker run -d -p 80:80 -v /本地文档目录:/usr/share/nginx/html --name user-docs [镜像名称]

• -v /本地文档目录:/usr/share/nginx/html：将本地文档目录挂载到容器内静态文件目录（目录路径可能因基础镜像不同而调整，具体以镜像实际结构为准）

Docker Compose配置

创建docker-compose.yml文件，配置如下：

yaml
version: '3'
services:
  user-docs:
    image: [镜像名称]
    container_name: user-docs
    ports:
      - "80:80"  # 主机端口:容器端口
    volumes:
      - /本地文档目录:/usr/share/nginx/html  # 可选，用于自定义文档
    restart: unless-stopped  # 容器退出时自动重启（可选）

启动服务：

bash
docker-compose up -d

访问文档

部署完成后，通过浏览器访问 http://主机IP:映射端口 即可查看用户文档。