mirror of
https://github.com/zitadel/zitadel.git
synced 2025-02-28 23:07:22 +00:00
docs: fix reverse proxy guides (#9118)
# Which Problems Are Solved Commands for installing compose stacks with reverse proxies don't work. # How the Problems Are Solved - The `docker compose up` commands are fixed by specifying all necessary services to spin up. This is obviously not (or not with all docker compose versions) resolved by the dependencies declarations. - The initial postgres admin username is postgres. - Fix postgres health check to succeed before the init job created the DB. - A hint tells the user to install the grpcurl binary. # Additional Changes - Passing `--wait` to `docker compose up` doesn't require us to sleep for exactly three seconds. - It looks to me like the order of the depends_on declaration for zitadel matters, but I don't understand why. I changed it so that it's for sure correct. - Silenced some command outputs - Removed the version property from all compose files to avoid the following warning ``` WARN[0000] /tmp/caddy-example/docker-compose-base.yaml: the attribute `version` is obsolete, it will be ignored, please remove it to avoid potential confusion ``` # Additional Context - Closes https://github.com/zitadel/zitadel/issues/9115 This is the easiest way to test the updated docs: ```bash # Use this PR branches files: export ZITADEL_CONFIG_FILES=https://raw.githubusercontent.com/zitadel/zitadel/refs/heads/fix-reverse-proxy-guides/docs/docs/self-hosting/manage/reverseproxy ``` The rest of the commands as described in https://docs-git-fix-reverse-proxy-guides-zitadel.vercel.app/docs/self-hosting/manage/reverseproxy/caddy 
This commit is contained in:
parent
a3d80f93ff
commit
2bfdb72bf3
@ -1,4 +1,3 @@
|
|||||||
version: '3.8'
|
|
||||||
services:
|
services:
|
||||||
|
|
||||||
traefik:
|
traefik:
|
||||||
|
@ -1,5 +1,3 @@
|
|||||||
version: "3.8"
|
|
||||||
|
|
||||||
services:
|
services:
|
||||||
zitadel:
|
zitadel:
|
||||||
restart: "always"
|
restart: "always"
|
||||||
|
@ -24,7 +24,7 @@ export const Description = ({mode, link}) => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export const Commands = ({mode, name, lower, configfilename}) => {
|
export const Commands = ({mode, name, lower, configfilename}) => {
|
||||||
let genCert = '# Generate a self signed certificate and key.\nopenssl req -x509 -batch -subj "/CN=127.0.0.1.sslip.io/O=ZITADEL Demo" -nodes -newkey rsa:2048 -keyout ./selfsigned.key -out ./selfsigned.crt\n\n';
|
let genCert = '# Generate a self signed certificate and key.\nopenssl req -x509 -batch -subj "/CN=127.0.0.1.sslip.io/O=ZITADEL Demo" -nodes -newkey rsa:2048 -keyout ./selfsigned.key -out ./selfsigned.crt 2>/dev/null\n\n';
|
||||||
let connPort = "443"
|
let connPort = "443"
|
||||||
let connInsecureFlag = "--insecure "
|
let connInsecureFlag = "--insecure "
|
||||||
let connScheme = "https"
|
let connScheme = "https"
|
||||||
@ -42,16 +42,16 @@ export const Commands = ({mode, name, lower, configfilename}) => {
|
|||||||
<CodeBlock language="bash">
|
<CodeBlock language="bash">
|
||||||
{'# Download the configuration files.'}{'\n'}
|
{'# Download the configuration files.'}{'\n'}
|
||||||
{'export ZITADEL_CONFIG_FILES=https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/self-hosting/manage/reverseproxy\n'}
|
{'export ZITADEL_CONFIG_FILES=https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/self-hosting/manage/reverseproxy\n'}
|
||||||
{`wget $\{ZITADEL_CONFIG_FILES\}/docker-compose.yaml -O docker-compose-base.yaml`}{'\n'}
|
{'wget $\{ZITADEL_CONFIG_FILES\}/docker-compose.yaml -O docker-compose-base.yaml --quiet \n'}
|
||||||
{'wget $\{ZITADEL_CONFIG_FILES\}/'}{lower}{'/docker-compose.yaml -O docker-compose-'}{lower}{'.yaml'}{'\n'}
|
{'wget $\{ZITADEL_CONFIG_FILES\}/'}{lower}{'/docker-compose.yaml -O docker-compose-'}{lower}{'.yaml --quiet \n'}
|
||||||
{'wget $\{ZITADEL_CONFIG_FILES\}/'}{lower}{'/'}{configfilename}{' -O '}{configfilename}{'\n'}
|
{'wget $\{ZITADEL_CONFIG_FILES\}/'}{lower}{'/'}{configfilename}{' -O '}{configfilename}{' --quiet \n'}
|
||||||
{'\n'}
|
{'\n'}
|
||||||
{genCert}
|
{genCert}
|
||||||
{'# Run the database, ZITADEL and '}{name}{'.'}{'\n'}
|
{'# Run the database, ZITADEL and '}{name}{'.'}{'\n'}
|
||||||
{'docker compose --file docker-compose-base.yaml --file docker-compose-'}{lower}{'.yaml up --detach proxy-'}{mode}{'-tls'}{'\n'}
|
{'docker compose --file docker-compose-base.yaml --file docker-compose-'}{lower}{'.yaml up --detach --wait db zitadel-init zitadel-'}{mode}{'-tls proxy-'}{mode}{'-tls'}{'\n'}
|
||||||
{'\n'}
|
{'\n'}
|
||||||
{'# Test that gRPC and HTTP APIs work. Empty brackets like {} means success.\n'}
|
{'# Test that gRPC and HTTP APIs work. Empty brackets like {} means success.\n'}
|
||||||
{'sleep 3\n'}
|
{'# Make sure you have the grpcurl cli installed on your machine https://github.com/fullstorydev/grpcurl?tab=readme-ov-file#installation\n'}
|
||||||
{'grpcurl '}{connInsecureFlag}{grpcPlainTextFlag}{'127.0.0.1.sslip.io:'}{connPort}{' zitadel.admin.v1.AdminService/Healthz\n'}
|
{'grpcurl '}{connInsecureFlag}{grpcPlainTextFlag}{'127.0.0.1.sslip.io:'}{connPort}{' zitadel.admin.v1.AdminService/Healthz\n'}
|
||||||
{'curl '}{connInsecureFlag}{connScheme}{'://127.0.0.1.sslip.io:'}{connPort}{'/admin/v1/healthz\n'}
|
{'curl '}{connInsecureFlag}{connScheme}{'://127.0.0.1.sslip.io:'}{connPort}{'/admin/v1/healthz\n'}
|
||||||
</CodeBlock>
|
</CodeBlock>
|
||||||
|
@ -1,5 +1,3 @@
|
|||||||
version: '3.8'
|
|
||||||
|
|
||||||
services:
|
services:
|
||||||
|
|
||||||
proxy-disabled-tls:
|
proxy-disabled-tls:
|
||||||
|
@ -1,5 +1,3 @@
|
|||||||
version: '3.8'
|
|
||||||
|
|
||||||
services:
|
services:
|
||||||
|
|
||||||
zitadel-disabled-tls:
|
zitadel-disabled-tls:
|
||||||
@ -17,7 +15,7 @@ services:
|
|||||||
ZITADEL_DATABASE_POSTGRES_USER_USERNAME: zitadel_user
|
ZITADEL_DATABASE_POSTGRES_USER_USERNAME: zitadel_user
|
||||||
ZITADEL_DATABASE_POSTGRES_USER_PASSWORD: zitadel_pw
|
ZITADEL_DATABASE_POSTGRES_USER_PASSWORD: zitadel_pw
|
||||||
ZITADEL_DATABASE_POSTGRES_USER_SSL_MODE: disable
|
ZITADEL_DATABASE_POSTGRES_USER_SSL_MODE: disable
|
||||||
ZITADEL_DATABASE_POSTGRES_ADMIN_USERNAME: root
|
ZITADEL_DATABASE_POSTGRES_ADMIN_USERNAME: postgres
|
||||||
ZITADEL_DATABASE_POSTGRES_ADMIN_PASSWORD: postgres
|
ZITADEL_DATABASE_POSTGRES_ADMIN_PASSWORD: postgres
|
||||||
ZITADEL_DATABASE_POSTGRES_ADMIN_SSL_MODE: disable
|
ZITADEL_DATABASE_POSTGRES_ADMIN_SSL_MODE: disable
|
||||||
networks:
|
networks:
|
||||||
@ -43,16 +41,16 @@ services:
|
|||||||
ZITADEL_DATABASE_POSTGRES_USER_USERNAME: zitadel_user
|
ZITADEL_DATABASE_POSTGRES_USER_USERNAME: zitadel_user
|
||||||
ZITADEL_DATABASE_POSTGRES_USER_PASSWORD: zitadel_pw
|
ZITADEL_DATABASE_POSTGRES_USER_PASSWORD: zitadel_pw
|
||||||
ZITADEL_DATABASE_POSTGRES_USER_SSL_MODE: disable
|
ZITADEL_DATABASE_POSTGRES_USER_SSL_MODE: disable
|
||||||
ZITADEL_DATABASE_POSTGRES_ADMIN_USERNAME: root
|
ZITADEL_DATABASE_POSTGRES_ADMIN_USERNAME: postgres
|
||||||
ZITADEL_DATABASE_POSTGRES_ADMIN_PASSWORD: postgres
|
ZITADEL_DATABASE_POSTGRES_ADMIN_PASSWORD: postgres
|
||||||
ZITADEL_DATABASE_POSTGRES_ADMIN_SSL_MODE: disable
|
ZITADEL_DATABASE_POSTGRES_ADMIN_SSL_MODE: disable
|
||||||
networks:
|
networks:
|
||||||
- 'zitadel'
|
- 'zitadel'
|
||||||
depends_on:
|
depends_on:
|
||||||
zitadel-init:
|
|
||||||
condition: 'service_completed_successfully'
|
|
||||||
db:
|
db:
|
||||||
condition: 'service_healthy'
|
condition: 'service_healthy'
|
||||||
|
zitadel-init:
|
||||||
|
condition: 'service_completed_successfully'
|
||||||
|
|
||||||
zitadel-enabled-tls:
|
zitadel-enabled-tls:
|
||||||
extends:
|
extends:
|
||||||
@ -71,7 +69,7 @@ services:
|
|||||||
ZITADEL_DATABASE_POSTGRES_USER_USERNAME: zitadel_user
|
ZITADEL_DATABASE_POSTGRES_USER_USERNAME: zitadel_user
|
||||||
ZITADEL_DATABASE_POSTGRES_USER_PASSWORD: zitadel_pw
|
ZITADEL_DATABASE_POSTGRES_USER_PASSWORD: zitadel_pw
|
||||||
ZITADEL_DATABASE_POSTGRES_USER_SSL_MODE: disable
|
ZITADEL_DATABASE_POSTGRES_USER_SSL_MODE: disable
|
||||||
ZITADEL_DATABASE_POSTGRES_ADMIN_USERNAME: root
|
ZITADEL_DATABASE_POSTGRES_ADMIN_USERNAME: postgres
|
||||||
ZITADEL_DATABASE_POSTGRES_ADMIN_PASSWORD: postgres
|
ZITADEL_DATABASE_POSTGRES_ADMIN_PASSWORD: postgres
|
||||||
ZITADEL_DATABASE_POSTGRES_ADMIN_SSL_MODE: disable
|
ZITADEL_DATABASE_POSTGRES_ADMIN_SSL_MODE: disable
|
||||||
volumes:
|
volumes:
|
||||||
@ -109,7 +107,7 @@ services:
|
|||||||
ZITADEL_DATABASE_POSTGRES_USER_USERNAME: zitadel_user
|
ZITADEL_DATABASE_POSTGRES_USER_USERNAME: zitadel_user
|
||||||
ZITADEL_DATABASE_POSTGRES_USER_PASSWORD: zitadel_pw
|
ZITADEL_DATABASE_POSTGRES_USER_PASSWORD: zitadel_pw
|
||||||
ZITADEL_DATABASE_POSTGRES_USER_SSL_MODE: disable
|
ZITADEL_DATABASE_POSTGRES_USER_SSL_MODE: disable
|
||||||
ZITADEL_DATABASE_POSTGRES_ADMIN_USERNAME: root
|
ZITADEL_DATABASE_POSTGRES_ADMIN_USERNAME: postgres
|
||||||
ZITADEL_DATABASE_POSTGRES_ADMIN_PASSWORD: postgres
|
ZITADEL_DATABASE_POSTGRES_ADMIN_PASSWORD: postgres
|
||||||
ZITADEL_DATABASE_POSTGRES_ADMIN_SSL_MODE: disable
|
ZITADEL_DATABASE_POSTGRES_ADMIN_SSL_MODE: disable
|
||||||
networks:
|
networks:
|
||||||
@ -125,10 +123,9 @@ services:
|
|||||||
restart: 'always'
|
restart: 'always'
|
||||||
image: postgres:16-alpine
|
image: postgres:16-alpine
|
||||||
environment:
|
environment:
|
||||||
PGUSER: root
|
|
||||||
POSTGRES_PASSWORD: postgres
|
POSTGRES_PASSWORD: postgres
|
||||||
healthcheck:
|
healthcheck:
|
||||||
test: ["CMD-SHELL", "pg_isready", "-d", "zitadel", "-U", "postgres"]
|
test: ["CMD-SHELL", "pg_isready"]
|
||||||
interval: 5s
|
interval: 5s
|
||||||
timeout: 60s
|
timeout: 60s
|
||||||
retries: 10
|
retries: 10
|
||||||
|
@ -1,5 +1,3 @@
|
|||||||
version: '3.8'
|
|
||||||
|
|
||||||
services:
|
services:
|
||||||
|
|
||||||
proxy-disabled-tls:
|
proxy-disabled-tls:
|
||||||
|
@ -1,5 +1,3 @@
|
|||||||
version: '3.8'
|
|
||||||
|
|
||||||
services:
|
services:
|
||||||
|
|
||||||
proxy-disabled-tls:
|
proxy-disabled-tls:
|
||||||
|
@ -1,5 +1,3 @@
|
|||||||
version: '3.8'
|
|
||||||
|
|
||||||
services:
|
services:
|
||||||
|
|
||||||
proxy-disabled-tls:
|
proxy-disabled-tls:
|
||||||
|
@ -1,5 +1,3 @@
|
|||||||
version: '3.8'
|
|
||||||
|
|
||||||
services:
|
services:
|
||||||
|
|
||||||
db:
|
db:
|
||||||
|
@ -1,5 +1,3 @@
|
|||||||
version: '3.8'
|
|
||||||
|
|
||||||
services:
|
services:
|
||||||
zitadel:
|
zitadel:
|
||||||
user: '$UID'
|
user: '$UID'
|
||||||
|
@ -1,5 +1,3 @@
|
|||||||
version: '3.8'
|
|
||||||
|
|
||||||
services:
|
services:
|
||||||
zitadel:
|
zitadel:
|
||||||
extends:
|
extends:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user