Fixed some bugs and updated docs
This commit is contained in:
parent
e787b70da9
commit
42928444aa
10
CHANGELOG.md
Normal file
10
CHANGELOG.md
Normal file
@ -0,0 +1,10 @@
|
||||
### 20/10/2022
|
||||
|
||||
- Upgraded packages and fixed some bugs
|
||||
|
||||
### Initialized
|
||||
|
||||
- HTTP tunnel between server and client via https link
|
||||
- Custom profile (using `-p myprofile`)
|
||||
- Suffix url (using `-s`)
|
||||
- Config (get/set token,access,server,client,key configs)
|
30
README.md
30
README.md
@ -13,9 +13,15 @@ npx @cubetiq/hlt
|
||||
|
||||
```
|
||||
|
||||
### Usage
|
||||
### Usages
|
||||
|
||||
- Initialize Client and Start (Quick)
|
||||
- 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)
|
||||
@ -25,6 +31,12 @@ npx @cubetiq/hlt init
|
||||
npx @cubetiq/hlt start 3000
|
||||
```
|
||||
|
||||
# Start port 3000 with suffix to remote server
|
||||
|
||||
npx @cubetiq/hlt start 3000 -s mytest
|
||||
|
||||
````
|
||||
|
||||
- Initialize Client and Start (Quick with custom's profile)
|
||||
|
||||
```shell
|
||||
@ -33,29 +45,29 @@ npx @cubetiq/hlt init -p mytest
|
||||
|
||||
# Start port 3000 to remote server (mytest's profile)
|
||||
npx @cubetiq/hlt start 3000 -p mytest
|
||||
```
|
||||
````
|
||||
|
||||
### Custom Config
|
||||
|
||||
- Generate Client Key
|
||||
- Generate Client Key
|
||||
|
||||
```shell
|
||||
npx @cubetiq/hlt config client new
|
||||
```
|
||||
|
||||
- Set Client Token (Required, contact to vendor)
|
||||
- Set Client Token (Required, contact to vendor)
|
||||
|
||||
```shell
|
||||
npx @cubetiq/hlt config token $TOKEN
|
||||
```
|
||||
|
||||
- Custom Server
|
||||
- Set Custom Server
|
||||
|
||||
```shell
|
||||
npx @cubetiq/hlt config server https://lt.ctdn.net
|
||||
```
|
||||
|
||||
- Start Client
|
||||
- Start Client
|
||||
|
||||
```shell
|
||||
npx @cubetiq/hlt start $YOUR_PORT
|
||||
@ -63,5 +75,5 @@ npx @cubetiq/hlt start $YOUR_PORT
|
||||
|
||||
### Contributors
|
||||
|
||||
- Original [web-tunnel](https://github.com/web-tunnel/lite-http-tunnel-client)
|
||||
- Sambo Chea <sombochea@cubetiqs.com>
|
||||
- Original [web-tunnel](https://github.com/web-tunnel/lite-http-tunnel-client)
|
||||
- Sambo Chea <sombochea@cubetiqs.com>
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@cubetiq/hlt",
|
||||
"version": "0.1.0",
|
||||
"version": "0.1.1",
|
||||
"description": "A lightweight http tunnel client using nodejs and socket.io client",
|
||||
"main": "dist/client.js",
|
||||
"bin": {
|
||||
|
Loading…
Reference in New Issue
Block a user