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

docs: clearer masterkey, config iam admin (#3670)

Browse Source 
Co-authored-by: Florian Forster <florian@caos.ch>
This commit is contained in:
Elio Bischof
2022-05-19 15:59:11 +02:00
committed by GitHub
parent a95b1ab3d0
commit a5cea82670
6 changed files with 15 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
deploy/compose/docker-compose.yml
View File

@@ -6,9 +6,8 @@ services:
networks: networks:
- zitadel - zitadel
image: ghcr.io/zitadel/zitadel:v2.0.0-v2-alpha.3-amd64 image: ghcr.io/zitadel/zitadel:v2.0.0-v2-alpha.3-amd64
command: admin start-from-init --masterkeyFromEnv command: admin start-from-init --masterkey "MasterkeyNeedsToHave32Characters"
environment: environment:
- ZITADEL_MASTERKEY=${ZITADEL_MASTERKEY}
- ZITADEL_DATABASE_HOST=db - ZITADEL_DATABASE_HOST=db
- ZITADEL_EXTERNALSECURE=false - ZITADEL_EXTERNALSECURE=false
- ZITADEL_DEFAULTINSTANCE_CUSTOMDOMAIN=localhost - ZITADEL_DEFAULTINSTANCE_CUSTOMDOMAIN=localhost

3
docs/docs/guides/installation/compose.mdx
View File

@@ -1,7 +1,4 @@
```bash ```bash
# Generate a master encryption key
export ZITADEL_MASTERKEY="$(tr -dc A-Za-z0-9 </dev/urandom | head -c 32)"
# Download the docker compose example configuration # Download the docker compose example configuration
wget https://raw.githubusercontent.com/zitadel/zitadel/v2-alpha/deploy/compose/docker-compose.yml wget https://raw.githubusercontent.com/zitadel/zitadel/v2-alpha/deploy/compose/docker-compose.yml

18
docs/docs/guides/installation/configuration.mdx
View File

@@ -6,11 +6,11 @@ You can overwrite these values using environment variables or configuration file
### Configure by environment variables ### Configure by environment variables
Prefix the key with *ZITADEL\_*, uppercase the propery and join sections by an underscore _. Prefix the key with *ZITADEL\_*, uppercase the propery and join sections by an underscore _.
For example, if you want to configure the cockroach admin user name and password, export these two variables. For example, if you want to configure the default ZITADEL IAM admin username and password, export these two variables.
```bash ```bash
export ZITADEL_ADMINUSER_USERNAME="my_root_users_name" export ZITADEL_DEFAULTINSTANCE_HUMAN_USERNAME="root"
export ZITADEL_ADMINUSER_PASSWORD="my_root_users_password" export ZITADEL_DEFAULTINSTANCE_HUMAN_PASSWORD="RootPassword1!"
``` ```
### Configure by configuration files ### Configure by configuration files
@@ -21,16 +21,18 @@ Fortunately, you can pass multiple configuration files to the zitadel command.
```bash ```bash
# Create a configuration file containing normal configuration # Create a configuration file containing normal configuration
cat << EOF > ./zitadel-config.yaml cat << EOF > ./zitadel-config.yaml
AdminUser: DefaultInstance:
Username: my_root_users_name Human:
Username: root
EOF EOF
# Create a configuration file containing secrets # Create a configuration file containing secrets
cat << EOF > ./zitadel-secrets.yaml cat << EOF > ./zitadel-secrets.yaml
AdminUser: DefaultInstance:
Password: "my_root_users_password" Human:
Password: RootPassword1!
EOF EOF
# Pass multiple config files using the --config argument # Pass multiple config files using the --config argument
zitadel admin start-from-init --masterkeyFromEnv --config ./zitadel-config.yaml --config ./zitadel-secrets.yaml zitadel admin start-from-init --config ./zitadel-config.yaml --config ./zitadel-secrets.yaml --masterkey "MasterkeyNeedsToHave32Characters"
``` ```

3
docs/docs/guides/installation/linux.mdx
View File

@@ -11,7 +11,6 @@ cockroach start-single-node --insecure --background --http-addr :9090
# Configure your environment # Configure your environment
# Generate a master encryption key # Generate a master encryption key
export ZITADEL_MASTERKEY="$(tr -dc A-Za-z0-9 </dev/urandom | head -c 32)"
export ZITADEL_EXTERNALSECURE=false export ZITADEL_EXTERNALSECURE=false
export ZITADEL_EXTERNALDOMAIN=localhost export ZITADEL_EXTERNALDOMAIN=localhost
export ZITADEL_DEFAULTINSTANCE_CUSTOMDOMAIN=localhost export ZITADEL_DEFAULTINSTANCE_CUSTOMDOMAIN=localhost
@@ -20,5 +19,5 @@ export ZITADEL_DEFAULTINSTANCE_CUSTOMDOMAIN=localhost
curl -s https://api.github.com/repos/zitadel/zitadel/releases/tags/v2.0.0-v2-alpha.3 | grep "browser_download_url.*zitadel_.*_linux_$(dpkg --print-architecture)" | cut -d '"' -f 4 | sudo wget -i - -O /usr/local/bin/zitadel && sudo chmod +x /usr/local/bin/zitadel && sudo chown $(id -u):$(id -g) /usr/local/bin/zitadel curl -s https://api.github.com/repos/zitadel/zitadel/releases/tags/v2.0.0-v2-alpha.3 | grep "browser_download_url.*zitadel_.*_linux_$(dpkg --print-architecture)" | cut -d '"' -f 4 | sudo wget -i - -O /usr/local/bin/zitadel && sudo chmod +x /usr/local/bin/zitadel && sudo chown $(id -u):$(id -g) /usr/local/bin/zitadel
# Run the database and application containers # Run the database and application containers
zitadel admin start-from-init --masterkeyFromEnv zitadel admin start-from-init --masterkey "MasterkeyNeedsToHave32Characters"
``` ```

3
docs/docs/guides/installation/macos.mdx
View File

@@ -11,7 +11,6 @@ cockroach start-single-node --insecure --background --http-addr :9090
# Configure your environment # Configure your environment
# Generate a master encryption key # Generate a master encryption key
export ZITADEL_MASTERKEY="$(tr -dc A-Za-z0-9 </dev/urandom | head -c 32)"
export ZITADEL_EXTERNALSECURE=false export ZITADEL_EXTERNALSECURE=false
export ZITADEL_EXTERNALDOMAIN=localhost export ZITADEL_EXTERNALDOMAIN=localhost
export ZITADEL_DEFAULTINSTANCE_CUSTOMDOMAIN=localhost export ZITADEL_DEFAULTINSTANCE_CUSTOMDOMAIN=localhost
@@ -21,5 +20,5 @@ export MY_ARCHITECTURE="arm64"
curl -s https://api.github.com/repos/zitadel/zitadel/releases/tags/v2.0.0-v2-alpha.3 | grep "browser_download_url.*zitadel_.*_darwin_${MY_ARCHITECTURE}" | cut -d '"' -f 4 | sudo wget -i - -O /usr/local/bin/zitadel && sudo chmod +x /usr/local/bin/zitadel && sudo chown $(id -u):$(id -g) /usr/local/bin/zitadel curl -s https://api.github.com/repos/zitadel/zitadel/releases/tags/v2.0.0-v2-alpha.3 | grep "browser_download_url.*zitadel_.*_darwin_${MY_ARCHITECTURE}" | cut -d '"' -f 4 | sudo wget -i - -O /usr/local/bin/zitadel && sudo chmod +x /usr/local/bin/zitadel && sudo chown $(id -u):$(id -g) /usr/local/bin/zitadel
# Run the database and application containers # Run the database and application containers
zitadel admin start-from-init --masterkeyFromEnv zitadel admin start-from-init --masterkey "MasterkeyNeedsToHave32Characters"
``` ```

3
docs/docs/guides/installation/openlocal.mdx
View File

@@ -1,4 +1,5 @@
Open your favorite internet browser and navigate to [http://localhost:8080/ui/console](http://localhost:8080/ui/console). Open your favorite internet browser and navigate to [http://localhost:8080/ui/console](http://localhost:8080/ui/console).
Log in as default admin user: If you didn't configure something else, this is the default IAM admin users login:
- **username**: *zitadel-admin@<span></span>zitadel.localhost* - **username**: *zitadel-admin@<span></span>zitadel.localhost*
- **password**: *Password1!* - **password**: *Password1!*
If you configured a different username, replace the substring zitadel-admin above by the username you configured.