Add documentation for environment variables to readme.

This commit is contained in:
Kevin Baensch 2022-11-18 12:38:56 +01:00
parent 63067cbb7a
commit d5324a7017

View file

@ -78,3 +78,32 @@ 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 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 disconnect: schließt die SSH Multiplex Session und damit auch alle aktuellen Verbindungen
``` ```
#### myssh Umgebungsvariablen
- `SQL_PROXY_HOST`
- DEFAULT: `"localhost"`
- DESCRIPTION: Setzt den Target Proxy Host
- `SQL_PROXY_DB_PORT`
- DEFAULT: `"3306"`
- DESCRIPTION: Setzt den DB Host Target Port
- `SQL_CLI_TEMPLATE`
- DEFAULT LINUX: `'mysql --protocol=TCP -u $MYSQL_USERNAME -p$MYSQL_PASSWORD -h localhost -P 3306'`
- DEFAULT MACOS: `'open \"mysql://$MYSQL_USERNAME:$MYSQL_PASSWORD@localhost:3306\" -a \"Sequel Ace\"'`
- DESCRIPTION: Setzt den auszuführenden Datenbank-Client Befehl
## Hostman Umgebugsvariablen (für docker compose)
- `DOCKER_SOCK_PATH`
- DEFAULT: `"/tmp/docker.sock"`
- DESCRIPTION: Docker Socket Pfad
- `NETWORK_NAME`
- DEFAULT: `"proxy"`
- DESCRIPTION: Docker netzwerk in dem nach Containern gesucht wird
- `RESOLVE_DOCKERHOST`
- DEFAULT: `false`
- DESCRIPTION: Setzt ob IP Addressen in der hosts Datei auf die der Docker Container (true) oder 127.0.0.1 (false) aufgelöst werden.
- `HOST_CONF_PATH`
- DEFAULT: `"/tmp/hosts"`
- DESCRIPTION: hosts Datei-Pfad
- `DOCKER_HOSTNAME_VAR`
- DEFAULT: `"VIRTUAL_HOST"`
- DESCRIPTION: Docker Container Umgebungsvariable die den Hostnamen bestimmt