Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@architect/docs
Advanced tools
@architect/docs - npm Package Compare versions
Comparing version 30.1.33 to 30.1.34
@@ -5,9 +5,31 @@ # Custom DNS | ||
| `architect` bakes in support for Amazon Route53. Following the [workflows reference](/reference/npm-run-scripts) to get setup with `dns` entry under `scripts` in `package.json`. From there add `@domain` to your `.arc` file, invoke `npm run dns` and follow the instructions. | ||
| To use Amazon Route53: | ||
| 1. Ensure your project `package.json` has `dns` entry under `scripts` per [workflows reference](/reference/npm-run-scripts) | ||
| 2. Add `@domain` to your `.arc` file with a value of the domain name you wish to setup | ||
| 3. Invoke `npm run dns` and follow the instructions | ||
| If you _really_ want to manually configure DNS you can follow these guides below: | ||
| * [Route 53](#route-53) | ||
| * [Cloudflare](#cloudflare) | ||
| * [Cloudflare](#cloudflare) | ||
| ## Route 53<a name="route-53"></a> | ||
| 1. Sign into AWS Route 53 and click on Hosted Zones | ||
| 2. Create Hosted Zone | ||
| 3. Copy the name server information to your domain registar (if you register with Amazon this happens automatically) | ||
| 4. Sign into AWS Certificate Manager | ||
| 5. Request a certificate (protip: setup both `example.com` and `*.example.com` for subdomains) | ||
| 6. Follow the instructions to verify the certificate | ||
| 7. Sign into AWS API Gateway | ||
| 8. Click on Custom Domain Names | ||
| 9. Create Custom Domain Name | ||
| 10. Enter the **Domain Name**, **ACM Certificate** you just verified, **Path** `/`, **Destination** API name and **Stage** of `staging` or `production` | ||
| 11. Copy the value of the generated **Distribution Domain Name** to your clipboard | ||
| 12. Sign back into Route53 and click into the domain you want to enable | ||
| 13. Create Record Set | ||
| 14. Set **Alias** `yes` and **Alias Target** to the **Distribution Domain Name** you just copied to your clipboard | ||
| 15. Create the Record Set (and be patient it can take a bit for everything to wire up) | ||
| ## Cloudflare<a name="cloudflare"></a> | ||
@@ -17,2 +39,3 @@ | ||
| 0. [Strongly reccomend: leave Cloudflare](http://www.sfgate.com/technology/businessinsider/article/Cloudflare-is-helping-defend-a-neo-Nazi-website-11818696.php) | ||
| 1. First, ensure that your domain is registered and is using the Cloudflare name servers and that your architect-generated application has been deployed to AWS. | ||
@@ -37,18 +60,1 @@ 2. In your AWS management console go to the Certificate Management service and ensure you are in the US East (N. Virginia) aka us-east-1 region. | ||
| ## Route 53<a name="route-53"></a> | ||
| 1. Sign into AWS Route 53 and click on Hosted Zones | ||
| 2. Create Hosted Zone | ||
| 3. Copy the name server information to your domain registar (if you register with Amazon this happens automatically) | ||
| 4. Sign into AWS Certificate Manager | ||
| 5. Request a certificate (protip: setup both `example.com` and `*.example.com` for subdomains) | ||
| 6. Follow the instructions to verify the certificate | ||
| 7. Sign into AWS API Gateway | ||
| 8. Click on Custom Domain Names | ||
| 9. Create Custom Domain Name | ||
| 10. Enter the **Domain Name**, **ACM Certificate** you just verified, **Path** `/`, **Destination** API name and **Stage** of `staging` or `production` | ||
| 11. Copy the value of the generated **Distribution Domain Name** to your clipboard | ||
| 12. Sign back into Route53 and click into the domain you want to enable | ||
| 13. Create Record Set | ||
| 14. Set **Alias** `yes` and **Alias Target** to the **Distribution Domain Name** you just copied to your clipboard | ||
| 15. Create the Record Set (and be patient it can take a bit for everything to wire up) |
@@ -18,4 +18,11 @@ # @domain | ||
| Running `npm run dns` will: | ||
| - Setup certificates with AWS Certificate Manager | ||
| - Create a DNS Recordset on Route 53 | ||
| - Setup `staging` and `production` Domains in API Gateway | ||
| - Create corosponding Alias records in Route 53 | ||
| > Also see [workflows](/reference/npm-run-scripts#arc-dns) for working with `@domain` | ||
| ## Next: [Defining routes with `@html`](/reference/html) |
@@ -76,4 +76,11 @@ # Workflows | ||
| Setup a custom domain on Route53: | ||
| Setting up a custom domain for API Gateway on Route53 requires the following steps: | ||
| - Setup certificates with AWS Certificate Manager | ||
| - Create a DNS Recordset on Route 53 | ||
| - Setup `staging` and `production` Domains in API Gateway | ||
| - Create corosponding Alias records in Route 53 | ||
| Proceed through these steps by running: | ||
| ```bash | ||
@@ -83,3 +90,3 @@ npm run dns | ||
| > This command needs to be re-run as you progress through setup steps of creating/verifying certificates | ||
| > Note: `npm run dns` needs to be re-run as you progress through setup steps of creating/verifying certificates | ||
@@ -86,0 +93,0 @@ --- |
| { | ||
| "name": "@architect/docs", | ||
| "version": "30.1.33", | ||
| "version": "30.1.34", | ||
| "main": "index", | ||
@@ -5,0 +5,0 @@ "scripts": { |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.53%
132179
No dependency changes