extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2024-12-23 15:18:52 +01:00
Code Issues Packages Projects Releases Wiki Activity
Geo-scale, next-generation peer-to-peer sharing platform built on top of OpenZiti.
766 Commits 32 Branches 95 Tags 42 MiB
Go 44.1%
Python 25.1%
TypeScript 15.5%
HTML 7.6%
JavaScript 6%
Other 1.7%
ebfea01f84
Go to file
Michael Quigley ebfea01f84
document the configuration files (#176)
2023-01-24 14:12:54 -05:00
.github/workflows switch from ubuntu-latest to ubuntu-20.04 (#179) 2023-01-24 11:38:58 -05:00
bin initial rough pass for a stored token implementation 2023-01-09 11:00:37 -06:00
build use series in unlabeled build slug (#97) 2022-11-21 14:09:27 -05:00
cmd/zrok output generated tokens to stdout (#181) 2023-01-24 13:46:52 -05:00
controller registration/email_from -> email/from (#178) 2023-01-23 16:52:13 -05:00
docs Merge pull request #166 from openziti/qrkourier-patch-4 2023-01-19 13:10:53 -05:00
endpoints openziti-rest-kitchen -> openziti (#158) 2023-01-13 15:01:34 -05:00
etc document the configuration files (#176) 2023-01-24 14:12:54 -05:00
model better metrics accumulator (#74, #76) 2022-10-18 11:57:32 -04:00
rest_client_zrok forgot -> reset; password reset testing & tweaks (#65) 2023-01-20 12:08:40 -05:00
rest_model_zrok forgot -> reset; password reset testing & tweaks (#65) 2023-01-20 12:08:40 -05:00
rest_server_zrok forgot -> reset; password reset testing & tweaks (#65) 2023-01-20 12:08:40 -05:00
specs forgot -> reset; password reset testing & tweaks (#65) 2023-01-20 12:08:40 -05:00
tui seriousbusiness 2023-01-13 14:36:07 -05:00
ui forgot -> reset; password reset testing & tweaks (#65) 2023-01-20 12:08:40 -05:00
util ensure supplied email addresses are valid at both the CLI and the API (#108) 2022-11-29 13:23:23 -05:00
zrokdir openziti-rest-kitchen -> openziti (#158) 2023-01-13 15:01:34 -05:00
.gitignore don't check in local development config 2022-11-18 16:12:30 -05:00
.goreleaser-darwin.yml openziti-rest-kitchen -> openziti (#158) 2023-01-13 15:01:34 -05: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
CHANGELOG.md changelog 2023-01-24 13:47:52 -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
README.md readme (#159) 2023-01-18 13:42:22 -05:00

README.md

zrok

zrok is a next-generation sharing platform built on top of Ziti, 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

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 an OpenZiti network with zrok layered on top of it 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 a Ziti network and you're up and running.

See the v0.3 Quick Start for details on getting your own zrok service instance running. This builds on top of the Ziti Quick Start to have you running a zrok service instance in minutes.