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. Run 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 ไม่ว่าจะเป็นวัตถุในถังที่ควรถูกลบเมื่อไฟล์ถูกลบออกจากดิสก์หรือไม่

เปลี่ยนบันทึก

เปลี่ยนบันทึก