chore: update .gitignore to include .env.example and enhance deployment documentation with Caddy reverse proxy setup
This commit is contained in:
106
.env.example
Normal file
106
.env.example
Normal file
@@ -0,0 +1,106 @@
|
||||
# ============================================
|
||||
# Hördle Environment Variables
|
||||
# ============================================
|
||||
# Kopiere diese Datei zu .env und passe die Werte an deine Umgebung an:
|
||||
# cp .env.example .env
|
||||
#
|
||||
# WICHTIG: Die .env-Datei sollte niemals in Git committed werden!
|
||||
|
||||
# ============================================
|
||||
# Build-Time Variables (NEXT_PUBLIC_*)
|
||||
# ============================================
|
||||
# Diese Variablen werden beim Build-Zeitpunkt in die Next.js-App eingebettet.
|
||||
# Nach dem Build können sie nicht mehr geändert werden (ohne Rebuild).
|
||||
|
||||
# App-Name (wird in Browser-Tab, PWA, etc. verwendet)
|
||||
NEXT_PUBLIC_APP_NAME=Hördle
|
||||
|
||||
# App-Beschreibung (für SEO, PWA, etc.)
|
||||
NEXT_PUBLIC_APP_DESCRIPTION=Daily music guessing game - Guess the song from short audio clips
|
||||
|
||||
# Hauptdomain (ohne https://)
|
||||
NEXT_PUBLIC_DOMAIN=hoerdle.de
|
||||
|
||||
# Twitter/X Handle (für Meta-Tags)
|
||||
NEXT_PUBLIC_TWITTER_HANDLE=@hoerdle
|
||||
|
||||
# Plausible Analytics - Domain
|
||||
NEXT_PUBLIC_PLAUSIBLE_DOMAIN=hoerdle.de
|
||||
|
||||
# Plausible Analytics - Script-URL (selbst gehostet oder extern)
|
||||
NEXT_PUBLIC_PLAUSIBLE_SCRIPT_SRC=https://plausible.example.com/js/script.js
|
||||
|
||||
# Theme-Farbe (für Browser-UI, PWA, etc.)
|
||||
NEXT_PUBLIC_THEME_COLOR=#000000
|
||||
|
||||
# Hintergrundfarbe (für PWA, etc.)
|
||||
NEXT_PUBLIC_BACKGROUND_COLOR=#ffffff
|
||||
|
||||
# Credits im Footer aktivieren (true/false)
|
||||
NEXT_PUBLIC_CREDITS_ENABLED=true
|
||||
|
||||
# Credits-Text (vor dem Link)
|
||||
NEXT_PUBLIC_CREDITS_TEXT=Vibe coded with ☕ and 🍺 by
|
||||
|
||||
# Credits-Link-Text
|
||||
NEXT_PUBLIC_CREDITS_LINK_TEXT=@yourhandle@server.social
|
||||
|
||||
# Credits-Link-URL
|
||||
NEXT_PUBLIC_CREDITS_LINK_URL=https://server.social/@yourhandle
|
||||
|
||||
# ============================================
|
||||
# Runtime Variables
|
||||
# ============================================
|
||||
# Diese Variablen können zur Laufzeit geändert werden (benötigen keinen Rebuild).
|
||||
|
||||
# Datenbank-URL (SQLite für lokale/kleine Deployments)
|
||||
# Format: file:/path/to/database.db
|
||||
DATABASE_URL=file:/app/data/prod.db
|
||||
|
||||
# Admin-Passwort (bcrypt Hash)
|
||||
# Generiere einen Hash mit: node scripts/hash-password.js dein_passwort
|
||||
# In docker-compose.yml müssen $ als $$ escaped werden!
|
||||
ADMIN_PASSWORD=$2b$10$SHOt9G1qUNIvHoWre7499.eEtp5PtOII0daOQGNV.dhDEuPmOUdsq
|
||||
|
||||
# Zeitzone (für tägliche Puzzle-Rotation)
|
||||
TZ=Europe/Berlin
|
||||
|
||||
# ============================================
|
||||
# Optional: Gotify Integration
|
||||
# ============================================
|
||||
# Für Benachrichtigungen (z.B. Fehler-Alerts)
|
||||
|
||||
# Gotify Server URL
|
||||
GOTIFY_URL=https://gotify.example.com
|
||||
|
||||
# Gotify App Token
|
||||
GOTIFY_APP_TOKEN=your_gotify_app_token_here
|
||||
|
||||
# ============================================
|
||||
# Optional: OpenRouter Integration
|
||||
# ============================================
|
||||
# Für AI-Features (falls vorhanden)
|
||||
|
||||
# OpenRouter API Key
|
||||
OPENROUTER_API_KEY=your_openrouter_api_key_here
|
||||
|
||||
# ============================================
|
||||
# Caddy Reverse Proxy (Optional - Production)
|
||||
# ============================================
|
||||
# Nur benötigt, wenn Caddy für SSL/TLS verwendet wird.
|
||||
|
||||
# GoDaddy API Key (für DNS-01 Challenge bei Wildcard-Zertifikaten)
|
||||
# Siehe CADDY_SETUP.md für Anleitung zur Erstellung
|
||||
GODADDY_API_KEY=your_godaddy_api_key_here
|
||||
|
||||
# GoDaddy API Secret
|
||||
GODADDY_API_SECRET=your_godaddy_api_secret_here
|
||||
|
||||
# Email für Let's Encrypt Benachrichtigungen (optional)
|
||||
CADDY_EMAIL=admin@hoerdle.de
|
||||
|
||||
# ============================================
|
||||
# Build-Time Overrides
|
||||
# ============================================
|
||||
# Optional: Spezifische Version beim Build setzen
|
||||
# APP_VERSION=v1.0.0
|
||||
Reference in New Issue
Block a user