Geo-scale, next-generation peer-to-peer sharing platform built on top of OpenZiti.
Go to file
Michael Quigley 53b7c3c7b7
api reshuffle
2022-07-25 11:51:23 -04:00
.github/workflows Initial commit 2022-07-19 19:10:32 -04:00
bin skip the automatically generated main 2022-07-22 11:48:24 -04:00
cmd/zrok api reshuffle 2022-07-25 11:51:23 -04:00
controller api reshuffle 2022-07-25 11:51:23 -04:00
docs/images fixed diagram; wthwit? 2022-07-21 21:30:49 -04:00
http solid proxy infrastructure 2022-07-21 16:01:39 -04:00
proxy solid proxy infrastructure 2022-07-21 16:01:39 -04:00
rest_model rudimentary account registration swagger 2022-07-25 11:44:17 -04:00
rest_zrok_client api reshuffle 2022-07-25 11:51:23 -04:00
rest_zrok_server api reshuffle 2022-07-25 11:51:23 -04:00
specs api reshuffle 2022-07-25 11:51:23 -04:00
util more minor logging lint 2022-07-21 16:19:05 -04:00
.gitignore controller store skeleton; sqlx; sqlite3; migrations 2022-07-22 13:53:39 -04:00
go.mod controller store skeleton; sqlx; sqlite3; migrations 2022-07-22 13:53:39 -04:00
go.sum controller store skeleton; sqlx; sqlite3; migrations 2022-07-22 13:53:39 -04:00
README.md multi-tenant is important 2022-07-21 09:45:51 -04:00

zrok

zrok is a utility for quickly proving public access to dark, private applications.

zrok overview

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 token, which can be used from any shell environment to quickly enable access to private applications.

Enabling zrok in a shell should be as simple as executing something like:

$ zrok enable <token>

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.

URLs that Don't Change

The smallest, simplest zrok implementation could be capable of providing URLs that don't change. The competition does not offer this capability without a subscription.

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.

Multiple Isolated Tenants

A single zrok implementation should support multiple isolated tenants coexisting on the same deployment (and underlying Ziti network) in a secure manner.

Self-hosting Capable

The zrok implementation should support self-hosting, such that existing Ziti users can easily add zrok capabilities to their existing networks.