Konfigurationsvalidator
Validiert Konfigurationsdateien und Umgebungsvariablen, um Laufzeitfehler und fehlende Einstellungen zu vermeiden.
Wann verwenden
- Arbeiten mit Umgebungsvariablen oder Konfigurationsdateien
- Bereitstellungs- oder Konfigurationsprobleme
- Benutzer erwähnen „.env“, „config“, „Umgebungsvariablen“ oder „Einstellungen“
Anleitung
1. Konfigurationsdateien finden
Suche nach:
.env,.env.example,.env.localconfig/,config.js,config.jsonsettings.py,application.ymlappsettings.json,.env.production
2. Fehlende Variablen erkennen
.env.example mit .env vergleichen:
# Variablen in der Beispiel-Datei, aber nicht in .env
comm -23 <(grep -o '^[A-Z_]*' .env.example | sort) <(grep -o '^[A-Z_]*' .env | sort)
Häufig erforderliche Variablen:
DATABASE_URL
API_KEY
SECRET_KEY
NODE_ENV
PORT
3. Format der Variablen validieren
Auf häufige Probleme prüfen:
// Fehlende Anführungszeichen bei Werten mit Leerzeichen
DATABASE_URL=postgres://localhost/db name // Schlecht
DATABASE_URL="postgres://localhost/db name" // Gut
// Fehlendes Protokoll
API_URL=example.com // Schlecht
API_URL=https://example.com // Gut
// Boolean als String
DEBUG=true // Könnte als String interpretiert werden
DEBUG=1 // Eindeutiger
4. Erforderliche Variablen zur Laufzeit validieren
Node.js Beispiel:
const requiredEnvVars = [
'DATABASE_URL',
'API_KEY',
'JWT_SECRET'
];
const missing = requiredEnvVars.filter(v => !process.env[v]);
if (missing.length > 0) {
throw new Error(`Fehlende erforderliche Umgebungsvariablen: ${missing.join(', ')}`);
}
Python Beispiel:
import os
REQUIRED_ENV_VARS = [
'DATABASE_URL',
'SECRET_KEY',
'ALLOWED_HOSTS'
]
missing = [var for var in REQUIRED_ENV_VARS if not os.getenv(var)]
if missing:
raise EnvironmentError(f"Fehlende Umgebungsvariablen: {', '.join(missing)}")
5. Typvalidierung
Typen validieren:
const config = {
port: parseInt(process.env.PORT || '3000', 10),
debug: process.env.DEBUG === 'true',
apiUrl: new URL(process.env.API_URL), // Wirft Fehler bei Ungültigkeit
maxConnections: Number(process.env.MAX_CONNECTIONS),
};
// Validieren
if (isNaN(config.port) || config.port < 1 || config.port > 65535) {
throw new Error('PORT muss eine gültige Portnummer sein');
}
6. .env.example generieren
Vorlage aus der tatsächlichen .env erstellen:
# Werte entfernen, Schlüssel behalten
sed 's/=.*/=/' .env > .env.example
Oder mit Platzhaltern:
DATABASE_URL=postgres://benutzer:passwort@localhost:5432/datenbank
API_KEY=dein_api_schluessel_hier
SECRET_KEY=zufaelliges_geheimnis_generieren
PORT=3000
NODE_ENV=development
7. Konfigurationsschema
Schema definieren (Joi Beispiel):
const Joi = require('joi');
const envSchema = Joi.object({
NODE_ENV: Joi.string()
.valid('development', 'production', 'test')
.required(),
PORT: Joi.number()
.port()
.default(3000),
DATABASE_URL: Joi.string()
.uri()
.required(),
API_KEY: Joi.string()
.min(32)
.required(),
DEBUG: Joi.boolean()
.default(false),
}).unknown();
const { error, value } = envSchema.validate(process.env);
if (error) {
throw new Error(`Konfigurationsvalidierungsfehler: ${error.message}`);
}
module.exports = value;
8. Sicherheitsprüfungen
Keine Geheimnisse committen:
# Prüfen, ob .env in .gitignore ist
if ! grep -q "^\.env$" .gitignore; then
echo "Warnung: .env nicht in .gitignore"
fi
# Nach hartcodierten Geheimnissen im Code suchen
grep -r "api_key.*=.*['\"]" --exclude-dir=node_modules
Häufige Sicherheitsprobleme:
- Hartcodierte Passwörter/Schlüssel
- Standardgeheimnisse in der Produktion
- Offengelegte sensible Konfigurationen
- Unverschlüsselte Geheimnisse
9. Umgebungsspezifische Konfigurationen
Nach Umgebung organisieren:
.env.development
.env.staging
.env.production
.env.test
Entsprechend laden:
require('dotenv').config({
path: `.env.${process.env.NODE_ENV || 'development'}`
});
10. Alle Variablen dokumentieren
CONFIG.md erstellen:
# Konfiguration
## Umgebungsvariablen
### Erforderlich
- `DATABASE_URL`: PostgreSQL-Verbindungszeichenfolge
- Format: `postgres://benutzer:passwort@host:port/datenbank`
- Beispiel: `postgres://app:geheimnis@localhost:5432/myapp`
- `API_KEY`: API-Schlüssel eines Drittanbieters
- Abrufen von: https://dashboard.example.com
- Erforderliche Berechtigungen: read, write
### Optional
- `PORT`: Server-Port (Standard: 3000)
- `DEBUG`: Debug-Logging aktivieren (Standard: false)
- `MAX_CONNECTIONS`: Datenbank-Poolgröße (Standard: 10)
## Einrichtung
1. Kopiere `.env.example` nach `.env`
2. Fülle alle erforderlichen Werte aus
3. Führe `npm run validate-config` aus, um zu überprüfen
11. Validierungsskript
scripts/validate-config.js erstellen:
const fs = require('fs');
function validateConfig() {
const required = ['DATABASE_URL', 'API_KEY'];
const missing = required.filter(v => !process.env[v]);
if (missing.length > 0) {
console.error(`❌ Fehlend: ${missing.join(', ')}`);
process.exit(1);
}
console.log('✓ Alle erforderlichen Konfigurationsvariablen vorhanden');
}
validateConfig();
12. Best Practices
- .env niemals committen: Immer in .gitignore
- .env.example pflegen: Aktuell halten
- Beim Start validieren: Frühzeitig bei Fehlkonfiguration scheitern
- Starke Standardwerte verwenden: Sinnvolle Fallbacks
- Alles dokumentieren: Jede Variable erklären
- Geheimnisse regelmäßig rotieren: Schlüssel aktualisieren
- Geheimnisverwaltung nutzen: Vault, AWS Secrets Manager für die Produktion
- Typen prüfen: Nicht nur Vorhandensein, sondern auch Typen validieren
Unterstützende Dateien
templates/config-validator.jstemplates/.env.examplescripts/generate-env-example.sh