tutum/api-docs

tutum/api-docs

镜像概述和主要用途

tutum/api-docs是Tutum API的文档镜像，提供Tutum v2 API的详细文档访问服务，官方文档地址为[***]

核心功能和特性

• 提供Tutum v2 API的完整文档访问
• 支持本地部署，方便离线查阅
• 可通过Docker快速构建和运行
• 支持文档发布功能（需授权用户）

使用场景和适用范围

适用于需要查阅Tutum API使用方法的开发者，可用于本地开发环境中的API文档参考，或作为内部文档服务部署。

使用方法和配置说明

本地运行

1. 克隆仓库：

   bash
   git clone https://github.com/tutumcloud/api-docs.git
   

2. 初始化并更新子模块：

   bash
   git submodule init && git submodule update 
   

3. 构建镜像：

   bash
   docker build -t tutum/api-docs .
   

4. 运行容器：

   bash
   docker run -p 4567:4567 tutum/api-docs
   

5. 访问文档：文档将通过 http://localhost:4567/ 提供访问

发布说明

（仅授权用户）

如需发布文档，需运行以下命令，其中需包含有效的AWS访问凭证：

bash
docker run -i -t -e AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY tutum/api-docs publish.sh

环境变量说明：

• AWS_ACCESS_KEY_ID：AWS访问密钥ID
• AWS_SECRET_ACCESS_KEY：AWS秘密访问密钥

需确保上述环境变量中包含适当的授权凭证。