Skip to content

Commit

Permalink
update site domains
Browse files Browse the repository at this point in the history
  • Loading branch information
gugzkumar committed Jan 1, 2020
1 parent 757f4ea commit 6f85aa2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/environment-variable-glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This README tries to break down what each of these variables are.
| AWS_DEFAULT_REGION | This is AWS region you want to deploy the app to. Ex: us-east-1, us-west-2, etc. |
| AWS_ACCESS_KEY_ID | This is for the IAM Credentials with which we gain the authentication provision infrastructure and deploy the app to AWS with. You need this for local development too, because some resources like S3 will sill run in the cloud. |
| AWS_SECRET_ACCESS_KEY | This is another IAM Credential (pairs with AWS_ACCESS_KEY_ID) with which we gain the authentication provision infrastructure and deploy the app to AWS with. You need this for local development too, because some resources like S3 will sill run in the cloud. |
| SITE_SUB_DOMAIN | This is the subdomain to which your app will be deployed to. For example, if you wish to have the app on https://cheet-sheet.mydomain.com this variable is set to cheet-sheet`. For local environments this is not used for networking. Only for Naming conventions for S3 resources. |
| SITE_SUB_DOMAIN | This is the subdomain to which your app will be deployed to. For example, if you wish to have the app on https://cheet-sheet.mydomain.com this variable is set to `cheet-sheet`. For local environments this is not used for networking. Only for Naming conventions for S3 resources. |
| SITE_DOMAIN | This is the subdomain to which your app will be deployed to. For example, if you wish to have the app on https://cheet-sheet.mydomain.com this variable is set to `mydomain.com`. You must own this domain on Route53 if you are deploying the app to the internet. For local environments this is not used for networking. Only for Naming conventions for S3 resources. |
| AWS_ACM_CERTIFICATE_ARN | Not need for `ENVIRONMENT=local`. This is the AWS ACM ARN for the SSL certificate of the website, so we can use https. The certificate must valid for both these domains: `{SITE_SUB_DOMAIN}`.`{SITE_DOMAIN}`, `{SITE_SUB_DOMAIN}`.api.`{SITE_DOMAIN}` |
| AWS_ROUTE53_HOSTED_ZONE_ID | This is the Zone Id for `SITE_DOMAIN` |
Expand Down

0 comments on commit 6f85aa2

Please sign in to comment.