Configuration
Guide complet des variables d'environnement et modes de déploiement.
Configuration
DBKeep utilise des variables d'environnement pour sa configuration. Un fichier .env.example est fourni comme modèle.
Variables requises
DATABASE_URL
URL de connexion PostgreSQL.
# Format
DATABASE_URL=postgresql://USER:PASSWORD@HOST:PORT/DATABASE
# Exemples
DATABASE_URL=postgresql://postgres:mypassword@localhost:5432/dbkeep
DATABASE_URL=postgresql://username@localhost:5432/dbkeep
DATABASE_URL=postgresql://user:pass@host.com:5432/dbkeep?sslmode=require
BETTER_AUTH_SECRET
Clé secrète pour signer les sessions et tokens. Doit faire au moins 32 caractères.
# Générer une clé sécurisée
openssl rand -base64 32
BETTER_AUTH_SECRET=+dh34Ge0TJcUPxtk7Nza9eOZ7+lPlX6itV/ATEw3jzs=
Important : Ne jamais commiter cette clé dans le code source !
BETTER_AUTH_URL
URL de base de l'application. Utilisée pour les redirections et callbacks.
# Développement
BETTER_AUTH_URL=http://localhost:3000
# Production
BETTER_AUTH_URL=https://dbkeep.example.com
Modes de fonctionnement
NUXT_PUBLIC_GUEST_MODE
Active le Mode Invité permettant d'utiliser l'application sans authentification.
| Valeur | Comportement |
|---|---|
false (défaut) | Authentification requise |
true | Accès ouvert, projets assignés à un utilisateur "guest" |
NUXT_PUBLIC_GUEST_MODE=true
NUXT_PUBLIC_ENABLE_REGISTER
Contrôle l'inscription des nouveaux utilisateurs.
| Valeur | Comportement |
|---|---|
true (défaut) | Inscription ouverte |
false | Inscription désactivée |
NUXT_PUBLIC_ENABLE_REGISTER=false
Scénarios de déploiement
Multi-utilisateurs (défaut)
Configuration standard avec authentification et inscription ouverte.
DATABASE_URL=postgresql://user:pass@db.host.com:5432/dbkeep
BETTER_AUTH_SECRET=<clé-sécurisée>
BETTER_AUTH_URL=https://dbkeep.example.com
NUXT_PUBLIC_GUEST_MODE=false
NUXT_PUBLIC_ENABLE_REGISTER=true
Déploiement privé
Authentification requise, inscription désactivée.
DATABASE_URL=postgresql://user:pass@db.host.com:5432/dbkeep
BETTER_AUTH_SECRET=<clé-sécurisée>
BETTER_AUTH_URL=https://private.dbkeep.example.com
NUXT_PUBLIC_GUEST_MODE=false
NUXT_PUBLIC_ENABLE_REGISTER=false
Auto-hébergement personnel
Mode invité pour usage personnel sans gestion de comptes.
DATABASE_URL=postgresql://localhost/dbkeep
BETTER_AUTH_SECRET=dev-key-not-important-in-guest-mode
BETTER_AUTH_URL=http://localhost:3000
NUXT_PUBLIC_GUEST_MODE=true
Exemple complet
# Base de données PostgreSQL
DATABASE_URL=postgresql://postgres:password@localhost:5432/dbkeep
# Better Auth
BETTER_AUTH_SECRET=+dh34Ge0TJcUPxtk7Nza9eOZ7+lPlX6itV/ATEw3jzs=
BETTER_AUTH_URL=http://localhost:3000
# Mode de fonctionnement
NUXT_PUBLIC_GUEST_MODE=false
NUXT_PUBLIC_ENABLE_REGISTER=true
Validation
Après configuration, vérifiez que tout fonctionne :
# Tester la connexion à la base de données
pnpm db:push
# Lancer l'application
pnpm dev
# Ouvrir Drizzle Studio pour vérifier les tables
pnpm db:studio