From 31cf99a670cf926f9debf27d13a76d0b5d4a9051 Mon Sep 17 00:00:00 2001 From: Kevin Baensch Date: Fri, 4 Nov 2022 17:37:32 +0100 Subject: [PATCH] Add readme file. --- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e97b429 --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +# Starten des Reverse-Proxies +Der Proxy kann über docker compose gestartet werden +```bash +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. +2. Im gleichen Docker-Netzwek (Default: `proxy`) sind. + +Optional kann über die Umgebungsvariable `VIRTUAL_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. +```yaml +version: "3.4" +services: + db: + image: mariadb:10.4 + environment: + MYSQL_DATABASE: db_name + MYSQL_USER: db_user + MYSQL_PASSWORD: db_user_pass + MYSQL_ROOT_PASSWORD: db_root_pass + restart: unless-stopped + volumes: + - db-data:/var/lib/mysql + + app: + 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 + restart: unless-stopped + networks: + - proxy + +networks: + proxy: + name: proxy + external: true +``` + +Alternativ kann auch das default netzwerk Überschrieben werden. Dadurch sind alle Container Teil des Netzwerks. +```yaml +networks: + default: + name: proxy + external: true +```