From 1bcda5d8f8ff0c99f8a84bbd3ce950f0dcfde3e7 Mon Sep 17 00:00:00 2001 From: Gerhard <gerhard@tinned-software.net> Date: Fri, 11 Oct 2013 00:42:32 +0200 Subject: [PATCH] added README file --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8556684 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# SSH-Tunnel-Manager + +The SSH-Tunnel-Manager is a bash shell script created to manage ssh tunnels. + +This SSH-Tunnel-Manager script aims to setup one or more configured ssh connection with port forwarding. The list of functionality includes the following: + +* Multiple tunnels can be configured +* Flexible configuration to forward mulitiple ports ber connection +* Reconnect to the SSH server if connection lost +* Log containing reconnect attempts +* Maaging configured tunnels (start/stop/restart) + + +## Download & Installation + +[Download Download SSH-Tunnel-Manager from Github](https://github.com/tinned-software/ssh-tunnel-manager) + +To install the the script download it from Github and upload it to your server. Copy the example config file "**ssh-tunnel-manager.conf.example**" to "**ssh-tunnel-manager.conf**" and change its configuration values. The configuration file contains a description for its configuration items. To see the available commandline options execute "ssh-tunnel-manager.ssh -h". + +## Description + +Connecting to a service on a server that does not expose the service port or connection between servers not exposing there ports publicly is only possible via some kind of VPN or port forwarding. SSH port forwarding provides a simple port forwarding to the service you need to access. + +With the SSH-Tunnel-Manager multiple SSH connections to different servers with different portforwardings can be configured. These tunnels can be comfortable managed. The script provides a start command to start the tunnels as well as a stop command to stop the running tunnels. The integrated logic will as well automatically restart the ssh tunnel if the connection to the ssh server should be lost. + +The SSH-Tunnel-Manager script will establishing a ssh connection for every configured tunnel. Entering the password on every connect can be annoying. I suggest a [SSH passwordless login with SSH key](http://blog.tinned-software.net/ssh-passwordless-login-with-ssh-key/) setup. This allows the script to run without user interaction. -- GitLab