Update README.md
This commit is contained in:
99
README.md
99
README.md
@@ -1,37 +1,65 @@
|
|||||||
# Pterodactyl Wings + Caddy (SSL z Let's Encrypt)
|
# Pterodactyl Wings + Traefik (SSL z Let's Encrypt)
|
||||||
|
|
||||||
Ten projekt uruchamia Pterodactyl Wings za reverse proxy Caddy, który
|
|
||||||
automatycznie generuje i odnawia certyfikaty SSL z Let's Encrypt.
|
|
||||||
Konfiguracja jest oparta na `docker-compose` i nie wymaga ręcznej
|
|
||||||
obsługi certyfikatów.
|
|
||||||
|
|
||||||
## 📁 Struktura katalogów
|
## Konfiguracja ```.env```
|
||||||
|
|
||||||
|
```
|
||||||
|
# Wings domain
|
||||||
|
DOMAIN=wing-02.prod.kzbikowski.pl
|
||||||
|
|
||||||
|
# Wings configuration
|
||||||
|
TMP_DIR=/srv/wings/wing/tmp
|
||||||
|
DATA_DIR=/srv/wings/wing/data
|
||||||
|
VOLUMES_DIR=/srv/wings/wing/volumes
|
||||||
|
|
||||||
|
# Traefik configuration
|
||||||
|
TRAEFIK_DIR=/srv/wings/traefik
|
||||||
|
TRAEFIK_EMAIL=mail@kzbikowski.pl
|
||||||
|
|
||||||
|
|
||||||
|
# Prometheus configuration
|
||||||
|
PROMETHEUS_DIR=/srv/wings/prometheus
|
||||||
|
```
|
||||||
|
|
||||||
Przykładowy układ plików:
|
|
||||||
|
|
||||||
/srv/wing/
|
|
||||||
├─ wing/
|
|
||||||
│ ├─ tmp/
|
|
||||||
│ ├─ data/
|
|
||||||
│ └─ volumes/
|
|
||||||
└─ caddy/
|
|
||||||
├─ data/
|
|
||||||
└─ config/
|
|
||||||
|
|
||||||
## 🔧 Zmienne środowiskowe (`.env`)
|
|
||||||
|
|
||||||
W pliku `.env` należy ustawić:
|
|
||||||
|
|
||||||
DOMAIN=wing-02.prod.kzbikowski.pl
|
|
||||||
TMP_DIR=/srv/wing/wing/tmp
|
|
||||||
DATA_DIR=/srv/wing/wing/data
|
|
||||||
VOLUMES_DIR=/srv/wing/wing/volumes
|
|
||||||
CADDY_DIR=/srv/wing/caddy
|
|
||||||
MAIL=mail@kzbikowski.pl
|
|
||||||
|
|
||||||
## 🚀 Uruchamianie
|
## 🚀 Uruchamianie
|
||||||
|
|
||||||
1. Utwórz katalogi zgodnie ze strukturą powyżej.
|
1. Utwórz plik ${DATA_DIR}/etc/config.yml
|
||||||
|
1. Skopiuj config wygenerowany w panelu:
|
||||||
|
2. Do wygenerowanego w panelu onfigu dodaj:
|
||||||
|
|
||||||
|
```
|
||||||
|
docker:
|
||||||
|
network:
|
||||||
|
interface: 172.18.0.1
|
||||||
|
dns:
|
||||||
|
- 1.1.1.1
|
||||||
|
- 1.0.0.1
|
||||||
|
name: wings0
|
||||||
|
ispn: false
|
||||||
|
driver: bridge
|
||||||
|
network_mode: wings0
|
||||||
|
is_internal: false
|
||||||
|
enable_icc: true
|
||||||
|
network_mtu: 1500
|
||||||
|
interfaces:
|
||||||
|
v4:
|
||||||
|
subnet: 10.172.0.0/16
|
||||||
|
gateway: 10.172.0.1
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Zmień pole ```data``` na ścieżkę podaną w ```.env``` (```VOLUMES_DIR```)
|
||||||
|
|
||||||
|
```
|
||||||
|
data: /srv/wings/wing/volumes
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
2. Upewnij się, że domena wskazuje na IP serwera.
|
2. Upewnij się, że domena wskazuje na IP serwera.
|
||||||
3. Uruchom:
|
3. Uruchom:
|
||||||
|
|
||||||
@@ -40,33 +68,13 @@ W pliku `.env` należy ustawić:
|
|||||||
docker compose up -d
|
docker compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
Caddy automatycznie: - wykryje usługę Wings, - wygeneruje certyfikat
|
|
||||||
Let's Encrypt, - wystawi HTTPS.
|
|
||||||
|
|
||||||
## 🧩 Jak to działa?
|
|
||||||
|
|
||||||
### Caddy
|
|
||||||
|
|
||||||
- nasłuchuje na portach 80 i 443,
|
|
||||||
- automatycznie zarządza certyfikatami,
|
|
||||||
- kieruje ruch HTTPS do Wings.
|
|
||||||
|
|
||||||
### Wings
|
|
||||||
|
|
||||||
Kontener Wings działa na porcie 443 wewnątrz sieci Docker.\
|
|
||||||
Caddy przekazuje do niego ruch za pomocą etykiet.
|
|
||||||
|
|
||||||
## 🔒 Certyfikaty Let's Encrypt
|
|
||||||
|
|
||||||
Certyfikaty są zapisywane w:
|
|
||||||
|
|
||||||
${CADDY_DIR}/data
|
|
||||||
|
|
||||||
## 🔍 Sprawdzenie działania
|
## 🔍 Sprawdzenie działania
|
||||||
|
|
||||||
### Logi Caddy:
|
### Logi Caddy:
|
||||||
|
|
||||||
docker compose logs -f caddy
|
docker compose logs -f traefik
|
||||||
|
|
||||||
### Logi Wings:
|
### Logi Wings:
|
||||||
|
|
||||||
@@ -88,6 +96,5 @@ Certyfikaty są zapisywane w:
|
|||||||
|
|
||||||
- Porty 80 i 443 muszą być wolne.
|
- Porty 80 i 443 muszą być wolne.
|
||||||
- Domena musi wskazywać na IP serwera.
|
- Domena musi wskazywać na IP serwera.
|
||||||
- Nie trzeba tworzyć konfiguracji Caddy.
|
|
||||||
|
|
||||||
## ✔️ Gotowe!
|
## ✔️ Gotowe!
|
||||||
|
|||||||
Reference in New Issue
Block a user