From 84b23f2c23202e838ce2581055d4ac1890c000e1 Mon Sep 17 00:00:00 2001 From: Kenneth Bingham Date: Tue, 5 Nov 2024 13:46:22 -0500 Subject: [PATCH] doc unique names --- CHANGELOG.md | 4 ++++ docs/concepts/sharing-reserved.md | 19 ++++++++++++++++++- 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 22c41f9e..756a473d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # CHANGELOG +## v0.4.45 + +FIX: Document unique names + ## v0.4.44 FIX: Fix for goreleaser build action to align with changed ARM64 build path. diff --git a/docs/concepts/sharing-reserved.md b/docs/concepts/sharing-reserved.md index 4fec2360..a705d3fd 100644 --- a/docs/concepts/sharing-reserved.md +++ b/docs/concepts/sharing-reserved.md @@ -1,9 +1,10 @@ --- sidebar_position: 10 --- + # Reserved Shares -By default a `public` or `private` share is assigned a _share token_ when you create a share using the `zrok share` command. The `zrok share` command is the bridge between your local environment and the users you are sharing with. When you terminate the `zrok share`, the bridge is eliminated and the _share token_ is deleted. If you run `zrok share` again, you will be allocated a brand new _share token_. +By default, a `public` or `private` share is assigned a _share token_ when you create a share using the `zrok share` command. The `zrok share` command is the bridge between your local environment and the users you are sharing with. When you terminate the `zrok share`, the bridge is eliminated and the _share token_ is deleted. If you run `zrok share` again, you will be allocated a brand new _share token_. You can use a `reserved` share to persist your _share token_ across multiple runs of the `zrok share` bridge. When you use a `reserved` share, the share token will not be deleted between multiple runs of `zrok share`. @@ -12,3 +13,19 @@ To use a `reserved` share, you will first run the `zrok reserve` command to crea This pattern works for both `public` and `private` shares, and for all resource types supported by `zrok`. To delete your `reserved` share use the `zrok release` command or click the delete button in the share's _Actions_ tab in the web console. + +## Unique Names + +The default is to generate a random _share token_ and you may specify a _unique name_. + +This reserves public share token "myshare." + +```bash title="Reserve with the Command Line" +zrok reserve public 80 --unique-name "myshare" +``` + +This shares `127.0.0.1:80` as `https://myshare.zrok.example.com` where `https://{token}.zrok.example.com` is the frontend's template. + +```bash title="Share a Reserved Token" +zrok share reserved "myshare" +```