satay

ساتاي

فائدة لتحميل المواقع الثابتة إلى AWS S3.

الاستخدام

باستخدام CLI

1. تثبيت satay على مستوى العالم:

   $ npm install -g satay

2. إنشاء ملف تكوين:

   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. تكوين بيانات اعتماد AWS الخاصة بك

4. تشغيل satay

   $ satay

باستخدام API

1. تثبيت satay محليا:

   $ npm install --save-dev satay

2. إنشاء ملف نص:

   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. تكوين بيانات اعتماد AWS الخاصة بك

4. تشغيل upload.js

   $ node upload.js

CLI

$ satay --config=satay.config.js

الأعلام:

• --config -اختياري . اسم ملف التكوين. الإعدادات الافتراضية إلى satay.config.js في دليل العمل الحالي.

إعدادات

ملكيات:

• bucket - اختياري . string . اسم الدلو.
• groups - مطلوب . array من مجموعات الملفات.
  • source - اختياري . string . الدليل الذي سيتم تفتيشه. الإعدادات الافتراضية إلى process.cwd() .
  • include - اختياري . RegExp أو function . تعبير أو وظيفة منتظمة لتصفية الملفات التي يتم تضمينها.
  • exclude - اختياري . RegExp أو function . تعبير أو وظيفة منتظمة لتصفية الملفات التي يتم استبعادها.
  • prefix - اختياري . string . البادئة التي سيتم إعدادها مسبقا إلى مفتاح الكائن. الإعدادات الافتراضية إلى "" .
  • params - اختياري . object . المعلمات الإضافية لتمريرها إلى S3.putObject() . الإعدادات الافتراضية إلى {ContentType: mime.lookup(filename), ACL: 'public-read'} .
• policy - اختياري . object . سياسة AWS. الإعدادات الافتراضية للوصول العام لجميع الملفات.
• website - اختياري . object . تكوين موقع AWS. يستخدم index.html باعتباره IndexDocument الافتراضي و 404.html باعتباره ErrorDocument الافتراضي.
• shouldCreateBucket - اختياري . boolean . ما إذا كان ينبغي إنشاء دلو إذا لم يكن موجودًا.
• shouldConfigureBucket - اختياري . boolean . ما إذا كان ينبغي تكوين الجرافة كموقع عام إذا لم يكن موجودًا.
• shouldUploadUnmodifiedObjects - اختياري . boolean . ما إذا كان ينبغي تحميل الملفات غير المعدلة على القرص على الرغم من أنها هي نفس الملفات الموجودة في الدلو.
• shouldDeleteDeletedObjects - اختياري . boolean . ما إذا كان ينبغي حذف الكائنات الموجودة في الدلو عند حذف الملفات من القرص.

API

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

حدود:

• bucket - مطلوب . string . اسم الدلو.
• groups - مطلوب . array من مجموعات الملفات.
  • source - اختياري . string . الدليل الذي سيتم تفتيشه. الإعدادات الافتراضية إلى process.cwd() .
  • include - اختياري . RegExp أو function . تعبير أو وظيفة منتظمة لتصفية الملفات التي يتم تضمينها.
  • exclude - اختياري . RegExp أو function . تعبير أو وظيفة منتظمة لتصفية الملفات التي يتم استبعادها.
  • prefix - اختياري . string . البادئة التي سيتم إعدادها مسبقا إلى مفتاح الكائن. الإعدادات الافتراضية إلى "" .
  • params - اختياري . object . المعلمات الإضافية لتمريرها إلى S3.putObject() . الإعدادات الافتراضية إلى {ContentType: mime.lookup(filename), ACL: 'public-read'} .
• options - اختياري . object . خيارات إضافية.
  • policy - اختياري . object . سياسة AWS. الإعدادات الافتراضية للوصول العام لجميع الملفات.
  • website - اختياري . object . تكوين موقع AWS. يستخدم index.html باعتباره IndexDocument الافتراضي و 404.html باعتباره ErrorDocument الافتراضي.
  • shouldCreateBucket - اختياري . boolean . ما إذا كان ينبغي إنشاء دلو إذا لم يكن موجودًا.
  • shouldConfigureBucket - اختياري . boolean . ما إذا كان ينبغي تكوين الجرافة كموقع عام إذا لم يكن موجودًا.
  • shouldUploadUnmodifiedObjects - اختياري . boolean . ما إذا كان ينبغي تحميل الملفات غير المعدلة على القرص على الرغم من أنها هي نفس الملفات الموجودة في الدلو.
  • shouldDeleteDeletedObjects - اختياري . boolean . ما إذا كان ينبغي حذف الكائنات الموجودة في الدلو عند حذف الملفات من القرص.

تغيير السجل

تغيير السجل