Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brianleroux/arc-plugin-custom-domain
Setup a custom domain on AWS with Route53 and CloudFront
https://github.com/brianleroux/arc-plugin-custom-domain
apigateway aws cloudfront lambda route53 s3 serverless websockets
Last synced: 2 days ago
JSON representation
Setup a custom domain on AWS with Route53 and CloudFront
- Host: GitHub
- URL: https://github.com/brianleroux/arc-plugin-custom-domain
- Owner: brianleroux
- Created: 2024-06-17T22:10:47.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-06-21T21:11:37.000Z (3 months ago)
- Last Synced: 2024-06-22T12:45:55.519Z (3 months ago)
- Topics: apigateway, aws, cloudfront, lambda, route53, s3, serverless, websockets
- Language: JavaScript
- Homepage: https://arc.codes
- Size: 10.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# arc-plugin-custom-domain
This is a plugin for https://arc.codes to help setup a custom domain on CloudFront without pain!
Features:
- Creates all the necessary resources for a CloudFront CDN distribution
- Optionally create DNS records in Route53 including an automatically verified certificate in ACM
- Automatically detects `@ws` and adds magic same-origin route for `_/wss`; this enables session sharing to web socket lambda functions
# Usage
```bash
npm install arc-plugin-custom-domain
```
- If you want to use Route53 then use `@dns`
- If you want to manage your DNS elsewhere then use `@cdn`
> [!IMPORTANT]
> To use this plugin your application must be deployed in `us-east-1`. This is a limitation of how CloudFront works with API Gateway and ACM Certificates.
> [!NOTE]
> This plugin requires a URLs to exist *before* you use it. Make sure you've deployed at least once before using this plugin with `arc deploy` and `arc deploy --production` respectively.
> [!WARNING]
> This plugin will fail if used with an app that has never been deployed. You need to deploy the stack at least once before using this plugin. (API Gateway cannot create a domain mapping until it has been deployed at least once.)
## `@dns`
Creates a CloudFront distribution, Route53 A alias record and ACM Certificate automatically; you need to specify `domain` and `zone` for the HostedZoneId. Buying/importing a domain w Route53 should automatically setup a HostedZone for you.
Example:
```
@app
myapp
@aws
region us-east-1
@http
@plugins
arc-plugin-custom-domain
@dns
staging b4.example.com
production example.com
zone XKDISW7D
```
## `@cdn`
Creates a Cloudfront distribution; you need to specify `staging` domain, `production` domain and `cert` with an ACM Certificate ARN.
Requirements:
- Create a certificate and verify it in ACM (AWS Certificate Manager) console in `us-east-1` (ensure you set not only domain `example.com` but also add `*.domain.com` so same cert can be used for staging
- After deployment; create an A record in your DNS registrar to point to the generated CloudFront distribution (look AWS CloudFront console to find this)
Example:
```
@app
myapp
@aws
region us-east-1
@http
@plugins
arc-plugin-custom-domain
@cdn
staging b4.example.com
production example.com
cert arn:aws:acm:us-east-1:555:certificate/xxx
```