diff --git a/docs/index.html b/docs/index.html index 7f5eda7..948be3e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -48,46 +48,32 @@

Pipeline Status Codecov Status License

-

Synchronize files and directories between a remote computer and multiple Serverless cloud providers' storages.

-

Supported cloud providers:

- +

Synchronize files and directories between a remote machine and a cloud storage via cloud frameworks and stacks consisting of AWS SAM (Serverless) and AWS Cloud Development Kit (CDK). This package supports the following cloud storage providers: AWS S3.

Features

-

Installation

-
    -
  1. ni: ni sync-cloud-storage -D
  2. -
  3. npm: npm i sync-cloud-storage -D
  4. -
  5. yarn: yarn add sync-cloud-storage -D
  6. -
  7. pnpm: pnpm add sync-cloud-storage -D
  8. -

Usage

-

Serverless

-

AWS S3

+

AWS S3

+

Serverless

+

Sync storages action as a pre-deploy hook in the serverless.yml:

plugins:
   - sync-cloud-storage
 
@@ -105,96 +91,179 @@ 

AWS S3

foo: bar bar: foo
-

Configuration Reference

-

This section provides a detailed reference for all configuration options.

- +

Options

+

General

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionNotesTypeRequiredDefault
storagesList of storages, Minimum items: 1array of storagetrueundefined
regionCloud (AWS) regionstringfalseundefined or AWS_REGION environment variable
endpointCloud (AWS) Endpoint URLstringfalseundefined or AWS_ENDPOINT_URL environment variable
offlineOffline modebooleanfalsefalse or IS_OFFLINE environment variable
disabledDisable syncbooleanfalsefalse
silentSilent output logsbooleanfalsefalse
+

Storage

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionNotesTypeRequiredDefault
nameName of storage (AWS S3 Bucket), Minimum length: 1stringtrueundefined
patternsPatterns of glob paths to include or exclude on sync action, Minimum items: 1array of stringtrueundefined
actionsSync actions, Valid values: upload, deletearray of stringfalseupload, delete
prefixPrefix for the storage files and foldersstringfalse''
enabledEnable or disable the storage on sync actionbooleanfalsetrue
aclAWS S3 Canned ACL, Valid values: private, public-read, public-read-write, authenticated-readstringfalseundefined
metadataA set of metadata key/value pair to be set or unset on the objectobjectfalseundefined
tagsA set of tag key/value pair to be set or unset on the objectobjectfalse{}
gitignoreUse .gitignore file to exclude files and directoriesbooleanfalsefalse
ignoreFilesIgnore files and directories to exclude from sync actionarray of stringfalseundefined
@@ -211,10 +280,10 @@

Home


- \ No newline at end of file + diff --git a/package.json b/package.json index 86d59dc..eb9d83e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "sync-cloud-storage", - "version": "1.0.0-rc.3", + "version": "1.0.0-rc.4", "license": "MIT", "type": "module", "main": "dist/esm/index.js", @@ -34,7 +34,7 @@ "lint:fix": "eslint . --fix", "docs:build": "pnpm run build && rm -rf ./docs && ./node_modules/.bin/jsdoc -c jsdoc.json", "docs:start": "pnpm run docs:build && ./node_modules/.bin/http-server -c-1 -o docs", - "preversion": "pnpm run lint && pnpm run build && pnpm run format && pnpm run docs:build", + "preversion": "pnpm run lint", "clean": "rm -rf ./dist ./docs", "start": "node dist/esm/index.js" },