s3 site cache optimizer

s3-Site-Cache-Optimierer

Optimieren Sie eine statische Website für das Hosting in S3, indem Sie einen Fingerabdruck in die Dateinamen aller Assets einfügen. Die optimierte Website wird mit den richtigen Cache-Headern in den angegebenen S3-Bucket hochgeladen.

Installation

Sie können die stabile Version mit dem folgenden pip-Befehl installieren:

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

Wenn Sie mit den neuesten Funktionen Schritt halten möchten, installieren Sie die Entwicklungsversion:

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

Betrieb

Das Kommandozeilentool führt die folgenden Schritte aus:

1. Indizieren Sie das (lokale) Quellverzeichnis, das die statische Website enthält, und suchen Sie nach Assets und wiederbeschreibbaren Dateien .
2. Berechnen Sie einen Hash aus dem Inhalt jedes Assets und benennen Sie ihn mit dem Filehash im Dateinamen um.
3. Durchsuchen Sie den Inhalt der wiederbeschreibbaren Dateien nach Verweisen auf die einzelnen Assets und schreiben Sie die URLs bei Bedarf neu.
4. (optional) Gzip alle textbasierten Dateien.
5. (optional) Laden Sie alle Dateien in einen Pfad in einem S3-Bucket hoch und entfernen Sie alle anderen Dateien aus diesem Pfad. Assets erhalten einen nie ablaufenden Cache-Header, um das Browser- und Proxy-Caching zu optimieren.

Alle Dateioperationen werden in einem (temporären) Ausgabeverzeichnis ausgeführt, das Quellverzeichnis wird nicht verändert.

Assets und wiederbeschreibbare Dateien werden anhand ihrer Dateierweiterung erkannt. Derzeit gelten die folgenden Dateierweiterungen als Assets :

• CSS
• SVG
• ttf
• Wow
• woff2
• otf
• eot
• png
• jpg
• jpeg
• GIF
• js
• xml
• mp4
• webm
• webp

Wiederbeschreibbare Dateien sind textbasierte Dateien mit einer der folgenden Erweiterungen:

• html
• htm
• js
• CSS
• xml
• json

Reichen Sie eine Funktionsanfrage ein, wenn Sie weitere hinzugefügte Dateierweiterungen sehen möchten.

Verwendung

 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.

Beispiel

 $ 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"

Lizenz

Der s3-site-cache-optimizer wird unter der MIT-Lizenz veröffentlicht.