extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2024-11-21 23:53:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
Michael Quigley 2022-07-19 13:37:30 -04:00
parent 1160d02945
commit b8354d71dd
No known key found for this signature in database
GPG Key ID: 9B60314A9DD20A62
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,3 +1,27 @@
# zrok
`zrok` is a utility for quickly proving public access to dark, private applications.
![zrok overview](docs/images/zrok_overview.png)
`zrok` is designed with the following properties:
## Easiest Possible On-ramp
`zrok` is the fastest, simplest path for exposing dark, private applications onto the public internet using Ziti.
### Simple Registration
Registering for access to `zrok` should provide the user with a single identity, which can be used from any shell environment to quickly enable access to private applications.
### Single-Executable Deployment
A registered user should only need a single executable (`zrok`), along with their identity, to enable `zrok` capabilities in any shell environment.
## Expand into Ziti
The `zrok` implementation should (ideally) be such that `zrok` usage patterns can co-exist with larger, more featureful Ziti implementations. Ideally, a developer who started with `zrok` should have patterns that allow them to incrementally expand their usage.
## Self-hosting Capable
The `zrok` implementation should support self-hosting, such that existing Ziti users can easily add `zrok` capabilities to their existing networks.