From f2d0eb6233dd739c58dd3fca9275fbaa8c14b7bb Mon Sep 17 00:00:00 2001 From: Maximilian Panne Date: Fri, 1 Aug 2025 11:06:42 +0200 Subject: [PATCH] replace instance domain --- docs/docs/apis/openidoauth/authrequest.mdx | 2 +- docs/docs/examples/login/go.md | 2 +- docs/docs/examples/login/symfony.md | 2 +- docs/docs/examples/secure-api/go.md | 2 +- docs/docs/examples/secure-api/python-flask.mdx | 3 ++- docs/docs/guides/integrate/login/hosted-login.mdx | 2 +- docs/docs/guides/integrate/services/google-workspace.md | 4 ++-- docs/docs/guides/manage/console/default-settings.mdx | 4 ++-- docs/docs/guides/manage/console/overview.mdx | 2 +- docs/docs/self-hosting/manage/cache.md | 2 +- docs/src/components/authrequest.jsx | 2 +- docs/src/components/environment.jsx | 2 +- 12 files changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/docs/apis/openidoauth/authrequest.mdx b/docs/docs/apis/openidoauth/authrequest.mdx index c3be807ab1..95fdd6713b 100644 --- a/docs/docs/apis/openidoauth/authrequest.mdx +++ b/docs/docs/apis/openidoauth/authrequest.mdx @@ -24,7 +24,7 @@ Not all request parameters are available in the playground. Please refer to the ### Your Domain -The Instance Domain to your ZITADEL instance. Use the base-path, the playground will add the required path to the request. +The Custom Domain to your ZITADEL instance. Use the base-path, the playground will add the required path to the request. ### Required Parameters diff --git a/docs/docs/examples/login/go.md b/docs/docs/examples/login/go.md index ae24148952..ed4f9ba61f 100644 --- a/docs/docs/examples/login/go.md +++ b/docs/docs/examples/login/go.md @@ -122,7 +122,7 @@ https://github.com/zitadel/zitadel-go/blob/next/example/app/templates/profile.ht ### Start your application You will need to provide some values for the program to run: -- `domain`: Your ZITADEL instance domain, e.g. my-domain.zitadel.cloud +- `domain`: Your ZITADEL custom domain, e.g. my-domain.zitadel.cloud - `key`: Random secret string. Used for symmetric encryption of state parameters, cookies and PCKE. - `clientID`: The clientID provided by ZITADEL - `redirectURI`: The redirectURI registered at ZITADEL diff --git a/docs/docs/examples/login/symfony.md b/docs/docs/examples/login/symfony.md index 1856e68df5..8e5fd43b9c 100644 --- a/docs/docs/examples/login/symfony.md +++ b/docs/docs/examples/login/symfony.md @@ -375,7 +375,7 @@ OIDC_CLIENT_ID="248680248240075805@dev" OIDC_CLIENT_SECRET="BJPhEJULSUXseC4geqg5Yg4wWMoy7RgZKar86mbIpt8ZekC5kixMzYGcXLDeeJv7" ``` -> The well-known URL needs to be adjusted to your own instance domain. +> The well-known URL needs to be adjusted to your own custom domain. Activate the route that is used as callback by the OIDC bundle: diff --git a/docs/docs/examples/secure-api/go.md b/docs/docs/examples/secure-api/go.md index 7c1db14cf2..66d1f2d070 100644 --- a/docs/docs/examples/secure-api/go.md +++ b/docs/docs/examples/secure-api/go.md @@ -98,7 +98,7 @@ https://github.com/zitadel/zitadel-go/blob/next/example/api/http/main.go ``` You will need to provide some values for the program to run: -- `domain`: Your ZITADEL instance domain, e.g. https://my-domain.zitadel.cloud +- `domain`: Your ZITADEL custom domain, e.g. https://my-domain.zitadel.cloud - `key`: The path to the downloaded key.json - `port`: The port on which the API will be accessible, default it 8089 diff --git a/docs/docs/examples/secure-api/python-flask.mdx b/docs/docs/examples/secure-api/python-flask.mdx index 798dfe5f1e..ce2f83c40f 100644 --- a/docs/docs/examples/secure-api/python-flask.mdx +++ b/docs/docs/examples/secure-api/python-flask.mdx @@ -179,7 +179,8 @@ class ZitadelIntrospectTokenValidator(IntrospectTokenValidator): res = self.introspect_token(*args, **kwargs) return res ``` -3. Create a new file named ".env" in the directory. Copy the configuration in the [".env.example"](https://github.com/zitadel/example-api-python3-flask/blob/main/.env.example) file to the newly created .env file. Set the values with your Instance Domain/Issuer URL, Client ID, and Client Secret from the previous steps. Obtain your Issuer URL by following [these steps](/docs/guides/start/quickstart#referred1). + +3. Create a new file named ".env" in the directory. Copy the configuration in the [".env.example"](https://github.com/zitadel/example-api-python3-flask/blob/main/.env.example) file to the newly created .env file. Set the values with your Custom Domain/Issuer URL, Client ID, and Client Secret from the previous steps. Obtain your Issuer URL by following [these steps](/docs/guides/start/quickstart#referred1). ```python ZITADEL_DOMAIN = "https://your-domain-abcdef.zitadel.cloud" diff --git a/docs/docs/guides/integrate/login/hosted-login.mdx b/docs/docs/guides/integrate/login/hosted-login.mdx index 09fb86f8f0..121fb5fe5f 100644 --- a/docs/docs/guides/integrate/login/hosted-login.mdx +++ b/docs/docs/guides/integrate/login/hosted-login.mdx @@ -180,7 +180,7 @@ Your contributions will play a crucial role in shaping the future of our login s #### Step-by-step Guide -**Trying out the new login:** To preview the new login without changing your current setup, the easiest way is to visit `https:///ui/v2/login` on your Zitadel Cloud instance domain. You can also activate the v2 login for your apps, so users are redirected to `/ui/v2/login` for authentication. +**Trying out the new login:** To preview the new login without changing your current setup, the easiest way is to visit `https:///ui/v2/login` on your Zitadel Cloud custom domain. You can also activate the v2 login for your apps, so users are redirected to `/ui/v2/login` for authentication. **Customizing the new login:** The easiest way to actually customizing it is to fork the https://github.com/zitadel/typescript repo and use the "Deploy" button to run your code on Vercel. diff --git a/docs/docs/guides/integrate/services/google-workspace.md b/docs/docs/guides/integrate/services/google-workspace.md index 14c9aba524..e3f7259ada 100644 --- a/docs/docs/guides/integrate/services/google-workspace.md +++ b/docs/docs/guides/integrate/services/google-workspace.md @@ -39,7 +39,7 @@ Download the public certificate from your ZITADEL instance by requesting `$YOUR_ wget $YOUR_DOMAIN/saml/v2/certificate -O idp.crt ``` -Always replace `$YOUR_DOMAIN` with your instance domain. +Always replace `$YOUR_DOMAIN` with your custom domain. Use the following configuration @@ -125,7 +125,7 @@ Download the public certificate from your ZITADEL instance by requesting `$YOUR_ wget $YOUR_DOMAIN/saml/v2/certificate -O idp.crt ``` -Always replace `$YOUR_DOMAIN` with your instance domain. +Always replace `$YOUR_DOMAIN` with your custom domain. Use the following configuration diff --git a/docs/docs/guides/manage/console/default-settings.mdx b/docs/docs/guides/manage/console/default-settings.mdx index f255d15d93..941268c549 100644 --- a/docs/docs/guides/manage/console/default-settings.mdx +++ b/docs/docs/guides/manage/console/default-settings.mdx @@ -268,9 +268,9 @@ If this is enabled all created domains on an organization must be verified per d More about how to verify a domain [here](/guides/manage/console/organizations#domain-verification-and-primary-domain). If it is set to false, all registered domain will automatically be created as verified and the users will be able to use the domain for login. -### SMTP Sender Address matches Instance Domain +### SMTP Sender Address matches Custom Domain -If enabled, the SMTP server address must match the instance's primary domain. +If enabled, the SMTP server address must match the instance's primary custom domain. With that you can ensure that users receive notifications from the same domain that is used for login. ### Use email as username diff --git a/docs/docs/guides/manage/console/overview.mdx b/docs/docs/guides/manage/console/overview.mdx index 665e3b21e1..9c81062a8c 100644 --- a/docs/docs/guides/manage/console/overview.mdx +++ b/docs/docs/guides/manage/console/overview.mdx @@ -5,7 +5,7 @@ sidebar_label: Overview ## What is console? -Console is the Dashboard UI for your instance. It can be accessed from all configured instance domains, defined in the Customer Portal. +Console is the Dashboard UI for your instance. It can be accessed from all configured custom domains, defined in the Customer Portal. The console is used to configure global default settings and can be used by multiple Managers. Read more about [Console Managers](./managers) here. diff --git a/docs/docs/self-hosting/manage/cache.md b/docs/docs/self-hosting/manage/cache.md index 32973d5586..0d8293911a 100644 --- a/docs/docs/self-hosting/manage/cache.md +++ b/docs/docs/self-hosting/manage/cache.md @@ -161,7 +161,7 @@ Caches: All HTTP and gRPC requests sent to ZITADEL receive an instance context. The instance is usually resolved by the domain from the request. In some cases, like the [system service](/docs/apis/resources/system/system-service), the instance can be resolved by its ID. An instance object contains many of the [default settings](/docs/guides/manage/console/default-settings): - Instance [features](/docs/guides/manage/console/default-settings#features) -- Instance domains: generated and [custom](/docs/guides/manage/cloud/instances#add-custom-domain) +- Custom domains: generated and [custom](/docs/guides/manage/cloud/instances#add-custom-domain) - [Trusted domains](/docs/apis/resources/admin/admin-service-add-instance-trusted-domain) - Security settings ([IFrame policy](/docs/guides/solution-scenarios/configurations#embedding-zitadel-in-an-iframe)) - Limits[^2] diff --git a/docs/src/components/authrequest.jsx b/docs/src/components/authrequest.jsx index 82ecc91337..41d43652fb 100644 --- a/docs/src/components/authrequest.jsx +++ b/docs/src/components/authrequest.jsx @@ -196,7 +196,7 @@ export function SetAuthRequest() {
- +