explain UNIQUE_NAME in the reserved public share context

This commit is contained in:
Kenneth Bingham 2023-12-11 11:34:59 -05:00
parent 63d639408c
commit b887e33a30
No known key found for this signature in database
GPG Key ID: 31709281860130B6
4 changed files with 9 additions and 8 deletions

View File

@ -38,7 +38,7 @@ services:
STATE_DIRECTORY: /mnt # zrok homedir in container
# most relevant options
ZROK_SUBDOMAIN: # frontend subdomain, e.g. "myapp" for "myapp.in.zrok.io"
UNIQUE_NAME: # vanity share token is used to construct frontend subdomain, e.g. "myapp" for "myapp.in.zrok.io"
ZROK_BACKEND_MODE: # web, caddy, drive, proxy
ZROK_TARGET: # backend target, is a path in container filesystem unless proxy mode
ZROK_INSECURE: # "--insecure" if proxy target has unverifiable TLS server certificate

View File

@ -110,8 +110,8 @@ case "${ZROK_BACKEND_MODE}" in
;;
esac
[[ -n "${ZROK_SUBDOMAIN:-}" ]] && {
ZROK_CMD+=" --unique-name ${ZROK_SUBDOMAIN}"
[[ -n "${UNIQUE_NAME:-}" ]] && {
ZROK_CMD+=" --unique-name ${UNIQUE_NAME}"
}
ZROK_CMD+=" --backend-mode ${ZROK_BACKEND_MODE} ${ZROK_TARGET}"

View File

@ -64,10 +64,10 @@ ZROK_SHARE_OPTS=""
## ZROK FRONTEND
#
# you MAY customize the subdomain that is reserved for the frontend; must be a valid DNS subdomain; if not set a random
# you MAY customize the share token that is used to construct the reserved subdomain; if not set a random
# subdomain is reserved
# WARNING: changes take effect the next time the frontend URL is reserved
#ZROK_SUBDOMAIN=""
#UNIQUE_NAME=""
# you MAY set one OAuth2/OIDC provider; "google" and "github" are valid for the default instance api.zrok.io
# WARNING: changes take effect the next time the frontend URL is reserved

View File

@ -1,5 +1,6 @@
from zrok.environment.root import Root
import openziti
from zrok.environment.root import Root
class Listener():
shrToken: str