diff --git a/AUTHORS b/AUTHORS index 3902d46..6f3e279 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,6 +1,6 @@ -N:Johann Dréo +N:nojhan P:nojhan -E:nojhan@gmail.com +E:nojhan@nojhan.net D:2009-06-23 C:Initial code, lead developper diff --git a/CHANGELOG b/CHANGELOG index bdd954a..ef56041 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,7 @@ +0:4: +* adds IPv6 support +* bugfixes + 0.3: * added a via_host field (show on which host the tunnel is build) * don't try to show connections if the user is not root diff --git a/README.md b/README.md new file mode 100644 index 0000000..d070632 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +ereshkigal -- Monitor and manage autoSSH tunnels +================================================ + +## SYNOPSIS + +`ereshkigal` [-h] + +`ereshkigal` [-c] [-n] [-a] [-l LEVEL] [-f FILE] + + +## DESCRIPTION + +`ereshkigal` 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. + + +## INSTALLATION + +`ereshkigal` targets Linux operating systems, and depends on: +* `autossh` (which needs `OpenSSH`, obviously) +* `python` ≥ 2.4 + + +## OPTIONS + +Called without option,`ereshkigal` will print the current state of the autossh tunnels and exit. + +* `-h`, `--help`: + Show a help message and exit + +* `-c`, `--curses`: + 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. + +* `-a`, `--autossh`: + Only display the list of `autossh` 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`: + 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. + + +## INTERACTIVE INTERFACE + +Keyboard commands: + +* `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. + diff --git a/ereshkigal.py b/ereshkigal.py old mode 100644 new mode 100755 diff --git a/index.html b/index.html deleted file mode 100644 index 2fb1aba..0000000 --- a/index.html +++ /dev/null @@ -1,84 +0,0 @@ - - - -
- - - -Ereshkigal is an autossh tunnel monitor. It gives a user interface to monitor existing SSH tunnel that are managed with autossh.
- - - -Ereshkigal targets Unix-like operating systems, and depends on: -
- - -Simply run ereshkigal to have the tunnel list, or ereshkigal --curses for the text-mode interactive interface.
See the help for more options:
--$ ./ereshkigal --help -Usage: ereshkigal [options] -A user interface to monitor existing SSH tunnel that are managed with autossh. -Called without options, ereshkigal displays a list of tunnels on the standard output. - -Options: - -h, --help show this help message and exit - -c, --curses start the user interface in text mode - -n, --connections display only SSH connections related to a tunnel - -a, --autossh display only the list of autossh processes -- - -
Ereshigal is released under the GNU General Public License version 3.
-See the sourceforge project page if you want to participate or get more informations.
- - - - -