extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2024-11-07 16:54:23 +01:00
Code Issues Packages Projects Releases Wiki Activity
Geo-scale, next-generation peer-to-peer sharing platform built on top of OpenZiti.
820 Commits 29 Branches 94 Tags 37 MiB
Go 45.6%
Python 23.3%
TypeScript 14.9%
HTML 8.1%
JavaScript 6.2%
Other 1.9%
a3936f6e3f
Go to file
Michael Quigley a3936f6e3f
doc tweaks
2023-01-30 14:43:04 -05:00
.github/workflows merge from origin/main 2023-01-30 13:48:02 -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 config unset; config set tweaks (#188) 2023-01-30 13:57:48 -05:00
controller log invalid authentication attempts (#186) 2023-01-30 11:43:28 -05:00
docs doc tweaks 2023-01-30 14:43:04 -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
website remove test component 2023-01-30 14:22:08 -05:00
zrokdir openziti-rest-kitchen -> openziti (#158) 2023-01-13 15:01:34 -05:00
.gitignore add package-lock and unignore 2023-01-27 22:12:49 -05: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-01-30 13:59:02 -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 readme lint 2023-01-30 14:27:40 -05:00
SECURITY.md add standard markdowns, start to fill them out 2023-01-27 08:28:50 -05:00

README.md

zrok

zrok is a next-generation sharing platform built on top of OpenZiti, a programmable zero-trust network overlay. zrok is an OpenZiti 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 an OpenZiti network and you're up and running.

See the Quick Start for details on getting your own zrok service instance running. This builds on top of the OpenZiti Quick Start to have you running a 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.