Скачать satay - Скачать исходный код satay

satay

Другие категории

1.0.0

Скачать

сатай

Утилита для загрузки статических сайтов в AWS S3.

Использование

Используя CLI

Установите satay во всем мире:
```
$ npm install -g satay
```

Создайте файл конфигурации:

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

Настройте свои учетные данные AWS
Запустить satay
```
$ satay
```

Используя API

Установите satay на местном уровне:
```
$ npm install --save-dev satay
```

Создайте файл скрипта:

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
  }
) ;

Настройте свои учетные данные AWS
Запустить upload.js
```
$ node upload.js
```

Кли

$ 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 . Должны ли объекты в ведре быть удалены при удалении файлов с диска.