0.2.2 • Published 6 years ago
statick v0.2.2
WIP
This is a Node.js module that takes a folder containing your static app, and hosts it in the selected provider's cloud. Currently only works with provider: aws, and hosts from an S3 bucket endpoint.
Compatible with any version since LTS:Boron (v6.9.0)
Roadmap:
- AWS: Attach S3 endpoint to a cloudfront distribution
- AWS: Associate a Route53 hosted zone with (bucket|distribution)
- Azure
CLI
# currently only accepts a config.yml (or .json) file
>> statick -c config.ymlor node API
import statick from "statick"
import config from "statick.json"
statick(config);config.yml
provider: aws
domain: statick.io
path: ./public
exclude:
- deleteme.html
aws:
region: eu-west-1
s3:
IndexDocument: myIndex.htmloptions
| key | description | default | type |
|---|---|---|---|
| provider* | one of; "aws" | - | string |
| domain* | name of the uploaded-to storage | - | string |
| path* | path of the folder the static app resides in | - | string |
| aws.region | global region of the AWS clients | "us-east-1" | string |
| aws.credentials | of the shape { accessKeyId, secretAccessKey } | - | object |
| aws.s3.IndexDocument | entry .html to your bucket (basename) | "index.html" | string |
| aws.s3.ErrorDocument | .html to redirect to (basename) | IndexDocument | string |
| exclude | RegExp patterns to test against each file (put quotes if using yml) | - | array |
* required
Notes
Constraints on S3 bucket name
- The bucket name must be between 3 and 63 characters long (inclusive).
- The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes. periods, underscores, and dashes.
- The bucket name must not contain adjacent periods.
Conflicting conditional operation in progress error indicates the S3 bucket name is currently unavailable. Trying again in a couple minutes works.