From f783ef46b66f5684af50006275292d64017e424b Mon Sep 17 00:00:00 2001 From: Kevin Baensch Date: Wed, 18 Jan 2023 17:26:35 +0100 Subject: [PATCH] Update documentation for database related options. --- README.md | 26 ++++++++++++++++++++++++++ script/myssh | 20 ++++++++++++-------- 2 files changed, 38 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 49ecb70..e85ce37 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,31 @@ Container werden automatisch vom reverse proxy/host manager aufgegriffen wenn si Optional kann über das Label `local.web.port` der gebundene Port gesetzt werden (Default mysql: 3306, Default postgres: 5432) +### Label Liste +#### Erforderlich +- `local.db.type` + - DEFAULT: `unset` + - DESCRIPTION: Datenbank Typ. Muss auf `mysql` oder `postgres` gesetzt werden. +- `local.db.host` + - DEFAULT: `unset` + - DESCRIPTION: Der Hostname unter dem der Container registriert wird + +#### Optional +- `local.db.port` + - DEFAULT (mysql): `3306` + - DEFAULT (postgres): `5432` + - DESCRIPTION: Der Datenbank Port des Zielcontainers +- `local.db.dbname` + - DEFAULT (mysql): `unset` + - DEFAULT (postgres): `postgres` + - DESCRIPTION: Name der initialen Zieldatenbank +- `local.db.user` + - DEFAULT: `unset` + - DESCRIPTION: Nutzername für den Datenbank Login +- `local.db.password` + - DEFAULT: `unset` + - DESCRIPTION: Passwort für den Datenbank Login + ## Minimale Beispiel-Konfiguration In diesem Beispiel sind zwei Container, beide sind Teil des `proxy` Netzwerks. Der `app` Container hat das Label `local.web.host` und wird deshalb als HTTP Proxy Target registriert. @@ -52,6 +77,7 @@ services: local.db.type: "mysql" local.db.host: "db.myapp.localhost" # Optional labels + local.db.dbname: "db_name" local.db.port: "3306" local.db.user: "db_user" local.db.password: "db_user_pass" diff --git a/script/myssh b/script/myssh index d26b1bd..ff17fe6 100755 --- a/script/myssh +++ b/script/myssh @@ -4,14 +4,18 @@ SQL_PROXY_HOST="${SQL_PROXY_HOST:-localhost}" SSH_SQL_PROXY_HOST="sqlproxy.${SQL_PROXY_HOST}" CONNECTION_CACHE="$HOME/.cache/sqlproxy_${SQL_PROXY_HOST}" -HELP="Usage: myssh [ls|connect]\n -SUBCOMMANDS:\n - ls: list available database hosts\n - connect: connect to a database host\n - disconnect: Quit existing ssh master session\n -\n -SYNTAX connect host [-u user] [-p password] [-c client] -" +HELP="Usage: myssh [ ls | connect | disconnect ] +SUBCOMMAND LIST: + ls: list available database hosts + connect: connect to a database host + disconnect: Quit existing ssh master session + +[ connect ] + SYNTAX connect host [-u user] [-p password] [-d dbname] [-c] + -u\tSets/Overrides the database user login name + -p\tSets/Overrides the database user login password + -d\tSets/Overrides the target database name + -c\tRun SQL on CLI instead of GUI" # Detect Pipe if ! [ -t 1 ]