Files
pdf_to_ics/WEB_README.md

72 lines
1.3 KiB
Markdown

# 🌐 Web-Version (Docker-only)
Diese Anwendung wird ausschließlich als Container betrieben.
## Voraussetzungen
- Docker + Docker Compose
- Optional externes Netzwerk `proxy` (wenn Reverse Proxy genutzt wird)
## Erststart
```bash
cp .env.example .env
./deploy.sh
```
## Update
```bash
./update.sh
```
Für ein neues Release den Tag in `.env` erhöhen, z. B.:
```dotenv
PDF_TO_ICS_IMAGE=ghcr.io/webfarben/pdf_to_ics:v1.1.0
```
Danach `./update.sh` ausführen.
## Manuelle Kommandos (optional)
Starten:
```bash
docker compose -f docker-compose.deploy.yml up -d
```
Status/Logs:
```bash
docker compose -f docker-compose.deploy.yml ps
docker compose -f docker-compose.deploy.yml logs -f pdf-to-ics-web
```
Stoppen:
```bash
docker compose -f docker-compose.deploy.yml down
```
## Sicherheit
Optional App-Basic-Auth in `.env` setzen:
```dotenv
WEB_AUTH_USER=kalender
WEB_AUTH_PASSWORD=BitteSicheresPasswortSetzen
```
Für öffentliches Deployment zusätzlich Reverse Proxy + HTTPS verwenden.
## Schlanker Server-Checkout (Sparse)
```bash
git clone --filter=blob:none --sparse <REPO_URL> pdf_to_ics
cd pdf_to_ics
git sparse-checkout set docker-compose.deploy.yml .env.example deploy.sh update.sh README.md WEB_README.md
```
Hinweis: Ein bestehender Voll-Clone wird dadurch nicht automatisch kleiner.