Merge branch 'main' of github.com:openziti/zrok into python-sdk

This commit is contained in:
Cam 2023-12-05 13:51:51 -06:00
commit 5c553f6144
No known key found for this signature in database
GPG Key ID: 367B7C7EBD84A8BD
5 changed files with 18 additions and 102 deletions

View File

@ -6,6 +6,8 @@ FEATURE: Python sdk added. Can be found on [pypi](https://test.pypi.org/project/
CHANGE: Moved the golang zrok sdk into `sdk/golang/sdk` to normalize location for future sdk's.
CHANGE: add restart policies to docker compose samples used by the guide docs, e.g., reserved public share should auto-start on boot, temp public share should not.
## v0.4.17
CHANGE: Replaced most in-line shell scripts in Docker Compose projects with installed scripts that are shared between the Docker and Linux service. This normalizes the operational configuration of both Docker shares and Linux service, i.e., to use the same env vars.

View File

@ -34,8 +34,6 @@ services:
condition: service_completed_successfully
volumes:
- zrok_env:/mnt
ports: []
# - 127.0.0.1:2019:2019 # Caddy admin API
environment:
# internal configuration
STATE_DIRECTORY: /mnt # zrok homedir in container

View File

@ -6,13 +6,23 @@ hide_table_of_contents: true
---
import OsTabs from '@theme/OsTabs';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
// import Details from '@theme/MDXComponents/Details';
import LinuxService from './_frontdoor-linux.mdx';
import ReservedDocker from './_frontdoor-docker.mdx';
**zrok frontdoor** provides a shielded entry point for your production website or service. This is useful if you want to expose it to the public internet, but not directly.
**zrok frontdoor** is the heavy-duty front door to your app or site. It makes your website or app available to your online audience through the shield of zrok.io's hardened, managed frontends.
<iframe width="100%" height="315" src="https://www.youtube.com/embed/5Vi8GKuTi_I" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
## Overview
zrok frontends are the parts of zrok that proxy incoming public web traffic to zrok backend shares via OpenZiti. When you use zrok with a `zrok.io` frontend, you're using **zrok frontdoor**. `zrok.io` is zrok-as-a-service by NetFoundry, the team behind OpenZiti. You need a free account to use **zrok frontdoor**.
![diagram](/img/zrok-frontdoor.excalidraw.png)
## Choose your OS
Choose between installing the Linux package or running zrok with Docker (Linux, macOS, or Windows).
<OsTabs
queryString="os"

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 4.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 291 KiB