docs: update custom domain guide for customer portal (#11691)

This PR fixes some issues on the custom domain guide for the customer
portal

---------

Co-authored-by: Copilot <[email protected]>
This commit is contained in:
Federico Coppede
2026-02-25 21:59:22 +00:00
committed by GitHub
co-authored by Copilot
parent 3b74b86dc4
commit ed48fbfbcd
4 changed files with 13 additions and 7 deletions
@@ -67,26 +67,32 @@ You can also upgrade manually at any time.
We recommend register a Custom Domain to access your ZITADEL instance.
The primary Custom Domain of your ZITADEL instance will be the issuer of the instance. All other Custom Domains can be used to access the instance itself
1. Browse to the "Custom Domains" Tab
2. Click **Add Custom Domain**
3. Enter the domain you want and select the instance where the domain should belong to
4. In the next screen you will get all the information you will have to add to your DNS provider to verify your domain
1. Browse to the "Instances" Tab
2. Click on the instance box to open the instance detailed view
3. Scroll down to the **Custom Domains** section
4. Click on **+ Add Custom Domain**
5. Enter the domain you want
6. In the next screen you will get all the information you will have to add to your DNS provider to verify your domain
> **_Please note:_** Do not delete the verification code, as ZITADEL Customer Portal will re-check the ownership of your domain from time to time
![Select Instance](../../../../public/img/manuals/portal/customer_portal_select_instance.png)
![Add Custom Domain](../../../../public/img/manuals/portal/customer_portal_add_domain.png)
Be aware that it has some impacts if you change the primary domain of your instance.
1. The urls and issuer have to change in your app
2. Passkey authentication is based on the domain, if you change it, your users will not be able to login with the registered passkey authentication
![Add Custom Domain](../../../../public/img/manuals/portal/customer_portal_add_domain.png)
#### Verify Custom Domain
As soon as you have added your Custom Domain you will have to verify it, by adding a CNAME record to your DNS provider.
![Verify Custom Domain](../../../../public/img/manuals/portal/customer_portal_verify_domain.png)
1. Go to your DNS provider
2. Add a new CNAME record (You can find the target on the detail page of your instance)
3. After adding the CNAME you need to wait till the domain is verified (this can take some time)
> **_Please note:_** Do not delete the verification code, as ZITADEL Customer Portal will re-check the ownership of your domain periodically.
You will now be able to use the added Custom Domain to access your ZITADEL instance
Binary file not shown.

Before

Width:  |  Height:  |  Size: 302 KiB

After

Width:  |  Height:  |  Size: 394 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 366 KiB