From a5fd3ca0ddd987ef625cd83da206fe9639622ffc Mon Sep 17 00:00:00 2001 From: Michael Quigley Date: Tue, 15 Nov 2022 13:24:13 -0500 Subject: [PATCH] public/private sharing (#20) --- docs/v0.3_public_private_sharing.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/v0.3_public_private_sharing.md b/docs/v0.3_public_private_sharing.md index a7905b9e..f395cadf 100644 --- a/docs/v0.3_public_private_sharing.md +++ b/docs/v0.3_public_private_sharing.md @@ -8,4 +8,8 @@ The `v0.3` series includes support for both "public" and "private" reverse proxi The following illustration shows the possibilities available. -![v0.3 Frontend Selection](images/zrok_frontends_v0.3.png) \ No newline at end of file +![v0.3 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 row in the `frontends` table with a `NULL` `environment_id`, a `type` of `public`, and a `name` set to `public` (or some other representative name). + +The other two "private" frontends are configured with an `environment_id` and no `name` label. The ephemeral environment is allocated when a `zrok` frontend request is made without an account on behalf of a private share.