mirror of
https://github.com/openziti/zrok.git
synced 2024-11-07 16:54:23 +01:00
README; (#159)
This commit is contained in:
parent
9ca5b967e4
commit
601098a617
49
README.md
49
README.md
@ -1,47 +1,16 @@
|
||||
![zrok](docs/images/zrok.png)
|
||||
|
||||
# zrok
|
||||
|
||||
`zrok` is a service designed to provide frictionless access to ephemeral, geo-scale reverse proxy capabilities. `zrok` is implemented on top of OpenZiti as a _Ziti Native Application_.
|
||||
`zrok` is a next-generation sharing platform built on top of [Ziti][openziti], a programmable zero-trust network overlay. `zrok` is a _Ziti Native Application_.
|
||||
|
||||
## Characteristics
|
||||
`zrok` facilitates sharing resources publicly and privately, exposing them to an audience you can easily control.
|
||||
|
||||
`zrok` has the following characteristics:
|
||||
As of version `v0.3.0`, `zrok` provides users the ability to publicly proxy local `http`/`https` endpoints (similar to other players in this space). Additionally, `zrok` provides the ability to:
|
||||
|
||||
### Frictionless
|
||||
* _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
|
||||
|
||||
`zrok` is designed to provide a "frictionless" experience. Only a single binary and a single command are required to take advantage of all of the power of `zrok`.
|
||||
## Self-Hostable
|
||||
|
||||
`zrok` works in a large number environments: developer shells, container sidecars, serverless environments, webhooks.
|
||||
|
||||
### Expand with OpenZiti
|
||||
|
||||
`zrok` is built on top of OpenZiti, a next-generation solution for secure application connectivity. `zrok` is a fantastic way to start working with OpenZiti. Start with simple `zrok` ephemeral connectivity, and then layer on additional capabilities provided by the underlying OpenZiti network.
|
||||
|
||||
Bring `zrok` into your existing OpenZiti deployment to provide rapid, ephemeral connectivity for a number of important HTTP scenarios.
|
||||
|
||||
### World-Scale
|
||||
|
||||
`zrok` is the software that powers the `zrok.io` world-scale service. `zrok` can scale as large as you need.
|
||||
|
||||
### Multiple Isolated Tenants
|
||||
|
||||
A single `zrok` instance can support any number of isolated tenants, allowing them to coexist on top of the same OpenZiti deployment in a secure manner.
|
||||
|
||||
### Self-hosting Capable
|
||||
|
||||
Install `zrok` on top of your own OpenZiti network. `zrok` is simple to operate and scale.
|
||||
|
||||
## Concepts
|
||||
|
||||
`zrok` is conceptually structured like this:
|
||||
|
||||
![zrok overview](docs/images/zrok_v0.2_overview.png)
|
||||
|
||||
### zrok Frontend, zrok Backend
|
||||
|
||||
The `zrok` reverse proxy is broken into two halves, a _frontend_ and a _backend_. These two components connect over an OpenZiti network. Together the frontend and the backend work together to implement a reverse proxy.
|
||||
|
||||
The frontend is designed to be sited on an accessible network (typically the public internet). This allows traffic from that accessible network to ingress into the `zrok` frontend, across the dynamic reverse proxy.
|
||||
|
||||
The backend is designed to be sited in a private environment, such as a private development server, or a serverless environment, or a container sidecar. The backend only needs outbound connectivity to reach the OpenZiti network and the `zrok` controller.
|
||||
|
||||
The controller is a lightweight control plane component, which orchestrates connectivity between frontend and backend components.
|
||||
`zrok` is fully self-hostable.
|
||||
|
BIN
docs/images/zrok.png
Executable file
BIN
docs/images/zrok.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 33 KiB |
Loading…
Reference in New Issue
Block a user