website: atlas backend requires https protocol in address (#18585)

Just providing the hostname won't work. This commit adds an example and fixes
the explanation.
This commit is contained in:
Nick Fagerlund 2018-08-01 17:33:11 -07:00 committed by Martin Atkins
parent 4e826cc4f5
commit 2487af1945
1 changed files with 4 additions and 2 deletions

View File

@ -33,6 +33,7 @@ workflow](/docs/enterprise/run/cli.html) instead.
terraform { terraform {
backend "atlas" { backend "atlas" {
name = "example_corp/networking-prod" name = "example_corp/networking-prod"
address = "https://app.terraform.io" # optional
} }
} }
``` ```
@ -60,5 +61,6 @@ The following configuration options / environment variables are supported:
token](/docs/enterprise/users-teams-organizations/users.html#api-tokens). We token](/docs/enterprise/users-teams-organizations/users.html#api-tokens). We
recommend using the `ATLAS_TOKEN` environment variable rather than setting recommend using the `ATLAS_TOKEN` environment variable rather than setting
`access_token` in the configuration. `access_token` in the configuration.
* `address` - (Optional) The hostname of a Terraform Enterprise instance. * `address` - (Optional) The URL of a Terraform Enterprise instance. Defaults to
(Defaults to the SaaS version of Terraform Enterprise.) the SaaS version of Terraform Enterprise, at `"https://app.terraform.io"`; if
you use a private install, provide its URL here.