make the docs more transparent

This commit is contained in:
Elio Bischof 2022-06-15 11:39:09 +02:00
parent 96e17e32ab
commit e2ef825122
No known key found for this signature in database
GPG Key ID: 7B383FDE4DDBF1BD
15 changed files with 71 additions and 45 deletions

View File

@ -1,3 +1,9 @@
You will need to download the following files:
- [docker-compose.yaml](./docker-compose.yaml)
- [example-zitadel-config.yaml](./example-zitadel-config.yaml)
- [example-zitadel-secrets.yaml](./example-zitadel-secrets.yaml)
- [example-zitadel-init-steps.yaml](./example-zitadel-init-steps.yaml)
```bash
# Download the docker compose example configuration for a secure CockroachDB. For example:
wget https://docs.zitadel.com/docs/guides/installation/configure/docker-compose.yaml

View File

@ -65,14 +65,16 @@ For example, if you want to configure the default ZITADEL IAM admin username and
</TabItem>
</Tabs>
Open your favorite internet browser and navigate to [http://localhost:8080/ui/console](http://localhost:8080/ui/console).
Open your favorite internet browser at [http://localhost:8080/ui/console](http://localhost:8080/ui/console).
This is the IAM admin users login according to your configuration in the [example-zitadel-init-steps.yaml](./example-zitadel-init-steps.yaml):
- **username**: *root@<span></span>zitadel.localhost*
- **password**: *RootPassword1!*
## What's next
If you want to run ZITADEL in production, you most certainly need to [customize your own domain](./custom-domain).
- If you want to run ZITADEL in production, you most certainly need to [customize your own domain](./custom-domain).
- Check out all possible [runtime configuration properties and their defaults in the source code](https://github.com/zitadel/zitadel/blob/v2-alpha/cmd/defaults.yaml)
- Check out all possible [setup step configuration properties and their defaults in the source code](https://github.com/zitadel/zitadel/blob/v2-alpha/cmd/adminn/setup/steps.yaml)
:::caution

View File

@ -1,5 +1,10 @@
### Configure by Files
You will need to download the following files:
- [example-zitadel-config.yaml](./example-zitadel-config.yaml)
- [example-zitadel-secrets.yaml](./example-zitadel-secrets.yaml)
- [example-zitadel-init-steps.yaml](./example-zitadel-init-steps.yaml)
```bash
# Download and adjust the example configuration file containing standard configuration
wget https://docs.zitadel.com/docs/guides/installation/configure/example-zitadel-config.yaml

View File

@ -32,4 +32,4 @@ S3DefaultInstance:
## Example
Go to the [near production example with Traefik](./near-production-example) for seeing a working example configuration.
Go to the [loadbalancing example with Traefik](./loadbalancing-example) for seeing a working example configuration.

View File

