s3 site cache optimizer

s3-站点缓存优化器

通过将指纹包含到所有资产的文件名中，优化在 S3 中托管的静态网站。优化后的网站将上传到具有正确缓存标头的指定 S3 存储桶中。

安装

您可以使用以下 pip 命令安装稳定版本：

 pip install --upgrade s3-site-cache-optimizer

如果您想跟上最新功能，请安装开发版本：

 pip install --upgrade https://github.com/novemberfiveco/s3-site-cache-optimizer/archive/develop.zip

手术

命令行工具执行以下步骤：

1. 索引包含静态网站的（本地）源目录，并搜索asset和rewriteables 。
2. 根据每个asset的内容计算哈希值，并使用文件名中的 filehash 对其进行重命名。
3. 搜索可重写的内容以获取对每个资产的引用，并在必要时重写 URL。
4. （可选）Gzip 所有基于文本的文件。
5. （可选）将所有文件上传到 S3 存储桶中的某个路径，并从该路径中删除所有其他文件。为资产提供永不过期的缓存标头，以优化浏览器和代理缓存。

所有文件操作都在（临时）输出目录中执行，源目录不变。

资产和可重写文件根据其文件扩展名进行识别。目前，以下文件扩展名被视为资产：

• CSS
• svg
• ttf
• 沃夫
• 沃夫2
• 奥特夫
• 埃奥特
• PNG
• .jpg
• JPEG
• 动图
• js
• XML
• mp4
• 网络管理
• 网页

可重写文件是基于文本的文件，具有以下扩展名之一：

• html
• 哈特姆
• js
• CSS
• XML
• json

如果您想查看添加的其他文件扩展名，请提出功能请求。

用法

 usage: s3-site-cache-optimizer [-h] [--debug] [--version]
                               [--exclude PATTERN [PATTERN ...]]
                               [-o OUTPUT_DIR]
                               [--access-key AWS_ACCESS_KEY_ID]
                               [--secret-key AWS_SECRET_ACCESS_KEY]
                               [--region REGION]
                               [--gzip]
                               [--prefix PREFIX]
                               [--domains DOMAIN [DOMAIN ...]]
                               [--skip-s3-upload]
                               source_dir destination_bucket

positional arguments:
  source_dir            Local directory containing a static website.
  destination_bucket    S3 bucket name.

optional arguments:
  -h, --help            show this help message and exit
  --debug               Enable debug output
  --version             show program's version number and exit
  --exclude PATTERN [PATTERN ...]
                        Exclude files and directories matching these patterns.
  -o OUTPUT_DIR, --output OUTPUT_DIR
                        Output directory in which local files are written.
                        When absent a temporary directory is created and used.
  --access-key AWS_ACCESS_KEY_ID
                        AWS access key. If this field is not specified,
                        credentials from environment or credentials files will
                        be used.
  --secret-key AWS_SECRET_ACCESS_KEY
                        AWS access secret. If this field is not specified,
                        credentials from environment or credentials files will
                        be used.
  --region REGION       AWS region to connect to.
  --gzip                Gzip text-based files.
  --prefix PREFIX       Subdirectory in which files are stored in the bucket.
                        Stored in the root of the bucket by default.
  --domains DOMAIN [DOMAIN ...]
                        Domain names on which the site will be hosted.
  --skip-s3-upload      Skip uploading to S3.

例子

 $ s3-site-cache-optimizer ~/srv/www.example.com www.example.com --access-key XXXXXNOVEMBERFIVEXXXXX --secret-key XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
$ s3-site-cache-optimizer ~/srv/www.example.com www.example.com --exclude ".git/*" ".git*" --region eu-west-1
$ s3-site-cache-optimizer ~/srv/www.example.com www.example.com --output ~/srv/example-optimized/ --skip-s3-upload
$ s3-site-cache-optimizer ~/srv/www.example.com my_bucket --domains www.example.com example.com --prefix "user/sites/www.example.com"

执照

s3-site-cache-optimizer 是根据 MIT 许可证发布的。