extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2024-12-22 14:50:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

refine unique name doc

Browse Source
This commit is contained in:
Kenneth Bingham 2023-12-11 18:15:02 -05:00
parent d4c005ccf3
commit 5126add525
No known key found for this signature in database
GPG Key ID: 31709281860130B6
3 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docker/compose/zrok-public-reserved/compose.yml
View File

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

7
docs/guides/_frontdoor-docker.mdx
View File

@ -22,6 +22,13 @@ When the project runs it will:
```bash title=".env" ```bash title=".env"
ZROK_ENABLE_TOKEN="8UL9-48rN0ua" ZROK_ENABLE_TOKEN="8UL9-48rN0ua"
``` ```
1. Name the Share
This unique name becomes part of the domain name of the share, e.g. `https://my-prod-app.in.zrok.io`. A random name is generated if you don't specify one.
```bash title=".env"
ZROK_UNIQUE_NAME="my-prod-app"
```
1. Run the Compose project to start sharing the built-in demo web server. Be sure to `--detach` so the project runs in the background if you want it to auto-restart when your computer reboots. 1. Run the Compose project to start sharing the built-in demo web server. Be sure to `--detach` so the project runs in the background if you want it to auto-restart when your computer reboots.

4
docs/guides/_frontdoor-linux.mdx
View File

@ -89,9 +89,9 @@ Save the enable token from the zrok console in the configuration file.
ZROK_ENABLE_TOKEN="14cbfca9772f" ZROK_ENABLE_TOKEN="14cbfca9772f"
``` ```
## Choose a Vanity Share Token ## Name your Share
This becomes the leading part of the domain name of the share, e.g. `https://my-prod-app.in.zrok.io`. This unique name becomes part of the domain name of the share, e.g. `https://my-prod-app.in.zrok.io`. A random name is generated if you don't specify one.
```bash title="/opt/openziti/etc/zrok/zrok-share.env" ```bash title="/opt/openziti/etc/zrok/zrok-share.env"
ZROK_UNIQUE_NAME="my-prod-app" ZROK_UNIQUE_NAME="my-prod-app"