caminofr/camino-docs

camino文档镜像

镜像概述

camino文档镜像是camino项目的官方文档部署镜像，旨在提供便捷、高效的文档服务。该镜像封装了camino项目的完整文档内容及轻量级Web服务组件，可快速部署文档网站，支持团队内部文档共享、项目文档公开访问等场景。

核心功能与特性

• 完整文档内容：集成camino项目的最新文档，包括用户指南、开发手册、API参考等。
• 轻量级部署：基于高效Web服务组件（如Nginx）构建，资源占用低，启动速度快。
• 灵活配置：支持自定义端口映射、文档路径挂载，满足不同部署需求。
• 跨平台兼容：兼容Docker支持的各类操作系统环境，部署一致性高。

使用场景

• 开发团队内部：快速搭建本地或局域网内的camino文档服务，方便团队成员查阅。
• 项目文档公开：通过容器化部署，将camino文档发布至公网服务器，供用户访问。
• CI/CD集成：作为文档自动化部署流程的一部分，实现文档更新后的自动发布。

使用方法

基本部署（docker run）

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

bash
docker run -d -p 8080:80 --name camino-docs docker.xuanyuan.run/camino/documentation:latest

• -p 8080:80：将容器内80端口映射至主机8080端口，可根据需要修改主机端口。
• --name camino-docs：指定容器名称为camino-docs，便于管理。
• camino/documentation:latest：使用最新版本的camino文档镜像。

启动后，通过 http://localhost:8080 即可访问文档内容。

自定义配置

端口映射

如需使用其他主机端口，修改端口映射参数：

bash
docker run -d -p 8888:80 docker.xuanyuan.run/camino/documentation:latest

文档内容挂载（可选）

若需自定义文档内容，可通过挂载本地文档目录覆盖容器内默认文档：

bash
docker run -d -p 8080:80 -v /本地文档路径:/usr/share/nginx/html docker.xuanyuan.run/camino/documentation:latest

注：本地文档路径需包含完整的HTML文档结构，确保与容器内Web服务兼容。

docker-compose配置示例

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  camino-docs:
    image: docker.xuanyuan.run/camino/documentation:latest
    ports:
      - "8080:80"
    restart: always
    container_name: camino-docs
    # 如需挂载本地文档，添加 volumes 配置
    # volumes:
    #   - ./local-docs:/usr/share/nginx/html

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

注意事项

• 镜像默认使用80端口提供HTTP服务，生产环境建议配合HTTPS反向代理使用。
• 挂载本地文档时，确保文件权限正确，避免容器访问权限问题。
• 如需获取特定版本文档，可替换镜像标签（如:v1.0.0），具体版本参考camino项目发布记录。