mirror of
https://github.com/tuxdotrs/trok.git
synced 2025-07-06 03:56:33 +05:30
doc: update README.md
This commit is contained in:
12
README.md
12
README.md
@ -21,9 +21,9 @@
|
||||
## Features
|
||||
|
||||
- [x] TCP Tunneling
|
||||
- [ ] UDP Tunneling
|
||||
- [ ] UDP Tunneling (planned)
|
||||
- [x] HTTP Tunneling
|
||||
- [ ] HTTPS Tunneling
|
||||
- [ ] HTTPS Tunneling (planned)
|
||||
|
||||
## Installation
|
||||
|
||||
@ -52,18 +52,25 @@ environment.systemPackages = [ inputs.trok.packages.${system}.default ];
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Start a TCP tunnel:
|
||||
|
||||
```sh
|
||||
trok tcp PORT_NUMBER
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```sh
|
||||
trok tcp 3000
|
||||
```
|
||||
|
||||
This will expose your local service running on port `3000` to a public endpoint via the `trok` server.
|
||||
|
||||
## Selfhost
|
||||
|
||||
You can host your own `trok` server with NixOS:
|
||||
|
||||
```nix
|
||||
# Add to your flake inputs
|
||||
trok = {
|
||||
@ -87,4 +94,5 @@ trok = {
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
Once deployed, your `trok` server will be ready to handle tunneling requests from clients.
|
||||
|
Reference in New Issue
Block a user