Téléchargement satay - Téléchargement du code source satay

satay

Autres catégories

1.0.0

Télécharger

satay

Un utilitaire pour télécharger des sites statiques sur AWS S3.

Usage

Utilisation de la CLI

Installez satay à l'échelle mondiale:
```
$ npm install -g satay
```

Créer un fichier de configuration:

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

Configurez vos informations d'identification AWS
Courir satay
```
$ satay
```

Utilisation de l'API

Installez satay localement:
```
$ npm install --save-dev satay
```

Créer un fichier 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
  }
) ;

Configurez vos informations d'identification AWS
Run upload.js
```
$ node upload.js
```

CLI

$ satay --config=satay.config.js

Frappeurs:

--config - Facultatif . Le nom du fichier de configuration. Par défaut est satay.config.js dans le répertoire de travail actuel.

Configuration

Propriétés:

bucket - facultatif . Une string . Le nom du seau.
groups - requis . Un array de groupes de fichiers.
- source - Facultatif . Une string . Le répertoire qui sera fouillé. Par défaut est process.cwd() .
- include - Facultatif . Un RegExp ou function . Une expression ou une fonction régulière pour filtrer quels fichiers sont inclus.
- exclude - facultatif . Un RegExp ou function . Une expression ou une fonction régulière pour filtrer quels fichiers sont exclus.
- prefix - Facultatif . Une string . Le préfixe qui sera apparenté à la clé de l'objet. Par défaut "" .
- params - Facultatif . Un object . Les paramètres supplémentaires à passer à S3.putObject() . Par défaut à {ContentType: mime.lookup(filename), ACL: 'public-read'} .
policy - Facultatif . Un object . La politique AWS. Par défaut, l'accès à la lecture du public pour tous les fichiers.
website - Facultatif . Un object . La configuration du site Web AWS. Utilise index.html comme IndexDocument par défaut et 404.html comme ErrorDocument par défaut.
shouldCreateBucket - Facultatif . Un boolean . Si le seau doit être créé s'il n'existe pas.
shouldConfigureBucket - Facultatif . Un boolean . Si le seau doit être configuré comme un site Web public s'il n'existe pas.
shouldUploadUnmodifiedObjects - Facultatif . Un boolean . Si les fichiers non modifiés sur le disque doivent être téléchargés même s'ils sont les mêmes que les fichiers du seau.
shouldDeleteDeletedObjects - Facultatif . Un boolean . Si les objets du seau doivent être supprimés lorsque les fichiers sont supprimés du disque.

API

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

Paramètres:

bucket - requis . Une string . Le nom du seau.
groups - requis . Un array de groupes de fichiers.
- source - Facultatif . Une string . Le répertoire qui sera fouillé. Par défaut est process.cwd() .
- include - Facultatif . Un RegExp ou function . Une expression ou une fonction régulière pour filtrer quels fichiers sont inclus.
- exclude - facultatif . Un RegExp ou function . Une expression ou une fonction régulière pour filtrer quels fichiers sont exclus.
- prefix - Facultatif . Une string . Le préfixe qui sera apparenté à la clé de l'objet. Par défaut "" .
- params - Facultatif . Un object . Les paramètres supplémentaires à passer à S3.putObject() . Par défaut à {ContentType: mime.lookup(filename), ACL: 'public-read'} .
options - Facultatif . Un object . Options supplémentaires.
- policy - Facultatif . Un object . La politique AWS. Par défaut, l'accès à la lecture du public pour tous les fichiers.
- website - Facultatif . Un object . La configuration du site Web AWS. Utilise index.html comme IndexDocument par défaut et 404.html comme ErrorDocument par défaut.
- shouldCreateBucket - Facultatif . Un boolean . Si le seau doit être créé s'il n'existe pas.
- shouldConfigureBucket - Facultatif . Un boolean . Si le seau doit être configuré comme un site Web public s'il n'existe pas.
- shouldUploadUnmodifiedObjects - Facultatif . Un boolean . Si les fichiers non modifiés sur le disque doivent être téléchargés même s'ils sont les mêmes que les fichiers du seau.
- shouldDeleteDeletedObjects - Facultatif . Un boolean . Si les objets du seau doivent être supprimés lorsque les fichiers sont supprimés du disque.