Update README documentation to reference labels
This commit is contained in:
parent
cfb82fd78a
commit
0f8b7b0530
1 changed files with 17 additions and 13 deletions
30
README.md
30
README.md
|
@ -6,10 +6,10 @@ docker compose up -d
|
|||
|
||||
# Hinzufügen von Docker Containern
|
||||
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.
|
||||
|
||||
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
|
||||
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:
|
||||
db:
|
||||
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:
|
||||
MYSQL_DATABASE: db_name
|
||||
MYSQL_USER: db_user
|
||||
|
@ -31,15 +39,9 @@ services:
|
|||
image: some_base/image
|
||||
depends_on:
|
||||
- db
|
||||
environment:
|
||||
DB_TYPE: mysql
|
||||
DB_HOST: db
|
||||
DB_PORT: 3306
|
||||
DB_USER: db_user
|
||||
DB_PASS: db_user_pass
|
||||
DB_NAME: db_name
|
||||
VIRTUAL_HOST: app_host
|
||||
VIRTUAL_PORT: 3000
|
||||
labels:
|
||||
local.web.host: "app_host"
|
||||
local.web.port: "3000"
|
||||
restart: unless-stopped
|
||||
networks:
|
||||
- proxy
|
||||
|
@ -81,9 +83,11 @@ docker compose -f docker-compose.yml -f docker-compose-sqlproxy.yml up -d
|
|||
|
||||
### Hinzufügen von DB Docker Containern
|
||||
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.
|
||||
|
||||
Optional kann über das Label `local.web.port` der gebundene Port gesetzt werden (Default mysql: 3306, Default psql: 5432)
|
||||
|
||||
### myssh cli
|
||||
Der SQL Proxy Client hat folgende Optionen:
|
||||
```bash
|
||||
|
@ -97,7 +101,7 @@ disconnect: schließt die SSH Multiplex Session und damit auch alle aktuellen Ve
|
|||
- DEFAULT: `"localhost"`
|
||||
- DESCRIPTION: Setzt den Target Proxy Host
|
||||
- `SQL_PROXY_DB_PORT`
|
||||
- DEFAULT: `"3306"`
|
||||
- DEFAULT: sql: `"3306"`, psql: `"5432"`
|
||||
- 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'`
|
||||
|
|
Loading…
Reference in a new issue