From 0cb7e70a6843adb84c5b983fd9f2b0044c2d35c5 Mon Sep 17 00:00:00 2001 From: Kevin Baensch Date: Thu, 17 Nov 2022 15:33:17 +0100 Subject: [PATCH] Readme: Document SQL Proxy usage --- .gitignore | 1 + README.md | 21 +++++++++++++++++++++ 2 files changed, 22 insertions(+) diff --git a/.gitignore b/.gitignore index f7b85c6..55c916e 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ /etc/ssh/*key* +/etc/ssh/.ssh diff --git a/README.md b/README.md index e97b429..6263146 100644 --- a/README.md +++ b/README.md @@ -57,3 +57,24 @@ networks: name: proxy external: true ``` + +## SQL Proxy +### Initiales Setup +Öffne ein Terminal und führe die `sqlproxy_setup.sh` Datei aus. +Das Script: +1. Installiert den `myssh` befehl nach `$HOME/bin` und fügt diesen ggf zur PATH variable hinzu +2. Erstellt SSH Keys für den SSH Docker Container (wenn diese nicht bereits existieren) +3. Erstellt und Konfiguriert einen Client SSH Key, dessen public Key wird dem SSH Docker Container hinzugefügt + +### Hinzufügen von DB Docker Containern +Container werden automatisch vom reverse proxy/host manager aufgegriffen wenn sie: +1. Die Umgebungsvariable `DB_VHOST` gesetzt haben. +2. Im gleichen Docker-Netzwek (Default: `proxy`) sind. + +### myssh cli +Der SQL Proxy Client hat folgende Optionen: +```bash +ls: Gibt eine Liste an verfügbaren DB Hosts zurück +connect $DB_HOST [-u $USERNAME ] [-p $PASSWORD]: Erstellt einen Tunnel zum DB Host, wenn Nutzername und Passwort angegeben werden wird eine DB Anwendung geöffnet +disconnect: schließt die SSH Multiplex Session und damit auch alle aktuellen Verbindungen +```