extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-02-18 03:01:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

update images and getting started

Browse Source
This commit is contained in:
dovholuknf 2023-02-02 20:34:57 -05:00
parent fcb531bdb0
commit e8c575f34e
No known key found for this signature in database
GPG Key ID: 0EE08251136D3480
3 changed files with 16 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/getting-started.md
View File

@ -3,6 +3,20 @@ sidebar_position: 0
--- ---
# Getting Started with zrok # Getting Started with zrok
`zrok` is an open source, Apache v2 licensed sharing platform, built on top of [OpenZiti](https://docs.openziti.io/docs/learn/introduction/),
a programmable zero trust network overlay. `zrok` is an _OpenZiti Native Application_. You can choose to self-host `zrok`
or leverage the free, managed offering provided by NetFoundry: https://zrok.io
As of version `v0.3.0`, `zrok` provides the ability to:
* share resources [publicly](./core-features/sharing-public.md), similar to other distributed reverse proxies.
* share [privately](./core-features/sharing-private.md). It does this by leveraging
[OpenZiti](https://docs.openziti.io/docs/learn/introduction/) to support zero trust, peer to peer connections without
the need for any open ports on the internet.
* use `web` sharing; easily share files with others using a single `zrok` command
Let's take a look at how to get started with `zrok`.
:::note `zrok` moves fast! :::note `zrok` moves fast!
`zrok` is currently in a closed-beta phase and requires an invitation token. If you would like to try `zrok` and provide `zrok` is currently in a closed-beta phase and requires an invitation token. If you would like to try `zrok` and provide
@ -14,22 +28,6 @@ out directly.
::: :::
`zrok` is an open source, Apache v2 licensed sharing platform, built on top of [OpenZiti](https://docs.openziti.io/docs/learn/introduction/),
a programmable zero trust network overlay. `zrok` is an _OpenZiti Native Application_.
`zrok` facilitates sharing [publicly](./core-features/sharing-public.md), similar to other distributed reverse proxies.
But `zrok` __also__ supports sharing [privately](./core-features/sharing-private.md). It does this by leveraging
[OpenZiti](https://docs.openziti.io/docs/learn/introduction/) to support zero trust, peer to peer connections without
the need for any open ports on the internet.
As of version `v0.3.0`, `zrok` provides users the ability to publicly proxy local HTTP endpoints (similar to other offerings in this space). Additionally, `zrok` provides the ability to:
* _privately_ share resources with other `zrok` users; in _private_ usage scenarios, your private resources are not exposed to any public endpoints, and all communication is securely and privately transported between `zrok` clients
* use `web` sharing; easily share files with others using a single `zrok` command
Let's take a look at how to get started with `zrok`.
## Downloading zrok ## Downloading zrok
Releases are also available from the `zrok` project repository on GitHub at https://github.com/openziti/zrok/releases/latest Releases are also available from the `zrok` project repository on GitHub at https://github.com/openziti/zrok/releases/latest

BIN
docs/images/zrok_private_share.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 68 KiB

BIN
docs/images/zrok_public_share.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 72 KiB