Geo-scale, next-generation peer-to-peer sharing platform built on top of OpenZiti.
Go to file
2023-02-07 19:06:35 -06:00
.github/workflows Add on-watch for zhook action 2023-02-07 11:07:38 -05:00
bin initial rough pass for a stored token implementation 2023-01-09 11:00:37 -06:00
build gon changes to enable notarization 2023-01-25 15:44:48 -06:00
cmd/zrok small ui fix and added better error for tokens 2023-02-07 19:06:35 -06:00
controller small ui fix and added better error for tokens 2023-02-07 19:06:35 -06:00
docs Diagram Swap for Private and Public 2023-02-05 10:22:11 -05:00
endpoints --insecure for share '<public|private|reserved>' (#195) 2023-01-30 17:38:58 -05:00
etc minor tou revisions (#184) 2023-01-31 14:04:42 -05:00
model better metrics accumulator (#74, #76) 2022-10-18 11:57:32 -04:00
rest_client_zrok small ui fix and added better error for tokens 2023-02-07 19:06:35 -06:00
rest_model_zrok added configuration endpoint which sends tou link and version info 2023-01-31 12:44:03 -06:00
rest_server_zrok small ui fix and added better error for tokens 2023-02-07 19:06:35 -06:00
specs small ui fix and added better error for tokens 2023-02-07 19:06:35 -06:00
tui seriousbusiness 2023-01-13 14:36:07 -05:00
ui updated package.json and cleaned up some linter warnings 2023-02-03 10:27:31 -06:00
util ensure supplied email addresses are valid at both the CLI and the API (#108) 2022-11-29 13:23:23 -05:00
website lint 2023-02-07 13:59:51 -05:00
zrokdir openziti-rest-kitchen -> openziti (#158) 2023-01-13 15:01:34 -05:00
.gitignore added error checking for name collision on frontend and send corresponding error 2023-02-01 13:13:15 -06:00
.goreleaser-darwin.yml openziti-rest-kitchen -> openziti (#158) 2023-01-13 15:01:34 -05:00
.goreleaser-linux-arm.yml added arm7 builds 2023-01-30 10:42:22 -06:00
.goreleaser-linux.yml openziti-rest-kitchen -> openziti (#158) 2023-01-13 15:01:34 -05:00
.goreleaser-release.yml fully cross-platform build? (#70) 2022-11-03 16:51:22 -04:00
.goreleaser-windows.yml openziti-rest-kitchen -> openziti (#158) 2023-01-13 15:01:34 -05:00
BUILD.md rearranging getting started to use v3 2023-01-30 13:45:12 -05:00
CHANGELOG.md changelog 2023-02-06 13:50:56 -05:00
CODE_OF_CONDUCT.md add standard markdowns, start to fill them out 2023-01-27 08:28:50 -05:00
CONTRIBUTING.md add standard markdowns, start to fill them out 2023-01-27 08:28:50 -05:00
go.mod openziti-rest-kitchen -> openziti (#158) 2023-01-13 15:01:34 -05:00
go.sum zrok invite tui (#153) 2023-01-11 14:26:58 -05:00
LICENSE add LICENSE 2023-01-30 13:22:37 -05:00
README.md lint 2023-02-07 15:00:50 -05:00
SECURITY.md add standard markdowns, start to fill them out 2023-01-27 08:28:50 -05:00

zrok

zrok is a next-generation sharing platform built on top of OpenZiti, a programmable zero-trust network overlay. zrok is a Ziti Native Application.

zrok facilitates sharing resources both publicly and privately, exposing them to an audience you can easily control.

Like other offerings in this space, zrok allows users to create ephemeral reverse proxies ("tunnels") for http resources. Additionally:

  • zrok allows users to privately share resources with other zrok users; in private usage scenarios, your private resources are not exposed to any public endpoints; all communication is securely and privately transported between zrok environments
  • zrok allows sharing other types of resources; rather than just proxying http endpoints, zrok allows users to easily and rapidly share files and web content
  • zrok is ready to be extended to easily support many kinds of decentralized resource sharing; zrok provides a framework that makes this kind of peer-to-peer resource sharing simple and secure

zrok

Frictionless

You can be up and sharing using the zrok.io service in minutes. Here is a synopsis of what's involved.

First-time Setup

  • Download the binary for your platform here
  • zrok invite to create an account with the service
  • zrok enable to enable your shell environment for sharing with the service

And then... sharing...

  • zrok share to share resources immediately, simply and securely

See the Concepts and Getting Started Guide for a full overview.

Self-Hosting

zrok is designed to scale up to support extremely large service instances. zrok.io is a public service instance operated by NetFoundry using the same code base that is available to self-hosted environments.

zrok is also designed to scale down to support extremely small deployments. Run zrok and OpenZiti on a Raspberry Pi!

The single zrok binary contains everything you need to operate zrok environments and also host your own service instances. Just add an OpenZiti network and you're up and running.

See the Self-Hosting Guide for details on getting your own zrok service instance running. This builds on top of the OpenZiti Quick Start to have a running zrok service instance in minutes.

Building

If you are interested in building zrok for yourself instead of using a released package, please refer to BUILD.md

Contributing

If you'd like to contribute back to zrok, that'd be great. Please see our CONTRIBUTING.md page and abide by the CODE_OF_CONDUCT.md.