From 0f2ea4d5107ab5bc5b7c313344dc1a16c629c48a Mon Sep 17 00:00:00 2001 From: Michael Quigley Date: Mon, 26 Jun 2023 12:00:06 -0400 Subject: [PATCH] reserved shares --- docs/core-features/sharing-reserved.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/core-features/sharing-reserved.md b/docs/core-features/sharing-reserved.md index b111d12d..b9a786cd 100644 --- a/docs/core-features/sharing-reserved.md +++ b/docs/core-features/sharing-reserved.md @@ -3,9 +3,12 @@ sidebar_position: 10 --- # Shares - Reserved -`zrok` was built to share and access digital resources. A `reserved` share allows the user to have a reliable, -public, persistent shared url. (the share name not ephemeral, it is `reserved`). This means that the share -will be able to be used and regardless of how many times the resource is shared. This is useful when the -url must be known. +By default a `public` or `private` share is allocated a _share token_ when you run 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_. -Use the `zrok reserve` command to create a reserved 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`. + +To use a `reserved` share, you will first run the `zrok reserve` command to create the reserved share (see `zrok reserve --help` for details). Once you've created your `reserved` share, you will use the `zrok share reserved` command (see `--help` for details) to run the bridge for the shared resource. + +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.