You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(portal): apply review learnings to B16 custom domain page
- Remove Config Key column from domain variables table (env vars only per learning 21)
- Add SSO doc links in verify step and troubleshooting accordion (learning 3.2)
|`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`. |
39
+
40
+
For the equivalent config file keys, see the [configuration reference](/product-stack/tyk-enterprise-developer-portal/deploy/configuration).
39
41
40
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).
41
43
@@ -145,7 +147,7 @@ After restarting the Portal with the updated configuration:
145
147
146
148
{/* TODO: Screenshot — Live Portal home page loading on the custom domain with a valid padlock in the browser address bar */}
147
149
148
-
3.**Test SSO (if configured).** Log in through your identity provider and confirm the callback URL resolves correctly on your custom domain.
150
+
3.**Test SSO (if configured).** Log in through your identity provider and confirm the callback URL resolves correctly on your custom domain. See [Single Sign On](/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/enable-sso) for SSO configuration details.
149
151
150
152
## Update the Custom Domain on an Existing Installation
151
153
@@ -166,7 +168,7 @@ To change the custom domain after the initial setup:
166
168
Confirm that `PORTAL_DOMAIN_ENABLE_CUSTOM` is set to `true` and that `PORTAL_DOMAIN_DEFAULT` is set to your custom domain. Restart the Portal after making any changes to environment variables.
167
169
</Accordion>
168
170
<Accordiontitle="SSO callbacks or email links use the wrong host or scheme">
169
-
The Portal constructs base URLs from the `X-Forwarded-Host` and `X-Forwarded-Proto` headers. If these headers are missing or set incorrectly, callbacks and links will use the wrong host or scheme. Check that your reverse proxy sets both headers on every request.
171
+
The Portal constructs base URLs from the `X-Forwarded-Host` and `X-Forwarded-Proto` headers. If these headers are missing or set incorrectly, callbacks and links will use the wrong host or scheme. Check that your reverse proxy sets both headers on every request. See [Single Sign On](/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/enable-sso) for SSO configuration details.
170
172
</Accordion>
171
173
<Accordiontitle="All users are locked out after login attempts">
172
174
This occurs when `X-Forwarded-For` is not forwarded by the reverse proxy. Without this header, the Portal treats all requests as coming from the proxy IP address and applies rate limits globally. Add `proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;` to your proxy configuration and restart nginx.
0 commit comments