Documentation
Brume produit des copies alignées RGPD de vos données PostgreSQL pour le debug, les tests et les démos — sans jamais embarquer d’identités réelles.
Cette documentation est organisée comme un parcours : découvrir, comprendre, consulter, exploiter en production.
Commencer ici
Section intitulée « Commencer ici »Nouveau sur Brume ? Démarrez par ces deux pages.
- Démarrage — installez Brume sur Debian, Fedora ou macOS et vérifiez l’installation.
- Votre première pseudonymisation — écrivez un
brume.ymlminimal, exécutezbrume planpuisbrume execute, de bout en bout en cinq minutes.
Concepts
Section intitulée « Concepts »Le modèle mental derrière l’outil — lisez-les une fois et le reste de la doc prend tout son sens.
- Comment fonctionne Brume — phases d’extraction, transformation, écriture. Déterminisme. Secrets. Traversée des FK.
- Stratégies de pseudonymisation —
FAKE,MASK,HASH,NULLIFY,FPE_ID,FPE_UUID,KEEP. Quand choisir laquelle. - Types sémantiques —
EMAIL,PHONE,IBAN… commentFAKEetMASKles utilisent.
Référence
Section intitulée « Référence »La doc exhaustive de chaque flag, chaque clé, chaque variable.
brume.yml— schéma complet du fichier de configuration.- Commandes CLI — chaque sous-commande, chaque flag, codes de sortie.
- Variables
.env— secrets, chaînes de connexion, options d’exécution.
Bien l’utiliser
Section intitulée « Bien l’utiliser »Usage de niveau production, conformité et dépannage.
- Recettes — parcours orientés tâches de bout en bout (rafraîchir le staging, multi-tenant, JSONB, CI/CD…).
- RGPD & conformité — position juridique, articles RGPD couverts, checklist DPO.
- Audit k-anonymat — mesurez le risque résiduel de ré-identification.
- Exploitation & dépannage — performance, gestion des secrets, erreurs courantes.
Vous cherchez la Roadmap ? Voir Roadmap. Besoin d’aide ? Voir Support.