Skip to content

Commit 4c9bb03

Browse files
committed
docs: updated docs and pictures
1 parent aa57a86 commit 4c9bb03

7 files changed

Lines changed: 376 additions & 20 deletions

README.md

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -187,25 +187,14 @@ The configuration file is a JSON array of objects. Each object defines a tunnel.
187187
- **R (Remote)**: Forwards traffic from **local → remote**
188188

189189
### Example Topology Diagram
190-
```mermaid
191-
flowchart LR
192-
A[Local Machine] -->|SSH Tunnel| J1[Jump Host 2]
193-
J1 --> J2[Jump Host 1]
194-
J2 --> S[Final SSH Server]
195-
S --> M[MongoDB:27017]
196-
```
197-
190+
![ExampleTopologyDiagram](docs/images/example-topology-diagram.svg)
198191
- **A:** Your local machine
199-
- **J1, J2:** Intermediate jump hosts
192+
- **J2, J1:** Intermediate jump hosts
200193
- **S:** Final SSH server
201194
- **M:** MongoDB service running on the remote host
202195

203196
### Simple Tunnel Diagram (No Jump Hosts)
204-
```mermaid
205-
flowchart LR
206-
L[Local Machine] -->|SSH Tunnel| F[Final Server]
207-
F --> D[Service:27017]
208-
```
197+
![SimpleTunnelDiagram](docs/images/simple-tunnel-diagram.svg)
209198

210199
- **L:** Local machine
211200
- **F:** Final SSH server
@@ -217,12 +206,7 @@ flowchart LR
217206
2. **Password authentication**
218207
- Uses `password` field directly.
219208

220-
```mermaid
221-
flowchart TB
222-
LocalMachine --> SSHAuth[SSH Authentication]
223-
SSHAuth -->|KEY| PrivateKey["Key + Passphrase"]
224-
SSHAuth -->|PASS| Password["Password"]
225-
```
209+
![AuthenticationFlow](docs/images/authentication-flow.svg)
226210

227211
## Usage Notes
228212
- You can have multiple tunnels defined in the JSON array.

docs/images/authentication-flow.d2

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
local:Local Machine
2+
sshAuth:SSH Authentication
3+
key: Key + Passphrase
4+
pass: Password
5+
6+
local -> sshAuth
7+
sshAuth -> key: KEY
8+
sshAuth -> pass: PASS

docs/images/authentication-flow.svg

Lines changed: 115 additions & 0 deletions
Loading
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
local:Local Machine
2+
host1: Jump Host 1
3+
host2: Jump Host 2
4+
5+
final: Final Server
6+
mongo: MongoDB
7+
8+
direction: right
9+
10+
local -> host2: Tunnel
11+
host2 -> host1
12+
host1 -> final
13+
final -> mongo

docs/images/example-topology-diagram.svg

Lines changed: 114 additions & 0 deletions
Loading
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
local:Local Machine
2+
final: Final Server
3+
mongo: MongoDB
4+
5+
direction: right
6+
7+
local -> final: Tunnel
8+
final -> mongo

docs/images/simple-tunnel-diagram.svg

Lines changed: 114 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)