Skip to content

Commit 5cf70f8

Browse files
committed
docs(portal): add domain config keys to reference and anchor links in B16
- Add PORTAL_DOMAIN_ENABLE_CUSTOM and PORTAL_DOMAIN_DEFAULT entries to the configuration reference with type, config file key, and description - Update B16 config table links to point directly to those anchors
1 parent 6bfd3ec commit 5cf70f8

2 files changed

Lines changed: 12 additions & 2 deletions

File tree

portal/install/custom-domain.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ Two configuration keys control custom domain behavior:
3434

3535
| Config Key | Description |
3636
| :--------- | :---------- |
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`. |
37+
| [`Domain.EnableCustomDomains`](/product-stack/tyk-enterprise-developer-portal/deploy/configuration#portal-domain-enable-custom) | Enables custom domain support. Set to `true`. Env var: `PORTAL_DOMAIN_ENABLE_CUSTOM`. |
38+
| [`Domain.DefaultDomain`](/product-stack/tyk-enterprise-developer-portal/deploy/configuration#portal-domain-default) | The domain consumers use to access the Live Portal, for example `developers.mycompany.com`. Env var: `PORTAL_DOMAIN_DEFAULT`. |
3939

4040
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).
4141

product-stack/tyk-enterprise-developer-portal/deploy/configuration.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,16 @@ You can specify any string value in this setting. Omit this setting if you don't
285285
**Type:** `string` <br/>
286286
**Description**: Redirects the portal login page to a custom SSO login URL. When set, GET requests to `/auth/password/login` are automatically redirected to this URL, and the portal's "Log in" button points to it. This is useful when using an Identity Provider (IDP) based login/SSO profile, as it allows you to bypass the default portal password login page and direct users to your external IDP login page instead. This setting only affects the login page redirect; user registration and password reset pages remain unchanged.
287287

288+
### PORTAL_DOMAIN_ENABLE_CUSTOM
289+
**Config file:** Domain.EnableCustomDomains <br/>
290+
**Type:** `boolean` <br/>
291+
**Description**: Enables custom domain support for the Developer Portal. When set to `true`, the portal uses the domain specified in `PORTAL_DOMAIN_DEFAULT` as the public-facing URL for the Live Portal instead of inferring it from incoming request headers. The default value is `false`.
292+
293+
### PORTAL_DOMAIN_DEFAULT
294+
**Config file:** Domain.DefaultDomain <br/>
295+
**Type:** `string` <br/>
296+
**Description**: The custom domain that API consumers use to access the Live Portal, for example `developers.mycompany.com`. This setting takes effect only when `PORTAL_DOMAIN_ENABLE_CUSTOM` is set to `true`.
297+
288298
## Response Headers Configuration
289299
This section explains how to configure custom HTTP response headers that will be added to all responses from the Portal.
290300

0 commit comments

Comments
 (0)