mirror of
https://github.com/openziti/zrok.git
synced 2024-11-29 11:34:07 +01:00
76 lines
2.5 KiB
Plaintext
76 lines
2.5 KiB
Plaintext
---
|
|
title: zrok frontdoor
|
|
sidebar_label: frontdoor
|
|
sidebar_position: 20
|
|
hide_table_of_contents: true
|
|
---
|
|
|
|
import OsTabs from '@theme/OsTabs';
|
|
import TabItem from '@theme/TabItem';
|
|
import LinuxService from './_frontdoor-linux.mdx';
|
|
import ReservedDocker from './_frontdoor-docker.mdx';
|
|
import ThemedImage from '@theme/ThemedImage';
|
|
import useBaseUrl from '@docusaurus/useBaseUrl';
|
|
|
|
**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**.
|
|
|
|
|
|
<ThemedImage
|
|
alt="frontdoor diagram"
|
|
sources={{
|
|
light: useBaseUrl('/img/zrok-frontdoor-light-mode.svg'),
|
|
dark: useBaseUrl('/img/zrok-frontdoor-dark-mode.svg'),
|
|
}}
|
|
/>
|
|
|
|
## Choose your OS
|
|
|
|
Choose between installing the Linux package or running zrok with Docker (Linux, macOS, or Windows).
|
|
|
|
<OsTabs
|
|
queryString="os"
|
|
values={[
|
|
{ label: 'Linux', value: 'Linux', },
|
|
{ label: 'macOS', value: 'Mac OS', },
|
|
{ label: 'Windows', value: 'Windows', },
|
|
]}
|
|
>
|
|
|
|
<TabItem value="Linux">
|
|
|
|
On Linux, zrok frontdoor is implemented natively as a system service provided by the `zrok-share` DEB or RPM package.
|
|
|
|
If you'd prefer to run zrok in Docker instead of installing the package then you can follow the Docker instructions. With Docker, the steps are the same for Linux, [macOS](./?os=Mac+OS), and [Windows](./?os=Windows).
|
|
|
|
<LinuxService/>
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="Mac OS">
|
|
|
|
On macOS, zrok frontdoor is implemented as a Docker Compose project which reserves a public subdomain for your website or service.
|
|
|
|
<ReservedDocker/>
|
|
|
|
</TabItem>
|
|
|
|
<TabItem value="Windows">
|
|
|
|
On Windows, zrok frontdoor is implemented as a Docker Compose project which reserves a public subdomain for your website or service.
|
|
|
|
<ReservedDocker/>
|
|
|
|
</TabItem>
|
|
|
|
</OsTabs>
|
|
|
|
## Concepts
|
|
|
|
Overview of [zrok reserved shares](/concepts/sharing-reserved.md)
|