PcLuks::ini
De wiki_pcwiki2
Aller à la navigationAller à la recherche
KEYWORDS: PCLUKS, INI, EXEMPLE
Le 27/07/2026:
; ============================================================ ; pcLuks.ini - configuration des modules pcLuks ; Emplacement : /root/.config/pcLuks/pcLuks.ini (optionnel) ; ============================================================ ; ; Format : clés "cle = valeur", sections [nom_module]. ; Commentaires : ligne entière commençant par ';' ou '#' - PAS de ; commentaire en fin de ligne après une valeur (non supporte par ; le parseur, serait inclus dans la valeur). ; ; Clés reconnues (section globale ET section de module) : ; host, user, image, keyfile, mapper, mountpoint, path, ; preExecLocal, preExecRemote, postExecLocal, postExecRemote ; ; preExecLocal/preExecRemote : commande shell executee UNE FOIS juste ; avant toute ouverture REELLE du conteneur (ignoree si deja ouvert) - ; respectivement en local (sur cette machine) et sur --host (via ssh). ; postExecLocal/postExecRemote : meme principe, juste avant toute ; fermeture REELLE. Un code de retour non nul interrompt l'operation ; (ouverture/fermeture bloquee). Ces 4 cles n'ont pas d'equivalent CLI. ; Variables exposees dans l'environnement de la commande : PCLUKS_HOST, ; PCLUKS_USER, PCLUKS_MODULE, PCLUKS_PATH, PCLUKS_IMAGE, PCLUKS_MAPPER, ; PCLUKS_MOUNTPOINT. ; ; Pour DESACTIVER un hook explicitement (tout en gardant la cle visible, ; en rappel de sa disponibilite) : 'preExecLocal = ""' - le parseur retire ; une paire de guillemets doubles entourant la valeur, donnant une valeur ; VIDE, donc un hook desactive (equivalent a omettre la cle). Omettre la ; cle fonctionne evidemment aussi. ; ; Cas particulier de "host" : accepte aussi une liste "A|B|C" (liste ; blanche des hotes autorises pour un module). Sans --host explicite en ; CLI, le premier (A) sert de defaut. Avec --host explicite, la valeur ; DOIT figurer dans la liste, sinon pcLuks refuse de demarrer - ; protection contre une synchronisation accidentelle vers le mauvais ; serveur. Exemple : host = srv14|srv18|ovh1 ; ; Priorite (la premiere valeur trouvee gagne) : ; 1. option CLI explicite (--host=, -p, --image=, etc.) ; 2. section [NOM_MODULE] ci-dessous ; 3. section globale (cles avant tout [section], juste en dessous) ; 4. valeur deduite du nom de module (--image/--keyfile/--mapper/ ; --mountpoint uniquement - pas host/user/path) ; 5. valeur par defaut brute du programme (localhost, root, ; /mnt/pcLuks/images/backup.img, /Atelier, etc.) ; ; Utilisation : pcLuks -m NOM_MODULE [action] [options] ; --- Section globale : s'applique a tout module qui ne la surcharge pas --- host = srv05 user = root ; ============================================================ ; Module "Atelier" : exemple de reference listant les 7 cles de base, ; une par une, meme celles qui reprennent ici la valeur qui aurait de ; toute facon ete deduite/heritee automatiquement si elles avaient ete ; omises (voir modules "Documents"/"Mail" pour la version minimale ; equivalente, et "system" pour un exemple de preExecLocal/postExecRemote). ; ============================================================ [Atelier] ; Machine distante (nom ou adresse), resolue par ssh. Liste blanche ; (forme 'A|B|C') : sans --host CLI, srv14 (1er) sert de defaut ; avec ; --host CLI, la valeur DOIT figurer dans la liste, sinon pcLuks refuse ; de demarrer - protection contre une synchronisation accidentelle ; vers le mauvais serveur. host = srv14|srv18|srv09|ovh1|ovh2 ; Utilisateur ssh pour la connexion distante. ; Omis -> herite de la section globale (ici: root), ou sinon 'root' ; par defaut brut. user = root ; Repertoire local a synchroniser vers ce depot (peut etre un lien ; symbolique, correctement suivi par le calcul automatique de ; taille -s/--size). ; Aucune deduction possible pour cette cle : omise, valeur par ; defaut brute /Atelier (ou -p/--path en ligne de commande). path = /Atelier ; Chemin du conteneur LUKS sur la machine distante. ; Omis -> deduit de la machine locale + du nom de module : ; /mnt/pcLuks/images/pcLuks.debian-dvt.Atelier.img image = /mnt/pcLuks/images/pcLuks.debian-dvt.Atelier.img ; Chemin du fichier de cle LUKS (cf. -C/--createKey pour la generer - ; en local uniquement, jamais stockee en permanence a cet emplacement ; distant, cf. section "Gestion de la cle" plus haut). Commune a TOUS ; les modules de cette machine locale (pas de dependance au module, ; contrairement aux 3 autres cles ci-dessous). ; Omise -> deduite de la machine locale uniquement : ; /mnt/pcLuks/pcLuks.debian-dvt.key keyfile = /mnt/pcLuks/pcLuks.debian-dvt.key ; Nom du device-mapper utilise pour le volume dechiffre. ; Omis -> deduit de la machine locale + du nom de module : ; data.debian-dvt.Atelier.pcLuks mapper = data.debian-dvt.Atelier.pcLuks ; Point de montage distant du volume dechiffre. ; Omis -> deduit de la machine locale + du nom de module : ; /mnt/pcLuks/debian-dvt.Atelier.dir mountpoint = /mnt/pcLuks/debian-dvt.Atelier.dir [etc] host = srv14|srv18|srv09|ovh1|ovh2 ; Repertoire local a synchroniser vers le depot path = /etc ; Chemin du conteneur LUKS sur la machine distante. image = /mnt/pcLuks/images/pcLuks.debian-dvt.etc.img ; Chemin du fichier de cle LUKS (cle elle-meme toujours locale, cf. ; section [Atelier] plus haut pour le detail). keyfile = /mnt/pcLuks/pcLuks.debian-dvt.key ; Nom du device-mapper utilise pour le volume dechiffré. mapper = data.debian-dvt.etc.pcLuks ; Point de montage distant du volume dechiffre. mountpoint = /mnt/pcLuks/debian-dvt.etc.dir ; Hooks disponibles (cf. commentaire d'en-tete) - non utilises ici sauf ; postExecRemote (versionne le contenu copie SUR LE DISTANT juste avant ; la fermeture, 6 versions conservees). preExecLocal = "" preExecRemote = "" postExecLocal = "" postExecRemote = /PCStreet/bin/pcversionning -f -r -n 6 $PCLUKS_MOUNTPOINT [system] host = srv14|srv18|srv09|ovh1|ovh2 ; Repertoire local a synchroniser vers le depot path = /root/debian-dvt.pcCollect ; Chemin du conteneur LUKS sur la machine distante. image = /mnt/pcLuks/images/pcLuks.debian-dvt.system.img ; Chemin du fichier de cle LUKS (cle elle-meme toujours locale, cf. ; section [Atelier] plus haut pour le detail). keyfile = /mnt/pcLuks/pcLuks.debian-dvt.key ; Nom du device-mapper utilise pour le volume dechiffré. mapper = data.debian-dvt.system.pcLuks ; Point de montage distant du volume dechiffre. mountpoint = /mnt/pcLuks/debian-dvt.system.dir ; Collecte les donnees systeme AVANT l'ouverture (sur cette machine, ; remplit --path avant sa copie par rsync). preExecLocal = /home/local/bin/pcCollect ; Versionne le contenu copie SUR LE DISTANT juste avant la fermeture ; (12 versions conservees) - $PCLUKS_MOUNTPOINT expose la valeur ; effective, cf. commentaire d'en-tete. postExecRemote = /PCStreet/bin/pcversionning -f -r -n 10 $PCLUKS_MOUNTPOINT ; ============================================================ ; Module "Documents" : meme principe, chemin local different. ; Illustration d'un module qui ne fixe que le strict necessaire. ; ============================================================ [Documents] path = /home/user/Documents ; ============================================================ ; Module "Photos" : exemple complet, toutes les cles surchargees ; explicitement - aucune valeur deduite ni heritee ici. Utile pour ; un depot dont les noms distants doivent etre independants du nom ; de module (ex: conteneur/cle deja en place avant l'usage de ; pcLuks, ou convention de nommage differente). ; ============================================================ [Photos] host = srv18 user = root path = /home/user/Photos image = /root/backups/photos.img keyfile = /root/.config/pcLuks/photos-secret.key mapper = photos_crypt mountpoint = /mnt/photos-crypt ; ============================================================ ; Module "Mail" : sur une machine differente (srv14), en ne ; surchargeant que host et path - image/keyfile/mapper/mountpoint ; restent deduits du nom "Mail". La taille du conteneur, elle, ; n'est pas configurable en ini : a fournir via -s/--size a la ; creation, ou omise pour un calcul automatique (1.5x le contenu ; de 'path', mesure au moment de -c/--create). ; ============================================================ [Mail] host = srv14 path = /var/mail