http-tunnel-client/README.md

80 lines
1.3 KiB
Markdown
Raw Normal View History

# CUBETIQ HTTP Tunnel Client
A lightweight http tunnel client using nodejs and socket.io client.
### Installation
```shell
npm i -g @cubetiq/hlt
OR
2022-11-11 09:25:29 +07:00
npx -y @cubetiq/hlt
```
2022-10-20 10:18:08 +07:00
### Usages
2022-10-20 10:18:08 +07:00
- If installed to global (bin), please using cli
```shell
hlt [command] [options]
```
- Initialize Client and Start (Quick)
```shell
# Initialize a client and token for connect (default's profile)
2022-11-11 09:25:29 +07:00
npx -y @cubetiq/hlt init
# Start port 3000 to remote server
2022-11-11 09:25:29 +07:00
npx -y @cubetiq/hlt start 3000
```
2022-10-20 10:18:08 +07:00
# Start port 3000 with suffix to remote server
2022-11-11 09:25:29 +07:00
npx -y @cubetiq/hlt start 3000 -s mytest
2022-10-20 10:18:08 +07:00
````
- Initialize Client and Start (Quick with custom's profile)
```shell
# Initialize a client and token for connect (mytest's profile)
2022-11-11 09:25:29 +07:00
npx -y @cubetiq/hlt init -p mytest
# Start port 3000 to remote server (mytest's profile)
2022-11-11 09:25:29 +07:00
npx -y @cubetiq/hlt start 3000 -p mytest
2022-10-20 10:18:08 +07:00
````
### Custom Config
2022-10-20 10:18:08 +07:00
- Generate Client Key
```shell
2022-11-11 09:25:29 +07:00
npx -y @cubetiq/hlt config client new
```
2022-06-24 23:29:41 +07:00
2022-10-20 10:18:08 +07:00
- Set Client Token (Required, contact to vendor)
```shell
2022-11-11 09:25:29 +07:00
npx -y @cubetiq/hlt config token $TOKEN
```
2022-10-20 10:18:08 +07:00
- Set Custom Server
```shell
2022-11-11 09:25:29 +07:00
npx -y @cubetiq/hlt config server https://lt.ctdn.net
```
2022-10-20 10:18:08 +07:00
- Start Client
```shell
2022-11-11 09:25:29 +07:00
npx -y @cubetiq/hlt start $YOUR_PORT
```
2022-06-24 23:44:12 +07:00
### Contributors
2022-10-20 10:18:08 +07:00
- Original [web-tunnel](https://github.com/web-tunnel/lite-http-tunnel-client)
- Sambo Chea <sombochea@cubetiqs.com>