s3 site cache optimizer

otimizador de cache de site s3

Otimize um site estático para hospedagem no S3, incluindo uma impressão digital nos nomes de arquivos de todos os ativos. O site otimizado é carregado no bucket S3 especificado com os cabeçalhos de cache corretos.

Instalação

Você pode instalar a versão estável usando o seguinte comando pip:

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

Se você quiser acompanhar os recursos mais recentes, instale a versão de desenvolvimento:

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

Operação

A ferramenta de linha de comando executa as seguintes etapas:

1. Indexe o diretório de origem (local) que contém o site estático e pesquise ativos e regraváveis .
2. Calcule um hash do conteúdo de cada ativo e renomeie-o com o filehash no nome do arquivo.
3. Pesquise no conteúdo dos regraváveis ​​referências a cada um dos ativos e reescreva os URLs, se necessário.
4. (opcional) Gzip todos os arquivos baseados em texto.
5. (opcional) Faça upload de todos os arquivos para um caminho em um bucket S3 e remova todos os outros arquivos desse caminho. Os ativos recebem um cabeçalho de cache que nunca expira para otimizar o cache do navegador e do proxy.

Todas as operações de arquivo são executadas em um diretório de saída (temporário), o diretório de origem não é alterado.

Ativos e regraváveis ​​são reconhecidos com base na extensão do arquivo. Atualmente, as seguintes extensões de arquivo são consideradas ativos :

• css
• SVG
• ttf
• uau
• woff2
• ai
• eot
• png
• jpg
• JPEG
• gif
• js
• xml
• mp4
• webm
• webp

Regraváveis ​​são arquivos baseados em texto com uma das seguintes extensões:

• HTML
• htm
• js
• css
• xml
• json

Registre uma solicitação de recurso se quiser ver outras extensões de arquivo adicionadas.

Uso

 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.

Exemplo

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

Licença

O s3-site-cache-optimizer é lançado sob a licença do MIT.