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-24 20:17:03 +05:30
parent 18d9117236
commit b37940f636
1 changed files with 20 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -11,19 +11,34 @@
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/tuxdotrs/trok"> <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/tuxdotrs/trok">
</p> </p>
### Table of Contents ## Table of Contents
- [Features](#features)
- [Installation](#installation) - [Installation](#installation)
- [Usage](#usage) - [Usage](#usage)
- [Selfhost](#selfhost) - [Selfhost](#selfhost)
### Installation ## Features
- [x] TCP Tunneling
- [ ] UDP Tunneling
- [x] HTTP Tunneling
- [ ] HTTPS Tunneling
## Installation
```sh ```sh
curl -fsSL https://trok.cloud/install.sh | sh curl -fsSL https://trok.cloud/install.sh | sh
``` ```
#### Nix Flake #### Nix
```nix
# If you want to quickly test trok
nix run github:tuxdotrs/trok
```
#### Flake
```nix ```nix
# Add to your flake inputs # Add to your flake inputs
@ -36,12 +51,12 @@ trok = {
environment.systemPackages = [ inputs.trok.packages.${system}.default ]; environment.systemPackages = [ inputs.trok.packages.${system}.default ];
``` ```
### Usage ## Usage
```sh ```sh
trok tcp PORT_NUMBER trok tcp PORT_NUMBER
``` ```
### Selfhost ## Selfhost
TODO TODO