nojhan/tunnelmon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

prepare 0.5

Browse source
This commit is contained in:
Johann Dreo 2016-12-13 22:57:13 +01:00
commit d6a3dbd75b
2 changed files with 28 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

8
CHANGELOG
View file

@ -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 * adds IPv6 support
* bugfixes * bugfixes

38
README.md
View file

@ -1,32 +1,35 @@
ereshkigal -- Monitor and manage autoSSH tunnels tunnelmon -- Monitor and manage autoSSH tunnels
================================================ ================================================
## SYNOPSIS ## SYNOPSIS
`ereshkigal` [-h] `tunnelmon` [-h]
`ereshkigal` [-c] [-n] [-a] [-l LEVEL] [-f FILE] `tunnelmon` [-c] [-n] [-u] [-l LEVEL] [-g FILE]
## DESCRIPTION ## 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. 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 ## INSTALLATION
`ereshkigal` targets Linux operating systems, and depends on: `tunnelmon` targets Linux operating systems, and depends on:
* `autossh` (which needs `OpenSSH`, obviously) * `openssh-client`
* `python` ≥ 2.4 * `python3`
You may want to install the recommend pacages also:
* `autossh`
## OPTIONS ## 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`: * `-h`, `--help`:
Show a help message and exit 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). Start the interactive user interface. Tunnels states will be updated regularly and you will be able to control them (see below).
* `-n`, `--connections`: * `-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`: * `-u`, `--tunnels`:
Only display the list of `autossh` processes. Only display the list of tunnels processes.
* `-l LEVEL`, `--log-level LEVEL`: * `-l LEVEL`, `--log-level LEVEL`:
Control the verbosity of the logging, the greater, the more verbose. Available log levels are: `error` < `warning` < 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. `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. 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 ## INTERACTIVE INTERFACE
Keyboard commands: 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). * `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`). * `C`: Close the selected tunnel (i.e. send a `SIGTERM`).
* `T`: (only available as root) show the tunnel connections related to each autossh instances. * `N`: Show the network connections related to each tunnel instances.
* `Q`: quit ereshkigal. * `Q`: Quit tunnelmon.