s3 site cache optimizer

optimiseur de cache-site-s3

Optimisez un site Web statique pour l'hébergement dans S3, en incluant une empreinte digitale dans les noms de fichiers de tous les actifs. Le site Web optimisé est téléchargé dans le compartiment S3 spécifié avec les en-têtes de cache appropriés.

Installation

Vous pouvez installer la version stable à l'aide de la commande pip suivante :

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

Si vous souhaitez rester informé des dernières fonctionnalités, installez la version de développement :

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

Opération

L'outil de ligne de commande exécute les étapes suivantes :

1. Indexez le répertoire source (local) contenant le site Web statique et recherchez les actifs et les réinscriptibles .
2. Calculez un hachage à partir du contenu de chaque actif et renommez-le avec le filehash dans le nom du fichier.
3. Recherchez dans le contenu des réinscriptibles les références à chacun des actifs et réécrivez les URL si nécessaire.
4. (facultatif) Gzippez tous les fichiers texte.
5. (facultatif) Téléchargez tous les fichiers vers un chemin dans un compartiment S3 et supprimez tous les autres fichiers de ce chemin. Les actifs reçoivent un en-tête de cache n'expirant jamais afin d'optimiser la mise en cache du navigateur et du proxy.

Toutes les opérations sur les fichiers sont exécutées dans un répertoire de sortie (temporaire), le répertoire source n'est pas modifié.

Les actifs et les réinscriptibles sont reconnus en fonction de leur extension de fichier. Actuellement, les extensions de fichiers suivantes sont considérées comme des atouts :

• css
• SVG
• tf
• wow
• woff2
• otf
• eot
• png
• jpg
• jpeg
• gif
• js
• XML
• mp4
• webm
• webp

Les réinscriptibles sont des fichiers texte portant l'une des extensions suivantes :

• HTML
• htm
• js
• css
• XML
• json

Déposez une demande de fonctionnalité si vous souhaitez voir d’autres extensions de fichiers ajoutées.

Usage

 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.

Exemple

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

Licence

Le s3-site-cache-optimizer est publié sous la licence MIT.