https://github.com/lerte/zroker
👻zrok gui client
https://github.com/lerte/zroker
zrok zrok-client zrok-gui zroker
Last synced: 5 months ago
JSON representation
👻zrok gui client
- Host: GitHub
- URL: https://github.com/lerte/zroker
- Owner: lerte
- License: mit
- Created: 2024-04-09T15:38:06.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-09T15:53:51.000Z (over 1 year ago)
- Last Synced: 2025-01-13T01:54:04.263Z (about 1 year ago)
- Topics: zrok, zrok-client, zrok-gui, zroker
- Language: TypeScript
- Homepage: https://zroker.com
- Size: 74.3 MB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zroker
## About
👻 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.
Now available on `Windows`, `macOS`,`Linux`.
Official website: [https://zroker.com](https://zroker.com)
# zrok is node wrapper for zrok
## To install dependencies:
#### use pnpm/yarn/npm
```bash
$ pnpm add zrok
# or
$ yarn add zrok
# or
$ npm i zrok
```
#### use bun
```bash
bun i --trust zrok
```
## Invite
```js
import zrok from "zrok";
const response = await zrok.invite("lerte@zrok.com");
// if success
// response.status 201
// response.statusText Created
```
## Create Account
> Check your email inbox, click the red button **Create Account**
## Enable
```js
// Enable your enviroment from Create Account link
// Copy the enable text for top right of your account
// paste to the enable parameter
const await zrok.enable("enalbe ************");
```
## Sharing
```js
const share = zrok.share("share public localhost:8080");
// kill share
share.kill();
```
## Overview
```js
const overview = zrok.overview();
// result
// {
// environments: [
// {
// environment: [Object ...],
// }
// ],
// }
```
### ⚠️ Note:
如果安装失败，可以手动从[https://github.com/openziti/zrok/releases](https://github.com/openziti/zrok/releases)下载对应平台最新的压缩包 tar.gz 格式的，直接放到 node_modules/zrok 目录，再执行
```sh
node node_modules/zrok/dist/install.js
```