satay

sate

Utilitas untuk mengunggah situs statis ke AWS S3.

Penggunaan

Menggunakan CLI

1. Instal satay secara global:

   $ npm install -g satay

2. Buat file konfigurasi:

   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. Konfigurasikan Kredensial AWS Anda

4. Jalankan satay

   $ satay

Menggunakan API

1. Instal satay Lokal:

   $ npm install --save-dev satay

2. Buat file skrip:

   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. Konfigurasikan Kredensial AWS Anda

4. Jalankan upload.js

   $ node upload.js

Cli

$ satay --config=satay.config.js

Bendera:

• --config -opsional . Nama file konfigurasi. Default ke satay.config.js di direktori kerja saat ini.

Konfigurasi

Properti:

• bucket - Opsional . string . Nama ember.
• groups - Diperlukan . array pengelompokan file.
  • source - Opsional . string . Direktori yang akan dicari. Default ke process.cwd() .
  • include - opsional . RegExp atau function . Ekspresi atau fungsi reguler untuk memfilter file mana yang disertakan.
  • exclude - Opsional . RegExp atau function . Ekspresi atau fungsi reguler untuk memfilter file mana yang dikecualikan.
  • prefix - opsional . string . Awalan yang akan disiapkan ke kunci objek. Default ke "" .
  • params - Opsional . object . Parameter tambahan untuk diteruskan ke S3.putObject() . Default ke {ContentType: mime.lookup(filename), ACL: 'public-read'} .
• policy - Opsional . object . Kebijakan AWS. Default ke akses baca publik untuk semua file.
• website - Opsional . object . Konfigurasi Situs Web AWS. Menggunakan index.html sebagai Default IndexDocument dan 404.html sebagai ErrorDocument default.
• shouldCreateBucket - Opsional . Seorang boolean . Apakah ember harus dibuat jika tidak ada.
• shouldConfigureBucket - opsional . Seorang boolean . Apakah ember harus dikonfigurasi sebagai situs web publik jika tidak ada.
• shouldUploadUnmodifiedObjects - Opsional . Seorang boolean . Apakah file yang tidak dimodifikasi pada disk harus diunggah meskipun mereka sama dengan file dalam ember.
• shouldDeleteDeletedObjects - Opsional . Seorang boolean . Apakah objek dalam ember harus dihapus ketika file dihapus dari disk.

API

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

Parameter:

• bucket - Diperlukan . string . Nama ember.
• groups - Diperlukan . array pengelompokan file.
  • source - Opsional . string . Direktori yang akan dicari. Default ke process.cwd() .
  • include - opsional . RegExp atau function . Ekspresi atau fungsi reguler untuk memfilter file mana yang disertakan.
  • exclude - Opsional . RegExp atau function . Ekspresi atau fungsi reguler untuk memfilter file mana yang dikecualikan.
  • prefix - opsional . string . Awalan yang akan disiapkan ke kunci objek. Default ke "" .
  • params - Opsional . object . Parameter tambahan untuk diteruskan ke S3.putObject() . Default ke {ContentType: mime.lookup(filename), ACL: 'public-read'} .
• options - Opsional . object . Opsi tambahan.
  • policy - Opsional . object . Kebijakan AWS. Default ke akses baca publik untuk semua file.
  • website - Opsional . object . Konfigurasi Situs Web AWS. Menggunakan index.html sebagai Default IndexDocument dan 404.html sebagai ErrorDocument default.
  • shouldCreateBucket - Opsional . Seorang boolean . Apakah ember harus dibuat jika tidak ada.
  • shouldConfigureBucket - opsional . Seorang boolean . Apakah ember harus dikonfigurasi sebagai situs web publik jika tidak ada.
  • shouldUploadUnmodifiedObjects - Opsional . Seorang boolean . Apakah file yang tidak dimodifikasi pada disk harus diunggah meskipun mereka sama dengan file dalam ember.
  • shouldDeleteDeletedObjects - Opsional . Seorang boolean . Apakah objek dalam ember harus dihapus ketika file dihapus dari disk.

Ubah log

Ubah log