Skip to content

Commit 35941d4

Browse files
committed
add downloader + update readme
1 parent 7143c43 commit 35941d4

File tree

2 files changed

+27
-3
lines changed

2 files changed

+27
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# SSH Tunnel Swarm
22

3+
![ssh-tunnel-swarm](https://raw.githubusercontent.com/psyb0t/ssh-tunnel-swarm/master/assets/ssh-tunnel-swarm.png)
4+
35
SSH Tunnel Swarm is a powerful shell script tool for managing multiple SSH tunnels concurrently. It simplifies the process of creating and managing both forward and reverse SSH tunnels by applying a predefined set of rules for each tunnel.
46

57
The script supports the configuration of multiple SSH connections and can establish tunnels based on defined rules. The process is controlled through different shell scripts for logging, rule definition, and data splitting.
@@ -13,11 +15,19 @@ The script supports the configuration of multiple SSH connections and can establ
1315
- Supports both forward and reverse SSH tunnels.
1416
- Tunnels are continuously maintained and re-established in case of disconnection.
1517

16-
## Installation
18+
## Prerequisites
1719

18-
SSH Tunnel Swarm is a shell script and thus does not need a traditional installation process. However, you must ensure you have a working SSH client installed on your system. This script is designed to be run in a Unix-like environment.
20+
This script is designed to be run in a Unix-like environment.
1921

20-
- coming up soon
22+
- **Bash Shell**: The script is written in Bash, so you need to have Bash installed on your system.
23+
24+
- **SSH**: The script uses SSH to establish connections and create tunnels. Make sure you have SSH installed and properly configured on your machine.
25+
26+
## Installation
27+
28+
```shell
29+
wget -qO- https://raw.githubusercontent.com/psyb0t/ssh-tunnel-swarm/master/tools/downloader.sh | bash
30+
```
2131

2232
## Configuration
2333

tools/downloader.sh

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#!/bin/bash
2+
owner=psyb0t
3+
repo=ssh-tunnel-swarm
4+
asset_name=ssh-tunnel-swarm
5+
6+
echo "Looking up the latest release of $asset_name for github.com/$owner/$repo..."
7+
releases=$(wget -qO- "https://api.github.com/repos/$owner/$repo/releases")
8+
latest_release=$(echo "$releases" | jq -r '.[0]')
9+
asset_url=$(echo "$latest_release" | jq -r ".assets[] | select(.name == \"$asset_name\") | .browser_download_url")
10+
11+
echo "Downloading $asset_url..."
12+
wget -q "$asset_url" -O "$asset_name"
13+
14+
chmod +x "$asset_name"

0 commit comments

Comments
 (0)