Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update to specify account and user permissions for created root domain #20

Merged
merged 1 commit into from
Sep 13, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ Export environment variables with the keys listed below for your desired provide

### AWS

| Env Var | Example Value | Description |
|------------------------------|-----------------------------|----------------------------------------------------------------|
| `MGC_ZONE_ROOT_DOMAIN` | `jbloggs.hcpapps.net` | Hostname for the root Domain |
| `MGC_AWS_DNS_PUBLIC_ZONE_ID` | `Z01234567US0IQE3YLO00` | AWS Route 53 Zone ID for specified `MGC_ZONE_ROOT_DOMAIN` |
| `MGC_AWS_ACCESS_KEY_ID` | `AKIA1234567890000000` | Access Key ID, with access to resources in Route 53 |
| `MGC_AWS_SECRET_ACCESS_KEY` | `Z01234567US0000000` | Access Secret Access Key, with access to resources in Route 53 |
| `MGC_AWS_REGION` | `eu-west-1` | AWS Region |
| `MGC_SUB_DOMAIN` | `myapp.jbloggs.hcpapps.net` | Desired Sub domain |
| Env Var | Example Value | Description |
|------------------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------|
| `MGC_ZONE_ROOT_DOMAIN` | `jbloggs.hcpapps.net` | Hostname for the root Domain |
| `MGC_AWS_DNS_PUBLIC_ZONE_ID` | `Z01234567US0IQE3YLO00` | AWS Route 53 Zone ID for specified `MGC_ZONE_ROOT_DOMAIN` |
| `MGC_AWS_ACCESS_KEY_ID` | `AKIA1234567890000000` | Access Key ID, for user with permissions to Route 53 in the account where root domain is created |
| `MGC_AWS_SECRET_ACCESS_KEY` | `Z01234567US0000000` | Access Secret Access Key, for user with permissions to Route 53 in the account where root domain is created |
| `MGC_AWS_REGION` | `eu-west-1` | AWS Region |
| `MGC_SUB_DOMAIN` | `myapp.jbloggs.hcpapps.net` | Desired Sub domain |


### GCP
Expand Down