diff --git a/docker/compose/zrok-public-share/docker-compose.yml b/docker/compose/zrok-public-share/docker-compose.yml index 7fb0e4d0..53f71017 100644 --- a/docker/compose/zrok-public-share/docker-compose.yml +++ b/docker/compose/zrok-public-share/docker-compose.yml @@ -41,11 +41,6 @@ services: environment: HOME: /mnt PFXLOG_NO_JSON: "true" - volumes: - - zrok_env:/mnt/.zrok - environment: - HOME: /mnt - PFXLOG_NO_JSON: "true" # demo servers you can share with zrok zrok-test: diff --git a/docs/guides/docker-share/v0.3_docker_private_share_guide.md b/docs/guides/docker-share/docker_private_share_guide.md similarity index 94% rename from docs/guides/docker-share/v0.3_docker_private_share_guide.md rename to docs/guides/docker-share/docker_private_share_guide.md index de3fa938..d3ef8323 100644 --- a/docs/guides/docker-share/v0.3_docker_private_share_guide.md +++ b/docs/guides/docker-share/docker_private_share_guide.md @@ -32,6 +32,13 @@ First, let's create the private share. ZROK_ENABLE_TOKEN="8UL9-48rN0ua" ``` +1. If you are self-hosting zrok then it's important to set your API endpoint URL too. If you're using the hosted zrok service then you can skip this step. + + ```bash + # file name ".env" + ZROK_API_ENDPOINT="https://zrok.example.com" + ``` + 1. Run your Compose project to start sharing the built-in demo web server: ```bash diff --git a/docs/guides/docker-share/v0.3_docker_public_share_guide.md b/docs/guides/docker-share/docker_public_share_guide.md similarity index 91% rename from docs/guides/docker-share/v0.3_docker_public_share_guide.md rename to docs/guides/docker-share/docker_public_share_guide.md index 3b3c320b..9bb6db0e 100644 --- a/docs/guides/docker-share/v0.3_docker_public_share_guide.md +++ b/docs/guides/docker-share/docker_public_share_guide.md @@ -27,6 +27,13 @@ To follow this guide you will need [Docker](https://docs.docker.com/get-docker/) ZROK_ENABLE_TOKEN="8UL9-48rN0ua" ``` +1. If you are self-hosting zrok then it's important to set your API endpoint URL too. If you're using the hosted zrok service then you can skip this step. + + ```bash + # file name ".env" + ZROK_API_ENDPOINT="https://zrok.example.com" + ``` + 1. Run your Compose project to start sharing the built-in demo web server: ```bash diff --git a/docs/guides/self-hosting/self_hosting_guide.md b/docs/guides/self-hosting/self_hosting_guide.md index 940ba3d5..0ee17a35 100644 --- a/docs/guides/self-hosting/self_hosting_guide.md +++ b/docs/guides/self-hosting/self_hosting_guide.md @@ -53,18 +53,21 @@ admin: # generate these admin tokens from a source of randomness, e.g. # LC_ALL=C tr -dc _A-Z-a-z-0-9 < /dev/urandom | head -c32 secrets: - - Q8V0LqnNb5wNX9kE1fgQ0H6VlcvJybB1 + - Q8V0LqnNb5wNX9kE1fgQ0H6VlcvJybB1 # be sure to change this! endpoint: host: 0.0.0.0 port: 18080 +invites: + invites_open: true + store: path: zrok.db type: sqlite3 ziti: - api_endpoint: "https://127.0.0.1:1280" + api_endpoint: "https://127.0.0.1:8441" username: admin password: "XO0xHp75uuyeireO2xmmVlK91T7B9fpD" @@ -72,7 +75,7 @@ ziti: The `admin` section defines privileged administrative credentials and must be set in the `ZROK_ADMIN_TOKEN` environment variable in shells where you want to run `zrok admin`. -The `endpoint` section defines where your `zrok` controller will listen. +The `endpoint` section defines where your `zrok` controller will listen. The `store` section defines the local `sqlite3` database used by the controller. @@ -87,7 +90,7 @@ To work with a self-hosted `zrok` deployment, you'll need to set the `ZROK_API_E In my case, I've set: ```bash -export ZROK_API_ENDPOINT=http://localhost:18080 +export ZROK_API_ENDPOINT=http://127.0.0.1:18080 ``` ## Bootstrap OpenZiti for zrok