diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 37 |
1 files changed, 28 insertions, 9 deletions
@@ -1,26 +1,30 @@ # tunneltop + A tunnel manager in the familiar top style written with ncurses and asyncio.  ## Install + ```sh -pip install tunneltop +pipx install tunneltop ``` ## what it is -* a simple tunnel manager written in python that uses the standard library only(standard library only in python 3.11) -* it starts and manages the tunnels for you -* lets the user interactively manage the tunnels as well -* will reload the config file if it receives a `SIGHUP` -* it is intentionally written as simple and tunnel-agnostic -* may or may not work on windows(let me know if you test it on windows) + +- a simple tunnel manager written in python that uses the standard library only(standard library only in python 3.11) +- it starts and manages the tunnels for you +- lets the user interactively manage the tunnels as well +- will reload the config file if it receives a `SIGHUP` +- it is intentionally written as simple and tunnel-agnostic +- may or may not work on windows(let me know if you test it on windows) ## toml file tunneltop expects its config file to be at at `$HOME/.tunneltoprc`. You can see an example config file below:</br> + ```toml [color] header_fg = 4 @@ -62,40 +66,55 @@ auto_start = true The tunnel names must be unique.</br> ### address + Displays the address at which the tunnel is available at. It is a display-only option.</br> ### port + Displays the port at which the tunnel is available at. It is a display-only option.</br> ### command + The command used to start the tunnel.</br> ### test_command + The command used to test the state of the tunnel.</br> ### test_command_result + The expected result of the test command.</br> ### test_interval + How often should the `test_command` be run.</br> ### test_timeout + How long before the test is considered to have timed out.</br> ### auto_start -Whether to automatically start this tunnel on startup.</br> + +Whether to automatically start this tunnel on startup.</br> ## keybindings + `j` and `k` move you up and down.</br> `g` and `G`move you to the first or last tunnel.</br> `s` toggles a tunnel from enabled to disabled or vice versa.</br> -`r` restarts a tunnel.</br> +`r` restarts a tunnel.</br> `t` runs the test right now.</br> +`pgup` and `ctrl-b` move you up a page.<br/> + +`pgdown` and `ctrl-f` move you down a page.<br/> + +`ctrl-u` and `ctrl-d` move you up and down half a page respectively.<br/> + To quit send a `SIGINT` or a `SIGTERM`. I'm working on improving this of course.</br> tunneltop will reload its config file upon receiving a `SIGHUP` and apply the changes immediately if there are any.</br> |