Descarga satay - Descarga del código fuente satay

satay

Otras categorias

1.0.0

Descargar

satay

Una utilidad para cargar sitios estáticos a AWS S3.

Uso

Usando el CLI

Instale satay a nivel mundial:
```
$ npm install -g satay
```

Crear un archivo de configuración:

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`
      }
    }
  ]
} ;

Configure sus credenciales de AWS
Correr satay
```
$ satay
```

Usando la API

Instalar satay localmente:
```
$ npm install --save-dev satay
```

Crear un archivo 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
  }
) ;

Configure sus credenciales de AWS
Ejecutar upload.js
```
$ node upload.js
```

CLI

$ satay --config=satay.config.js

Banderas:

--config -Opcional . El nombre del archivo de configuración. El valor predeterminado a satay.config.js en el directorio de trabajo actual.

Configuración

Propiedades:

bucket - opcional . Una string . El nombre del balde.
groups - requeridos . Una array de agrupaciones de archivos.
- source - Opcional . Una string . El directorio que se buscará. El valor predeterminado a process.cwd() .
- include - opcional . Un RegExp o function . Una expresión o función regular para filtrar qué archivos están incluidos.
- exclude - opcional . Un RegExp o function . Una expresión o función regular para filtrar qué archivos están excluidos.
- prefix - opcional . Una string . El prefijo que se prefiere a la tecla de objeto. El valor predeterminado es "" .
- params - opcional . Un object . Los parámetros adicionales pasarán a S3.putObject() . El valor predeterminado es {ContentType: mime.lookup(filename), ACL: 'public-read'} .
policy - opcional . Un object . La política de AWS. El valor predeterminado al acceso de lectura pública para todos los archivos.
website : opcional . Un object . La configuración del sitio web de AWS. Usa index.html como el IndexDocument predeterminado y 404.html como el ErrorDocument predeterminado.
shouldCreateBucket - Opcional . Un boolean . Si el balde debe crearse si no existe.
shouldConfigureBucket - Opcional . Un boolean . Si el cubo debe configurarse como un sitio web público si no existe.
shouldUploadUnmodifiedObjects - opcional . Un boolean . Si los archivos no modificados en el disco deben cargarse a pesar de que son los mismos que los archivos en el cubo.
shouldDeleteDeletedObjects - opcional . Un boolean . Si los objetos en el cubo deben eliminarse cuando los archivos se eliminan del disco.

API

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

Parámetros:

bucket - requerido . Una string . El nombre del balde.
groups - requeridos . Una array de agrupaciones de archivos.
- source - Opcional . Una string . El directorio que se buscará. El valor predeterminado a process.cwd() .
- include - opcional . Un RegExp o function . Una expresión o función regular para filtrar qué archivos están incluidos.
- exclude - opcional . Un RegExp o function . Una expresión o función regular para filtrar qué archivos están excluidos.
- prefix - opcional . Una string . El prefijo que se prefiere a la tecla de objeto. El valor predeterminado es "" .
- params - opcional . Un object . Los parámetros adicionales pasarán a S3.putObject() . El valor predeterminado es {ContentType: mime.lookup(filename), ACL: 'public-read'} .
options - opcional . Un object . Opciones adicionales.
- policy - opcional . Un object . La política de AWS. El valor predeterminado al acceso de lectura pública para todos los archivos.
- website : opcional . Un object . La configuración del sitio web de AWS. Usa index.html como el IndexDocument predeterminado y 404.html como el ErrorDocument predeterminado.
- shouldCreateBucket - Opcional . Un boolean . Si el balde debe crearse si no existe.
- shouldConfigureBucket - Opcional . Un boolean . Si el cubo debe configurarse como un sitio web público si no existe.
- shouldUploadUnmodifiedObjects - opcional . Un boolean . Si los archivos no modificados en el disco deben cargarse a pesar de que son los mismos que los archivos en el cubo.
- shouldDeleteDeletedObjects - opcional . Un boolean . Si los objetos en el cubo deben eliminarse cuando los archivos se eliminan del disco.