Camo项目技术文档

1. 安装指南

Camo 项目是一个基于 Node.js 的 SSL 图片代理，旨在防止在安全页面中服务不安全资源时出现混合内容警告。以下是安装步骤：

• 确保系统中已安装 Node.js（版本 0.10.29 或更高）。
• 克隆 Camo 仓库到本地环境。
• 设置环境变量，如 CAMO_KEY（共享密钥），PORT（监听端口）等。

2. 项目的使用说明

Camo 允许用户在评论、问题、README 等地方嵌入图片，并通过代理服务确保这些图片的显示不会导致混合内容警告。以下是基本使用方法：

• 配置 Camo 服务的环境变量。
• 运行 Camo 服务。
• 使用 Camo 支持的两种 URL 格式之一来请求图片。

3. 项目API使用文档

Camo 支持 HTTP 请求，通过特定的 URL 格式代理图片：

• URL 格式 1：http://example.org/<digest>?url=<image-url>
• URL 格式 2：http://example.org/<digest>/<image-url>

其中 <digest> 是通过共享密钥和 <image-url> 生成的 HMAC 摘要，<image-url> 是图片的绝对 URL。

4. 项目安装方式

以下是在不同环境中安装 Camo 的方法：

本地环境

1. 克隆项目仓库。
2. 设置所需的环境变量。
3. 运行 rake 命令来启动服务。

git clone https://github.com/atmos/camo.git
cd camo
export CAMO_KEY=your_secret_key
rake

Heroku 部署

1. 将项目推送到 Heroku。
2. 设置 Heroku 环境变量。
3. 使用 Heroku 提供的按钮快速部署。

git push heroku master
heroku config:set CAMO_KEY=your_secret_key
heroku open

Docker 容器

1. 使用项目中的 Dockerfile 构建镜像。
2. 运行容器并设置 CAMO_KEY 环境变量。

docker build -t camo .
docker run --env CAMO_KEY=YOUR_KEY camo

以上是 Camo 项目的技术文档，用户可以根据以上说明进行安装、配置和使用 Camo 服务。