# aws-web-pub

> Publish a static website to AWS with one simple command.

Latest version **1.5.0** (published 2022-05-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install aws-web-pub
pnpm add aws-web-pub
yarn add aws-web-pub
bun add aws-web-pub
```

Provides the command `aws-web-pub`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.0 |
| Published | 2022-05-20 |
| First published | 2020-11-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Unpacked size | 57.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | mpvosseller |
| Keywords | host, static, website, s3, cloudfront, cdk, construct, site, app, webapp, spa, react, vue, spa |

## Links

- npm: https://www.npmjs.com/package/aws-web-pub
- Repository: https://github.com/mpvosseller/aws-web-pub
- npm.io page: https://npm.io/package/aws-web-pub

## Dependencies (13)

- [yargs](https://npm.io/package/yargs.md) ^16.1.0
- [aws-cdk](https://npm.io/package/aws-cdk.md) ^1.85.0
- [@aws-cdk/core](https://npm.io/package/@aws-cdk/core.md) ^1.85.0
- [@aws-cdk/aws-s3](https://npm.io/package/@aws-cdk/aws-s3.md) ^1.85.0
- [@aws-cdk/aws-iam](https://npm.io/package/@aws-cdk/aws-iam.md) ^1.85.0
- [source-map-support](https://npm.io/package/source-map-support.md) ^0.5.16
- [@aws-cdk/aws-lambda](https://npm.io/package/@aws-cdk/aws-lambda.md) ^1.85.0
- [domain-web-redirect](https://npm.io/package/domain-web-redirect.md) ^1.0.1
- [@aws-cdk/aws-route53](https://npm.io/package/@aws-cdk/aws-route53.md) ^1.85.0
- [@aws-cdk/aws-cloudfront](https://npm.io/package/@aws-cdk/aws-cloudfront.md) ^1.85.0
- [@aws-cdk/aws-s3-deployment](https://npm.io/package/@aws-cdk/aws-s3-deployment.md) ^1.85.0
- [@aws-cdk/aws-route53-targets](https://npm.io/package/@aws-cdk/aws-route53-targets.md) ^1.85.0
- [@aws-cdk/aws-certificatemanager](https://npm.io/package/@aws-cdk/aws-certificatemanager.md) ^1.85.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.5.0 (latest) — 2022-05-20
- 1.4.0 — 2021-02-06
- 1.3.0 — 2020-11-23
- 1.2.2 — 2020-11-20
- 1.2.1 — 2020-11-20
- 1.2.0 — 2020-11-19
- 1.1.0 — 2020-11-17
- 1.0.0 — 2020-11-17
- 0.1.2 — 2020-11-16
- 0.1.1 — 2020-11-16

## README

# aws-web-pub

Publish a static website to AWS with one simple command.

With one simple command this tool provisions all of the AWS resources required
to host your static website with a custom domain. The initial deployment takes
about 10 minutes but site updates usually complete in just a few minutes.

## Noteworthy Features

- Automatically generates an SSL/TLS certificate for your domain
- Supports traditional websites and single-page applications
- Supports redirecting to or from the APEX (naked) domain (e.g. have `https://example.com` redirect to `https://www.example.com` or vice versa)
- Redirects all `http` requests to `https`
- Tear down your website and delete all AWS resources with one command

## Prerequisites

- Your domain(s) is managed by [AWS Route 53](https://aws.amazon.com/route53)

- Your AWS credentials are configured with the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html)
  OR you have following [environment variables](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html#envvars-set) set to appropriate values:
  - `AWS_ACCESS_KEY_ID`
  - `AWS_SECRET_ACCESS_KEY`

## Quick Start

- Install `npm install aws-web-pub`

- Add a config file to the root of your project named `.aws-web-pub.json`

```json
{
  "projectName": "example-site",
  "publishDir": "dist",
  "notFoundPath": "/404.html",
  "domains": [
    {
      "name": "www.example.com"
    }
  ]
}
```

- Add convenience scripts to `package.json` like

```json
{
  "scripts": {
    "deploy": "aws-web-pub deploy",
    "destroy": "awe-web-pub destroy"
  }
}
```

- Deploy your site with `npm run deploy`

- Tear down your site (and delete the AWS resources) with `npm run destroy`

## Configuration File Options

```json
{
  "projectName": "example-site",
  "publishDir": "dist",
  "deleteOldFiles": true,
  "notFoundPath": "/404.html",
  "isSinglePageApp": false,
  "domains": [
    {
      "name": "www.example.com"
    },
    {
      "name": "example.com",
      "dnsZoneName": "example.com"
    }
  ],
  "certificateArn": "arn:aws:acm:region:account:certificate/123456789012-1234-1234-1234-12345678"
}
```

- `projectName` uniquely identifies a project within an AWS account. It must start with an alphabetic character (ASCII) and can't be longer than 128 characters. If you try to deploy more than one site with the same `projectName` they will overwrite each other. Note that internally all non-alphanumeric characters are converted to hyphens so projects with names `my project` and `my-project` are considered identical and would overwrite each other.
- `publishDir` is a path to the directory of web assets to publish. This should be relative to the configuration file.
- `deleteOldFiles` is optional and indicates whether old files (files that are in the S3 bucket but not in `publishDir`) should be deleted. This defaults to `true`.
- `notFoundPath` is optional and identifies an html file to use for the content of 404 responses. This should be relative to `publishDir` and prefixed with a `/`. This property is ignored when `isSinglePageApp` is set to `true`.
- `isSinglePageApp` is optional and when set to `true` it optimizes the configuration for single page applications. In this mode `404` errors are converted to `200` and return the root document. When this is enabled the `notFoundPath` property is ignored.
- `domains` is an optional array and describes custom domains to use. The first entry will be the primary domain and any subsequent entries will be configured to redirect to the primary. If this property is not set you can still access the site via a CloudFront URL.

  - `name` is the domain name
  - `dnsZoneName` is optional and identifies the Route 53 HostedZone that manages this domain. When `dnsZoneName` is not provided it defaults to the parent domain (e.g. the domain name `www.example.com` defaults to using `example.com` as the `dnsZoneName`). This is typically used to support the APEX / naked domain by setting `name` and `dnsZoneName` to the same value. In the example configuration above the APEX domain `https://example.com` would redirect to the primary domain `https://www.example.com`

- `certificateArn` is optional and specifies the ARN of an AWS ACM certificate to use. This certificate must be valid for every domain in the `domains` setting. If present we use this certificate instead of generating a new one (See [Additional Notes](#additional-notes) below regarding AWS certificate limits).

## Additional Notes

- This tool generates temporary files in a directory called `aws-web-pub.out`. You should add this to `.gitignore`
- Due to [CloudFront limitations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-acmcertificatearn) the website will always be hosted in the `us-east-1` AWS region.
- If you are using [AWS named profiles](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) you can pass a `--profile` option
- By default most AWS Accounts can generate just 20 ACM certficates per year. If you plan on destroying sites frequently you should [manually generate a certificate](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html) and use the `certificateArn` to prevent hitting this limit. Alternatively you can also ask AWS support to increase your [ACM "Imported certificates in last 365 days"](https://console.aws.amazon.com/servicequotas/home?#!/services/acm/quotas/L-3808DC70) quota limit.

---
_Source: https://npm.io/package/aws-web-pub · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._