fix default mountpoint in Docker share examples

This commit is contained in:
Kenneth Bingham 2024-12-16 14:00:32 -05:00
parent f406c8c8a6
commit 70babf15c8
No known key found for this signature in database
GPG Key ID: 31709281860130B6
2 changed files with 11 additions and 7 deletions

View File

@ -1,5 +1,9 @@
# CHANGELOG # CHANGELOG
## v0.4.46
FIX: Docker share examples had incorrect default path for zrok environment mountpoint
## v0.4.45 ## v0.4.45
FEATURE: Minimal support for "organizations". Site admin API endpoints provided to create, list, and delete "organizations". Site admin API endpoints provided to add, list, and remove "organization members" (zrok accounts) with the ability to mark accounts as a "organization admin". API endpoints provided for organization admins to list the members of their organizations, and to also see the overview (environments, shares, and accesses) for any account in their organization. API endpoint for end users to see which organizations their account is a member of (https://github.com/openziti/zrok/issues/537) FEATURE: Minimal support for "organizations". Site admin API endpoints provided to create, list, and delete "organizations". Site admin API endpoints provided to add, list, and remove "organization members" (zrok accounts) with the ability to mark accounts as a "organization admin". API endpoints provided for organization admins to list the members of their organizations, and to also see the overview (environments, shares, and accesses) for any account in their organization. API endpoint for end users to see which organizations their account is a member of (https://github.com/openziti/zrok/issues/537)

View File

@ -26,7 +26,7 @@ Let's say you have a `compose.yml` file that defines a web app known within the
restart: unless-stopped restart: unless-stopped
user: "${UID}" user: "${UID}"
volumes: volumes:
- ${HOME}/.zrok:/.zrok - ${HOME}/.zrok:/home/ziggy/.zrok
environment: environment:
PFXLOG_NO_JSON: "true" PFXLOG_NO_JSON: "true"
command: share reserved "myapp" --headless command: share reserved "myapp" --headless
@ -42,8 +42,8 @@ Let's say you have a web server running on the host's private network at `https:
docker run \ docker run \
--rm \ --rm \
--network=host \ --network=host \
--volume ~/.zrok:/.zrok \ --volume ~/.zrok:/home/ziggy/.zrok \
--user "${UID}" \ --user "${UID:-1000}:${GID:-1000}" \
openziti/zrok share public \ openziti/zrok share public \
--headless \ --headless \
https://10.11.12.13:8080 https://10.11.12.13:8080
@ -89,8 +89,8 @@ docker.exe run ^
docker run \ docker run \
--rm \ --rm \
--network "host" \ --network "host" \
--volume "/mnt/c/Users/$(powershell.exe -Command 'Write-Output $env:USERNAME' | tr -d '\r')/.zrok:/.zrok" \ --volume "/mnt/c/Users/$(powershell.exe -Command 'Write-Output $env:USERNAME' | tr -d '\r')/.zrok:/home/ziggy/.zrok" \
--user "$UID" \ --user "${UID:-1000}:${GID:-1000}" \
openziti/zrok share public \ openziti/zrok share public \
--headless \ --headless \
https://10.11.12.13:8080 https://10.11.12.13:8080
@ -104,8 +104,8 @@ Let's break down those options and arguments.
1. `--rm` don't save this container because it's providing a temporary public share that's destroyed when the container stops 1. `--rm` don't save this container because it's providing a temporary public share that's destroyed when the container stops
1. `--network=host` shares the host's network with the container so that the container can reach the web server directly. This is always necessary when the web server is listening only on the host's loopback interface, e.g., `https://::1:8080`, and may not be strictly necessary if the target is routeable from the default Docker bridge. 1. `--network=host` shares the host's network with the container so that the container can reach the web server directly. This is always necessary when the web server is listening only on the host's loopback interface, e.g., `https://::1:8080`, and may not be strictly necessary if the target is routeable from the default Docker bridge.
1. `--volume ~/.zrok:/.zrok` mounts the `zrok` configuration from the Docker host into the container. 1. `--volume ~/.zrok:/home/ziggy/.zrok` mounts the `zrok` configuration from the Docker host into the container.
1. `--user "${UID}:${GID}"` sets the container's user to the current user on the Docker host to avoid permission issues with reading the mounted `zrok` configuration. 1. `--user "${UID:-1000}:${GID:-1000}"` sets the container's user to the current user on the Docker host to avoid permission issues with reading the mounted `zrok` configuration (defaults to `1000:1000`).
1. `openziti/zrok` is the `zrok` Docker image. 1. `openziti/zrok` is the `zrok` Docker image.
1. `share public` is the `zrok` command to share the target publicly until zrok exits. 1. `share public` is the `zrok` command to share the target publicly until zrok exits.
1. `--headless` runs the `zrok` command without the interactive terminal UI. 1. `--headless` runs the `zrok` command without the interactive terminal UI.