From aebe1e8acc365b2bfb4815356898a5858c0d2b70 Mon Sep 17 00:00:00 2001 From: Tin Pecirep Date: Thu, 4 Mar 2021 02:19:29 +0100 Subject: [PATCH] Add documentation --- CHANGELOG.md | 3 ++- README.md | 19 +++++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 739bab4..59922a1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +- Add `route53` config parameter to manage domains and certifiacte automatically using route53 ## [0.8.0] - 2021-1-28 Thanks @pecirep, @miguel-a-calles-mba, @superandrew213 @@ -98,4 +99,4 @@ Better support for generating client code on Windows [0.5.4]: https://github.com/MadSkills-io/fullstack-serverless/compare/v0.5.3...v0.5.4 [0.5.3]: https://github.com/MadSkills-io/fullstack-serverless/compare/v0.5.2...v0.5.3 [0.5.2]: https://github.com/MadSkills-io/fullstack-serverless/compare/v0.5.1...v0.5.2 -[0.5.1]: https://github.com/MadSkills-io/fullstack-serverless/compare/v0.5.0...v0.5.1 \ No newline at end of file +[0.5.1]: https://github.com/MadSkills-io/fullstack-serverless/compare/v0.5.0...v0.5.1 diff --git a/README.md b/README.md index 9f61b80..bd7a005 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ custom: fullstack: domain: my-custom-domain.com certificate: arn:aws:acm:us-east-1:... # The ARN for the SSL cert to use form AWS CertificateManager + route53: false # Use route53 to manage domains and certificate bucketName: webapp-deploy # Unique name for the S3 bucket to host the client assets distributionFolder: client/dist # Path to the client assets to be uploaded to S3 indexDocument: index.html # The index document to use @@ -259,6 +260,24 @@ The custom domain for your fullstack serverless app. --- +**route53** + +_optional_, default: `false` + +```yaml +custom: + fullstack: + ... + route53: true + ... +``` + +Use this parameter if you want the plugin to manage domains via route53, including automatic SSL certificate creation and validation through ACM (this means you can omit the `certificateArn` parameter). + +If one or more domains aren't managed by a Hosted Zone in your account, the required DNS entries will be written to the console. + +--- + **errorDocument** _optional_, default: `error.html`