andwati/zitadel
1
0
Fork 0
mirror of https://github.com/andwati/zitadel.git synced 2026-11-05 13:52:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: replace Instance Settings with Default Settings in i18n and docs (#8143)

Browse Source 
# Which Problems Are Solved

- The console shows the Instance Settings title and a description.
Instance settings should be replaced with Default settings

# How the Problems Are Solved

- The DESCRIPTIONS.SETTINGS.INSTANCE.TITLE and
DESCRIPTIONS.SETTINGS.INSTANCE.DESCRIPTION have been replaced with
Default Settings and in the corresponding translation files.

Here's a screenshot:


![image](https://github.com/zitadel/zitadel/assets/30386061/b404f209-2043-414c-b06d-3291771d54fb)

# Additional Changes

- The docs have been updated to replace remaining texts mentioning
Instance Settings with Default Settings
- Two unused texts have been deleted from the translation files
- VSCode with Prettier have applied some markdown changes

# Additional Context

- Closes #7632

---------

Co-authored-by: Fabi <[email protected]>
This commit is contained in:
Miguel Cabrerizo
2024-06-25 09:18:06 +00:00
committed by GitHub
co-authored by Fabi
parent dc170dc46e
commit 88182f98ba
22 changed files with 143 additions and 197 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/guides/integrate/login-ui/typescript-repo.mdx
+1 -1
View File
@@ -132,7 +132,7 @@ After your domain has been verified, you can reconfigure your DNS settings in or
To deploy your own version on Vercel, navigate to your instance and create a service user.
Copy its id from the overview and set it as `ZITADEL_SERVICE_USER_ID`.
Then create a personal access token (PAT), copy and set it as `ZITADEL_SERVICE_USER_TOKEN`, then navigate to your instance settings and make sure it gets `IAM_OWNER` permissions.
Then create a personal access token (PAT), copy and set it as `ZITADEL_SERVICE_USER_TOKEN`, then navigate to Default settings and make sure it gets `IAM_OWNER` permissions.
Finally set your instance url as `ZITADEL_API_URL`. Make sure to set it without trailing slash.
![Deploy to Vercel](/img/deploy-to-vercel.png)
docs/docs/guides/manage/console/default-settings.mdx
+1 -1
View File
@@ -366,4 +366,4 @@ The following secrets can be configured:
width="400px"
/>
If your done with your instance settings, you can proceed setting up your organizations. Again, make sure you get an understanding on how your project is structured and then continue.
If your done with your default settings, you can proceed setting up your organizations. Again, make sure you get an understanding on how your project is structured and then continue.
docs/docs/guides/manage/console/organizations.mdx
+5 -5
View File
@@ -71,7 +71,7 @@ ZITADEL will notify users affected by this change.
## Verify your domain name
:::info
You can also disable domain verification with DNS challenge in the [instance settings](/docs/guides/manage/console/default-settings#domain-settings).
You can also disable domain verification with DNS challenge in the [default settings](/docs/guides/manage/console/default-settings#domain-settings).
:::
1. Browse to your organization settings
@@ -100,10 +100,10 @@ Do not delete the verification code, as ZITADEL will re-check the ownership of y
## Organization Settings
In organizations you also have settings that have higher priority then on your instance, and therefore override its instance.
Those settings are the same as on your instance.
In organizations you also have settings that have higher priority than on your default settings, and therefore override them.
Those settings are the same as your default settings.
> Note: that the following links, redirect to instance settings to omit redundancy.
> Note: that the following links, redirect to default settings to omit redundancy.
- [**Login Behavior and Access**](./default-settings#login-behaviour-and-access): Multifactor Authentication Options and Enforcement, Define whether Passwordless authentication methods are allowed or not, Set Login Lifetimes and advanced behavour for the login interface.
- [**Identity Providers**](./default-settings#identity-providers): Define IDPs which are available for all organizations
@@ -135,7 +135,7 @@ Read more about the [scopes](/docs/apis/openidoauth/scopes#reserved-scopes) or t
## Default organization
On the instance settings page ($YOUR_DOMAIN//ui/console/orgs) you can set an organization as default organization.
On the Default settings page ($YOUR_DOMAIN//ui/console/orgs) you can set an organization as default organization.
Click the "..." on the right hand side of the table and select "Set as default organization".
The current default organization is marked by a label "Default".
docs/docs/guides/manage/console/overview.mdx
+2 -2
View File
@@ -21,9 +21,9 @@ Depending on your use case, multiple organizations can be created (B2B) or you c
width="400px"
/>
If your new to console, you'll probably want to set some settings initially. Continue reading instance settings on the next page.
If your new to console, you'll probably want to set some settings initially. Continue reading Default settings on the next page.
## Prevent console access
In some use cases you want to prevent users from accessing the ZITADEL management console.
Please follow this [guide](/docs/guides/solution-scenarios/restrict-console) to achieve that.
Please follow this [guide](/docs/guides/solution-scenarios/restrict-console) to achieve that.
docs/docs/guides/migrate/sources/zitadel.md
+52 -52
View File
@@ -5,22 +5,22 @@ sidebar_label: From ZITADEL
This guide explains how to migrate from ZITADEL, this includes
* ZITADEL Cloud to self-hosted
* ZITADEL self-hosted to ZITADEL Cloud
* ZITADEL v1 (deprecated) to ZITADEL v2.x
- ZITADEL Cloud to self-hosted
- ZITADEL self-hosted to ZITADEL Cloud
- ZITADEL v1 (deprecated) to ZITADEL v2.x
## Considerations
The following scripts don't include:
* Global policies
* IAM members
* Global IDPs
* Global second/multi factors
* Machine keys
* Personal Access Tokens
* Application keys
* Passwordless authentication
- Global policies
- IAM members
- Global IDPs
- Global second/multi factors
- Machine keys
- Personal Access Tokens
- Application keys
- Passwordless authentication
Which results in that if you want to import, and you have no defined organization-specific custom policies, the experience for your users will not be exactly like in your old instance.
@@ -37,7 +37,7 @@ You need a PAT from a service user with IAM Owner permissions in both the source
1. Go to your default organization
2. Create a service user "import_user" with Access Token Type "Bearer"
3. Create a [personal access token](/docs/guides/integrate/service-users/personal-access-token)
4. Go to the global instance settings
4. Go to the Default settings
5. Add the import_user as [manager](/docs/guides/manage/console/managers) with the role "IAM Owner"
Save the PAT to the environment variabel `PAT_EXPORT_TOKEN` and the source domain as `ZITADEL_EXPORT_DOMAIN` to run the following scripts.
@@ -47,7 +47,7 @@ Save the PAT to the environment variabel `PAT_EXPORT_TOKEN` and the source domai
1. Go to your default organization
2. Create a service user "export_user" with Access Token Type "Bearer"
3. Create a [personal access token](/docs/guides/integrate/service-users/personal-access-token)
4. Go to the global instance settings
4. Go to the Default settings
5. Add the export_user as [manager](/docs/guides/manage/console/managers) with the role "IAM Owner"
Save the PAT to the environment variabel `PAT_IMPORT_TOKEN` and the source domain as `ZITADEL_IMPORT_DOMAIN` to run the following scripts.
@@ -68,8 +68,8 @@ curl --request POST \
--url $ZITADEL_EXPORT_DOMAIN/admin/v1/export \
--header "Authorization: Bearer $PAT_EXPORT_TOKEN" \
--header 'Content-Type: application/json' \
--data '{
"org_ids": [ ],
--data '{
"org_ids": [ ],
"excluded_org_ids": [ ],
"with_passwords": true,
"with_otp": true,
@@ -78,14 +78,14 @@ curl --request POST \
}' -o export.json
```
| Field | Type | Description |
| --- | --- | --- |
| org_ids | list of strings | provide a list of organizationIDs to select which organizations should be exported (eg, `[ "70669144072186707", "70671105999825752" ]`); leave empty to export all |
| excluded_org_ids | list of strings | to exclude several organization, if for example no organizations are selected |
| with_passwords | bool | to include the hashed_passwords of the users in the export |
| with_otp | bool | to include the OTP-code of the users in the export |
| timeout | duration string | timeout of the call to export the data |
| response_output | bool | to output the export as response to the call |
| Field | Type | Description |
| ---------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| org_ids | list of strings | provide a list of organizationIDs to select which organizations should be exported (eg, `[ "70669144072186707", "70671105999825752" ]`); leave empty to export all |
| excluded_org_ids | list of strings | to exclude several organization, if for example no organizations are selected |
| with_passwords | bool | to include the hashed_passwords of the users in the export |
| with_otp | bool | to include the OTP-code of the users in the export |
| timeout | duration string | timeout of the call to export the data |
| response_output | bool | to output the export as response to the call |
### Import from file
@@ -106,16 +106,16 @@ curl --request POST \
}'
```
| Field | Type | Description |
| --- | --- | --- |
| timeout | duration string | timeout of the call to import the data |
| data_orgsv1 | string | data which was exported from ZITADEL V1 |
| Field | Type | Description |
| ----------- | --------------- | --------------------------------------- |
| timeout | duration string | timeout of the call to import the data |
| data_orgsv1 | string | data which was exported from ZITADEL V1 |
## Use Google Cloud Storage
### Export to GCS
:::note
:::note
To use this requests you have to have an access token with enough permissions to export and import.
The used serviceaccount has to have at least the role "Storage Object Creator" to create objects on GCS
:::
@@ -127,8 +127,8 @@ curl --request POST \
--url $ZITADEL_EXPORT_DOMAIN/admin/v1/export \
--header "Authorization: Bearer $PAT_EXPORT_TOKEN" \
--header 'Content-Type: application/json' \
--data '{
"org_ids": [ ],
--data '{
"org_ids": [ ],
"excluded_org_ids": [ ],
"with_passwords": true,
"with_otp": true,
@@ -141,21 +141,21 @@ curl --request POST \
}' -o export.json
```
| Field | Type | Description |
| --- | --- | --- |
| org_ids | list of strings | provide a list of organizationIDs to select which organizations should be exported (eg, `[ "70669144072186707", "70671105999825752" ]`); leave empty to export all |
| excluded_org_ids | list of strings | to exclude several organization, if for example no organizations are selected |
| with_passwords | bool | to include the hashed_passwords of the users in the export |
| with_otp | bool | to include the OTP-code of the users in the export |
| timeout | duration string | timeout of the call to export the data |
| gcs_output | object(data_orgsv1_gcs) | to write a file into GCS as output to the call |
| Field | Type | Description |
| ---------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| org_ids | list of strings | provide a list of organizationIDs to select which organizations should be exported (eg, `[ "70669144072186707", "70671105999825752" ]`); leave empty to export all |
| excluded_org_ids | list of strings | to exclude several organization, if for example no organizations are selected |
| with_passwords | bool | to include the hashed_passwords of the users in the export |
| with_otp | bool | to include the OTP-code of the users in the export |
| timeout | duration string | timeout of the call to export the data |
| gcs_output | object(data_orgsv1_gcs) | to write a file into GCS as output to the call |
data_orgsv1_gcs object:
data_orgsv1_gcs object:
| Field | Type | Description |
| --- | --- | --- |
| path | string | path to the output file on GCS |
| bucket | string | used bucket for output on GCS |
| Field | Type | Description |
| ------------------- | ------ | ----------------------------------------------------------------- |
| path | string | path to the output file on GCS |
| bucket | string | used bucket for output on GCS |
| serviceaccount_json | string | base64-encoded serviceaccount.json used to output the file on GCS |
### Import to GCS
@@ -182,15 +182,15 @@ curl --request POST \
}'
```
| Field | Type | Description |
| --- | --- | --- |
| timeout | duration string | timeout of the call to import the data |
| data_orgsv1_gcs | object(data_orgsv1_gcs) | to read the export from GCS directly |
| Field | Type | Description |
| --------------- | ----------------------- | -------------------------------------- |
| timeout | duration string | timeout of the call to import the data |
| data_orgsv1_gcs | object(data_orgsv1_gcs) | to read the export from GCS directly |
data_orgsv1_gcs object:
| Field | Type | Description |
| --- | --- | --- |
| path | string | path to the exported file on GCS |
| bucket | string | used bucket to read from GCS |
| serviceaccount_json | string | base64-encoded serviceaccount.json used to read the file from GCS|
| Field | Type | Description |
| ------------------- | ------ | ----------------------------------------------------------------- |
| path | string | path to the exported file on GCS |
| bucket | string | used bucket to read from GCS |
| serviceaccount_json | string | base64-encoded serviceaccount.json used to read the file from GCS |