extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2024-11-21 23:53:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #785 from openziti/doc-reserved-unique-name

Browse Source 
doc unique names
This commit is contained in:
Kenneth Bingham 2024-11-05 14:16:54 -05:00 committed by GitHub
commit c96fba8c34
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -1,5 +1,9 @@
# CHANGELOG # CHANGELOG
## v0.4.45
FIX: Document unique names
## v0.4.44 ## v0.4.44
FIX: Fix for goreleaser build action to align with changed ARM64 build path. FIX: Fix for goreleaser build action to align with changed ARM64 build path.

19
docs/concepts/sharing-reserved.md
View File

@ -1,9 +1,10 @@
--- ---
sidebar_position: 10 sidebar_position: 10
--- ---
# Reserved Shares # 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`. 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`. 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. 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"
```