mirror of
https://github.com/tuxdotrs/trok.git
synced 2025-07-06 20:06:34 +05:30
91 lines
2.1 KiB
Markdown
91 lines
2.1 KiB
Markdown
<h3 align="center">
|
|
trok
|
|
</h3>
|
|
<p align="center">
|
|
Accessing your local service should be simple
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://wakatime.com/badge/user/012e8da9-99fe-4600-891b-bd9d8dce73d9/project/52396aaa-6648-4ee3-a470-7f02ce8d30b9"><img src="https://wakatime.com/badge/user/012e8da9-99fe-4600-891b-bd9d8dce73d9/project/52396aaa-6648-4ee3-a470-7f02ce8d30b9.svg" alt="wakatime"></a>
|
|
<a href="https://builtwithnix.org" target="_blank"><img alt="home" src="https://img.shields.io/static/v1?logo=nixos&logoColor=white&label=&message=Built%20with%20Nix&color=41439a"></a>
|
|
<img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/tuxdotrs/nix-config">
|
|
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/tuxdotrs/trok">
|
|
</p>
|
|
|
|
## Table of Contents
|
|
|
|
- [Features](#features)
|
|
- [Installation](#installation)
|
|
- [Usage](#usage)
|
|
- [Selfhost](#selfhost)
|
|
|
|
## Features
|
|
|
|
- [x] TCP Tunneling
|
|
- [ ] UDP Tunneling
|
|
- [x] HTTP Tunneling
|
|
- [ ] HTTPS Tunneling
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
curl -fsSL https://trok.cloud/install.sh | sh
|
|
```
|
|
|
|
#### Nix
|
|
|
|
```nix
|
|
# If you want to quickly test trok
|
|
nix run github:tuxdotrs/trok
|
|
```
|
|
|
|
#### Flake
|
|
|
|
```nix
|
|
# Add to your flake inputs
|
|
trok = {
|
|
url = "github:tuxdotrs/trok";
|
|
inputs.nixpkgs.follows = "nixpkgs";
|
|
};
|
|
|
|
# Add this in your nixos config
|
|
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 = {
|
|
url = "github:tuxdotrs/trok";
|
|
inputs.nixpkgs.follows = "nixpkgs";
|
|
};
|
|
|
|
# Add this in your nixos config
|
|
{inputs, ...}: {
|
|
imports = [
|
|
inputs.trok.nixosModules.default
|
|
];
|
|
|
|
tux.services.trok = {
|
|
enable = true;
|
|
host = "0.0.0.0";
|
|
port = 1337;
|
|
openFirewall = true;
|
|
user = "trok";
|
|
group = "trok";
|
|
};
|
|
}
|
|
```
|
|
Once deployed, your `trok` server will be ready to handle tunneling requests from clients.
|