replace instance domain

This commit is contained in:
Maximilian Panne
2025-08-01 11:06:42 +02:00
parent 00b0af4368
commit f2d0eb6233
12 changed files with 15 additions and 14 deletions

View File

@@ -24,7 +24,7 @@ Not all request parameters are available in the playground. Please refer to the
### Your Domain ### Your Domain
The <span className="text-yellow-500">Instance Domain</span> to your ZITADEL instance. Use the base-path, the playground will add the required path to the request. The <span className="text-yellow-500">Custom Domain</span> to your ZITADEL instance. Use the base-path, the playground will add the required path to the request.
### Required Parameters ### Required Parameters

View File

@@ -122,7 +122,7 @@ https://github.com/zitadel/zitadel-go/blob/next/example/app/templates/profile.ht
### Start your application ### Start your application
You will need to provide some values for the program to run: 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. - `key`: Random secret string. Used for symmetric encryption of state parameters, cookies and PCKE.
- `clientID`: The clientID provided by ZITADEL - `clientID`: The clientID provided by ZITADEL
- `redirectURI`: The redirectURI registered at ZITADEL - `redirectURI`: The redirectURI registered at ZITADEL

View File

@@ -375,7 +375,7 @@ OIDC_CLIENT_ID="248680248240075805@dev"
OIDC_CLIENT_SECRET="BJPhEJULSUXseC4geqg5Yg4wWMoy7RgZKar86mbIpt8ZekC5kixMzYGcXLDeeJv7" 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: Activate the route that is used as callback by the OIDC bundle:

View File

@@ -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: 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 - `key`: The path to the downloaded key.json
- `port`: The port on which the API will be accessible, default it 8089 - `port`: The port on which the API will be accessible, default it 8089

View File

@@ -179,7 +179,8 @@ class ZitadelIntrospectTokenValidator(IntrospectTokenValidator):
res = self.introspect_token(*args, **kwargs) res = self.introspect_token(*args, **kwargs)
return res 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 ```python
ZITADEL_DOMAIN = "https://your-domain-abcdef.zitadel.cloud" ZITADEL_DOMAIN = "https://your-domain-abcdef.zitadel.cloud"

View File

@@ -180,7 +180,7 @@ Your contributions will play a crucial role in shaping the future of our login s
#### Step-by-step Guide #### 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://<YOUR_ZITADEL_INSTANCE_DOMAIN>/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://<YOUR_ZITADEL_INSTANCE_DOMAIN>/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. **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.

View File

@@ -39,7 +39,7 @@ Download the public certificate from your ZITADEL instance by requesting `$YOUR_
wget $YOUR_DOMAIN/saml/v2/certificate -O idp.crt 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 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 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 Use the following configuration

View File

@@ -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). 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. 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. With that you can ensure that users receive notifications from the same domain that is used for login.
### Use email as username ### Use email as username

View File

@@ -5,7 +5,7 @@ sidebar_label: Overview
## What is console? ## 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. The console is used to configure global default settings and can be used by multiple Managers.
Read more about [Console Managers](./managers) here. Read more about [Console Managers](./managers) here.

View File

@@ -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): 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 [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) - [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)) - Security settings ([IFrame policy](/docs/guides/solution-scenarios/configurations#embedding-zitadel-in-an-iframe))
- Limits[^2] - Limits[^2]

View File

@@ -196,7 +196,7 @@ export function SetAuthRequest() {
</div> </div>
<div className="flex flex-col"> <div className="flex flex-col">
<label className={`${labelClasses} text-yellow-500`}> <label className={`${labelClasses} text-yellow-500`}>
Instance Domain Custom Domain
</label> </label>
<input <input
className={inputClasses(false)} className={inputClasses(false)}

View File

@@ -39,7 +39,7 @@ export function SetEnvironment() {
return ( return (
<div> <div>
<div className={styles.inputwrapper}> <div className={styles.inputwrapper}>
<label className={styles.label}>Your instance domain</label> <label className={styles.label}>Your custom domain</label>
<input <input
className={styles.input} className={styles.input}
id="instance" id="instance"