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 許可證發布的。