{"id":16328767,"url":"https://github.com/lerte/zroker","last_synced_at":"2025-10-25T21:30:44.208Z","repository":{"id":232654391,"uuid":"784307445","full_name":"lerte/zroker","owner":"lerte","description":"👻zrok gui client","archived":false,"fork":false,"pushed_at":"2024-07-09T15:53:51.000Z","size":77924,"stargazers_count":9,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-13T01:54:04.263Z","etag":null,"topics":["zrok","zrok-client","zrok-gui","zroker"],"latest_commit_sha":null,"homepage":"https://zroker.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lerte.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-09T15:38:06.000Z","updated_at":"2024-09-28T12:27:09.000Z","dependencies_parsed_at":"2024-04-14T18:29:09.645Z","dependency_job_id":"69ce2e4d-021c-4c85-a08d-5c02a9c4b52f","html_url":"https://github.com/lerte/zroker","commit_stats":null,"previous_names":["lerte/zroker"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lerte%2Fzroker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lerte%2Fzroker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lerte%2Fzroker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lerte%2Fzroker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lerte","download_url":"https://codeload.github.com/lerte/zroker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238212347,"owners_count":19434946,"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":["zrok","zrok-client","zrok-gui","zroker"],"created_at":"2024-10-10T23:14:30.946Z","updated_at":"2025-10-25T21:30:42.271Z","avatar_url":"https://github.com/lerte.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Zroker\n\n## About\n\n👻 Zroker is a gui client for [zrok](https://zrok.io). An open source sharing solution built on OpenZiti, the zero trust networking platform. Available as SaaS or self-hosted.\nNow available on `Windows`, `macOS`,`Linux`.\n\nOfficial website: [https://zroker.com](https://zroker.com)\n\n![overview](https://github.com/lerte/zroker/assets/15228321/6a5289ed-d07c-42e8-a8cf-5fe14bcf72df)\n# zrok is node wrapper for zrok\n\n## To install dependencies:\n\n#### use pnpm/yarn/npm\n\n```bash\n$ pnpm add zrok\n# or\n$ yarn add zrok\n# or\n$ npm i zrok\n```\n\n#### use bun\n\n```bash\nbun i --trust zrok\n```\n\n## Invite\n\n```js\nimport zrok from \"zrok\";\nconst response = await zrok.invite(\"lerte@zrok.com\");\n// if success\n// response.status 201\n// response.statusText Created\n```\n\n## Create Account\n\n\u003e Check your email inbox, click the red button **Create Account**\n\n## Enable\n\n```js\n// Enable your enviroment from Create Account link\n// Copy the enable text for top right of your account\n// paste to the enable parameter\nconst await zrok.enable(\"enalbe ************\");\n```\n\n## Sharing\n\n```js\nconst share = zrok.share(\"share public localhost:8080\");\n// kill share\nshare.kill();\n```\n\n## Overview\n\n```js\nconst overview = zrok.overview();\n// result\n// {\n//   environments: [\n//     {\n//       environment: [Object ...],\n//     }\n//   ],\n// }\n```\n\n### ⚠️ Note:\n\n如果安装失败，可以手动从[https://github.com/openziti/zrok/releases](https://github.com/openziti/zrok/releases)下载对应平台最新的压缩包 tar.gz 格式的，直接放到 node_modules/zrok 目录，再执行\n\n```sh\nnode node_modules/zrok/dist/install.js\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flerte%2Fzroker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flerte%2Fzroker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flerte%2Fzroker/lists"}