satay

Satay

Ein Dienstprogramm zum Hochladen statischer Websites auf AWS S3.

Verwendung

Mit der CLI

1. satay weltweit installieren:

   $ npm install -g satay

2. Erstellen Sie eine Konfigurationsdatei:

   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. Konfigurieren Sie Ihre AWS -Anmeldeinformationen

4. satay laufen

   $ satay

Verwenden der API

1. satay lokal installieren:

   $ npm install --save-dev satay

2. Erstellen einer Skriptdatei:

   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. Konfigurieren Sie Ihre AWS -Anmeldeinformationen

4. upload.js ausführen

   $ node upload.js

Cli

$ satay --config=satay.config.js

Flaggen:

• --config -Optional . Der Konfigurationsdateiname. Standardeinstellungen zu satay.config.js im aktuellen Arbeitsverzeichnis.

Konfiguration

Eigenschaften:

• bucket - optional . Eine string . Der Name des Eimers.
• groups - erforderlich . Eine array von Dateigruppierungen.
  • source - optional . Eine string . Das Verzeichnis, das durchsucht wird. Standardmäßig process.cwd() .
  • include - optional . Ein RegExp oder function . Ein regelmäßiger Ausdruck oder eine Funktion zum Filtern, die Dateien enthalten sind.
  • exclude - optional . Ein RegExp oder function . Ein regelmäßiger Ausdruck oder eine Funktion zum Filtern, die Dateien ausgeschlossen sind.
  • prefix - optional . Eine string . Das Präfix, das auf den Objektschlüssel vorbereitet wird. Standardeinstellung zu "" .
  • params - optional . Ein object . Die zusätzlichen Parameter an S3.putObject() übergeben. Standardeinstellungen zu {ContentType: mime.lookup(filename), ACL: 'public-read'} .
• policy - optional . Ein object . Die AWS -Richtlinie. Standardeinstellungen zum öffentlichen Lesezugriff für alle Dateien.
• website - optional . Ein object . Die AWS -Website -Konfiguration. Verwendet index.html als IndexDocument und 404.html als Standard ErrorDocument .
• shouldCreateBucket - optional . Ein boolean . Ob der Eimer erstellt werden sollte, wenn es nicht existiert.
• shouldConfigureBucket - optional . Ein boolean . Ob der Eimer als öffentliche Website konfiguriert werden sollte, wenn es nicht vorhanden ist.
• shouldUploadUnmodifiedObjects - optional . Ein boolean . Ob die unmodifizierten Dateien auf der Festplatte hochgeladen werden sollten, obwohl sie mit den Dateien im Eimer übereinstimmen.
• shouldDeleteDeletedObjects - Optional . Ein boolean . Ob die Objekte im Eimer gelöscht werden sollten, wenn die Dateien von der Festplatte gelöscht werden.

API

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

Parameter:

• bucket - erforderlich . Eine string . Der Name des Eimers.
• groups - erforderlich . Eine array von Dateigruppierungen.
  • source - optional . Eine string . Das Verzeichnis, das durchsucht wird. Standardmäßig process.cwd() .
  • include - optional . Ein RegExp oder function . Ein regelmäßiger Ausdruck oder eine Funktion zum Filtern, die Dateien enthalten sind.
  • exclude - optional . Ein RegExp oder function . Ein regelmäßiger Ausdruck oder eine Funktion zum Filtern, die Dateien ausgeschlossen sind.
  • prefix - optional . Eine string . Das Präfix, das auf den Objektschlüssel vorbereitet wird. Standardeinstellung zu "" .
  • params - optional . Ein object . Die zusätzlichen Parameter an S3.putObject() übergeben. Standardeinstellungen zu {ContentType: mime.lookup(filename), ACL: 'public-read'} .
• options - optional . Ein object . Zusätzliche Optionen.
  • policy - optional . Ein object . Die AWS -Richtlinie. Standardeinstellungen zum öffentlichen Lesezugriff für alle Dateien.
  • website - optional . Ein object . Die AWS -Website -Konfiguration. Verwendet index.html als IndexDocument und 404.html als Standard ErrorDocument .
  • shouldCreateBucket - optional . Ein boolean . Ob der Eimer erstellt werden sollte, wenn es nicht existiert.
  • shouldConfigureBucket - optional . Ein boolean . Ob der Eimer als öffentliche Website konfiguriert werden sollte, wenn es nicht vorhanden ist.
  • shouldUploadUnmodifiedObjects - optional . Ein boolean . Ob die unmodifizierten Dateien auf der Festplatte hochgeladen werden sollten, obwohl sie mit den Dateien im Eimer übereinstimmen.
  • shouldDeleteDeletedObjects - Optional . Ein boolean . Ob die Objekte im Eimer gelöscht werden sollten, wenn die Dateien von der Festplatte gelöscht werden.

Protokoll ändern

Protokoll ändern