derped/AutoDevReverseProxy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improve readablility of README.

Browse source
This commit is contained in:
Kevin Baensch 2023-01-18 15:11:10 +01:00
parent b77fa30c7b
commit d0def12044
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -3,7 +3,7 @@
Öffne ein Terminal und führe die `setup.sh` Datei aus. Öffne ein Terminal und führe die `setup.sh` Datei aus.
Das Script: Das Script:
1. Behebt Berechtigungsprobleme und legt alle nötigen Ordner/Dateien an, die zum starten des Proxies benötigt werden. 1. Behebt Berechtigungsprobleme und legt alle nötigen Ordner/Dateien an, die zum starten des Proxies benötigt werden.
2. Installiert den `myssh` befehl nach `$HOME/bin` und fügt diesen ggf zur PATH variable hinzu 2. Installiert den `myssh` Befehl nach `$HOME/bin` und fügt diesen ggf. zur `PATH` variable hinzu
3. Erstellt SSH Keys für den SSH Docker Container (wenn diese nicht bereits existieren) 3. Erstellt SSH Keys für den SSH Docker Container (wenn diese nicht bereits existieren)
4. Erstellt und Konfiguriert einen Client SSH Key, dessen public Key wird dem SSH Docker Container hinzugefügt 4. Erstellt und Konfiguriert einen Client SSH Key, dessen public Key wird dem SSH Docker Container hinzugefügt
@ -24,7 +24,7 @@ Einem Container können mehrere Hostnamen vergeben werden indem die gewünschten
Optional kann über das Label `local.web.port` der gebundene Port gesetzt werden (Default: 80) Optional kann über das Label `local.web.port` der gebundene Port gesetzt werden (Default: 80)
### SSL Zertifikat Konfiguration ### SSL Zertifikat Konfiguration
Nach starten des docker containers ist das von caddy erstellte SSL Zertifikat in './caddy_data/pki/authorities/local/root.crt' gefunden werden. Nach starten des docker containers ist das von Caddy erstellte SSL Zertifikat in `./caddy_data/pki/authorities/local/root.crt` auffindbar.
Relevante Dokumentation: Relevante Dokumentation:
- [MacOS](https://support.apple.com/guide/keychain-access/add-certificates-to-a-keychain-kyca2431/mac) - [MacOS](https://support.apple.com/guide/keychain-access/add-certificates-to-a-keychain-kyca2431/mac)
- [Linux](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/security_guide/sec-shared-system-certificates) - [Linux](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/security_guide/sec-shared-system-certificates)
@ -40,7 +40,7 @@ Optional kann über das Label `local.web.port` der gebundene Port gesetzt werden
## Minimale Beispiel-Konfiguration ## Minimale Beispiel-Konfiguration
In diesem Beispiel sind zwei Container, beide sind Teil des `proxy` Netzwerks. 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. Der `app` Container hat das Label `local.web.host` und wird deshalb als HTTP Proxy Target registriert.
Der `db` Container hat die Label `local.db.type` und `local.db.host` und wird deshalt als SQL Proxy Target registriert. Der `db` Container hat die Label `local.db.type` und `local.db.host` und wird deshalb als SQL Proxy Target registriert.
```yaml ```yaml
version: "3.4" version: "3.4"
services: services:
@ -88,7 +88,7 @@ networks:
external: true external: true
``` ```
Alternativ kann auch das default netzwerk Überschrieben werden. Dadurch sind alle Container Teil des Netzwerks. Alternativ kann auch das default Netzwerk Überschrieben werden. Dadurch sind alle Container Teil des Netzwerks.
```yaml ```yaml
networks: networks:
default: default: