Merge pull request #924 from openziti/WMcKibbin-main

minor doc edits

docker/compose/zrok-private-share/compose.yml

@@ -36,7 +36,7 @@ services:
       HOME: /mnt            # zrok homedir in container
 
       # most relevant options
-      ZROK_UNIQUE_NAME:     # name is used to construct frontend domain name, e.g. "myapp" in "myapp.share.zrok.io"
+      ZROK_UNIQUE_NAME:     # name is used to construct frontend domain name, e.g. "toaster" in "toaster.share.zrok.io"; lowercase alphanumeric, between 4 and 32 characters in length
       ZROK_BACKEND_MODE:    # web, caddy, drive, proxy
       ZROK_TARGET:          # backend target, is a path in container filesystem unless proxy mode
       ZROK_INSECURE:        # "--insecure" if proxy target has unverifiable TLS server certificate

docker/compose/zrok-public-reserved/compose.override.yml

@@ -11,7 +11,7 @@ services:
       - ./Caddyfile:/Caddyfile
     environment:
       # most relevant options
-      ZROK_UNIQUE_NAME:     "my-other-zrok-share"
+      ZROK_UNIQUE_NAME:     "butter"
       ZROK_BACKEND_MODE:    caddy
       ZROK_TARGET:          /Caddyfile
       # internal configuration

docker/compose/zrok-public-reserved/compose.yml

@@ -38,7 +38,7 @@ services:
       HOME: /mnt  # zrok homedir in container
 
       # most relevant options
-      ZROK_UNIQUE_NAME:     # name is used to construct frontend domain name, e.g. "myapp" in "myapp.share.zrok.io"
+      ZROK_UNIQUE_NAME:     # name is used to construct frontend domain name, e.g. "toaster" in "toaster.share.zrok.io"; lowercase alphanumeric, between 4 and 32 characters in length
       ZROK_BACKEND_MODE:    # web, caddy, drive, proxy
       ZROK_TARGET:          # backend target, is a path in container filesystem unless proxy mode
       ZROK_INSECURE:        # "--insecure" if proxy target has unverifiable TLS server certificate

docs/_attic/sharing/sharing_modes.md

@@ -48,6 +48,6 @@ The following illustration shows the possibilities available.
 
 ![Frontend Selection](../../images/zrok_frontends_v0.3.png)
 
-The `*.in.zrok.io` frontend is a "public" frontend, available to all `zrok` users. Most `zrok` installations will want to have at least one public, global frontend for all public, internet-facing ingress traffic for private backend instances. In the underlying data store, the public frontend will have a `name` set to `public` (or some other representative name), allowing users to reference that `frontend` using a friendly label.
+The `*.share.zrok.io` frontend is a "public" frontend, available to all `zrok` users. Most `zrok` installations will want to have at least one public, global frontend for all public, internet-facing ingress traffic for private backend instances. In the underlying data store, the public frontend will have a `name` set to `public` (or some other representative name), allowing users to reference that `frontend` using a friendly label.
 
 The other two "private" frontends are configured with no `name` label (the lack of a `name` label signifies that these are "private" frontends). The ephemeral environment is allocated when a `zrok` frontend request is made without an account on behalf of a private share.

docs/concepts/sharing-reserved.md

@@ -16,16 +16,16 @@ To delete your `reserved` share use the `zrok release` command or click the dele
 
 ## Unique Names
 
-The default is to generate a random _share token_ and you may specify a _unique name_.
+The default is to generate a random _share token_ and you may instead specify a _unique name_. The unique name must be lowercase alphanumeric, between 4 and 32 characters in length.
 
-This reserves public share token "myshare."
+This reserves public share token "toaster".
 
 ```bash title="Reserve with the Command Line"
-zrok reserve public 80 --unique-name "myshare"
+zrok reserve public 80 --unique-name "toaster"
 ```
 
-This shares `127.0.0.1:80` as `https://myshare.zrok.example.com` where `https://{token}.zrok.example.com` is the frontend's template.
+This shares `127.0.0.1:80` as `https://toaster.zrok.example.com` where `https://{token}.zrok.example.com` is the frontend's template.
 
 ```bash title="Share a Reserved Token"
-zrok share reserved "myshare"
+zrok share reserved "toaster"
 ```

docs/guides/_frontdoor-linux.mdx

@@ -59,10 +59,10 @@ ZROK_ENABLE_TOKEN="14cbfca9772f"
 
 ## Name your Share
 
-This unique name becomes part of the domain name of the share, e.g. `https://my-prod-app.in.zrok.io`. A random name is generated if you don't specify one.
+This unique name becomes part of the domain name of the share, e.g. `https://toaster.share.zrok.io`. A random name is generated if you don't specify one. The name must be lowercase alphanumeric, between 4 and 32 characters in length.
 
 ```bash title="/opt/openziti/etc/zrok/zrok-share.env"
-ZROK_UNIQUE_NAME="my-prod-app"
+ZROK_UNIQUE_NAME="toaster"
 ```
 
 ## Use Cases

docs/guides/docker-share/docker_public_share_guide.md

@@ -41,10 +41,10 @@ When the project runs it will:
 
 1. Name the Share
 
-    This unique name becomes part of the domain name of the share, e.g. `https://my-prod-app.in.zrok.io`. A random name is generated if you don't specify one.
+    This unique name becomes part of the domain name of the share, e.g. `https://toaster.share.zrok.io`. A random name is generated if you don't specify one.
 
     ```bash title=".env"
-    ZROK_UNIQUE_NAME="my-prod-app"
+    ZROK_UNIQUE_NAME="toaster"
     ```
 
 1. Run the Compose project to start sharing the built-in demo web server. Be sure to `--detach` so the project runs in the background if you want it to auto-restart when your computer reboots.
@@ -60,7 +60,7 @@ When the project runs it will:
     ```
 
     ```buttonless title="Output"
-    zrok-public-share-1  |  https://w6r1vesearkj.in.zrok.io/
+    zrok-public-share-1  |  https://w6r1vesearkj.share.zrok.io/
     ```
 
 This concludes the minimum steps to begin sharing the demo web server. Read on to learn how to pivot to sharing any website or web service by leveraging additional zrok backend modes.
@@ -149,5 +149,5 @@ With Caddy, you can balance the workload for websites or web services or share s
     ```
 
     ```buttonless title="Output"
-    INFO: zrok public URL: https://88s803f2qvao.in.zrok.io/
+    INFO: zrok public URL: https://88s803f2qvao.share.zrok.io/
     ```

docs/guides/docker-share/index.mdx

@@ -14,9 +14,9 @@ This page provides `docker` and `docker compose` examples of mounting the host's
 
 ## Permanent Public Share
 
-Let's say you have a `compose.yml` file that defines a web app known within the project's bridge network as `https://myapp:8080` and you want to publish it as a reliable, public site.
+Let's say you have a `compose.yml` file that defines a web app known within the project's bridge network as `https://toaster:8080` and you want to publish it as a reliable, public site.
 
-1. Reserve a subdomain by running `zrok reserve public --unique-name "myapp" https://myapp:8080` on the Docker host.
+1. Reserve a subdomain by running `zrok reserve public --unique-name "toaster" https:toasterpp:8080` on the Docker host.
 1. Merge this YAML with `compose.yml` or save it in the same directory as `compose.override.yml` to let `docker compose up` merge it for you.
 
     ```yaml
@@ -29,10 +29,10 @@ Let's say you have a `compose.yml` file that defines a web app known within the
           - ${HOME}/.zrok:/home/ziggy/.zrok
         environment:
           PFXLOG_NO_JSON: "true"
-        command: share reserved "myapp" --headless
+        command: share reserved "toaster" --headless
     ```
 
-The reserved share will be available at `https://myapp.share.zrok.io` each time the `zrok` container starts up.
+The reserved share will be available at `https://toaster.share.zrok.io` each time the `zrok` container starts up.
 
 ## Temporary Public Share
 

docs/myzrok/custom-domains/index.mdx

@@ -6,7 +6,7 @@ title: Custom Domains
 [myzrok.io](https://myzrok.io) is a hosted zrok-as-a-service offering that provides a way for you bring a custom DNS name for zrok shares.
 For example, let's say you own the domain `foo.example.io`, you can leverage zrok custom domains to
 create ephemeral shares such as: `https://vw8jbg4ijz5g.foo.example.io`
-or [reserved shares](/concepts/sharing-reserved.md) such as `https://myshare.foo.example.io`.
+or [reserved shares](/concepts/sharing-reserved.md) such as `https://toaster.foo.example.io`.
 
 Custom domains require a Pro subscription with [myzrok.io](https://myzrok.io).
 If you don't already have an account, you can sign up for one [here](https://myzrok.io).

nfpm/zrok-share.env

@@ -84,7 +84,7 @@ ZROK_TARGET=""                  # e.g., http://127.0.0.1:3000
 #
 
 # you MAY customize the share token that is used to construct the reserved subdomain; if not set a random
-# subdomain is reserved
+# subdomain is reserved; lowercase alphanumeric, between 4 and 32 characters in length
 # WARNING: changes take effect the next time the frontend URL is reserved
 #ZROK_UNIQUE_NAME=""