Update README documentation to reference labels

This commit is contained in:
Kevin Baensch 2022-12-21 19:43:49 +01:00
parent cfb82fd78a
commit 0f8b7b0530

View file

@ -6,10 +6,10 @@ docker compose up -d
# Hinzufügen von Docker Containern # Hinzufügen von Docker Containern
Container werden automatisch vom reverse proxy/host manager aufgegriffen wenn sie: Container werden automatisch vom reverse proxy/host manager aufgegriffen wenn sie:
1. Die Umgebungsvariable `VIRTUAL_HOST` gesetzt haben. 1. Das Label `local.web.host` gesetzt haben.
2. Im gleichen Docker-Netzwek (Default: `proxy`) sind. 2. Im gleichen Docker-Netzwek (Default: `proxy`) sind.
Optional kann über die Umgebungsvariable `VIRTUAL_PORT` der gebundene Port gesetzt werden (Default: 80) Optional kann über das Label `local.web.port` der gebundene Port gesetzt werden (Default: 80)
## Minimale Beispiel-Konfiguration ## Minimale Beispiel-Konfiguration
In diesem Beispiel sind zwei Container, nur der `app` Kontainer ist teil des proxy Netzwerks, der `db` Container ist nicht im proxy Netzwerk. In diesem Beispiel sind zwei Container, nur der `app` Kontainer ist teil des proxy Netzwerks, der `db` Container ist nicht im proxy Netzwerk.
@ -18,6 +18,14 @@ version: "3.4"
services: services:
db: db:
image: mariadb:10.4 image: mariadb:10.4
labels:
# Required labels
local.db.type: "mysql"
local.db.host: "db_host"
# Optional labels
local.db.port: "3306"
local.db.user: "db_user"
local.db.password: "db_user_pass"
environment: environment:
MYSQL_DATABASE: db_name MYSQL_DATABASE: db_name
MYSQL_USER: db_user MYSQL_USER: db_user
@ -31,15 +39,9 @@ services:
image: some_base/image image: some_base/image
depends_on: depends_on:
- db - db
environment: labels:
DB_TYPE: mysql local.web.host: "app_host"
DB_HOST: db local.web.port: "3000"
DB_PORT: 3306
DB_USER: db_user
DB_PASS: db_user_pass
DB_NAME: db_name
VIRTUAL_HOST: app_host
VIRTUAL_PORT: 3000
restart: unless-stopped restart: unless-stopped
networks: networks:
- proxy - proxy
@ -81,9 +83,11 @@ docker compose -f docker-compose.yml -f docker-compose-sqlproxy.yml up -d
### Hinzufügen von DB Docker Containern ### Hinzufügen von DB Docker Containern
Container werden automatisch vom reverse proxy/host manager aufgegriffen wenn sie: Container werden automatisch vom reverse proxy/host manager aufgegriffen wenn sie:
1. Die Umgebungsvariable `DB_VHOST` gesetzt haben. 1. Die Umgebungsvariable `local.db.type` und `local.db.host` gesetzt haben.
2. Im gleichen Docker-Netzwek (Default: `proxy`) sind. 2. Im gleichen Docker-Netzwek (Default: `proxy`) sind.
Optional kann über das Label `local.web.port` der gebundene Port gesetzt werden (Default mysql: 3306, Default psql: 5432)
### myssh cli ### myssh cli
Der SQL Proxy Client hat folgende Optionen: Der SQL Proxy Client hat folgende Optionen:
```bash ```bash
@ -97,7 +101,7 @@ disconnect: schließt die SSH Multiplex Session und damit auch alle aktuellen Ve
- DEFAULT: `"localhost"` - DEFAULT: `"localhost"`
- DESCRIPTION: Setzt den Target Proxy Host - DESCRIPTION: Setzt den Target Proxy Host
- `SQL_PROXY_DB_PORT` - `SQL_PROXY_DB_PORT`
- DEFAULT: `"3306"` - DEFAULT: sql: `"3306"`, psql: `"5432"`
- DESCRIPTION: Setzt den DB Host Target Port - DESCRIPTION: Setzt den DB Host Target Port
- `SQL_CLI_TEMPLATE` - `SQL_CLI_TEMPLATE`
- DEFAULT LINUX: `'mysql --protocol=TCP -u $MYSQL_USERNAME -p$MYSQL_PASSWORD -h localhost -P 3306'` - DEFAULT LINUX: `'mysql --protocol=TCP -u $MYSQL_USERNAME -p$MYSQL_PASSWORD -h localhost -P 3306'`