Add README, remove old html doc.
Makes script executable.
This commit is contained in:
parent
9b0833f65c
commit
9a6ec1a6b3
5 changed files with 66 additions and 86 deletions
4
AUTHORS
4
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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
60
README.md
Normal file
60
README.md
Normal file
|
|
@ -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.
|
||||
|
||||
0
ereshkigal.py
Normal file → Executable file
0
ereshkigal.py
Normal file → Executable file
84
index.html
84
index.html
|
|
@ -1,84 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
||||
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/HTML; charset=utf-8" />
|
||||
<meta name=" robot" content="follow, index, all" />
|
||||
|
||||
<title>Ereshkigal</title>
|
||||
|
||||
<style>
|
||||
|
||||
h1, h2, h3, h4, h5, h6
|
||||
{
|
||||
font-family: Arial,Helvetica,sans-serif;
|
||||
font-weight: bold;
|
||||
color: #08f;
|
||||
}
|
||||
|
||||
h1
|
||||
{
|
||||
padding-top: 20px;
|
||||
}
|
||||
|
||||
a {
|
||||
color:black;
|
||||
font-weight:bold;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color:#00f;
|
||||
}
|
||||
|
||||
</style>
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<h1 id="title">Ereshkigal - AutoSSH tunnels monitor</h1>
|
||||
|
||||
<p>Ereshkigal is an autossh tunnel monitor. It gives a user interface to monitor existing SSH tunnel that are managed with autossh. </p>
|
||||
|
||||
<p><a href="https://sourceforge.net/projects/ereshkigal/files/">Download the latest version</a></p>
|
||||
|
||||
<img src="https://sourceforge.net/dbimage.php?id=220435" />
|
||||
|
||||
<h1>FAQ</h1>
|
||||
|
||||
<h2>Prerequisites</h2>
|
||||
<p>Ereshkigal targets Unix-like operating systems, and depends on:
|
||||
<ul>
|
||||
<li><a href="http://www.harding.motd.ca/autossh/">autossh</a> (which needs <a href="http://www.openssh.com/">OpenSSH</a>, obviously)</li>
|
||||
<li><a href="http://www.python.org">python</a> ≥ 2.4</li>
|
||||
</ul>
|
||||
</p>
|
||||
|
||||
<h2>How to use this ø$%*µ§! script?</h2>
|
||||
<p>Simply run <code>ereshkigal</code> to have the tunnel list, or <code>ereshkigal --curses</code> for the text-mode interactive interface.</p>
|
||||
<p>See the help for more options:</p>
|
||||
<pre>
|
||||
$ ./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
|
||||
</pre>
|
||||
</code>
|
||||
|
||||
<h2>Tell me more</h2>
|
||||
|
||||
<p>Ereshigal is released under the <a href="http://www.fsf.org/licensing/licenses/gpl-3.0.html">GNU General Public License version 3</a>.</p>
|
||||
<p>See the sourceforge <a href="https://sourceforge.net/projects/ereshkigal">project page</a> if you want to participate or get more informations.</p>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue