satay

Satay

Um utilitário para fazer upload de sites estáticos para o AWS S3.

Uso

Usando a CLI

1. Instale satay globalmente:

   $ npm install -g satay

2. Crie um arquivo de configuração:

   satay.config.js

    module . exports = {
     bucket : 'jameslnewell.me' ,
   
     groups : [
       {
         source : './static' ,
         include : / .html$ /
       } ,
   
       //cache finger-printed assets for up to 1 year
       {
         source : './static' ,
         exclude : / .html$ / ,
         params : {
           CacheControl : `max-age= ${ 60 * 60 * 24 * 365.25 } , public`
         }
       }
     ]
   } ;

3. Configure suas credenciais da AWS

4. Execute satay

   $ satay

Usando a API

1. Instale satay localmente:

   $ npm install --save-dev satay

2. Crie um arquivo de script:

   upload.js

    import satay from 'satay' ;
   
   satay (
     'jameslnewell.me' ,
     [
       {
         source : './static' ,
         include : / .html$ /
       } ,
   
       //cache finger-printed assets for up to 1 year
       {
         source : './static' ,
         exclude : / .html$ / ,
         params : {
           CacheControl : `max-age= ${ 60 * 60 * 24 * 365.25 } , public`
         }
       }
     ] ,
     {
       shouldUploadUnmodifiedObjects : true
     }
   ) ;

3. Configure suas credenciais da AWS

4. Execute upload.js

   $ node upload.js

CLI

$ satay --config=satay.config.js

Bandeiras:

• --config -Opcional . O nome do arquivo de configuração. Padrão para satay.config.js no diretório de trabalho atual.

Configuração

Propriedades:

• bucket - Opcional . Uma string . O nome do balde.
• groups - Necessário . Uma array de agrupamentos de arquivos.
  • source - Opcional . Uma string . O diretório que será pesquisado. Padrões para process.cwd() .
  • include - opcional . Um RegExp ou function . Uma expressão ou função regular para filtrar quais arquivos estão incluídos.
  • exclude - opcional . Um RegExp ou function . Uma expressão ou função regular para filtrar quais arquivos são excluídos.
  • prefix - Opcional . Uma string . O prefixo que será antecipado à chave do objeto. Padrões para "" .
  • params - opcional . Um object . Os parâmetros adicionais para passar para S3.putObject() . Padrão para {ContentType: mime.lookup(filename), ACL: 'public-read'} .
• policy - Opcional . Um object . A política da AWS. Padrões para o acesso de leitura pública para todos os arquivos.
• website - Opcional . Um object . A configuração do site da AWS. Usa index.html como o IndexDocument padrão e 404.html como o ErrorDocument padrão.
• shouldCreateBucket - Opcional . Um boolean . Se o balde deve ser criado se não existir.
• shouldConfigureBucket - Opcional . Um boolean . Se o balde deve ser configurado como um site público, se não existir.
• shouldUploadUnmodifiedObjects - Opcional . Um boolean . Se os arquivos não modificados no disco devem ser carregados, mesmo que sejam os mesmos que os arquivos no balde.
• shouldDeleteDeletedObjects - Opcional . Um boolean . Se os objetos no balde devem ser excluídos quando os arquivos são excluídos do disco.

API

 satay ( bucket : String , groups : Array < Group > , options : Object ) : Promise

Parâmetros:

• bucket - necessário . Uma string . O nome do balde.
• groups - Necessário . Uma array de agrupamentos de arquivos.
  • source - Opcional . Uma string . O diretório que será pesquisado. Padrões para process.cwd() .
  • include - opcional . Um RegExp ou function . Uma expressão ou função regular para filtrar quais arquivos estão incluídos.
  • exclude - opcional . Um RegExp ou function . Uma expressão ou função regular para filtrar quais arquivos são excluídos.
  • prefix - Opcional . Uma string . O prefixo que será antecipado à chave do objeto. Padrões para "" .
  • params - opcional . Um object . Os parâmetros adicionais para passar para S3.putObject() . Padrão para {ContentType: mime.lookup(filename), ACL: 'public-read'} .
• options - opcional . Um object . Opções adicionais.
  • policy - Opcional . Um object . A política da AWS. Padrões para o acesso de leitura pública para todos os arquivos.
  • website - Opcional . Um object . A configuração do site da AWS. Usa index.html como o IndexDocument padrão e 404.html como o ErrorDocument padrão.
  • shouldCreateBucket - Opcional . Um boolean . Se o balde deve ser criado se não existir.
  • shouldConfigureBucket - Opcional . Um boolean . Se o balde deve ser configurado como um site público, se não existir.
  • shouldUploadUnmodifiedObjects - Opcional . Um boolean . Se os arquivos não modificados no disco devem ser carregados, mesmo que sejam os mesmos que os arquivos no balde.
  • shouldDeleteDeletedObjects - Opcional . Um boolean . Se os objetos no balde devem ser excluídos quando os arquivos são excluídos do disco.

Alterar log

Alterar log