{"id":13576793,"url":"https://github.com/openziti/zrok","last_synced_at":"2025-05-13T15:12:56.136Z","repository":{"id":65592384,"uuid":"515311500","full_name":"openziti/zrok","owner":"openziti","description":"Geo-scale, next-generation peer-to-peer sharing platform built on top of OpenZiti.","archived":false,"fork":false,"pushed_at":"2025-04-30T19:08:37.000Z","size":33085,"stargazers_count":3154,"open_issues_count":94,"forks_count":126,"subscribers_count":27,"default_branch":"main","last_synced_at":"2025-04-30T19:43:41.033Z","etag":null,"topics":["file-sharing","golang","network","peer-to-peer","reverse-proxy","security","zero-trust"],"latest_commit_sha":null,"homepage":"https://zrok.io","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openziti.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-07-18T19:14:51.000Z","updated_at":"2025-04-30T13:35:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"fce189fb-d595-4476-ac92-b860932628d7","html_url":"https://github.com/openziti/zrok","commit_stats":{"total_commits":1781,"total_committers":23,"mean_commits":77.43478260869566,"dds":"0.21560920830993824","last_synced_commit":"b22bc9fb75c3f5c91464c558e58aed477c643d0b"},"previous_names":[],"tags_count":110,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openziti%2Fzrok","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openziti%2Fzrok/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openziti%2Fzrok/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openziti%2Fzrok/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openziti","download_url":"https://codeload.github.com/openziti/zrok/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253969266,"owners_count":21992264,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["file-sharing","golang","network","peer-to-peer","reverse-proxy","security","zero-trust"],"created_at":"2024-08-01T15:01:14.226Z","updated_at":"2025-05-13T15:12:51.123Z","avatar_url":"https://github.com/openziti.png","language":"Go","funding_links":[],"categories":["Go","security","\u003ca name=\"transfer\"\u003e\u003c/a\u003eData transfer"],"sub_categories":[],"readme":"![zrok logo](docs/images/zrok_cover.png)\n\n**Note: If you upgrade to `v1.0.0` and you receive an error message like this:**\n\n```\n[ERROR]: unable to create share (error getting zrok client: client version error accessing api endpoint 'https://api.zrok.io': [POST /clientVersionCheck] clientVersionCheck (status 404): {}: [POST /clientVersionCheck] clientVersionCheck (status 404): {})\n```\n\nUse the command `zrok rebase apiEndpoint https://api-v1.zrok.io/` to update your environment for the `v1.0.0` release.\n\n## Your Secure Internet Sharing Perimeter\n\n`zrok` is a next-generation, peer-to-peer sharing platform built on top of [OpenZiti](https://docs.openziti.io/docs/learn/introduction/), a programmable zero-trust network overlay. `zrok` is a _Ziti Native Application_.\n\n`zrok` facilitates both public and private sharing. Public sharing allows you to share securely with non-`zrok` users over the public internet. Private sharing allows you to directly share peer-to-peer with other `zrok` users. No security or firewall changes are required for either type of sharing. No inbound connectivity is required. The OpenZiti overlay provides peer-to-peer connectivity without IP addresses, and employs end-to-end encryption for world-class security.\n\nLike other offerings in this space, `zrok` allows users to create tunnels for HTTP, TCP and UDP network resources. `zrok` additionally allows users to easily and rapidly share files, web content, and custom resources in a peer-to-peer manner.\n\n![zrok Web Console](docs/images/zrok_web_console.png)\n\n## Frictionless\n\nYou can be up and sharing using the `zrok.io` service in minutes. Here is a synopsis of what's involved:\n\n* [Install the package or download the binary for your platform](https://docs.zrok.io/docs/guides/install/).\n* `zrok invite` to create an account with the service (use the [NetFoundry hosted zrok.io service](https://docs.zrok.io/docs/getting-started/))\n* `zrok enable` to enable your shell environment for sharing with the service\n\n### And then... sharing...\n\nEasily share private network resources with public internet users, securely, without having to alter any of your local network configuration:\n\n```\n$ zrok share public localhost:8080\n```\n\n![zrok share public](docs/images/zrok_share_public.png)\n\n```\n$ curl -s https://dslno640nct4.share.zrok.io | head\n\u003c!DOCTYPE html\u003e\n\u003chtml lang=\"en\"\u003e\n\u003chead\u003e\n    \u003cmeta charset=\"utf-8\"/\u003e\n    \u003cmeta name=\"viewport\" content=\"width=device-width, initial-scale=1\"/\u003e\n    \u003cmeta name=\"theme-color\" content=\"#000000\"/\u003e\n    \u003cmeta name=\"description\" content=\"zrok ui\"/\u003e\n    \u003clink rel=\"preconnect\" href=\"https://fonts.googleapis.com\"\u003e\n```\n\nShare \"network drives\" with public and private users running on Windows, macOS, or Linux systems:\n\n```\n$ zrok share public --backend-mode drive ~/Repos/zrok\n```\n\n![zrok share public -b drive](docs/images/zrok_share_public_drive.png)\n\nMounting and working with shared drives is simple, and works with any applications on the end users' systems:\n\n![mounted zrok drive](docs/images/zrok_share_public_drive_explorer.png)\n\nSee the [Concepts and Getting Started Guide](https://docs.zrok.io/docs/getting-started) for a full overview.\n\n## The `zrok` SDK\n\n`zrok` includes an SDK that allows you to embed `zrok` sharing capabilities into your own applications. If you're familiar with a golang `net.Conn` and `net.Listener`, you'll be right at home with our SDK.\n\n### A Simple `zrok` Sharing Service\n\n```go\n// load enabled zrok environment\nroot, err := environment.LoadRoot()\n\n// request a share for your resource\nshr, err := sdk.CreateShare(root, \u0026sdk.ShareRequest{\n    BackendMode: sdk.TcpTunnelBackendMode,\n    ShareMode:   sdk.PrivateShareMode,\n\t// ...\n})\n\n// accept requests for your resource\nlistener, err := sdk.NewListener(shr.Token, root)\n```\n\n### A Simple `zrok` Client\n\n```go\n// load enabled zrok environment\nroot, err := environment.LoadRoot()\n\n// request access to a shared zrok resource\nacc, err := sdk.CreateAccess(root, \u0026sdk.AccessRequest{ShareToken: shrToken})\n\n// establish a connection to the resource directly\nconn, err := sdk.NewDialer(shrToken, root)\n```\n\nThis [blog post](https://blog.openziti.io/the-zrok-sdk) provides more details for [getting started](https://blog.openziti.io/the-zrok-sdk) with the `zrok` SDK.\n\n## Self-Hosting\n\n`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.\n\n`zrok` is also designed to scale down to support extremely small deployments. Run `zrok` and OpenZiti on a Raspberry Pi!\n\nThe 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.\n\nSee the [Self-Hosting Guide](https://docs.zrok.io/docs/guides/self-hosting/self_hosting_guide/) for details on getting your own `zrok` service instance running.\n\n## zrok Office Hours\n\nWe maintain a growing playlist of videos focusing on various aspects of `zrok`. This includes the \"office hours\" series, which are longer-format videos digging into the implementation of `zrok` and showcasing some of the latest features and capabilities:\n\n[![zrok Office Hours](https://img.youtube.com/vi/Edqv7yRmXb0/0.jpg)](https://www.youtube.com/watch?v=Edqv7yRmXb0\u0026list=PLMUj_5fklasLuM6XiCNqwAFBuZD1t2lO2)\n\n\n\n## Building\n\nIf you are interested in building `zrok` for yourself instead of using a released package, please refer to [BUILD.md](./BUILD.md)\n\n## Contributing\n\nIf you'd like to contribute back to `zrok`, that'd be great. Please see our [CONTRIBUTING.md](./CONTRIBUTING.md) page and\nabide by the [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenziti%2Fzrok","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenziti%2Fzrok","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenziti%2Fzrok/lists"}