@ -1,3 +1,7 @@
You will need to download the file [docker-compose.yaml](./docker-compose.yaml)
The setup is tested against Docker version 20.10.17 and Docker Compose version v2.2.3
```bash
# Download the docker compose example configuration. For example:
wget https://docs.zitadel.com/docs/guides/installation/get-started/docker-compose.yaml

View File

@ -1,7 +1,7 @@
## Download The CockroachDB binary
Download a `cockroach` binary as described [in the CockroachDB docs](https://www.cockroachlabs.com/docs/v22.1/install-cockroachdb).
ZITADEL is tested against CockroachDB v22.1.0.
ZITADEL is tested against CockroachDB v22.1.0 and Ubuntu 20.04.
## Run CockroachDB and ZITADEL

View File

@ -7,4 +7,4 @@ The ZITADEL backend service accepts gRPC-Web requests and translates them into r
Because ZITADEL accepts gRPC-Web and translates it to gRPC itself, your reverse proxy doesn't need to be able to support gRPC or gRPC-Web.
However, as gRPC requires HTTP/2, your reverse proxy is required to send and receive downstream and upstream HTTP/2 traffic.
Go to the [near production example with Traefik](./near-production-example) for seeing a working example configuration.
Go to the [loadbalancing example with Traefik](./loadbalancing-example) for seeing a working example configuration.

View File

@ -0,0 +1,48 @@
---
title: Load Balancing Example
---
With this example configuration, you create a near production environment for ZITADEL with [Docker Compose](https://docs.docker.com/compose/).
The stack consists of three long-running containers:
- A [Traefik](https://doc.traefik.io/traefik/) reverse proxy with upstream HTTP/2 enabled, issuing a self-signed TLS certificate
- A secure ZITADEL container configured for a custom domain
- A secure [CockroachDB](https://www.cockroachlabs.com/docs/stable/)
You will need to download the following files:
- [docker-compose.yaml](./docker-compose.yaml)
- [example-zitadel-config.yaml](./example-zitadel-config.yaml)
- [example-zitadel-secrets.yaml](./example-zitadel-secrets.yaml)
- [example-zitadel-init-steps.yaml](./example-zitadel-init-steps.yaml)
The setup is tested against Docker version 20.10.17 and Docker Compose version v2.2.3
```bash
# Download the docker compose example configuration. For example:
wget https://docs.zitadel.com/docs/guides/installation/loadbalancing-example/docker-compose.yaml
# Download and adjust the example configuration file containing standard configuration
wget https://docs.zitadel.com/docs/guides/installation/loadbalancing-example/example-zitadel-config.yaml
# Download and adjust the example configuration file containing secret configuration
wget https://docs.zitadel.com/docs/guides/installation/loadbalancing-example/example-zitadel-secrets.yaml
# Download and adjust the example configuration file containing database initialization configuration
wget https://docs.zitadel.com/docs/guides/installation/loadbalancing-example/example-zitadel-init-steps.yaml
# 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.
# For example:
export ZITADEL_MASTERKEY="$(tr -dc A-Za-z0-9 </dev/urandom | head -c 32)"
# Run the database and application containers
docker compose up --detach
```
Make `127.0.0.1` available at `my.domain`. For example, this can be achived with an entry `127.0.1.1 my.domain` in the `/etc/hosts` file.
Open your favorite internet browser at [https://my.domain/ui/console/](https://my.domain/ui/console/).
You can safely proceed, if your browser warns you about the insecure self-signed TLS certificate.
This is the IAM admin users login according to your configuration in the [example-zitadel-init-steps.yaml](./example-zitadel-init-steps.yaml):
- **username**: *root@<span></span>my-org.my.domain*
- **password**: *RootPassword1!*

View File

@ -1,39 +0,0 @@
---
title: Near Production Example
---
With this configuration, you create an almost production-ready docker-compose environment for ZITADEL.
The stack consists of three long-running containers:
- A secure [CockroachDB](https://www.cockroachlabs.com/docs/stable/)
- A secure ZITADEL container configured for a custom domain
- A [Traefik](https://doc.traefik.io/traefik/) reverse proxy with upstream HTTP/2 enabled, issuing a self-signed TLS certificate
```bash
# Download the docker compose example configuration. For example:
wget https://docs.zitadel.com/docs/guides/installation/near-production-example/docker-compose.yaml
# Download and adjust the example configuration file containing standard configuration
wget https://docs.zitadel.com/docs/guides/installation/near-production-example/example-zitadel-config.yaml
# Download and adjust the example configuration file containing secret configuration
wget https://docs.zitadel.com/docs/guides/installation/near-production-example/example-zitadel-secrets.yaml
# Download and adjust the example configuration file containing database initialization configuration
wget https://docs.zitadel.com/docs/guides/installation/near-production-example/example-zitadel-init-steps.yaml
# 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.
# For example:
export ZITADEL_MASTERKEY="$(tr -dc A-Za-z0-9 </dev/urandom | head -c 32)"
# Run the database and application containers
docker compose up --detach
```
Make `127.0.0.1` available at `my.domain`. For example, this can be achived with an entry `127.0.1.1 my.domain` in the `/etc/hosts` file.
Open your browser at https://my.domain/ui/console/. You can safely proceed, if your browser warns you about the insecure self-signed TLS certificate.
With the configuration from the example files, you can log in with the following credentials:
- **username**: *root@<span></span>my-org.my.domain*
- **password**: *RootPassword1!*

View File

@ -45,7 +45,7 @@ module.exports = {
"guides/installation/configure/configure",
"guides/installation/custom-domain",
"guides/installation/http2-support",
"guides/installation/near-production-example/near-production-example",
"guides/installation/loadbalancing-example/loadbalancing-example",
],
},
{