Skip to content

Commit 6bfd3ec

Browse files
committed
docs(portal): use config keys as primary in domain config table
Prefer config key names (linked to config reference) over env var names in the configuration table, with env var listed inline per column.
1 parent 0ceba25 commit 6bfd3ec

1 file changed

Lines changed: 6 additions & 8 deletions

File tree

portal/install/custom-domain.mdx

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,14 @@ Configuring a custom domain involves three steps:
3030

3131
## Configure the Portal Domain
3232

33-
Two environment variables control custom domain behavior:
33+
Two configuration keys control custom domain behavior:
3434

35-
| Environment Variable | Description |
36-
| :---------------------------- | :------------------------------------------------------------------------------------------ |
37-
| `PORTAL_DOMAIN_ENABLE_CUSTOM` | Enables custom domain support. Set to `true`. |
38-
| `PORTAL_DOMAIN_DEFAULT` | The domain consumers use to access the Live Portal, for example `developers.mycompany.com`. |
35+
| Config Key | Description |
36+
| :--------- | :---------- |
37+
| [`Domain.EnableCustomDomains`](/product-stack/tyk-enterprise-developer-portal/deploy/configuration) | Enables custom domain support. Set to `true`. Env var: `PORTAL_DOMAIN_ENABLE_CUSTOM`. |
38+
| [`Domain.DefaultDomain`](/product-stack/tyk-enterprise-developer-portal/deploy/configuration) | The domain consumers use to access the Live Portal, for example `developers.mycompany.com`. Env var: `PORTAL_DOMAIN_DEFAULT`. |
3939

40-
For the equivalent config file keys, see the [configuration reference](/product-stack/tyk-enterprise-developer-portal/deploy/configuration).
41-
42-
Add these variables to your Portal configuration. For how to pass environment variables in your deployment type, see the install guide for [Docker](/portal/install/docker), [Kubernetes](/portal/install/kubernetes), or [Linux](/portal/install/linux).
40+
Add these to your Portal configuration. For how to pass environment variables in your deployment type, see the install guide for [Docker](/portal/install/docker), [Kubernetes](/portal/install/kubernetes), or [Linux](/portal/install/linux).
4341

4442
```ini
4543
PORTAL_DOMAIN_ENABLE_CUSTOM=true

0 commit comments

Comments
 (0)