tux/trok
1
0
Fork 0
mirror of https://github.com/tuxdotrs/trok.git synced 2025-07-06 11:56:34 +05:30
Code Issues Packages Projects Releases Wiki Activity

doc: update README.md

Browse Source
This commit is contained in:
tux
2025-06-25 01:38:47 +05:30
committed by GitHub
parent 071c671127
commit 56a4ba0460
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -52,13 +52,18 @@ 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 = {
@ -82,3 +87,4 @@ trok = {
};
}
```
Once deployed, your `trok` server will be ready to handle tunneling requests from clients.