TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-08-12 00:27:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: clarify instances in steps and config (#4003)

Browse Source 
* fix: clarify instances in steps and config

* docs: update setup step

Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>
Co-authored-by: Livio Amstutz <livio.a@gmail.com>
This commit is contained in:
Silvan
2022-07-27 10:22:20 +02:00
committed by GitHub
parent 5bd9badbcf
commit 0b742233f9
12 changed files with 28 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/docs/guides/installation/configure/_linuxunix.mdx
View File

@@ -47,8 +47,8 @@ zitadel start-from-init \
export ZITADEL_DATABASE_HOST="my.database"
export ZITADEL_DATABASE_USER_USERNAME="my_zitadel_db_user"
export ZITADEL_DATABASE_USER_PASSWORD="Secret_DB_User_Password"
export ZITADEL_S3DEFAULTINSTANCE_ORG_HUMAN_USERNAME="root"
export ZITADEL_S3DEFAULTINSTANCE_ORG_HUMAN_PASSWORD="RootPassword1!"
export ZITADEL_FIRSTINSTANCE_ORG_HUMAN_USERNAME="root"
export ZITADEL_FIRSTINSTANCE_ORG_HUMAN_PASSWORD="RootPassword1!"
# A single ZITADEL instance always needs the same 32 characters long masterkey
# If you haven't done so already, you can generate a new one

2
docs/docs/guides/installation/configure/configure.mdx
View File

@@ -32,7 +32,7 @@ Other configration that contains information like your databases admin username
All configuration properties are also configurable via environemnt variables.
Prefix the key with *ZITADEL\_*, uppercase the propery and join sections by an underscore _.
For example, if you want to configure the default ZITADEL IAM admin username and password, make sure the ZITADEL binary runtime has the variables *ZITADEL_S3DEFAULTINSTANCE_ORG_HUMAN_USERNAME* and *ZITADEL_S3DEFAULTINSTANCE_ORG_HUMAN_PASSWORD* set.
For example, if you want to configure the default ZITADEL IAM admin username and password, make sure the ZITADEL binary runtime has the variables *ZITADEL_FIRSTINSTANCE_ORG_HUMAN_USERNAME* and *ZITADEL_FIRSTINSTANCE_ORG_HUMAN_PASSWORD* set.
## Masterkey

2
docs/docs/guides/installation/configure/example-zitadel-init-steps.yaml
View File

@@ -1,5 +1,5 @@
# All possible options and their defaults: https://github.com/zitadel/zitadel/blob/v2-alpha/cmd/adminn/setup/steps.yaml
S3DefaultInstance:
FirstInstance:
Org:
Human:
# use the loginname root@zitadel.localhost

2
docs/docs/guides/installation/configure/example-zitadel-values.yaml
View File

@@ -9,7 +9,7 @@ zitadel:
ExternalDomain: localhost
# the configmap is also passed to the zitadel binary via the --steps flag
S3DefaultInstance:
FirstInstance:
Org:
Human:
# use the loginname root@zitadel.localhost

9
docs/docs/guides/installation/custom-domain.md
View File

@@ -22,13 +22,8 @@ ExternalPort: 443
## Database Initialization Steps Config
ZITADEL creates random subdomains for each instance created.
However, for the default instance, this is most probably not the desired behavior.
You can give the default instance a fixed custom domain here.
```yaml
S3DefaultInstance:
CustomDomain: 'zitadel.my.domain'
```
However, for the first instance, this is most probably not the desired behavior.
In this case the `ExternalDomain`-field of the configuration is used.
## Example

3
docs/docs/guides/installation/loadbalancing-example/example-zitadel-init-steps.yaml
View File

@@ -1,6 +1,5 @@
# All possible options and their defaults: https://github.com/zitadel/zitadel/blob/v2-alpha/cmd/adminn/setup/steps.yaml
S3DefaultInstance:
CustomDomain: my.domain
FirstInstance:
Org:
Name: 'My Org'
Human:

1
docs/docs/guides/installation/run/_knative.mdx
View File

@@ -42,7 +42,6 @@ kn service create zitadel \
--env ZITADEL_EXTERNALPORT=80 \
--env ZITADEL_TLS_ENABLED=false \
--env ZITADEL_EXTERNALDOMAIN=zitadel.default.127.0.0.1.sslip.io \
--env ZITADEL_S3DEFAULTINSTANCE_CUSTOMDOMAIN=zitadel.default.127.0.0.1.sslip.io \
--arg "start-from-init" --arg "--masterkey" --arg "MasterkeyNeedsToHave32Characters"
```