extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2024-11-22 08:03:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

clarify no-TLS option

Browse Source
This commit is contained in:
Kenneth Bingham 2024-05-20 09:27:22 -04:00
parent ba82048f24
commit 3a03f2c051
No known key found for this signature in database
GPG Key ID: 31709281860130B6
2 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docker/compose/zrok-instance/README.md
View File

@ -64,6 +64,7 @@ ZROK_ADMIN_TOKEN=zroktoken
``` ```
```bash title=".env options" ```bash title=".env options"
# Caddy TLS option: rename caddy.compose.override.yml to compose.override.yml and set these vars; allow 80,443 in firewall
# plugin name for your DNS provider # plugin name for your DNS provider
CADDY_DNS_PLUGIN=cloudflare CADDY_DNS_PLUGIN=cloudflare
# API token from your DNS provider # API token from your DNS provider
@ -71,12 +72,13 @@ CADDY_DNS_PLUGIN_TOKEN=abcd1234
# use the staging API until you're sure everything is working to avoid hitting the rate limit # use the staging API until you're sure everything is working to avoid hitting the rate limit
CADDY_ACME_API=https://acme-staging-v02.api.letsencrypt.org/directory CADDY_ACME_API=https://acme-staging-v02.api.letsencrypt.org/directory
# zrok version, e.g., 1.0.0 # no TLS option: publish the insecure ports to the internet and allow them in the firewall
ZROK_IMAGE_TAG=latest ZROK_INSECURE_INTERFACE=0.0.0.0
ZROK_CTRL_PORT=18080
ZROK_FRONTEND_PORT=8080
ZROK_OAUTH_PORT=8081
# ziti version, e.g., 1.0.0 # ziti ports must be published to the internet and allowed by firewall
ZITI_IMAGE_TAG=latest
# ziti ports
ZITI_CTRL_ADVERTISED_PORT=1280 ZITI_CTRL_ADVERTISED_PORT=1280
ZITI_ROUTER_PORT=3022 ZITI_ROUTER_PORT=3022
@ -86,6 +88,11 @@ ZROK_OAUTH_GITHUB_CLIENT_ID=abcd1234
ZROK_OAUTH_GITHUB_CLIENT_SECRET=abcd1234 ZROK_OAUTH_GITHUB_CLIENT_SECRET=abcd1234
ZROK_OAUTH_GOOGLE_CLIENT_ID=abcd1234 ZROK_OAUTH_GOOGLE_CLIENT_ID=abcd1234
ZROK_OAUTH_GOOGLE_CLIENT_SECRET=abcd1234 ZROK_OAUTH_GOOGLE_CLIENT_SECRET=abcd1234
# zrok version, e.g., 1.0.0
ZROK_IMAGE_TAG=latest
# ziti version, e.g., 1.0.0
ZITI_IMAGE_TAG=latest
``` ```
### Start the Docker Compose Project ### Start the Docker Compose Project

6
docker/compose/zrok-instance/compose.yml
View File

@ -110,7 +110,7 @@ services:
expose: expose:
- ${ZROK_CTRL_PORT:-18080} # (not published) - ${ZROK_CTRL_PORT:-18080} # (not published)
ports: ports:
- 127.0.0.1:${ZROK_CTRL_PORT:-18080}:${ZROK_CTRL_PORT:-18080} - ${ZROK_INSECURE_INTERFACE:-127.0.0.1}:${ZROK_CTRL_PORT:-18080}:${ZROK_CTRL_PORT:-18080}
environment: environment:
ZROK_USER_PWD: ${ZROK_USER_PWD} # admin account password (initial user account) ZROK_USER_PWD: ${ZROK_USER_PWD} # admin account password (initial user account)
ZROK_USER_EMAIL: ${ZROK_USER_EMAIL} # login email address (initial user account) ZROK_USER_EMAIL: ${ZROK_USER_EMAIL} # login email address (initial user account)
@ -144,8 +144,8 @@ services:
- ${ZROK_FRONTEND_PORT:-8080} # (not published) - ${ZROK_FRONTEND_PORT:-8080} # (not published)
- ${ZROK_OAUTH_PORT:-8081} # (not published) - ${ZROK_OAUTH_PORT:-8081} # (not published)
ports: ports:
- 127.0.0.1:${ZROK_FRONTEND_PORT:-8080}:${ZROK_FRONTEND_PORT:-8080} - ${ZROK_INSECURE_INTERFACE:-127.0.0.1}:${ZROK_FRONTEND_PORT:-8080}:${ZROK_FRONTEND_PORT:-8080}
- 127.0.0.1:${ZROK_OAUTH_PORT:-8081}:${ZROK_OAUTH_PORT:-8081} - ${ZROK_INSECURE_INTERFACE:-127.0.0.1}:${ZROK_OAUTH_PORT:-8081}:${ZROK_OAUTH_PORT:-8081}
environment: environment:
HOME: /var/lib/zrok-frontend HOME: /var/lib/zrok-frontend
ZROK_DNS_ZONE: ${ZROK_DNS_ZONE} # e.g., "example.com" or "127.0.0.1.sslip.io" ZROK_DNS_ZONE: ${ZROK_DNS_ZONE} # e.g., "example.com" or "127.0.0.1.sslip.io"