Jammit S3 技术文档

1. 安装指南

Jammit S3 是一个针对 Jammit 的包装器，它提供了适当的钩子，以便您可以轻松地将资产部署到 S3/CloudFront。它特别适用于使用生成资产（如 coffee-script 和 sass）的 Heroku 用户。

要安装 Jammit S3，只需使用以下命令：

gem install jammit-s3

如果您在使用 Rails3，请将其添加到项目的 Gemfile 中：

gem 'jammit-s3'

Jammit S3 已经包含了对 Jammit 的依赖，因此建议从您的 Gemfile 中移除任何现有的 gem 'jammit' 引用。

2. 项目使用说明

在 config/assets.yml 文件中，添加一个顶层键 s3_bucket，其中包含您要使用的存储桶名称。如果 jammit-s3 找不到存储桶，它将尝试创建一个。存储桶名称需要是全球唯一的。有关存储桶名称的更多信息，请参考这里。

s3_bucket: my-awesome-jammit-bucket

配置认证信息，将认证信息设置在 config/assets.yml 中：

s3_access_key_id: 03HDMNF59CWZ2J24T702
s3_secret_access_key: 1TzRlDmuH8DoOlJ2tlwW8qx+i+Pfe0jzIouWI2BL

将这些值替换为您的访问密钥，您可以在这里找到。

您可能不希望将这些数据检查到源控制中，因此建议您仅在本地机器上将其设置为环境变量，并使用 ERB：

s3_access_key_id: <%= ENV['ACCESS_KEY_ID'] %>
s3_secret_access_key: <%= ENV['SECRET_ACCESS_KEY'] %>

然后您可以在 .bash_profile 中设置这些环境变量。

3. 项目 API 使用文档

Jammit S3 的部署命令为：

jammit-s3

如果您在使用 Rails3 应用程序，建议使用 bundle exec：

bundle exec jammit-s3

4. 项目安装方式

默认上传文件夹

默认情况下，jammit-s3 将上传您配置的资产，以及 public/images。但是，您可以使用 s3_upload_files 设置来自定义上传的文件，它应该是一个文件通配符列表。

# 添加图片上传
s3_upload_files:
  - public/css/images/**

设置上传文件权限

默认情况下，jammit-s3 使用 S3 存储桶上的权限设置。但是，您可以通过以下配置来覆盖此设置：

s3_permission: public_read

有效的权限选项包括：

• private：所有者拥有完全控制权。其他人没有任何访问权限。这是默认设置。
• public_read：所有者拥有完全控制权，匿名用户被授予读取权限。
• public_read_write：所有者拥有完全控制权，匿名用户被授予读取和写入权限。
• authenticated_read：所有者拥有完全控制权，任何经过认证的 Amazon S3 用户被授予读取权限。

使用 CloudFront

要使用 CloudFront，您需要确保您的 Amazon 账户已启用 CloudFront。请访问：http://aws.amazon.com/cloudfront/ 并点击“注册”。

要使用 CloudFront，只需在 config/assets.yml 中添加以下设置：

use_cloudfront: on
cloudfront_dist_id: XXXXXXXXXXXXXX
cloudfront_domain: xyzxyxyz.cloudfront.net

请注意，cloudfront_dist_id 与 CloudFront 域名不同。在 CloudFront 管理控制台中，选择分发，您将看到分发 ID 和域名值。

这将使用 CloudFront 域名而不是从较慢的 S3 存储桶来为您提供资产。

CloudFront 知名问题

1. 据报道，全球所有 CloudFront 缓存无效可能需要多达 15 分钟（并且 Amazon 对超过每月一定数量的无效次数收费）。
2. 从最终用户的角度来看，它是非原子的：他们可能会得到一个包含较新 JavaScript 和 CSS 的旧版本网站，或者反之亦然。
3. 它与激进的 HTTP 缓存不兼容。例如，一旦我提供脚本或样式表，我希望建议它无限期缓存，而无需进行更多往返以查看其是否有效。

考虑到这些限制，仍然需要某种基于内容的哈希。正确实现后，它确保所有文件可以无限期缓存，并且用户总是得到匹配的 HTML/JS/CSS 文件。（目前正处于开发阶段）。