diff --git a/CHANGELOG b/CHANGELOG index ef56041..7109a0a 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,4 +1,10 @@ -0:4: +0.5: +* python3 +* complete rewrite for portability +* handle autossh tunnels *and* raw ssh tunnels +* better formatting + +0.4: * adds IPv6 support * bugfixes diff --git a/README.md b/README.md index d070632..93f3929 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,35 @@ -ereshkigal -- Monitor and manage autoSSH tunnels +tunnelmon -- Monitor and manage autoSSH tunnels ================================================ ## SYNOPSIS -`ereshkigal` [-h] +`tunnelmon` [-h] -`ereshkigal` [-c] [-n] [-a] [-l LEVEL] [-f FILE] +`tunnelmon` [-c] [-n] [-u] [-l LEVEL] [-g FILE] ## DESCRIPTION -`ereshkigal` is an autossh tunnel monitor. It gives a user interface to monitor existing SSH tunnel that are managed with autossh. +`tunnelmon` is an autossh tunnel monitor. It gives a user interface to monitor existing SSH tunnel that are managed with autossh. It can print the current state of your tunnels or display them in an interactive text-based interface. -`ereshkigal` is released under the GNU Public License v3. +`tunnelmon` is released under the GNU Public License v3. ## INSTALLATION -`ereshkigal` targets Linux operating systems, and depends on: -* `autossh` (which needs `OpenSSH`, obviously) -* `python` ≥ 2.4 +`tunnelmon` targets Linux operating systems, and depends on: +* `openssh-client` +* `python3` + +You may want to install the recommend pacages also: +* `autossh` ## OPTIONS -Called without option,`ereshkigal` will print the current state of the autossh tunnels and exit. +Called without option,`tunnelmon` will print the current state of the autossh tunnels and exit. * `-h`, `--help`: Show a help message and exit @@ -35,26 +38,27 @@ Called without option,`ereshkigal` will print the current state of the autossh t Start the interactive user interface. Tunnels states will be updated regularly and you will be able to control them (see below). * `-n`, `--connections`: - Display only SSH connections related to a tunnel. This feature is only available as `root`, because it needs system permissions. + Display only SSH connections related to a tunnel. -* `-a`, `--autossh`: - Only display the list of `autossh` processes. +* `-u`, `--tunnels`: + Only display the list of tunnels processes. * `-l LEVEL`, `--log-level LEVEL`: Control the verbosity of the logging, the greater, the more verbose. Available log levels are: `error` < `warning` < `debug`. Defaults to `error`, which only prints unrecoverable problems. -* `-f FILE`, `--log-file FILE`: +* `-g FILE`, `--log-file FILE`: Log messages are written to the given FILE. Useful to debug the interactive interface. - If not set, asking for the curses interface automatically set logging to the "ereshkigal.log" file. + If not set, asking for the curses interface automatically set logging to the "tunnelmon.log" file. ## INTERACTIVE INTERFACE Keyboard commands: +* `↑` and `↓`: Select a tunnel. * `R`: Reload the selected autossh instance (i.e. send a `SIGUSR1`, which is interpreted as a reload command by autossh). -* `K`: Kill the selected autossh instance (i.e. send a `SIGKILL`). -* `T`: (only available as root) show the tunnel connections related to each autossh instances. -* `Q`: quit ereshkigal. +* `C`: Close the selected tunnel (i.e. send a `SIGTERM`). +* `N`: Show the network connections related to each tunnel instances. +* `Q`: Quit tunnelmon.