Suivant: Introduction, Monter: (dir) [Table des matières][Index]
Cette documentation décrit GNU Guix version b2bd56f, un outil de gestion de paquets fonctionnel écrit pour le système GNU.
Ce manuel est aussi disponible en anglais (voir GNU Guix Reference Manual), en allemand (voir Referenzhandbuch zu GNU Guix), en chinois simplifié (voir GNU Guix参考手册), en espagnol (voir Manual de referencia de GNU Guix), en portugais brésilien (voir Manual de referência do GNU Guix), et en russe (voir Руководство GNU Guix). Si vous souhaitez nous aider à traduire ce manuel en français, vous pouvez nous rejoindre sur Weblate et sur la liste de diffusion traduc@traduc.org (voir Traduire Guix).
guix repl
guix build
guix edit
guix download
guix hash
guix import
guix refresh
guix style
guix lint
guix size
guix graph
guix publish
guix challenge
guix copy
guix container
guix weather
guix processes
operating-system
guix system
guix deploy
guix home
Suivant: Installation, Précédent: GNU Guix, Monter: GNU Guix [Table des matières][Index]
GNU Guix1 est un outil de gestion de paquets et une distribution pour le système GNU. Guix facilite pour les utilisateur·rice·s non privilégié·e·s l’installation, la mise à jour et la suppression de paquets, la restauration à un ensemble de paquets précédent, la construction de paquets depuis les sources et plus généralement aide à la création et à la maintenance d’environnements logiciels.
Vous pouvez installer GNU Guix sur un système GNU/Linux existant pour compléter les outils disponibles sans interférence (voir Installation) ou vous pouvez l’utiliser comme distribution système indépendante, Guix System2. Voir Distribution GNU.
Suivant: Distribution GNU, Monter: Introduction [Table des matières][Index]
Guix fournit une interface de gestion des paquets par la ligne de commande (voir Gestion de paquets), des outils pour aider au développement logiciel (voir Développement), des utilitaires en ligne de commande pour des utilisations plus avancées (voir Utilitaires) ainsi que des interfaces de programmation Scheme (voir Interface de programmation). Son démon de construction est responsable de la construction des paquets pour les utilisateur·rice·s (voir Paramétrer le démon) et du téléchargement des binaires pré-construits depuis les sources autorisées (voir Substituts).
Guix contient de nombreuses définitions de paquet GNU et non-GNU qui respectent tous les libertés de l’utilisateur ou utilisatrice. Il est extensible : chacun·e peut écrire ses propres définitions de paquets (voir Définition des paquets) et les rendre disponibles dans des modules de paquets indépendants (voir Modules de paquets). Il est aussi personnalisable : on peut dériver des définitions de paquets spécialisées à partir de définitions existantes, même depuis la ligne de commande (voir Options de transformation de paquets).
Sous le capot, Guix implémente la discipline de gestion de paquet fonctionnel inventé par Nix (voir Remerciements). Dans Guix le processus de construction et d’installation des paquets est vu comme une fonction dans le sens mathématique du terme. Cette fonction a des entrées (comme des scripts de construction, un compilateur et des bibliothèques) et renvoie un paquet installé. En tant que fonction pure, son résultat ne dépend que de ses entrées. Par exemple, il ne peut pas faire référence à des logiciels ou des scripts qui n’ont pas été explicitement passés en entrée. Une fonction de construction produit toujours le même résultat quand on lui donne le même ensemble d’entrée. Elle ne peut pas modifier l’environnement du système en cours d’exécution d’aucune manière ; par exemple elle ne peut pas créer, modifier ou supprimer des fichiers en dehors de ses répertoires de construction et d’installation. Ce résultat s’obtient en lançant les processus de construction dans des environnements isolés (ou des conteneurs) où seules les entrées explicites sont visibles.
Le résultat des fonctions de construction de paquets est mis en cache dans le système de fichier, dans répertoire spécial appelé le dépôt (voir Le dépôt). Chaque paquet est installé dans son répertoire propre dans le dépôt — par défaut dans /gnu/store. Le nom du répertoire contient un hash de toutes les entrées utilisées pour construire le paquet ; ainsi, changer une entrée donnera un nom de répertoire différent.
Cette approche est le fondement des fonctionnalités les plus importante de Guix : le support des mises à jour des paquets et des retours en arrière transactionnels, l’installation différenciée par utilisateur·rice et le ramassage de miettes pour les paquets (voir Fonctionnalités).
Précédent: Gérer ses logiciels avec Guix, Monter: Introduction [Table des matières][Index]
Guix fournit aussi une distribution du système GNU contenant uniquement des logiciels libres3. On peut installer la distribution elle-même (voir Installation du système), mais on peut aussi installer Guix comme gestionnaire de paquets par dessus un système GNU/Linux déjà installé (voir Installation). Pour distinguer ces deux cas, on appelle la distribution autonome le « système Guix » ou Guix System.
La distribution fournit les paquets cœur de GNU comme la GNU libc, GCC et
Binutils, ainsi que de nombreuses applications GNU et non-GNU. La liste
complète des paquets disponibles se trouve
en ligne ou en lançant
guix package
(voir Invoquer guix package
) :
guix package --list-available
Notre but est de fournir une distribution logicielle entièrement libre de GNU/Linux et d’autres variantes de GNU, en se concentrant sur la promotion et l’intégration étroite des composants GNU en insistant sur les programmes et les outils qui aident l’utilisateur·rice à exercer ses libertés.
Les paquets sont actuellement disponibles pour les plateformes suivantes :
x86_64-linux
Intel/AMD x86_64
avec le noyau Linux-libre.
i686-linux
Architecture Intel 32 bits (IA32) avec le noyau Linux-libre.
armhf-linux
L’architecture ARMv7-A avec gestion des flottants matérielle, Thumb-2 et NEON, avec l’interface binaire applicative (ABI) EABI hard-float et le noyau Linux-libre.
aarch64-linux
les processeurs 64 bits ARMv8-A en little-endian, avec le noyau Linux-libre.
i586-gnu
GNU/Hurd sur l’architecture Intel 32-bit (IA32).
Cette configuration en cours de développement est expérimentale. La manière
la plus facile pour vous de l’essayer est de créer une instance
hurd-vm-service-type
sur votre machine GNU/Linux
(voir hurd-vm-service-type
).
Voir Contribuer, sur la façon d’aider !
mips64el-linux (non pris en charge)
les processeurs MIPS 64 bits little-endian, en particulier la série Loongson, l’ABI n32 et le noyau Linux-Libre. Cette configuration n’est plus entièrement prise en charge ; en particulier, il n’y a pas de travaux en cours pour s’assurer que cette architecture fonctionne encore. Si quelqu’un décide de faire revivre cette architecture, le code est toujours disponible.
powerpc-linux (non pris en charge)
les processeurs PowerPC 32 bits big-endian, en particulier PowerPC G4 avec la prise en charge d’AltVec et le noyau Linux-Libre. Cette configuration n’est pas entièrement prise en charge et il n’y a pas de travaux en cours pour s’assurer que cette architecture fonctionne.
powerpc64le-linux
little-endian 64-bit Power ISA processors, Linux-Libre kernel. This includes POWER9 systems such as the RYF Talos II mainboard. This platform is available as a "technology preview": although it is supported, substitutes are not yet available from the build farm (voir Substituts), and some packages may fail to build (voir Suivi des bogues et des changements). That said, the Guix community is actively working on improving this support, and now is a great time to try it and get involved!
riscv64-linux
Les processeurs RISC-V petit-boutistes, en particulier RV64GC, et le noyau linux-Libre. Cette plateforme est disponible en tant que « démonstrateur technique » : bien qu’elle soit prise en charge, les substituts ne sont pas encore disponibles dans notre ferme de construction (voir Substituts) et certains paquets peuvent ne pas construire (voir Suivi des bogues et des changements). Cela dit, la communauté Guix travaille activement à améliorer cette prise en charge et c’est donc maintenant le bon moment pour l’essayer et participer !
Avec Guix System, vous déclarez tous les aspects de la configuration du système d’exploitation et guix s’occupe d’instancier la configuration de manière transactionnelle, reproductible et sans état (voir Configuration du système). Guix System utilise le noyau Linux-libre, le système d’initialisation Shepherd (voir Introduction dans The GNU Shepherd Manual), les outils GNU et la chaîne d’outils familière ainsi que l’environnement graphique et les services systèmes de votre choix.
Guix System est disponible sur toutes les plateformes ci-dessus à part
mips64el-linux
, powerpc-linux
, powerpc64le-linux
et
riscv64-linux
.
Pour des informations sur comment porter vers d’autres architectures et d’autres noyau, voir Porter vers une nouvelle plateforme.
La construction de cette distribution est un effort collaboratif et nous vous invitons à nous rejoindre ! Voir Contribuer, pour des informations sur la manière de nous aider.
Suivant: Installation du système, Précédent: Introduction, Monter: GNU Guix [Table des matières][Index]
You can install the package management tool Guix on top of an existing GNU/Linux or GNU/Hurd system4, referred to as a foreign distro. If, instead, you want to install the complete, standalone GNU system distribution, Guix System, voir Installation du système. This section is concerned only with the installation of Guix on a foreign distro.
Important : This section only applies to systems without Guix. Following it for existing Guix installations will overwrite important system files.
Lorsqu’il est installé sur une distro externe, GNU Guix complète les outils disponibles sans interférence. Ses données se trouvent exclusivement dans deux répertoires, typiquement /gnu/store et /var/guix ; les autres fichiers de votre système comme /etc sont laissés intacts.
Une fois installé, Guix peut être mis à jour en lançant guix pull
(voir Invoquer guix pull
).
guix-daemon
Suivant: Paramétrer le démon, Monter: Installation [Table des matières][Index]
This section describes how to install Guix from a self-contained tarball providing binaries for Guix and for all its dependencies. This is often quicker than installing from source, described later (voir Construire depuis Git).
Important : This section only applies to systems without Guix. Following it for existing Guix installations will overwrite important system files.
Some GNU/Linux distributions, such as Debian, Ubuntu, and openSUSE provide Guix through their own package managers. The version of Guix may be older than b2bd56f but you can update it afterwards by running ‘guix pull’.
We advise system administrators who install Guix, both from the installation
script or via the native package manager of their foreign distribution,
to also regularly read and follow security notices, as shown by
guix pull
.
For Debian or derivatives such as Ubuntu or Trisquel, call:
sudo apt install guix
Likewise, on openSUSE:
sudo zypper install guix
If you are running Parabola, after enabling the pcr (Parabola Community Repo) repository, you can install Guix with:
sudo pacman -S guix
The Guix project also provides a shell script, guix-install.sh, which automates the binary installation process without use of a foreign distro package manager5. Use of guix-install.sh requires Bash, GnuPG, GNU tar, wget, and Xz.
The script guides you through the following:
As root, run:
# cd /tmp # wget https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh # chmod +x guix-install.sh # ./guix-install.sh
The script to install Guix is also packaged in Parabola (in the pcr repository). You can install and run it with:
sudo pacman -S guix-installer sudo guix-install.sh
Remarque : By default, guix-install.sh will configure Guix to download pre-built package binaries, called substitutes (voir Substituts), from the project’s build farms. If you choose not to permit this, Guix will build everything from source, making each installation and upgrade very expensive. Voir De la confiance en des binaires for a discussion of why you may want to build packages from source.
To use substitutes from
bordeaux.guix.gnu.org
,ci.guix.gnu.org
or a mirror, you must authorize them. For example,# guix archive --authorize < \ ~root/.config/guix/current/share/guix/bordeaux.guix.gnu.org.pub # guix archive --authorize < \ ~root/.config/guix/current/share/guix/ci.guix.gnu.org.pub
When you’re done installing Guix, voir Réglages applicatifs for extra configuration you might need, and Guide de démarrage for your first steps!
Remarque : L’archive d’installation binaire peut être (re)produite et vérifiée simplement en lançant la commande suivante dans l’arborescence des sources de Guix :
make guix-binary.system.tar.xz… ce qui à son tour lance :
guix pack -s system --localstatedir \ --profile-name=current-guix guixVoir Invoquer
guix pack
, pour plus d’info sur cet outil pratique.
Should you eventually want to uninstall Guix, run the same script with the --uninstall flag:
./guix-install.sh --uninstall
With --uninstall, the script irreversibly deletes all the Guix files, configuration, and services.
Suivant: Invoquer guix-daemon
, Précédent: Installation binaire, Monter: Installation [Table des matières][Index]
During installation, the build daemon that must be running to use Guix
has already been set up and you can run guix
commands in your
terminal program, voir Guide de démarrage:
guix build hello
If this runs through without error, feel free to skip this section. You should continue with the following section, Réglages applicatifs.
However, now would be a good time to replace outdated daemon versions, tweak
it, perform builds on other machines (voir Utiliser le dispositif de déchargement), or
start it manually in special environments like “chroots” (voir Chrooter dans un système existant) or WSL (not needed for WSL images created with
Guix, voir wsl2-image-type
). If you want to know
more or optimize your system, this section is worth reading.
Les opérations comme la construction d’un paquet ou le lancement du
ramasse-miettes sont toutes effectuées par un processus spécialisé, le démon
de construction, pour le compte des clients. Seul le démon peut accéder au
dépôt et à sa base de données associée. Ainsi, toute opération manipulant
le dépôt passe par le démon. Par exemple, les outils en ligne de commande
comme guix package
et guix build
communiquent avec le
démon (via des appels de procédures distantes) pour lui dire quoi faire.
Les sections suivantes expliquent comment préparer l’environnement du démon de construction. Voir Substituts pour apprendre comment permettre le téléchargement de binaires pré-construits.
Suivant: Utiliser le dispositif de déchargement, Monter: Paramétrer le démon [Table des matières][Index]
Dans une installation standard multi-utilisateur·rice·s, Guix et son démon —
le programme guix-daemon
— sont installés par la personne qui
administre le système ; /gnu/store appartient à root
et
guix-daemon
est lancé en root
. Les utilisateur·rice·s
non-privilégié·e·s peuvent utiliser les outils Guix pour construire des
paquets ou accéder au dépôt et le démon le fera pour leur compte en
s’assurant que le dépôt garde un état cohérent et permet le partage des
paquets déjà construits entre les utilisateur·rice·s.
Alors que guix-daemon
tourne en root
, vous n’avez pas
forcément envie que les processus de construction de paquets tournent aussi
en root
, pour des raisons de sécurité évidentes. Pour éviter cela,
vous devriez créer une réserve spéciale de comptes de construction que
les processus de construction démarrés par le démon utiliseront. Ces
comptes de construction n’ont pas besoin d’un shell ou d’un répertoire
personnel ; ils seront seulement utilisés quand le démon délaissera ses
privilèges root
dans les processus de construction. En ayant
plusieurs de ces comptes, vous permettez au démon de lancer des processus de
construction distincts sous des UID différent, ce qui garanti qu’aucune
interférence n’ait lieu entre les uns et les autres — une fonctionnalité
essentielle puisque les constructions sont supposées être des fonctions
pures (voir Introduction).
Sur un système GNU/Linux, on peut créer une réserve de comptes de
construction comme ceci (avec la syntaxe Bash et les commandes
shadow
) :
# groupadd --system guixbuild # for i in $(seq -w 1 10); do useradd -g guixbuild -G guixbuild \ -d /var/empty -s $(which nologin) \ -c "Compte de construction Guix $i" --system \ guixbuilder$i; done
Le nombre de comptes de construction détermine le nombre de tâches de
constructions qui peuvent tourner en parallèle, tel que spécifié par
l’option --max-jobs (voir --max-jobs). Pour utiliser guix system vm
et les
commandes liées, vous devrez ajouter les comptes de construction au groupe
kvm
pour qu’ils puissent accéder à /dev/kvm avec -G
guixbuild,kvm
plutôt que -G guixbuild
(voir Invoquer guix system
).
Le programme guix-daemon
peut ensuite être lancé en root
avec
la commande suivante6 :
# guix-daemon --build-users-group=guixbuild
De cette façon, le démon démarre les processus de construction dans un
chroot, sous un des comptes guixbuilder
. Sur GNU/Linux par défaut,
l’environnement chroot ne contient rien d’autre que :
/dev
minimal, créé presque indépendamment du
/dev
de l’hôte7 ;
/proc
; il ne montre que les processus du conteneur car
on utilise une espace de nom séparé pour les PID ;
localhost
à
127.0.0.1
;
Le chroot ne contient pas de dossier /home, et la variable
d’environnement HOME
est initialisée au répertoire
/homeless-shelter inexistant. Cela permet de mettre en valeur les
utilisations inappropriées de HOME
dans les scripts de construction
des paquets.
All this usually enough to ensure details of the environment do not influence build processes. In some exceptional cases where more control is needed—typically over the date, kernel, or CPU—you can resort to a virtual build machine (voir virtual build machines).
Vous pouvez influencer le répertoire où le démon stocke les arbres de
construction via la variable d’environnement TMPDIR
. Cependant,
l’arbre de construction dans le chroot sera toujours appelé
/tmp/guix-build-nom.drv-0, où nom est le nom de la
dérivation — p.ex., coreutils-8.24
. De cette façon, la valeur de
TMPDIR
ne fuite pas à l’intérieur des environnements de construction,
ce qui évite des différences lorsque le processus de construction retient le
nom de leur répertoire de construction.
Le démon prend aussi en compte la variable d’environnement
https_proxy
pour ses téléchargements HTTP et HTTPS, que ce soit pour
les dérivations à sortie fixes (voir Dérivations) ou pour les substituts
(voir Substituts).
Si vous installez Guix en tant qu’utilisateur·rice non privilégié·ée, il est
toujours possible d’exécuter guix-daemon
à condition de passer
--disable-chroot. Cependant, les processus de compilation ne
seront pas isolés les uns des autres, ni du reste du système. Ainsi, les
processus de compilation peuvent interférer les uns avec les autres, et
peuvent accéder à des programmes, des bibliothèques et d’autres fichiers
disponibles sur le système - ce qui rend beaucoup plus difficile de les
considérer comme des fonctions pures.
Suivant: Support de SELinux, Précédent: Réglages de l’environnement de construction, Monter: Paramétrer le démon [Table des matières][Index]
Si vous le souhaitez, le démon de construction peut décharger des
constructions de dérivation sur d’autres machines Guix avec le crochet
de construction offload
8. Lorsque cette fonctionnalité est activée, Guix
lit une liste de machines de constructions spécifiée par l’utilisateur·rice
dans /etc/guix/machines.scm ; à chaque fois qu’une construction est
demandée, par exemple par guix build
, le démon essaie de la décharger
sur une des machines qui satisfont les contraintes de la dérivation, en
particulier le type de système, p. ex. x86_64-linux. Une même
machine peut avoir plusieurs types de systèmes, soit parce que son
architecture le supporte nativement, soit par émulation
(voir Émulation transparente avec QEMU), soit
les deux. Les prérequis manquants pour la construction sont copiés par SSH
sur la machine de construction qui procède ensuite à la construction ; si
elle réussit, les sorties de la construction sont copiés vers la machine de
départ. Le dispsitif de déchargement est dotée d’un scheduler de base qui
tente de sélectionner la meilleure machine. La meilleure machine est
choisie parmi les machines disponibles sur la base de critères tels que :
parallel-builds
de son objet build-machine
.
speed
de son
objet build-machine
.
overload-threshold
de son
objet build-machine
.
Le fichier /etc/guix/machines.scm ressemble typiquement à cela :
(list (build-machine
(name "eightysix.example.org")
(system "x86_64-linux")
(host-key "ssh-ed25519 AAAAC3Nza…")
(user "bob")
(speed 2.)) ;incroyablement rapide !
(build-machine
(name "armeight.example.org")
(systems (list "aarch64-linux"))
(host-key "ssh-rsa AAAAB3Nza…")
(user "alice")
;; Rappelez-vous que « guix offload » est démarré par
;; « guix-daemon » en root.
(private-key "/root/.ssh/identité-pour-guix")))
Dans l’exemple ci-dessus nous spécifions une liste de deux machines de
construction, une pour l’architecture x86_64
et i686
et une
pour l’architecture aarch64
.
En fait, ce fichier est — et ça ne devrait pas vous surprendre ! — un
fichier Scheme qui est évalué au démarrage du crochet offload
. Sa
valeur de retour doit être une liste d’objets build-machine
. Même si
cet exemple montre une liste fixée de machines de construction, on pourrait
imaginer par exemple utiliser DNS-SD pour renvoyer une liste de machines de
constructions potentielles découvertes sur le réseau local
(voir Guile-Avahi dans Using Avahi in Guile Scheme
Programs). Le type de données build-machine
est détaillé plus bas.
Ce type de données représente les machines de construction sur lesquelles le démon peut décharger des constructions. Les champs importants sont :
name
Le nom d’hôte de la machine distante.
systèmes
Le type de système de la machine distante, p. ex., (list
"x86_64-linux" "i686-linux")
.
user
The user account on the remote machine to use when connecting over SSH. Note that the SSH key pair must not be passphrase-protected, to allow non-interactive logins.
host-key
Cela doit être la clef d’hôte SSH publique de la machine au format OpenSSH. Elle est utilisée pour authentifier la machine lors de la connexion. C’est une longue chaîne qui ressemble à cela :
ssh-ed25519 AAAAC3NzaC…mde+UhL hint@example.org
Si la machine utilise le démon OpenSSH, sshd
, la clef d’hôte se
trouve dans un fichier comme /etc/ssh/ssh_host_ed25519_key.pub.
Si la machine utilise le démon SSH de GNU lsh, la clef d’hôte est dans
/etc/lsh/host-key.pub ou un fichier similaire. Elle peut être
convertie au format OpenSSH avec lsh-export-key
(voir Converting keys dans LSH Manual) :
$ lsh-export-key --openssh < /etc/lsh/host-key.pub ssh-rsa AAAAB3NzaC1yc2EAAAAEOp8FoQAAAQEAs1eB46LV…
Il y a un certain nombre de champs facultatifs que vous pouvez remplir :
port
(par défaut : 22
)Numéro de port du serveur SSH sur la machine.
private-key
(par défaut : ~root/.ssh/id_rsa)Le fichier de clef privée SSH à utiliser lors de la connexion à la machine, au format OpenSSH. Cette clef ne doit pas être protégée par phrase de passe.
Remarquez que la valeur par défaut est la clef privée du compte root. Assurez-vous qu’elle existe si vous utilisez la valeur par défaut.
compression
(par défaut : "zlib@openssh.com,zlib"
)compression-level
(par défaut : 3
)Les méthodes de compression au niveau SSH et le niveau de compression demandé.
Remarquez que le déchargement utilise la compression SSH pour réduire la bande passante utilisée lors du transfert vers et depuis les machines de construction.
daemon-socket
(par défaut : "/var/guix/daemon-socket/socket"
)Le nom de fichier du socket Unix-domain sur lequel guix-daemon
écoute sur cette machine.
overload-threshold
(par défaut : 0.8
)Le seuil de charge au-dessus duquel une machine de déchargement potentielle
est ignorée par le programme de déchargement. Cette valeur se traduit
approximativement par l’utilisation totale du processeur de la machine de
construction, allant de 0,0 (0%) à 1,0 (100%). Elle peut également être
désactivée en réglant overload-threshold
sur #f
.
parallel-builds
(par défaut : 1
)Le nombre de constructions qui peuvent tourner simultanément sur la machine.
speed
(par défaut : 1.0
)Un « facteur de vitesse relatif ». L’ordonnanceur des constructions tendra à préférer les machines avec un plus grand facteur de vitesse.
features
(par défaut : '()
)Une liste de chaînes qui contient les fonctionnalités spécifiques supportées
par la machine. Un exemple est "kvm"
pour les machines qui ont le
module Linux KVM et le support matériel correspondant. Les dérivations
peuvent demander des fonctionnalités par leur nom et seront orchestrées sur
les machines de construction correspondantes.
Remarque : On Guix System, instead of managing /etc/guix/machines.scm independently, you can choose to specify build machines directly in the
operating-system
declaration, in thebuild-machines
field ofguix-configuration
. Voirbuild-machines
field ofguix-configuration
.
La commande guix
doit être dans le chemin de recherche des machines
de construction. Vous pouvez vérifier si c’est le cas en lançant :
ssh build-machine guix repl --version
Il reste une dernière chose à faire maintenant que machines.scm est
en place. Comme expliqué ci-dessus, lors du déchargement les fichiers sont
transférés entre les dépôts des machines. Pour que cela fonctionne, vous
devez d’abord générer une paire de clef sur chaque machine pour permettre au
démon d’exporter des archives signées des fichiers de son dépôt
(voir Invoquer guix archive
) :
# guix archive --generate-key
Remarque : This key pair is not related to the SSH key pair that was previously mentioned in the description of the
build-machine
data type.
Chaque machine de construction doit autoriser la clef de la machine maîtresse pour qu’ils acceptent les éléments de dépôt de celle-ci :
# guix archive --authorize < master-public-key.txt
De même, la machine maîtresse doit autoriser les clefs de chaque machine de construction.
Toute cette histoire de clefs permet d’exprimer la confiance mutuelle deux-à-deux entre le maître et les machines de construction. Concrètement, lorsque le maître reçoit des fichiers d’une machine de construction (et vice-versa), son démon de construction s’assure qu’ils sont authentiques, n’ont pas été modifiés par un tiers et qu’il sont signés par un clef autorisée.
Pour tester que votre paramétrage fonctionne, lancez cette commande sur le nœud maître :
# guix offload test
Cela essaiera de se connecter à toutes les machines de construction spécifiées dans /etc/guix/machines.scm, s’assurera que Guix est disponible sur toutes les machines et tentera d’exporter vers la machine et d’importer depuis elle, et rapportera toute erreur survenu pendant le processus.
Si vous souhaitez tester un fichier de machines différent, spécifiez-le sur la ligne de commande :
# guix offload test machines-qualif.scm
Enfin, vous pouvez tester un sous-ensemble de machines dont le nom correspond à une expression rationnelle comme ceci :
# guix offload test machines.scm '\.gnu\.org$'
Pour afficher la charge actuelle de tous les hôtes de construction, lancez cette commande sur le nœud principal :
# guix offload status
Précédent: Utiliser le dispositif de déchargement, Monter: Paramétrer le démon [Table des matières][Index]
Guix inclus un fichier de politique SELinux dans etc/guix-daemon.cil qui peut être installé sur un système où SELinux est activé pour que les fichiers Guix soient étiquetés et pour spécifier le comportement attendu du démon. Comme Guix System ne fournit pas de politique SELinux de base, la politique du démon ne peut pas être utilisée sur le système Guix.
Remarque : The
guix-install.sh
binary installation script offers to perform the steps below for you (voir Installation binaire).
Pour installer la politique, lancez cette commande en root :
semodule -i /var/guix/profiles/per-user/root/current-guix/share/selinux/guix-daemon.cil
Then, as root, relabel the file system, possibly after making it writable:
mount -o remount,rw /gnu/store restorecon -R /gnu /var/guix
At this point you can start or restart guix-daemon
; on a
distribution that uses systemd as its service manager, you can do that with:
systemctl restart guix-daemon
Une fois la politique installée, le système de fichier ré-étiqueté et le
démon redémarré, il devrait être lancé dans le contexte
guix_daemon_t
. Vous pouvez le confirmer avec la commande suivante :
ps -Zax | grep guix-daemon
Surveillez les fichiers journaux de SELinux pendant que vous lancez une
commande comme guix build hello
pour vous convaincre que SELniux
permet toutes les opérations nécessaires.
La politique n’est pas parfaite. Voici une liste de limitations et de bizarreries qui vous devriez prendre en compte avant de déployer la politique SELinux fournie pour le démon Guix.
guix_daemon_socket_t
n’est pas vraiment utilisé. Aucune des
opérations sur les sockets n’impliquent de contextes qui ont quoi que ce
soit à voir avec guix_daemon_socket_t
. Ça ne fait pas de mal d’avoir
une étiquette inutilisée, mais il serait préférable de définir des règles
sur les sockets uniquement pour cette étiquette.
guix gc
ne peut pas accéder à n’importe quel lien vers les profils.
Par conception, l’étiquette de fichier de la destination d’un lien
symbolique est indépendant de l’étiquette du lien lui-même. Bien que tous
les profils sous $localstatedir aient une étiquette, les liens vers
ces profils héritent de l’étiquette du répertoire dans lequel ils se
trouvent. Pour les liens dans le répertoire personnel cela sera
user_home_t
. Mais pour les liens du répertoire personnel de root, ou
/tmp, ou du répertoire de travail du serveur HTTP, etc, cela ne
fonctionnera pas. SELinux empêcherait guix gc
de lire et de suivre
ces liens.
/gnu/store/.+-(guix-.+|profile)/bin/guix-daemon
reçoivent l’étiquette
guix_daemon_exec_t
; cela signifie que tout fichier avec ce
nom dans n’importe quel profil serait autorisé à se lancer dans le domaine
guix_daemon_t
. Ce n’est pas idéal. Un attaquant pourrait construire
un paquet qui fournit cet exécutable et convaincre un·e utilisateur·rice de
l’installer et de le lancer, ce qui l’élève dans le domaine
guix_daemon_t
. À ce moment SELinux ne pourrait pas l’empêcher
d’accéder à des fichiers autorisés pour les processus de ce domaine.
Vous devrez renommer le répertoire du dépôt après chaque mise à jour de
guix-daemon, par exemple après avoir lancé guix pull
. En
supposant que le dépôt est dans /gnu, vous pouvez le faire avec
restorecon -vR /gnu
, ou par d’autres moyens fournis par votre système
d’exploitation.
Nous pourrions générer une politique bien plus restrictive à l’installation,
pour que seuls les noms de fichiers exacts de l’exécutable
guix-daemon
actuellement installé soit étiqueté avec
guix_daemon_exec_t
, plutôt que d’utiliser une expression rationnelle
plus large. L’inconvénient c’est que root devrait installer ou mettre à
jour la politique à l’installation à chaque fois que le paquet Guix qui
fournit l’exécutable guix-daemon
effectivement exécuté est mis à
jour.
Suivant: Réglages applicatifs, Précédent: Paramétrer le démon, Monter: Installation [Table des matières][Index]
guix-daemon
Le programme guix-daemon
implémente toutes les fonctionnalités
d’accès au dépôt. Cela inclus le lancement des processus de construction,
le lancement du ramasse-miettes, la demande de disponibilité des résultats
de construction, etc. Il tourne normalement en root
comme ceci :
# guix-daemon --build-users-group=guixbuild
Ce démon peut aussi être démarré avec le protocole d’« activation par socket
» de systemd (voir make-systemd-constructor
dans le manuel de GNU Shepherd).
Pour des détails sur son paramétrage, voir Paramétrer le démon.
Par défaut, guix-daemon
lance les processus de construction sous
différents UIDs récupérés depuis le groupe de construction spécifié avec
--build-users-group
. En plus, chaque processus de construction est
lancé dans un environnement chroot qui ne contient que le sous-ensemble du
dépôt dont le processus de construction dépend, tel que spécifié par sa
dérivation (voir dérivation), plus un
ensemble de répertoires systèmes spécifiques. Par défaut ce dernier
contient /dev et /dev/pts. De plus, sous GNU/Linux,
l’environnement de construction est un conteneur : en plus d’avoir sa
propre arborescence du système de fichier, il a un espace de nom de montage
séparé, son propre espace de nom PID, son espace de nom de réseau, etc.
Cela aide à obtenir des constructions reproductibles
(voir Fonctionnalités).
Lorsque le démon effectue une construction pour le compte de
l’utilisateur·rice, il crée un répertoire de construction sous /tmp
ou sous le répertoire spécifié par sa variable d’environnement
TMPDIR
. Ce répertoire est partagé avec le conteneur pendant toute la
durée de la construction, bien que dans le conteneur, l’arbre de compilation
soit toujours appelé /tmp/guix-build-name.drv-0.
Le répertoire de construction est automatiquement supprimé à la fin, à moins que la construction n’ait échoué et que le client ait spécifié --keep-failed (voir --keep-failed).
Le démon écoute les connexions et démarre un sous-processus pour chaque
session démarrée par un client (l’une des sous-commandes de
guix
). La commande guix processes
vous permet d’obtenir
un aperçu de l’activité sur votre système en affichant chaque session et
client actifs. Voir Invoquer guix processes
pour plus d’informations.
Les options en ligne de commande suivantes sont disponibles :
--build-users-group=groupe
Utiliser les comptes du groupe pour lancer les processus de construction (voir comptes de construction).
--no-substitutes
¶Ne pas utiliser de substitut pour les résultats de la construction. C’est-à-dire, toujours construire localement plutôt que de permettre le téléchargement de binaires pré-construits (voir Substituts).
Lorsque le démon est lancé avec --no-substitutes
, les clients peuvent
toujours activer explicitement la substitution via l’appel de procédure
distante set-build-options
(voir Le dépôt).
--substitute-urls=urls
Considérer urls comme la liste séparée par des espaces des URL des
sources de substituts par défaut. Lorsque cette option est omise,
‘https://bordeaux.guix.gnu.org https://ci.guix.gnu.org
’ est utilisé.
Cela signifie que les substituts sont téléchargés depuis les urls, tant qu’ils sont signés par une signature de confiance (voir Substituts).
Voir Récupérer des substituts d’autres serveurs, pour plus d’information sur la configuration du démon pour récupérer des substituts d’autres serveurs.
--no-offload
N’essaye pas de décharger les constructions vers d’autres machines (voir Utiliser le dispositif de déchargement). C’est-à-dire que tout sera construit localement au lieu de décharger les constructions à une machine distante.
--cache-failures
Mettre les échecs de construction en cache. Par défaut, seules les constructions réussies sont mises en cache.
Lorsque cette option est utilisée, guix gc --list-failures
peut
être utilisé pour demander l’ensemble des éléments du dépôt marqués comme
échoués ; guix gc --clear-failures
vide la liste des éléments
aillant échoué. Voir Invoquer guix gc
.
--cores=n
-c n
Utiliser n cœurs CPU pour construire chaque dérivation ; 0
signifie autant que possible.
La valeur par défaut est 0
, mais elle peut être annulée par les
clients, comme avec l’option --cores
de guix build
(voir Invoquer guix build
).
L’effet est de définir la variable d’environnement NIX_BUILD_CORES
dans le processus de construction, qui peut ensuite l’utiliser pour
exploiter le parallélisme en interne — par exemple en lançant make
-j$NIX_BUILD_CORES
.
--max-jobs=n
-M n
Permettre au plus n travaux de construction en parallèle. La valeur
par défaut est 1
. La mettre à 0
signifie qu’aucune
construction ne sera effectuée localement ; à la place, le démon déchargera
les constructions (voir Utiliser le dispositif de déchargement) ou échouera.
--max-silent-time=secondes
Lorsque le processus de construction ou de substitution restent silencieux pendant plus de secondes, le terminer et rapporter une erreur de construction.
The default value is 3600
(one hour).
La valeur spécifiée ici peut être annulée par les clients (voir --max-silent-time
).
--timeout=secondes
De même, lorsque le processus de construction ou de substitution dure plus de secondes, le terminer et rapporter une erreur de construction.
The default value is 24 hours.
La valeur spécifiée ici peut être annulée par les clients (voir --timeout
).
--rounds=N
Construire chaque dérivations N fois à la suite, et lever une erreur
si les résultats de construction consécutifs ne sont pas identiques
bit-à-bit. Remarquez que ce paramètre peut être modifié par les clients
comme guix build
(voir Invoquer guix build
).
Lorsqu’utilisé avec --keep-failed, la sortie différente est gardée dans le dépôt sous /gnu/store/…-check. Cela rend plus facile l’étude des différences entre les deux résultats.
--debug
Produire une sortie de débogage.
Cela est utile pour déboguer des problèmes de démarrage du démon, mais
ensuite elle peut être annulée par les clients, par exemple par l’option
--verbosity
de guix build
(voir Invoquer guix build
).
--chroot-directory=rép
Ajouter rép au chroot de construction.
Cela peut changer le résultat d’un processus de construction — par exemple s’il utilise une dépendance facultative trouvée dans rép lorsqu’elle est disponible ou pas sinon. Pour cette raison, il n’est pas recommandé d’utiliser cette option. À la place, assurez-vous que chaque dérivation déclare toutes les entrées dont elle a besoin.
--disable-chroot
Désactive les constructions dans un chroot.
Utiliser cette option n’est pas recommandé car, de nouveau, elle permet aux
processus de construction d’accéder à des dépendances non déclarées. Elle
est nécessaire cependant lorsque guix-daemon
tourne sans
privilèges.
--log-compression=type
Compresser les journaux de construction suivant le type, parmi
gzip
, bzip2
ou none
.
À moins que --lose-logs ne soit utilisé, tous les journaux de construction sont gardés dans localstatedir. Pour gagner de la place, le démon les compresse automatiquement avec gzip par défaut.
--discover[=yes|no]
Indique s’il faut découvrir les serveurs de substitut sur le réseau local avec mDNS et DNS-SD.
Cette fonction est encore expérimentale. Cependant, voici quelques réflexions sur le sujet.
guix publish
sur votre LAN ne peut
pas vous proposer de binaire malveillants, mais il ou elle pourrait
apprendre quels logiciels vous installez ;
Il est aussi possible d’activer ou de désactiver la découverte de serveurs de substituts à l’exécution en lançant :
herd discover guix-daemon on herd discover guix-daemon off
--disable-deduplication
¶Désactiver la « déduplication » automatique des fichiers dans le dépôt.
Par défaut, les fichiers ajoutés au dépôt sont automatiquement « dédupliqués » : si un nouveau fichier est identique à un autre fichier trouvé dans le dépôt, le démon en fait un lien en dur vers l’autre fichier. Cela réduit considérablement l’utilisation de l’espace disque au prix d’une charge en entrée/sortie plus grande à la fin d’un processus de construction. Cette option désactive cette optimisation.
--gc-keep-outputs[=yes|no]
Dire si le ramasse-miettes (GC) doit garder les sorties des dérivations utilisées.
Lorsqu’il est réglé sur yes
, le GC conservera les sorties de toute
dérivation active disponibles dans le dépôt—les fichiers .drv. La
valeur par défaut est no
, ce qui signifie que les sorties des
dérivations ne sont conservées que si elles sont accessibles à partir d’une
racine GC. Voir Invoquer guix gc
, pour en savoir plus sur les racines GC.
--gc-keep-derivations[=yes|no]
Dire si le ramasse-miettes (GC) doit garder les dérivations correspondant à des sorties utilisées.
Lorsqu’il est réglé à « yes », comme c’est le cas par défaut, le GC garde
les dérivations — c.-à-d. les fichiers .drv — tant qu’au moins une
de leurs sorties est utilisée. Cela permet de garder une trace de l’origine
des éléments du dépôt. Le mettre à no
préserve un peu d’espace
disque.
De cette manière, le réglage de l’option --gc-keep-derivations sur
yes
étend le résultat des sorties aux dérivations, et le réglage de
l’option --gc-keep-outputs sur yes
étend le résultat des
dérivations aux sorties. Lorsque les deux sont réglés sur yes
,
l’effet est de conserver tous les prérequis de construction (les sources, le
compilateur, les bibliothèques et autres outils de construction) des objets
actifs dans le dépôt, que ces prérequis soient accessibles ou non depuis une
racine GC. Cela est pratique pour les développeurs car cela permet d’éviter
les reconstructions ou les téléchargements.
--impersonate-linux-2.6
Sur les systèmes basés sur Linux, imiter Linux 2.6. Cela signifie que
l’appel système uname
du noyau indiquera 2.6 comme numéro de
version.
Cela peut être utile pour construire des programmes qui dépendent (généralement sans fondement) du numéro de version du noyau.
--lose-logs
Ne pas garder les journaux de construction. Par défaut ils sont gardés dans localstatedir/guix/log.
--system=système
Supposer que système est le type de système actuel. Par défaut c’est
la paire architecture-noyau trouvée à la configuration, comme
x86_64-linux
.
--listen=extrémité
Écouter les connexions sur extrémité. extrémité est interprété
comme un nom de fichier d’un socket Unix-domain s’il commence par /
(barre oblique). Sinon, extrémité est interprété comme un nom de
domaine ou d’hôte et un port sur lequel écouter. Voici quelques exemples :
--listen=/gnu/var/daemon
Écouter les connexions sur le socket Unix-domain /gnu/var/daemon en le créant si besoin.
--listen=localhost
¶Écouter les connexions TCP sur l’interface réseau correspondant à
localhost
sur le port 44146.
--listen=128.0.0.42:1234
Écouter les connexions TCP sur l’interface réseau correspondant à
128.0.0.42
sur le port 1234.
Cette option peut être répétée plusieurs fois, auquel cas
guix-daemon
accepte des connexions sur tous les paramètres
spécifiés. On peut indiquer aux commandes clientes à quoi se connecter en
paramétrant la variable d’environnement GUIX_DAEMON_SOCKET
(voir GUIX_DAEMON_SOCKET
).
Remarque : Le protocole du démon est non authentifié et non chiffré. Utiliser --listen=host est adapté sur des réseaux locaux, comme pour des grappes de serveurs, où seuls des nœuds de confiance peuvent se connecter au démon de construction. Dans les autres cas où l’accès à distance au démon est requis, nous conseillons d’utiliser un socket Unix-domain avec SSH.
Lorsque --listen est omis, guix-daemon
écoute les
connexions sur le socket Unix-domain situé à
localstatedir/guix/daemon-socket/socket.
Suivant: Mettre à niveau Guix, Précédent: Invoquer guix-daemon
, Monter: Installation [Table des matières][Index]
Lorsque vous utilisez Guix par dessus une distribution GNU/Linux qui n’est pas Guix System — ce qu’on appelle une distro externe — quelques étapes supplémentaires sont requises pour que tout soit en place. En voici certaines.
Les paquets installés via Guix n’utiliseront pas les données de
régionalisation du système hôte. À la place, vous devrez d’abord installer
l’un des paquets linguistiques disponibles dans Guix puis définir la
variable d’environnement GUIX_LOCPATH
:
$ guix install glibc-locales $ export GUIX_LOCPATH=$HOME/.guix-profile/lib/locale
Remarquez que le paquet glibc-locales
contient les données de tous
les paramètres linguistiques pris en charge par la GNU libc et pèse
environ 930 Mio9. Si vous n’avez besoin que de quelques paramètres, vous pouvez définir
un paquet personnalisé avec la procédure make-glibc-utf8-locales
du
module (gnu packages base)
. L’exemple suivant défini un paquet
contenant plusieurs paramètres linguistiques canadiens connus de
GNU libc, qui pèse environ 14 Mio :
(use-modules (gnu packages base)) (define my-glibc-locales (make-glibc-utf8-locales glibc #:locales (list "en_CA" "fr_CA" "ik_CA" "iu_CA" "shs_CA") #:name "glibc-canadian-utf8-locales"))
La variable GUIX_LOCPATH
joue un rôle similaire à LOCPATH
(voir LOCPATH
dans The GNU C Library Reference
Manual). Il y a deux différences importantes cependant :
GUIX_LOCPATH
n’est pris en compte que par la libc dans Guix et pas par
la libc fournie par les distros externes. Ainsi, utiliser
GUIX_LOCPATH
vous permet de vous assurer que les programmes de la
distro externe ne chargeront pas de données linguistiques incompatibles.
/X.Y
à chaque entrée de GUIX_LOCPATH
,
où X.Y
est la version de la libc — p. ex. 2.22
. Cela
signifie que, si votre profile Guix contient un mélange de programmes liés
avec des versions différentes de la libc, chaque version de la libc essaiera
de charger les environnements linguistiques dans le bon format.
Cela est important car le format des données linguistiques utilisés par différentes version de la libc peuvent être incompatibles.
Lorsque vous utilisez Guix sur une distro externe, nous recommandons
fortement que ce système fasse tourner le démon de cache de service de
noms de la bibliothèque C de GNU, nscd
, qui devrait écouter sur
le socket /var/run/nscd/socket. Sans cela, les applications
installées avec Guix peuvent échouer à résoudre des noms d’hôtes ou de
comptes, ou même planter. Les paragraphes suivants expliquent pourquoi.
La bibliothèque C de GNU implémente un name service switch (NSS), qui est un mécanisme d’extension pour les « résolutions de noms » en général : résolution de nom d’hôte, de compte utilisateur·rice et plus (voir Name Service Switch dans The GNU C Library Reference Manual).
Comme il est extensible, NSS supporte des greffons qui fournissent une
nouvelle implémentation de résolution de nom : par exemple le greffon
nss-mdns
permet la résolution de noms d’hôtes en .local
, le
greffon nis
permet la résolution de comptes avec le Network
Information Service (NIS), etc. Ces « services de recherches »
supplémentaires sont configurés au niveau du système dans
/etc/nsswitch.conf, et tous les programmes qui tournent sur ce
système prennent en compte ces paramètres (voir NSS Configuration File dans The GNU C Reference Manual).
Lorsqu’ils essayent d’effectuer une résolution de nom — par exemple en
appelant la fonction getaddrinfo
en C — les applications essayent
d’abord de se connecter au nscd ; en cas de réussite, nscd effectue la
résolution de nom pour eux. Si le nscd ne tourne pas, alors ils effectuent
la résolution eux-mêmes, en changeant les service de résolution dans leur
propre espace d’adressage et en le lançant. Ce services de résolution de
noms — les fichiers libnns_*.so — sont dlopen
és mais ils
peuvent provenir de la bibliothèque C du système, plutôt que de la
bibliothèque C à laquelle l’application est liée (la bibliothèque C de
Guix).
Et c’est là que se trouve le problème : si votre application est liée à la
bibliothèque C de Guix (disons, glibc-2.24) et essaye de charger les
greffons NSS d’une autre bibliothèque C (disons, libnss_mdns.so
pour
glibc-2.22), il est très probable qu’elle plante ou que sa résolution de nom
échoue de manière inattendue.
Lancer nscd
sur le système, entre autres avantages, élimine ce
problème d’incompatibilité binaire car ces fichiers libnss_*.so
sont
chargés par le processus nscd
, pas par l’application elle-même.
La majorité des applications graphiques utilisent fontconfig pour trouver et
charger les polices et effectuer le rendu côté client X11. Le paquet
fontconfig
dans Guix cherche les polices dans
$HOME/.guix-profile par défaut. Ainsi, pour permettre aux
applications graphiques installées avec Guix d’afficher des polices, vous
devez aussi installer des polices avec Guix. Les paquets de polices
essentiels sont font-ghostscript
, font-dejavu
et
font-gnu-freefont
.
Lorsque vous installez ou supprimez des polices, ou lorsque vous remarquez qu’une application ne trouve pas les polices, vous pouvez avoir besoin d’installer Fontconfig et de forcer un rafraîchissement de son cache de police avec :
guix install fontconfig fc-cache -rv
Pour afficher des textes écrits en chinois, en japonais ou en coréen dans
les applications graphiques, installez font-adobe-source-han-sans
ou
font-wqy-zenhei
. Le premier a plusieurs sorties, une par famille de
langue (voir Des paquets avec plusieurs résultats). Par exemple, la commande
suivante installe les polices pour le chinois :
guix install font-adobe-source-han-sans:cn
Les vieux programmes comme xterm
n’utilisent pas fontconfig et
s’appuient sur le rendu du côté du serveur. Ces programmes ont besoin de
spécifier le nom complet de la police en utilisant XLFD (X Logical Font
Description), comme ceci :
-*-dejavu sans-medium-r-normal-*-*-100-*-*-*-*-*-1
Pour pouvoir utiliser ces noms complets avec les polices TrueType installées dans votre profil Guix, vous devez étendre le chemin des polices du serveur X :
xset +fp $(dirname $(readlink -f ~/.guix-profile/share/fonts/truetype/fonts.dir))
Ensuite, vous pouvez lancer xlsfonts
(du paquet xlsfonts
) pour
vous assurer que vos polices TrueType y sont listées.
Le paquet nss-certs
fournit les certificats X.509 qui permettent aux
programmes d’authentifier les serveurs web par HTTPS.
Lorsque vous utilisez Guix sur une distribution externe, vous pouvez installer ce paquet et définir les variables d’environnement adéquates pour que les paquets sachent où trouver les certificats. Voir Certificats X.509, pour des informations détaillées.
Quand vous installez des paquets Emacs avec Guix, les fichiers Elips sont
placés dans le répertoire share/emacs/site-lisp/ du profil dans
lequel ils sont installés. Les bibliothèques Elisp sont rendues disponibles
dans Emacs avec la variable d’environnement EMACSLOADPATH
, qui est
initialisée à l’installation d’Emacs lui-même.
Additionally, autoload definitions are automatically evaluated at the
initialization of Emacs, by the Guix-specific
guix-emacs-autoload-packages
procedure. This procedure can be
interactively invoked to have newly installed Emacs packages discovered,
without having to restart Emacs. If, for some reason, you want to avoid
auto-loading the Emacs packages installed with Guix, you can do so by
running Emacs with the --no-site-file option (voir Init File dans The GNU Emacs Manual).
Remarque : Most Emacs variants are now capable of doing native compilation. The approach taken by Guix Emacs however differs greatly from the approach taken upstream.
Upstream Emacs compiles packages just-in-time and typically places shared object files in a special folder within your
user-emacs-directory
. These shared objects within said folder are organized in a flat hierarchy, and their file names contain two hashes to verify the original file name and contents of the source code.Guix Emacs on the other hand prefers to compile packages ahead-of-time. Shared objects retain much of the original file name and no hashes are added to verify the original file name or the contents of the file. Crucially, this allows Guix Emacs and packages built against it to be grafted (voir grafts), but at the same time, Guix Emacs lacks the hash-based verification of source code baked into upstream Emacs. As this naming schema is trivial to exploit, we disable just-in-time compilation.
Further note, that
emacs-minimal
—the default Emacs for building packages—has been configured without native compilation. To natively compile your emacs packages ahead of time, use a transformation like --with-input=emacs-minimal=emacs.
Précédent: Réglages applicatifs, Monter: Installation [Table des matières][Index]
Pour mettre Guix à niveau, lancez :
guix pull
Voir Invoquer guix pull
, pour plus d’informations.
Sur une distribution externe, vous pouvez mettre à jour le démon de construction en lançant :
sudo -i guix pull
suivi de (dans le cas où votre distribution utilise l’outil de gestion de services Systemd) :
systemctl restart guix-daemon.service
Sur Guix System, la mise à jour du démon est effectuée par la
reconfiguration du système (voir guix system
reconfigure
).
Suivant: Guide de démarrage, Précédent: Installation, Monter: GNU Guix [Table des matières][Index]
Cette section explique comment installer Guix System sur une machine. Guix, en tant que gestionnaire de paquets, peut aussi être installé sur un système GNU/Linux déjà installé, voir Installation.
Suivant: Considérations matérielles, Monter: Installation du système [Table des matières][Index]
Nous considérons Guix System comme prêt pour une grande variété de cas d’utilisation pour le « bureau » et le serveur. Les garanties de fiabilité qu’il fournit — les mises à jour transactionnelles, les retours en arrières et la reproductibilité — en font une solide fondation.
More and more system services are provided (voir Services).
Nevertheless, before you proceed with the installation, be aware that some services you rely on may still be missing from version b2bd56f.
Plus qu’un avertissement, c’est une invitation à rapporter les problèmes (et vos succès !) et à nous rejoindre pour améliorer la distribution. Voir Contribuer, pour plus d’info.
Suivant: Installation depuis une clef USB ou un DVD, Précédent: Limitations, Monter: Installation du système [Table des matières][Index]
GNU Guix se concentre sur le respect des libertés de ses utilisateurs et utilisatrices. Il est construit autour du noyau Linux-libre, ce qui signifie que seuls les matériels pour lesquels des pilotes logiciels et des microgiciels libres sont disponibles sont pris en charge. De nos jours, une grande gamme de matériel qu’on peut acheter est prise en charge par GNU/Linux-libre — des claviers aux cartes graphiques en passant par les scanners et les contrôleurs Ethernet. Malheureusement, il reste des produits dont les fabricants refusent de laisser le contrôle aux utilisateur·rice·s sur leur propre utilisation de l’ordinateur, et ces matériels ne sont pas pris en charge par Guix System.
L’un des types de matériels où les pilotes ou les microgiciels sont le moins
disponibles sont les appareils WiFi. Les appareils WiFi connus pour
fonctionner sont ceux qui utilisent des puces Atheros (AR9271 et AR7010) qui
correspondent au pilote ath9k
de Linux-libre, et ceux qui utilisent
des puces Broadcom/AirForce (BCM43xx avec la révision Wireless-Core 5), qui
correspondent au pilote b43-open
de Linux-libre. Des microgiciels
libres existent pour les deux et sont disponibles directement sur Guix
System, dans %base-firmware (voir firmware
).
L’installateur vous averti rapidement s’il détecte des périphériques connus pour ne pas marcher à cause du manque de micrologiciel ou de pilote libre.
La Free Software Foundation a un programme de certification nommé Respects Your Freedom (RYF), pour les produits matériels qui respectent votre liberté et votre vie privée en s’assurant que vous avez le contrôle sur l’appareil. Nous vous encourageons à vérifier la liste des appareils certifiés par RYF.
Une autre ressource utile est le site web H-Node. Il contient un catalogue d’appareils avec des informations sur leur support dans GNU/Linux.
Suivant: Préparer l’installation, Précédent: Considérations matérielles, Monter: Installation du système [Table des matières][Index]
Une image d’installation ISO-9660 qui peut être écrite sur une clé USB ou
être gravée sur un DVD est téléchargeable à partir de
‘https://ftp.gnu.org/gnu/guix/guix-system-install-b2bd56f.x86_64-linux.iso
’,
où vous pouvez remplacer x86_64-linux
par l’un des éléments suivants
:
x86_64-linux
pour un système GNU/Linux sur un CPU compatible Intel/AMD 64-bits ;
i686-linux
pour un système GNU/Linux sur un CPU compatible Intel 32-bits.
Assurez-vous de télécharger les fichiers .sig associés et de vérifier l’authenticité de l’image avec, de cette manière :
$ wget https://ftp.gnu.org/gnu/guix/guix-system-install-b2bd56f.x86_64-linux.iso.sig $ gpg --verify guix-system-install-b2bd56f.x86_64-linux.iso.sig
Si cette commande échoue parce que vous n’avez pas la clef publique requise, lancez cette commande pour l’importer :
$ wget https://sv.gnu.org/people/viewgpg.php?user_id=15145 \ -qO - | gpg --import -
et relancez la commande gpg --verify
.
Remarquez qu’un avertissement du type « Cette clef n’est pas certifiée par une signature de confiance ! » est normal.
Cette image contient les outils nécessaires à l’installation. Elle est faite pour être copiée telle quelle sur une clef USB assez grosse ou un DVD.
Insérez la clef USB de 1 Gio ou plus dans votre machine et déterminez son nom d’appareil. En supposant que la clef usb est connue sous le nom de /dev/sdX, copiez l’image avec :
dd if=guix-system-install-b2bd56f.x86_64-linux.iso of=/dev/sdX status=progress sync
Accéder à /dev/sdX requiert généralement les privilèges d’administration.
Insérez un DVD vierge dans votre machine et déterminez son nom d’appareil. En supposant que le DVD soit connu sont le nom de /dev/srX, copiez l’image avec :
growisofs -dvd-compat -Z /dev/srX=guix-system-install-b2bd56f.x86_64-linux.iso
Accéder à /dev/srX requiert généralement les privilèges root.
Une fois que c’est fait, vous devriez pouvoir redémarrer le système et
démarrer depuis la clé USB ou le DVD. Pour cela, vous devrez généralement
entrer dans le menu de démarrage BIOS ou UEFI, où vous pourrez choisir de
démarrer sur la clé USB. Pour démarrer depuis Libreboot, passez en mode de
commande en appuyant sur la touche c et en tapant search grub
usb
.
Sadly, on some machines, the installation medium cannot be properly booted and you only see a black screen after booting even after you waited for ten minutes. This may indicate that your machine cannot run Guix System; perhaps you instead want to install Guix on a foreign distro (voir Installation binaire). But don’t give up just yet; a possible workaround is pressing the e key in the GRUB boot menu and appending nomodeset to the Linux bootline. Sometimes the black screen issue can also be resolved by connecting a different display.
Voir Installer Guix sur une machine virtuelle, si, à la place, vous souhaitez installer Guix System dans une machine virtuelle (VM).
Suivant: Installation graphique guidée, Précédent: Installation depuis une clef USB ou un DVD, Monter: Installation du système [Table des matières][Index]
Une fois que vous avez démarré, vous pouvez utiliser l’installateur graphique, qui rend facile la prise en main (voir Installation graphique guidée). Sinon, si vous êtes déjà familier avec GNU/Linux et que vous voulez plus de contrôle que ce que l’installateur graphique propose, vous pouvez choisir le processus d’installation « manuel » (voir Installation manuelle).
L’installateur graphique est disponible sur le TTY1. Vous pouvez obtenir des shells root sur les TTY 3 à 6 en tapant ctrl-alt-f3, ctrl-alt-f4 etc. Le TTY2 affiche cette documentation que vous pouvez atteindre avec ctrl-alt-f2. On peut naviguer dans la documentation avec les commandes du lecteur Info (voir Stand-alone GNU Info). Le démon de souris GPM tourne sur le système d’installation, ce qui vous permet de sélectionner du texte avec le bouton gauche de la souris et de le coller en appuyant sur la molette.
Remarque : L’installation nécessite un accès au réseau pour que les dépendances manquantes de votre configuration système puissent être téléchargées. Voyez la section « réseau » plus bas.
Suivant: Installation manuelle, Précédent: Préparer l’installation, Monter: Installation du système [Table des matières][Index]
L’installateur graphique est une interface utilisateur en mode texte. Il vous guidera, avec des boîtes de dialogue, le long des étapes requises pour installer GNU Guix System.
La première boîte de dialogue vous permet de paramétrer le système comme vous le souhaitez pendant l’installation : vous pouvez choisir la langue, la disposition du clavier et paramétrer le réseau, qui sera utilisé pendant l’installation. L’image ci-dessous montre le dialogue pour le réseau.
Les étapes suivantes vous permettent de partitionner votre disque dur, comme le montre l’image ci-dessous, de choisir si vous voulez ou non utiliser des systèmes de fichiers chiffrés, de saisir le nom d’hôte et le mot de passe root et de créer un compte supplémentaire, entre autres choses.
Remarquez que, à tout moment, l’installateur vous permet de sortir de l’étape d’installation actuelle et de recommencer une étape précédente, comme le montre l’image ci-dessous.
Une fois que vous avez fini, l’installateur produit une configuration de système d’exploitation et vous la montre (voir Utiliser le système de configuration). À ce moment, vous pouvez appuyer sur « OK » et l’installation continuera. Lorsqu’elle aura réussi, vous pourrez redémarrer sur le nouveau système et vous amuser. Voir Après l’installation du système, pour la suite des festivités !
Suivant: Après l’installation du système, Précédent: Installation graphique guidée, Monter: Installation du système [Table des matières][Index]
Cette section décrit comme vous pourriez installe « manuellement » GNU Guix System sur votre machine. Cette option nécessite que vous soyez familier avec GNU/Linux, le shell et avec les outils d’administration usuels. Si vous pensez que ce n’est pas pour vous, pensez à utiliser l’installateur graphique (voir Installation graphique guidée).
Le système d’installation fournit des shells root sur les TTY 3 à 6 ;
appuyez sur ctrl-alt-f3, ctrl-alt-f4 etc pour y accéder. Il
inclus plusieurs outils usuels pour requis pour cette tâche. Mais c’est
aussi un système Guix complet. Cela signifie que vous pouvez installer des
paquets supplémentaires si vous en avez besoin, avec guix package
(voir Invoquer guix package
).
Suivant: Effectuer l’installation, Monter: Installation manuelle [Table des matières][Index]
Avant que vous ne puissiez installer le système, vous voudrez sans doute ajuster la disposition du clavier, paramétrer le réseau et partitionner le disque dur cible. Cette section vous guidera à travers tout cela.
L’image d’installation utilise la disposition clavier qwerty (US). Si vous
voulez la changer, vous pouvez utiliser la commande loadkeys
. Par
exemple, la commande suivante sélectionne la disposition Dvorak :
loadkeys dvorak
Consultez les fichiers dans /run/current-system/profile/share/keymaps
pour trouver une liste des dispositions disponibles. Lancez man
loadkey
pour plus d’informations.
Lancez la commande suivante pour voir comment vos interfaces réseau sont appelées :
ifconfig -a
… ou, avec la commande spécifique à GNU/Linux ip
:
ip address
Les interfaces filaires ont un nom qui commence par ‘e’ ; par exemple, l’interface qui correspond au premier contrôleur Ethernet sur la carte mère est appelé ‘eno1’. Les interfaces sans-fil ont un nom qui commence par ‘w’, comme ‘w1p2s0’.
Pour configure une connexion filaire, lancez la commande suivante, en remplaçant interface par le nom de l’interface filaire que vous voulez utiliser.
ifconfig interface up
… ou, avec la commande spécifique à GNU/Linux ip
:
ip link set interface up
Pour configurer le réseau sans-fil, vous pouvez créer un fichier de
configuration pour l’outil de configuration wpa_supplicant
(son
emplacement importe peu) avec l’un des éditeurs de texte disponibles comme
nano
:
nano wpa_supplicant.conf
Par exemple, la déclaration qui suit peut aller dans ce fichier et fonctionnera pour plusieurs réseaux sans-fil, si vous donnez le vrai SSID et la phrase de passe pour le réseau auquel vous vous connectez :
network={ ssid="mon-ssid" key_mgmt=WPA-PSK psk="la phrase de passe secrète du réseau" }
Démarrez le service sans-fil et lancez-le en tâche de fond avec la commande suivante (en remplaçant interface par le nom de l’interface réseau que vous voulez utiliser) :
wpa_supplicant -c wpa_supplicant.conf -i interface -B
Lancez man wpa_supplicant
pour plus d’informations.
À partir de ce moment, vous avez besoin d’une adresse IP. Sur les réseaux où les IP sont automatiquement attribuée par DHCP, vous pouvez lancer :
dhclient -v interface
Essayez de pinger un serveur pour voir si le réseau fonctionne :
ping -c 3 gnu.org
Mettre en place un accès réseau est presque toujours une nécessité parce que l’image ne contient pas tous les logiciels et les outils dont vous pourriez avoir besoin.
Si vous avez besoin d’un accès HTTP et HTTPS pour passer à travers un proxy, lancez la commande suivante :
herd set-http-proxy guix-daemon URL
où URL est l’URL du proxy, par exemple http://example.org:8118
.
Si vous le souhaitez, vous pouvez continuer l’installation à distance en démarrant un serveur SSH :
herd start ssh-daemon
Assurez-vous soit de définir un mot de passe avec passwd
, soit de
configurer l’authentification par clef OpenSSH avant de vous connecter.
À moins que vous ne l’ayez déjà fait, l’étape suivante consiste à partitionner le disque puis à formater les partitions cibles.
L’image d’installation inclus plusieurs outils de partitionnement, dont
Parted (voir Overview dans GNU Parted User Manual),
fdisk
, et cfdisk
. Lancez-en un et paramétrez votre
disque avec le partitionnement qui vous convient :
cfdisk
Si votre disque utilise le format des tables de partitions GUID (GPT) et que vous souhaitez installer un GRUB pour système BIOS (c’est le cas par défaut), assurez-vous de créer qu’une partition de démarrage BIOS soit bien disponible (voir BIOS installation dans GNU GRUB manual).
Si vous souhaitez à la place utilise GRUB pour système EFI, vous devrez
avoir une partition système EFI (ESP) en FAT32. Cette partition peut
être montée dans /boot/efi par exemple et doit avoir le drapeau
esp
. P. ex. pour parted
:
parted /dev/sda set 1 esp on
Remarque : Vous n’êtes pas sûr de savoir si vous devez utiliser un GRUB EFI ou BIOS ? Si le répertoire /sys/firmware/efi existe sur l’image d’installation, vous devriez probablement effectuer une installation EFI, avec
grub-efi-bootloader
. Sinon, vous devriez utiliser le GRUB en BIOS,grub-bootloader
. Voir Configuration du chargeur d’amorçage pour plus d’information sur le chargeur d’amorçage.
Une fois que vous avez fini le partitionnement du disque dur cible, vous devez créer un système de fichier sur les partitions10. Pour l’ESP, si vous en avez une et en supposant que ce soit /dev/sda1, lancez :
mkfs.fat -F32 /dev/sda1
Concernant le système de fichier root, ext4 est le format le plus largement utilisé. D’autres systèmes de fichiers, comme Btrfs, supportent la compression, laquelle est reportée pour compléter agréablement la dédupplication que le démon réalise indépendamment du système de fichier (voir deduplication).
Préférez assigner une étiquette au système de fichier pour que vous puissiez
vous y référer de manière fiable dans la déclaration file-system
(voir Systèmes de fichiers). On le fait habituellement avec l’option -L
de mkfs.ext4
et des commandes liées. Donc, en supposant que la
partition racine soit sur /dev/sda2, on peut créer un système de
fichier avec pour étiquette my-root
avec :
mkfs.ext4 -L my-root /dev/sda2
Si vous voulez plutôt chiffrer la partition root, vous pouvez utiliser les
utilitaires Cryptsetup et LUKS pour cela (voir man cryptsetup
pour plus d’informations).
Assuming you want to store the root partition on /dev/sda2, the command sequence to format it as a LUKS partition would be along these lines:
cryptsetup luksFormat /dev/sda2 cryptsetup open /dev/sda2 my-partition mkfs.ext4 -L my-root /dev/mapper/my-partition
Une fois cela effectué, montez le système de fichier cible dans /mnt
avec une commande comme (de nouveau, en supposant que my-root
est
l’étiquette du système de fichiers racine) :
mount LABEL=my-root /mnt
Montez aussi tous les systèmes de fichiers que vous voudriez utiliser sur le
système cible relativement à ce chemin. Si vous avez choisi d’avoir un
/boot/efi comme point de montage EFI par exemple, montez-la sur
/mnt/boot/efi maintenant pour qu’elle puisse être trouvée par
guix system init
ensuite.
Enfin, si vous souhaitez utiliser une ou plusieurs partitions de swap
(voir Espace d’échange), assurez-vous de les initialiser avec
mkswap
. En supposant que vous avez une partition de swap sur
/dev/sda3, vous pouvez lancer :
mkswap /dev/sda3 swapon /dev/sda3
Autrement, vous pouvez utiliser un fichier de swap. Par exemple, en supposant que dans le nouveau système vous voulez utiliser le fichier /swapfile comme fichier de swap, vous lanceriez11 :
# Cela représente 10 Gio d'espace d'échange. Ajustez « count » pour changer la taille. dd if=/dev/zero of=/mnt/swapfile bs=1MiB count=10240 # Par sécurité, laissez le fichier en lecture et en écriture uniquement pour root. chmod 600 /mnt/swapfile mkswap /mnt/swapfile swapon /mnt/swapfile
Remarquez que si vous avez chiffré la partition racine et créé un fichier d’échange dans son système de fichier comme décrit ci-dessus, alors le chiffrement protégera aussi le fichier d’échange, comme n’importe quel fichier de ce système de fichiers.
Précédent: Disposition du clavier réseau et partitionnement, Monter: Installation manuelle [Table des matières][Index]
Lorsque la partition cible est prête et que les autres partitions sont montées, on est prêt à commencer l’installation. Commencez par :
herd start cow-store /mnt
Cela rend /gnu/store capable de faire de la copie sur écriture, de
sorte que les paquets ajoutés pendant l’installation sont écrits sur le
disque cible sur /mnt plutôt que gardés en mémoire. Cela est
nécessaire parce que la première phase de la commande guix system
init
(voir plus bas) implique de télécharger ou de construire des éléments
de /gnu/store qui est initialement un système de fichiers en mémoire.
Ensuite, vous devrez modifier un fichier et fournir la déclaration du
système à installer. Pour cela, le système d’installation propose trois
éditeurs de texte. Nous recommandons GNU nano (voir GNU nano
Manual), qui supporte la coloration syntaxique la correspondance de
parenthèses ; les autres éditeurs sont mg (un clone d’Emacs) et nvi (un
clone de l’éditeur vi
original de BSD). Nous recommandons
vivement de stocker ce fichier sur le système de fichier racine cible,
disons en tant que /mnt/etc/config.scm. Sinon, vous perdrez votre
fichier de configuration une fois que vous aurez redémarré sur votre nouveau
système.
Voir Utiliser le système de configuration, pour un aperçu de comment créer votre fichier de configuration. Les exemples de configuration dont on parle dans cette section sont disponibles dans /etc/configuration sur l’image d’installation. Ainsi, pour commencer avec une configuration du système qui fournit un serveur d’affichage graphique (un système de « bureau »), vous pouvez lancer ce qui suit :
# mkdir /mnt/etc # cp /etc/configuration/desktop.scm /mnt/etc/config.scm # nano /mnt/etc/config.scm
Vous devriez faire attention à ce que contient votre fichier de configuration, en particulier :
bootloader-configuration
se réfère aux
cibles où vous voulez installer GRUB. Elle devrait aussi mentionner
grub-bootloader
si vous installer GRUB en mode BIOS (ou « legacy »)
ou grub-efi-bootloader
pour les système UEFI plus récents. Pour les
anciens systèmes, le champs targets
contient le nom des périphériques
comme (list "/dev/sda")
; pour les systèmes UEFI il contient les
chemins vers les partitions EFI montées, comme (list "/boot/efi")
;
assurez-vous bien que ces chemins sont montés et qu’il y a une entrée
file-system
dans votre configuration.
device
dans votre configuration
file-system
, en supposant que la configuration file-system
utilise la procédure file-system-label
dans son champ device
.
mapped-device
pour les décrire (voir Périphériques mappés).
Une fois que vous avez fini les préparatifs sur le fichier de configuration, le nouveau système peut être initialisé (rappelez-vous que le système de fichiers racine cible est dans /mnt) :
guix system init /mnt/etc/config.scm /mnt
Cela copie tous les fichiers nécessaires et installe GRUB sur
/dev/sdX à moins que vous ne passiez l’option
--no-bootloader. Pour plus d’informations, voir Invoquer guix system
. Cette commande peut engendrer des téléchargements ou des
constructions pour les paquets manquants, ce qui peut prendre du temps.
Une fois que cette commande a terminé — et on l’espère réussi ! — vous
pouvez lancer reboot
et démarrer sur votre nouveau système. Le
mot de passe root
est d’abord vide ; les mots de passe des autres
comptes doivent être initialisés avec la commande passwd
en tant
que root
, à mois que votre configuration ne spécifie autre chose
(voir mot de passe des comptes). Voir Après l’installation du système, pour la suite !
Suivant: Installer Guix sur une machine virtuelle, Précédent: Installation manuelle, Monter: Installation du système [Table des matières][Index]
Success, you’ve now booted into Guix System! You can upgrade the system whenever you want by running:
guix pull sudo guix system reconfigure /etc/config.scm
This builds a new system generation with the latest packages and services.
Maintenant, voir Guide de démarrage, et rejoignez-nous sur
#guix
sur le réseau IRC Libera.Chat ou sur
guix-devel@gnu.org pour partager votre expérience !
Suivant: Construire l’image d’installation, Précédent: Après l’installation du système, Monter: Installation du système [Table des matières][Index]
Si vous souhaitez installer Guix System sur une machine virtuelle (VM) ou un serveur privé virtuel (VPS) plutôt que sur votre machine chérie, cette section est faite pour vous.
Pour démarrer une VM QEMU pour installer Guix System sur une image disque, suivez ces étapes :
qemu-img
:
qemu-img create -f qcow2 guix-system.img 50G
Le fichier qui en résulte sera bien plus petit que les 50 Go (habituellement moins de 1 Mo) mais il grossira au fur et à mesure que le stockage virtuel grossira.
qemu-system-x86_64 -m 1024 -smp 1 -enable-kvm \ -nic user,model=virtio-net-pci -boot menu=on,order=d \ -drive file=guix-system.img \ -drive media=cdrom,readonly=on,file=guix-system-install-b2bd56f.system.iso
-enable-kvm
est facultatif, mais améliore nettement les performances,
voir Exécuter Guix sur une machine virtuelle.
Une fois l’installation terminée, vous pouvez démarrer le système dans votre image guix-system.img. Voir Exécuter Guix sur une machine virtuelle, pour une manière de faire.
Précédent: Installer Guix sur une machine virtuelle, Monter: Installation du système [Table des matières][Index]
L’image d’installation décrite plus haut a été construite avec la commande
guix system
, plus précisément :
guix system image -t iso9660 gnu/system/install.scm
Regardez le fichier gnu/system/install.scm dans l’arborescence des
sources et regardez aussi Invoquer guix system
pour plus
d’informations sur l’image d’installation.
De nombreuses cartes ARM requièrent une variante spécifique du chargeur d’amorçage U-Boot.
Si vous construisez une image disque et que le chargeur d’amorçage n’est pas disponible autrement (sur un autre périphérique d’amorçage etc), il est recommandé de construire une image qui inclus le chargeur d’amorçage, plus précisément :
guix system image --system=armhf-linux -e '((@ (gnu system install) os-with-u-boot) (@ (gnu system install) installation-os) "A20-OLinuXino-Lime2")'
A20-OLinuXino-Lime2
est le nom de la carte. Si vous spécifiez une
carte invalide, une liste de cartes possibles sera affichée.
Suivant: Gestion de paquets, Précédent: Installation du système, Monter: GNU Guix [Table des matières][Index]
Vous êtes certainement arrivé·e à cette section parce que vous avez installé Guix sur une autre distribution (voir Installation), ou bien vous avez installé Guix System (voir Installation du système). Il est temps pour vous de commencer à utiliser Guix et cette section est là pour vous aider à le faire et vous donner une idée de ce que c’est.
Guix est, entre autres, un programme d’installation de logiciels, donc la première chose que vous voudrez probablement faire est de chercher un logiciel. Disons que vous cherchez un éditeur de texte, vous pouvez lancer :
guix search text editor
Cette commande vous montre un certain nombre de paquets correspondants, en indiquant à chaque fois le nom du paquet, sa version, une description et des informations supplémentaires. Une fois que vous avez trouvé celui que vous voulez utiliser, disons Emacs (ah ha !), vous pouvez l’installer (lancez cette commande en tant qu’ utilisateur·rice, pas besoin des privilèges d’administration !) :
guix install emacs
Vous avez installé votre premier paquet, félicitations ! Le paquet est maintenant visible dans votre profil par défaut, $HOME/.guix-profile — un profil est un répertoire contenant les paquets installés. Vous avez probablement remarqué que Guix a téléchargé des binaires pré-compilés ; ou bien, si vous vous êtes dit : non, pas de binaires pré-compilés, alors Guix est probablement encore en train de construire un logiciel (voir Substituts, pour plus d’informations).
À moins que vous utilisiez Guix System, la commande guix install
doit avoir affiché cet indice :
conseil : Pensez à paramétrer les variables d'environnement nécessaires en lançant : GUIX_PROFILE="$HOME/.guix-profile" . "$GUIX_PROFILE/etc/profile" Autrement, regardez `guix package --search-paths -p "$HOME/.guix-profile"'.
En effet, vous devez maintenant indiquer à votre shell où se trouvent
emacs
et les autres programmes installés avec Guix. En collant
les deux lignes ci-dessus, c’est exactement ce que vous ferez : vous
ajouterez $HOME/.guix-profile/bin
— qui est l’endroit où se trouve
le paquet installé — à la variable d’environnement PATH
. Vous
pouvez coller ces deux lignes dans votre shell pour qu’elles prennent effet
immédiatement, mais surtout vous devez les ajouter à ~/.bash_profile
(ou un fichier équivalent si vous n’utilisez pas Bash) afin que les
variables d’environnement soient définies la prochaine fois que vous
lancerez un shell. Vous n’avez besoin de le faire qu’une seule fois et les
autres variables d’environnement des chemins de recherche seront traitées de
la même manière — par exemple, si vous installez les bibliothèques
python
et Python, GUIX_PYTHONPATH
sera définie.
Vous pouvez continuer à installer des paquets à votre guise. Pour lister les paquets installés, lancez :
guix package --list-installed
Pour supprimer un paquet, sans surprise, lancez guix remove
. Une
caractéristique distinctive est la possibilité de faire revenir en
arrière toute opération que vous avez effectuée — installation,
suppression, mise à niveau — en tapant simplement :
guix package --roll-back
C’est parce que chaque opération est en fait une transaction qui crée une nouvelle génération. Les générations et leurs différences entre elles peuvent être affichées en lançant :
guix package --list-generations
Vous connaissez maintenant les bases de la gestion des paquets !
Pour aller plus loin : Voir Gestion de paquets, pour en savoir plus sur la gestion des paquets. Vous pouvez aimer la gestion declarative des paquets avec
guix package --manifest
, la gestion de profils séparés avec --profil, la suppression des anciennes générations, le ramasse-miettes et d’autres fonctionnalités astucieuses qui vous seront utiles à mesure que vous vous familiariserez avec Guix. Si vous développez du code, voir Développement pour des outils supplémentaires. Et si vous êtes curieux·euse, voir Fonctionnalités, pour jeter un coup d’œil sous le capot.You can also manage the configuration of your entire home environment—your user “dot files”, services, and packages—using Guix Home. Voir Configuration du dossier personnel, to learn more about it!
Une fois que vous avez installé un ensemble de paquets, vous voudrez périodiquement faire une mise à jour à la dernière version flambant neuve. Pour cela, vous devez d’abord récupérer la dernière révision de Guix et de sa collection de paquets :
guix pull
Le résultat final est une nouvelle commande guix
, sous
~/.config/guix/current/bin. A moins que vous ne soyez sous Guix
System, la première fois que vous lancez guix pull
, assurez-vous
de suivre le conseil que la commande affiche et, comme nous l’avons vu
ci-dessus, collez ces deux lignes dans votre terminal et dans
.bash_profile :
GUIX_PROFILE="$HOME/.config/guix/current" . "$GUIX_PROFILE/etc/profile"
Vous devez aussi informer votre shell de pointer sur ce nouveau
guix
:
hash guix
A ce stade, vous pilotez un Guix tout neuf. Vous pouvez donc aller de l’avant et mettre effectivement à jour tous les paquets que vous avez installés précédemment :
guix upgrade
En exécutant cette commande, vous verrez que des binaires sont téléchargés (ou peut-être que certains paquets sont construits), et vous finirez par obtenir les paquets mis à jour. Si l’un de ces paquets n’est pas à votre goût, n’oubliez pas que vous pouvez toujours revenir en arrière !
Vous pouvez afficher la révision exacte de Guix actuellement en cours d’exécution en lançant :
guix describe
L’information affichée est tout ce qu’il faut pour reproduire exactement le même Guix, que ce soit à un moment différent ou sur une machine différente.
Pour aller plus loin : Voir Invoquer
guix pull
, pour plus d’informations. Voir Canaux, sur la façon de spécifier des canaux supplémentaires pour extraire des paquets, sur la façon de répliquer Guix, et plus encore. Vous pouvez également trouvertime-machine
pratique (voir Invoquerguix time-machine
).
Si vous avez installé Guix System, une des premières choses que vous voudrez
faire est de le mettre à jour. Une fois que vous avez lancé guix
pull
pour obtenir le dernier Guix, vous pouvez mettre à jour le système
comme ceci :
sudo guix system reconfigure /etc/config.scm
Upon completion, the system runs the latest versions of its software packages. Just like for packages, you can always roll back to a previous generation of the whole system. Voir Guide de démarrage, to learn how to manage your system.
Maintenant, vous en savez assez pour commencer !
Ressources : Le reste de ce manuel constitue une référence pour tout ce qui concerne Guix. Voici quelques ressources supplémentaires que vous pourriez trouver utiles :
- Voir le Livre de recettes de GNU Guix, pour une liste de recettes de style "how-to" pour une variété d’applications.
- La GNU Guix Reference Card énumère en deux pages la plupart des commandes et options dont vous aurez besoin.
- Le site web contient des vidéos instructives couvrant des sujets tels que l’utilisation quotidienne de Guix, comment obtenir de l’aide et comment devenir un·e contributeur·rice.
- Voir Documentation, pour savoir comment accéder à la documentation sur votre ordinateur.
Nous espérons que vous apprécierez Guix autant que la communauté a de plaisir à le construire !
Suivant: Canaux, Précédent: Guide de démarrage, Monter: GNU Guix [Table des matières][Index]
Le but de GNU Guix est de permettre à ses utilisatrices et utilisateurs d’installer, mettre à jour et supprimer facilement des paquets logiciels sans devoir connaître leur procédure de construction ou leurs dépendances. Guix va aussi plus loin que ces fonctionnalités évidentes.
Ce chapitre décrit les principales fonctionnalités de Guix, ainsi que des
outils de gestion des paquets qu’il fournit. En plus de l’interface en
ligne de commande décrite en dessous de (voir guix package
), vous pouvez aussi utiliser l’interface Emacs-Guix
(voir Le manuel de référence de emacs-guix), après
avoir installé le paquet emacs-guix
(lancez la commande M-x
guix-help pour le démarrer) :
guix install emacs-guix
guix package
guix locate
guix gc
guix pull
guix time-machine
guix describe
guix archive
Suivant: Invoquer guix package
, Monter: Gestion de paquets [Table des matières][Index]
Ici, nous supposons que vous avez déjà fait vos premiers pas avec Guix voir Guide de démarrage) et que vous voulez avoir un aperçu de ce qui se passe sous le capot.
Lorsque vous utilisez Guix, chaque paquet arrive dans dépôt des
paquets, dans son propre répertoire — quelque chose comme
/gnu/store/xxx-paquet-1.2, où xxx
est une chaîne en base32.
Plutôt que de se rapporter à ces répertoires, les utilisateur·rice·s ont
leur propre profil qui pointe vers les paquets qu’ils ou elles veulent
vraiment utiliser. Ces profils sont stockés dans le répertoire personnel de
chacun·e dans $HOME/.guix-profile
.
Par exemple, alice
installe GCC 4.7.2. Il en résulte que
/home/alice/.guix-profile/bin/gcc pointe vers
/gnu/store/…-gcc-4.7.2/bin/gcc. Maintenant, sur la même
machine, bob
a déjà installé GCC 4.8.0. Le profil de bob
continue simplement de pointer vers
/gnu/store/…-gcc-4.8.0/bin/gcc — c.-à-d. les deux versions de
GCC coexistent surs le même système sans aucune interférence.
La commande guix package
est l’outil central pour gérer les
paquets (voir Invoquer guix package
). Il opère sur les profils de chaque
utilisateur·rice et peut être utilisé avec les privilèges normaux.
La commande fournit les opérations évidentes d’installation, de suppression
et de mise à jour. Chaque invocation est en fait une transaction :
soit l’opération demandée réussit, soit rien ne se passe. Ainsi, si le
processus guix package
est terminé pendant la transaction ou si
une panne de courant arrive pendant la transaction, le profil reste dans son
état précédent et reste utilisable.
In addition, any package transaction may be rolled back. So, if, for example, an upgrade installs a new version of a package that turns out to have a serious bug, users may roll back to the previous instance of their profile, which was known to work well. Similarly, the global system configuration on Guix is subject to transactional upgrades and roll-back (voir Guide de démarrage).
Tout paquet du dépôt des paquets peut être glané. Guix peut
déterminer quels paquets sont toujours référencés par les profils des
utilisateur·rice·s et supprimer ceux qui ne sont de tout évidence plus
référencés (voir Invoquer guix gc
). Les utilisateur·rice·s peuvent
toujours explicitement supprimer les anciennes générations de leur profil
pour que les paquets auxquels elles faisaient référence puissent être
glanés.
Guix prend une approche purement fonctionnelle de la gestion de paquets, telle que décrite dans l’introduction (voir Introduction). Chaque nom de répertoire de paquet dans /gnu/store contient un hash de toutes les entrées qui ont été utilisées pendant la construction de ce paquet — le compilateur, les bibliothèques, les scripts de construction, etc. Cette correspondance directe permet aux utilisateur·rice·s de s’assurer que l’installation d’un paquet donné correspond à l’état actuel de leur distribution. Elle aide aussi à maximiser la reproductibilité : grâce aux environnements de construction utilisés, une construction donnée a de forte chances de donner des fichiers identiques bit-à-bit lorsqu’elle est effectuée sur des machines différentes (voir container).
Ce fondement permet à Guix de supporter le déploiement transparent de
binaire ou source. Lorsqu’une binaire pré-construit pour une entrée de
/gnu/store est disponible depuis une source externe (un
substitut), Guix le télécharge simplement et le décompresse ; sinon,
il construit le paquet depuis les sources localement (voir Substituts).
Comme les résultats des constructions sont généralement reproductibles au
bit près, si vous n’avez pas besoin de faire confiance aux serveurs qui
fournissent les substituts : vous pouvez forcer une construction locale et
défier les fournisseurs (voir Invoquer guix challenge
).
Le contrôle de l’environnement de construction est aussi une fonctionnalité
utile pour les développeurs. La commande guix shell
permet aux
développeurs d’un paquet de mettre en place rapidement le bon environnement
de développement pour leur paquet, sans avoir à installer manuellement les
dépendances du paquet dans leur profil (voir Invoquer guix shell
).
La totalité de Guix et des définitions de paquets sont placés sous contrôle
de version, et guix pull
vous permet de « voyager dans le temps »
de l’historique de Guix lui-même (voir Invoquer guix pull
). Cela est
rend possible la réplication d’une instance Guix sur une machine différente
ou plus tard, ce qui vous permet de répliquer des environnements
logiciels complets, tout en garantissant un suivi de provenance
précis des logiciels.
Suivant: Substituts, Précédent: Fonctionnalités, Monter: Gestion de paquets [Table des matières][Index]
guix package
La commande guix package
est l’outil qui permet d’installer,
mettre à jour et supprimer les paquets ainsi que de revenir à une
configuration précédente. Ces opérations fonctionnent sur un profil
utilisateur—un répertoire avec les paquets installés. Chaque utilisateur
a un profile par défaut dans $HOME/.guix-profile. La commande
n’opère que dans le profil de l’utilisateur·rice et fonctionne avec les
privilèges normaux (voir Fonctionnalités). Sa syntaxe est :
guix package options
options spécifie d’abord les opérations à effectuer pendant la transaction. À la fin, une nouvelle génération du profil est créée mais les générations précédentes du profil restent disponibles si l’utilisateur·rice souhaite y revenir.
Par exemple, pour supprimer lua
et installer guile
et
guile-cairo
en une seule transaction :
guix package -r lua -i guile guile-cairo
Parce que c’est pratique, nous fournissons aussi les alias suivants :
guix search
est un alias de guix package -s
,
guix install
est un alias de guix package -i
,
guix remove
est un alias de guix package -r
,
guix upgrade
est un alias de guix package -u
,
guix search
est un alias de guix package -s
.
Ces alias sont moins expressifs que guix package
et fournissent
moins d’options, donc dans certains cas vous devrez probablement utiliser
guix package
directement.
guix package
supporte aussi une approche déclarative où on
spécifie l’ensemble exact des paquets qui doivent être disponibles que l’on
passe via l’option --manifest (voir --manifest).
Pour chaque utilisateur·rice, un lien symbolique vers son profil par défaut
est automatiquement créé dans $HOME/.guix-profile. Ce lien
symbolique pointe toujours vers la génération actuelle du profil par défaut
du compte. Ainsi, on peut ajouter $HOME/.guix-profile/bin à sa
variable d’environnement PATH
etc.
Si vous n’utilisez pas la distribution système Guix, vous devriez ajouter
les lignes suivantes à votre ~/.bash_profile (voir Bash Startup
Files dans The GNU Bash Reference Manual) pour que les shells créés
ensuite aient tous les bonnes définitions des variables d’environnement :
GUIX_PROFILE="$HOME/.guix-profile" ; \ source "$GUIX_PROFILE/etc/profile"
Dans un environnement multi-utilisateur·rice, les profils des
utilisateur·rice·s sont stockés dans un emplacement enregistré comme
garbage-collector root, vers lequel $HOME/.guix-profile pointe
(voir Invoquer guix gc
). Ce répertoire est normalement
localstatedir/guix/profiles/per-user/user
, où
localstatedir est la valeur passée à configure
comme
--localstatedir, et user est le nom d’utilisateur·rice. Le
répertoire per-user est créé au démarrage de guix-daemon
,
et le sous-répertoire user est créé par guix package
.
Les options peuvent être les suivante :
--install=paquet …
-i paquet …
Installer les paquets spécifiés.
Chaque paquet peut spécifier un simple nom de paquet, tel que
guile
, éventuellement suivi d’un arobase et d’un numéro de version,
tel que guile@3.0.7
ou simplement guile@3.0
. (dans ce
dernier cas, la version la plus récente préfixée par 3.0
est
sélectionnée).
Si aucun numéro de version n’est spécifié, la version la plus récente
disponible est choisie. En plus, une telle spécification de paquet
peut contenir un deux-points, suivi du nom d’une des sorties du paquet,
comme dans gcc:doc
ou binutils@2.22:lib
(voir Des paquets avec plusieurs résultats).
Des paquets avec un nom correspondant (et éventuellement une version) sont recherchés dans les modules de la distribution GNU (voir Modules de paquets).
Autrement, un paquet peut directement spécifier un fichier du dépôt
comme /gnu/store/...-guile-3.0.7, produit par exemple par guix
build
.
Parfois les paquets ont des entrées propagées : ce sont des
dépendances qui sont installées automatiquement avec le paquet demandé
(voir propagated-inputs
in
package
objects pour plus d’informations sur les entrées propagées
dans les définitions des paquets).
Un exemple est la bibliothèque MPC de GNU : ses fichiers d’en-tête C se réfèrent à ceux de la bibliothèque MPFR de GNU, qui se réfèrent en retour à ceux de la bibliothèque GMP. Ainsi, lorsqu’on installe MPC, les bibliothèques MPFR et GMP sont aussi installées dans le profil ; supprimer MPC supprimera aussi MPFR et GMP — à moins qu’ils n’aient été aussi installés explicitement par l’utilisateur·rice.
En outre, les paquets s’appuient parfois sur la définition de variables d’environnement pour leurs chemins de recherche (voir l’explication de l’--chemins de recherche ci-dessous). Toute définition de variable d’environnement manquante ou éventuellement incorrecte est reportée ici.
--install-from-expression=exp
-e exp
Installer le paquet évalué par exp.
exp must be a Scheme expression that evaluates to a <package>
object. This option is notably useful to disambiguate between same-named
variants of a package, with expressions such as (@ (gnu packages
commencement) guile-final)
.
Remarquez que cette option installe la première sortie du paquet, ce qui peut être insuffisant lorsque vous avez besoin d’une sortie spécifique d’un paquet à plusieurs sorties.
--install-from-file=fichier
-f fichier
Installer le paquet évalué par le code dans le fichier.
Par exemple, fichier peut contenir une définition comme celle-ci (voir Définition des paquets) :
(use-modules (guix) (guix build-system gnu) (guix licenses)) (package (name "hello") (version "2.10") (source (origin (method url-fetch) (uri (string-append "mirror://gnu/hello/hello-" version ".tar.gz")) (sha256 (base32 "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i")))) (build-system gnu-build-system) (synopsis "Hello, GNU world: An example GNU package") (description "Guess what GNU Hello prints!") (home-page "http://www.gnu.org/software/hello/") (license gpl3+))
Lorsqu’on développe, on peut trouver utile d’inclure un tel fichier
guix.scm à la racine de l’arborescence des sources de son projet qui
pourrait être utilisé pour tester des versions de développement et créer des
environnements de développement reproductibles (voir Invoquer guix shell
).
Le fichier peut aussi contenir une représentation JSON d’une ou de
plusieurs définitions de paquets. L’exécution de guix package -f
sur
hello.json avec le contenu suivant entraînerait l’installation du
paquet greeter
après la construction de myhello
:
[ { "name": "myhello", "version": "2.10", "source": "mirror://gnu/hello/hello-2.10.tar.gz", "build-system": "gnu", "arguments": { "tests?": false }, "home-page": "https://www.gnu.org/software/hello/", "synopsis": "Hello, GNU world: An example GNU package", "description": "GNU Hello prints a greeting.", "license": "GPL-3.0+", "native-inputs": ["gettext"] }, { "name": "greeter", "version": "1.0", "source": "mirror://gnu/hello/hello-2.10.tar.gz", "build-system": "gnu", "arguments": { "test-target": "foo", "parallel-build?": false }, "home-page": "https://example.com/", "synopsis": "Greeter using GNU Hello", "description": "This is a wrapper around GNU Hello.", "license": "GPL-3.0+", "inputs": ["myhello", "hello"] } ]
--remove=paquet …
-r paquet …
Supprimer les paquets spécifiés.
Comme pour --install, chaque paquet peut spécifier un numéro
de version ou un nom de sortie en plus du nom du paquet. Par exemple,
‘-r glibc:debug’ supprimerait la sortie debug
de glibc
.
--upgrade[=regexp …]
¶-u [regexp …]
Mettre à jour tous les paquets installés. Si un ou plusieurs regexp sont spécifiés, la mise à jour n’installera que les paquets dont le nom correspond à regexp. Voir aussi l’option --do-not-upgrade ci-dessous.
Remarquez que cela met à jour vers la dernière version des paquets trouvée
dans la distribution actuellement installée. Pour mettre à jour votre
distribution, vous devriez lancer régulièrement guix pull
(voir Invoquer guix pull
).
Quand une mise à jour est en cours d’exécution, les transformations de paquets initialement appliquées lors de la création du profil sont automatiquement réappliquées (voir Options de transformation de paquets). Par exemple, supposons que vous ayez d’abord installé Emacs depuis l’extrémité de sa branche de développement avec :
guix install emacs-next --with-branch=emacs-next=master
La prochaine fois que vous lancerez guix upgrade
, Guix va à
nouveau extraire l’extrémité de la branche de développement Emacs et
construira emacs-next
à partir de ce checkout.
Notez que les options de transformation comme --with-branch et --with-source dépendent de l’état exterieur ; c’est à vous de vous assurer qu’elles fonctionnent comme souhaité. Vous pouvez également écarter une transformation qui s’applique à un paquet en lançant :
$ guix install paquet
--do-not-upgrade[=regexp …]
Lors d’une utilisation conjointe avec l’option --upgrade, ne pas mettre à jour les paquets dont le nom correspond à regexp. Par exemple, pour mettre à jour tous les paquets du profil actuel à l’exception de ceux qui contiennent la chaîne « emacs » :
$ guix package --upgrade . --do-not-upgrade emacs
--manifest=fichier
¶-m fichier
Créer une nouvelle génération du profil depuis l’objet manifeste renvoyé par le code Scheme dans fichier. Cette option peut être répétée plusieurs fois, auquel cas les manifestes sont concaténés.
Cela vous permet de déclarer le contenu du profil plutôt que de le construire avec une série de --install et de commandes similaires. L’avantage étant que le fichier peut être placé sous contrôle de version, copié vers d’autres machines pour reproduire le même profil, etc.
fichier doit renvoyer un objet manifest qui est en gros une liste de paquets :
(use-package-modules guile emacs) (packages->manifest (list emacs guile-2.0 ;; Utiliser une sortie spécifique d'un paquet. (list guile-2.0 "debug")))
Voir Écrire un manifeste, pour des informations sur la manière d’écrire un manifeste. Voir --export-manifest, pour apprendre à obtenir un fichier manifeste depuis un profil existant.
--roll-back
¶Revenir à la génération précédente du profil c.-à-d. défaire la dernière transaction.
Lorsqu’elle est combinée avec des options comme --install, Le retour en arrière se produit avant toute autre action.
Lorsque vous revenez de la première génération qui contient des fichiers, le profil pointera vers la zéroième génération qui ne contient aucun fichier en dehors de ses propres métadonnées.
Après être revenu en arrière, l’installation, la suppression et la mise à jour de paquets réécrit les futures générations précédentes. Ainsi, l’historique des générations dans un profil est toujours linéaire.
--switch-generation=motif
¶-S motif
Basculer vers une génération particulière définie par le motif.
Le motif peut être soit un numéro de génération soit un nombre précédé de « + » ou « - ». Ce dernier signifie : se déplacer en avant ou en arrière d’un nombre donné de générations. Par exemple, si vous voulez retourner à la dernière génération après --roll-back, utilisez --switch-generation=+1.
La différence entre --roll-back et --switch-generation=-1 est que --switch-generation ne vous amènera pas à la génération initiale, donc si la génération demandée n’existe pas la génération actuelle ne changera pas.
--search-paths[=genre]
¶Rapporter les définitions des variables d’environnement dans la syntaxe Bash qui peuvent être requises pour utiliser l’ensemble des paquets installés. Ces variables d’environnement sont utilisées pour spécifier les chemins de recherche de fichiers utilisés par les paquets installés.
Par exemple, GCC a besoin des variables d’environnement CPATH
et
LIBRARY_PATH
pour trouver les en-têtes et les bibliothèques dans le
profil de l’utilisateur·rice (voir Environment Variables dans Using the
GNU Compiler Collection (GCC)). Si GCC et, disons, la bibliothèque C sont
installés dans le profil, alors --search-paths suggérera
d’initialiser ces variables à profil/include et
profil/lib, respectivement (voir Chemins de recherche, pour des
infos sur les spécifications de chemins de recherche associées aux paquets).
Le cas d’utilisation typique est de définir ces variables d’environnement dans le shell :
$ eval $(guix package --search-paths)
genre peut être l’une des valeurs exact
, prefix
ou
suffix
, ce qui signifie que les définitions des variables
d’environnement renvoyées seront soit les paramètres exacts, soit placés
avant ou après la valeur actuelle de ces paramètres. Lorsqu’il est omis,
genre a pour valeur par défaut exact
.
Cette option peut aussi être utilisé pour calculer les chemins de recherche combinés de plusieurs profils. Regardez cet exemple :
$ guix package -p toto -i guile $ guix package -p titi -i guile-json $ guix package -p toto -p titi --search-paths
La dernière commande ci-dessus montre la variable GUILE_LOAD_PATH
bien
que, pris individuellement, ni toto ni titi n’auraient donné
cette recommandation.
--profile=profil
-p profil
Utiliser le profil à la place du profil par défaut du compte.
profil doit être le nom d’un fichier qui sera créé une fois terminé. Concrètement, profil sera un simple lien symbolique (« symlink ») pointant vers le profil réel où les paquets sont installés :
$ guix install hello -p ~/code/my-profile … $ ~/code/my-profile/bin/hello Hello, world!
Tout ce qu’il faut pour se débarrasser du profil est de supprimer ce lien symbolique et ses frères et sœurs qui pointent vers des générations spécifiques :
$ rm ~/code/my-profile ~/code/my-profile-*-link
--list-profiles
Liste tous les profils utilisateur·rice :
$ guix package --list-profiles /home/charlie/.guix-profile /home/charlie/code/my-profile /home/charlie/code/devel-profile /home/charlie/tmp/test
En cours d’exécution sous root, liste tous les profils de tou·te·s les utilisateur·rice·s.
--allow-collisions
Permettre des collisions de paquets dans le nouveau profil. À utiliser à vos risques et périls !
Par défaut, guix package
rapporte les collisions dans le
profil comme des erreurs. Les collisions ont lieu quand deux version ou
variantes d’un paquet donné se retrouvent dans le profil.
--bootstrap
Utiliser le programme d’amorçage Guile pour compiler le profil. Cette option n’est utile qu’aux personnes qui développent la distribution.
En plus de ces actions, guix package
supporte les options
suivantes pour demander l’état actuel d’un profil ou la disponibilité des
paquets :
Lister les paquets disponibles dont le nom, le synopsis ou la description
correspondent à la regexp (en étant insensible à la casse), triés par
pertinence. Afficher toutes les métadonnées des paquets correspondants au
format recutils
(voir GNU recutils databases dans GNU
recutils manual).
Cela permet à des champs spécifiques d’être extraits avec la commande
recsel
, par exemple :
$ guix package -s malloc | recsel -p name,version,relevance name: jemalloc version: 4.5.0 relevance: 6 name: glibc version: 2.25 relevance: 1 name: libgc version: 7.6.0 relevance: 1
De manière similaire, pour montrer le nom de tous les paquets disponibles sous license GNU LGPL version 3 :
$ guix package -s "" | recsel -p name -e 'license ~ "LGPL 3"' name: elfutils name: gmp …
Il est aussi possible de raffiner les résultats de la recherche en donnant
plusieurs options -s
à guix package
, ou plusieurs arguments
à guix search
. Par exemple, la commande suivante renvoie la liste
des jeux de plateau (cette fois-ci avec l’alias guix search
) :
$ guix search '\<board\>' game | recsel -p name name: gnubg …
Si on avait oublié -s game
, on aurait aussi eu les paquets logiciels
qui s’occupent de circuits imprimés (en anglais : circuit board) ; supprimer
les chevrons autour de board
aurait aussi ajouté les paquets qui
parlent de clavier (en anglais : keyboard).
Et maintenant un exemple plus élaboré. La commande suivante recherche les bibliothèques cryptographiques, retire les bibliothèques Haskell, Perl, Python et Ruby et affiche le nom et le synopsis des paquets correspondants :
$ guix search crypto library | \ recsel -e '! (name ~ "^(ghc|perl|python|ruby)")' -p name,synopsis
Voir Selection Expressions dans GNU recutils manual pour plus
d’information sur les expressions de sélection pour recsel -e
.
Afficher les détails du paquet dans la liste des paquets disponibles,
au format recutils
(voir GNU recutils databases dans GNU recutils manual).
$ guix package --show=guile | recsel -p name,version name: guile version: 3.0.5 name: guile version: 3.0.2 name: guile version: 2.2.7 …
Vous pouvez aussi spécifier le nom complet d’un paquet pour n’avoir que les
détails concernant une version spécifique (cette fois-ci avec l’alias
guix show
) :
$ guix show guile@3.0.5 | recsel -p name,version name: guile version: 3.0.5
Liste les paquets actuellement installés dans le profil spécifié, avec les paquets les plus récemment installés en dernier. Lorsque regexp est spécifié, liste uniquement les paquets installés dont le nom correspond à regexp.
Pour chaque paquet installé, affiche les éléments suivants, séparés par des
tabulations : le nom du paquet, sa version, la partie du paquet qui est
installé (par exemple, out
pour la sortie par défaut, include
pour ses en-têtes, etc) et le chemin du paquet dans le dépôt.
Lister les paquets actuellement disponibles dans la distribution pour ce système (voir Distribution GNU). Lorsque regexp est spécifié, lister uniquement les paquets dont le nom correspond à regexp.
Pour chaque paquet, affiche les éléments suivants séparés par des tabulations : son nom, sa version, les parties du paquet (voir Des paquets avec plusieurs résultats), et l’emplacement de sa définition.
Renvoyer la liste des générations avec leur date de création ; pour chaque génération, montre les paquets installés avec les paquets installés les plus récemment en dernier. Remarquez que la zéroième génération n’est jamais montrée.
Pour chaque paquet installé, afficher les éléments suivants, séparés par des tabulations : le nom du paquet, sa version, la partie du paquet qui a été installée (voir Des paquets avec plusieurs résultats), et l’emplacement du paquet dans le dépôt.
Lorsque motif est utilisé, la commande ne renvoie que les générations correspondantes. Les motifs valides sont :
Et --list-generations=1,8,2 renvoie les trois générations dans l’ordre spécifié. Aucun espace ni virgule surnuméraire ne sont permis.
Il est aussi possible d’omettre le numéro final. Par exemple, --list-generations=2.. renvoie toutes les générations à partir de la deuxième.
Lorsque motif est omis, supprimer toutes les générations en dehors de l’actuelle.
Cette commande accepte les même motifs que --list-generations. Lorsque motif est spécifié, supprime les générations correspondantes. Lorsque motif spécifie une durée, les générations plus anciennes que la durée spécifiée correspondent. Par exemple --delete-generations=1m supprime les générations vieilles de plus d’un mois.
Si la génération actuelle correspond, elle n’est pas supprimée. La zéroième génération n’est elle non plus jamais supprimée.
Remarquez que supprimer des générations empêche de revenir en arrière vers elles. Ainsi, cette commande doit être utilisée avec précaution.
Écrire un manifeste vers la sortie standard utilisable avec --manifest et qui correspond à un ou plusieurs profils choisis.
Cette option est conçue pour vous aider à migre du mode de fonctionnement «
impératif » — lancer guix install
, guix upgrade
, etc
— au mode déclaratif offert par --manifest.
Soyez conscient que le manifeste qui est résulte est une approximation de ce que votre profil contient vraiment ; par exemple, en fonction de la manière dont votre profil a été créé, il peut se référer à des paquets ou des versions de paquets qui ne sont pas exactement ce que vous avez spécifié.
Gardez en tête qu’un manifeste est purement symbolique : il ne contient que des noms de paquets et éventuellement des versions, et leur signification varie avec le temps. Si vous voulez « épingler » des canaux aux révisions qui ont été utilisées pour construire les profils, voir --export-channels plus bas.
Écrit sur la sortie standard la liste des canaux utilisés par les profils
choisi, dans un format convenable pour guix pull --channels
ou
guix time-machine --channels
(voir Canaux).
Avec --export-manifest, cette option fournit les informations qui vous permettent de répliquer le profil actuel (voir Répliquer Guix).
Cependant, remarquez que la sortie de cette commande est une approximation de ce qui a vraiment été utilisé pour construire le profil. En particulier, a profil unique peut avoir été construit à partir de plusieurs révisions du même canal. Dans ce cas, --export-manifest choisi la dernière et écrit la liste des autres révisions dans un commentaire. Si vous avez vraiment besoin de choisir des paquets à partir d’autres révisions des canaux, vous pouvez utiliser des inférieurs dans votre manifeste pour cela (voir Inférieurs).
Avec --export-manifest, c’est un bon point de départ si vous voulez migrer du modèle « impératif » au modèle complètement déclaratif qui consiste en un fichier manifeste et un fichier de canaux qui épingle les révisions exactes des canaux que vous voulez.
Enfin, comme guix package
peut démarrer des processus de
construction, il supporte les options de construction communes
(voir Options de construction communes). Il prend aussi en charge les options de
transformation de paquets comme --with-source, et les préserve à
travers les mises à jour (voir Options de transformation de paquets).
Suivant: Des paquets avec plusieurs résultats, Précédent: Invoquer guix package
, Monter: Gestion de paquets [Table des matières][Index]
Guix gère le déploiement depuis des binaires ou des sources de manière transparente ce qui signifie qu’il peut aussi bien construire localement que télécharger des éléments pré-construits depuis un serveur ou les deux. Nous appelons ces éléments pré-construits des substituts — ils se substituent aux résultats des constructions locales. Dans la plupart des cas, télécharger un substitut est bien plus rapide que de construire les choses localement.
Les substituts peuvent être tout ce qui résulte d’une construction de dérivation (voir Dérivations). Bien sûr dans le cas général, il s’agit de paquets binaires pré-construits, mais les archives des sources par exemple résultent aussi de la construction d’une dérivation qui peut aussi être disponible en tant que substitut.
Suivant: Autoriser un serveur de substituts, Monter: Substituts [Table des matières][Index]
bordeaux.guix.gnu.org
et ci.guix.gnu.org
sont tous deux des interfaces aux fermes de construction officielles qui
construisent des paquets pour Guix continuellement pour certaines
architectures et les rend disponibles en tant que substituts. Ce sont les
sources par défaut des substituts qui peuvent être modifiées en passant
l’option --substitute-urls soit à guix-daemon
(voir guix-daemon --substitute-urls
) soit
aux outils clients comme guix package
(voir client --substitute-urls option).
Les URL des substituts peuvent être soit en HTTP soit en HTTPS. Le HTTPS est recommandé parce que les communications sont chiffrées ; à l’inverse HTTP rend les communications visibles pour un espion qui peut utiliser les informations accumulées sur vous pour déterminer par exemple si votre système a des vulnérabilités de sécurités non corrigées.
Les substituts des fermes de construction officielles sont activés par défaut dans la distribution système Guix (voir Distribution GNU). Cependant, ils sont désactivés par défaut lorsque vous utilisez Guix sur une distribution externe, à moins que vous ne les ayez explicitement activés via l’une des étapes d’installation recommandées (voir Installation). Les paragraphes suivants décrivent comment activer ou désactiver les substituts pour la ferme de construction officielle ; la même procédure peut être utilisée pour activer les substituts de n’importe quel autre serveur de substituts.
Suivant: Récupérer des substituts d’autres serveurs, Précédent: Serveur de substituts officiel, Monter: Substituts [Table des matières][Index]
Pour permettre à Guix de télécharger les substituts depuis
bordeaux.guix.gnu.org
, ci.guix.gnu.org
ou un
miroir, vous devez ajouter la clé publique correspondante à la liste de
contrôle d’accès (ACL) des imports d’archives, avec la commande
guix archive
(voir Invoquer guix archive
). Cela implique que
vous faîtes confiance au serveur de substituts pour ne pas être compromis et
vous servir des substituts authentiques.
Remarque : Si vous utilisez le système Guix, vous pouvez sauter cette section : le système Guix autorise les substituts de
bordeaux.guix.gnu.org
etci.guix.gnu.org
par défaut.
Les clés publiques de chaque serveur de substituts maintenu par le projet
sont installées avec Guix, dans préfixe/share/guix/
, où
préfixe est le préfixe d’installation de Guix. Si vous avez installé
Guix depuis les sources, assurez-vous d’avoir vérifié la signature GPG de
guix-b2bd56f.tar.gz qui contient ce fichier de clef
publique. Ensuite vous pouvez lancer quelque chose comme ceci :
# guix archive --authorize < prefix/share/guix/bordeaux.guix.gnu.org.pub # guix archive --authorize < prefix/share/guix/ci.guix.gnu.org.pub
Une fois que cela est en place, la sortie d’une commande comme guix
build
devrait changer de quelque chose comme :
$ guix build emacs --dry-run Les dérivations suivantes seraient construites : /gnu/store/yr7bnx8xwcayd6j95r2clmkdl1qh688w-emacs-24.3.drv /gnu/store/x8qsh1hlhgjx6cwsjyvybnfv2i37z23w-dbus-1.6.4.tar.gz.drv /gnu/store/1ixwp12fl950d15h2cj11c73733jay0z-alsa-lib-1.0.27.1.tar.bz2.drv /gnu/store/nlma1pw0p603fpfiqy7kn4zm105r5dmw-util-linux-2.21.drv …
à quelque chose comme :
$ guix build emacs --dry-run 112.3 Mo seraient téléchargés : /gnu/store/pk3n22lbq6ydamyymqkkz7i69wiwjiwi-emacs-24.3 /gnu/store/2ygn4ncnhrpr61rssa6z0d9x22si0va3-libjpeg-8d /gnu/store/71yz6lgx4dazma9dwn2mcjxaah9w77jq-cairo-1.12.16 /gnu/store/7zdhgp0n1518lvfn8mb96sxqfmvqrl7v-libxrender-0.9.7 …
Le texte a changé de « Les dérivations suivantes seront construites » à « 112,3 Mio seront téléchargés ». Cela indique que les substituts des serveurs configurés sont utilisables et seront téléchargés, si possible, pour les futures constructions.
Le mécanisme de substitution peut être désactivé globalement en lançant
guix-daemon
avec --no-substitutes (voir Invoquer guix-daemon
). Il peut aussi être désactivé temporairement en passant
l’option --no-substitutes à guix package
, guix
build
et aux autres outils en ligne de commande.
Suivant: Authentification des substituts, Précédent: Autoriser un serveur de substituts, Monter: Substituts [Table des matières][Index]
Guix peut chercher et récupérer des substituts à partir de plusieurs serveurs. C’est utile si vous utilisez des paquets de canaux supplémentaires pour lesquels le serveur officiel n’a pas de substituts mais que d’autres serveurs les fournissent. Une autre situation où cela est utile est si vous souhaitez télécharger depuis les serveurs de substituts de votre organisation, en utilisant le serveur officiel en dernier recours, ou en ne l’utilisant pas du tout.
Vous pouvez donner à Guix une liste d’URL de serveurs de substituts et il les vérifiera dans l’ordre indiqué. Vous devez aussi explicitement autoriser les clés publiques des serveurs de substituts pour dire à Guix d’accepter les substituts qu’ils signent.
Sur le système Guix, cela se fait en modifiant la configuration du service
guix
. Comme le service guix
fait partie des services par
défaut, %base-services
et %desktop-services
, vous pouvez
utiliser modify-services
pour changer sa configuration et ajouter les
URL et les clés des serveurs de substituts que vous voulez (voir modify-services
).
Par exemple, supposons que vous vouliez récupérer les substituts de
guix.example.org
et autoriser la clé de signature de ce serveur, en
plus des serveurs bordeaux.guix.gnu.org
et
ci.guix.gnu.org
par défaut. La configuration du système
d’exploitation qui en résulte ressemblera à :
(operating-system
;; …
(services
;; Supposons qu'on commence à partir de '%desktop-services'. Remplaçons-le
;; par la liste des services qu'on utilise vraiment.
(modify-services %desktop-services
(guix-service-type config =>
(guix-configuration
(inherit config)
(substitute-urls
(append (list "https://guix.example.org")
%default-substitute-urls))
(authorized-keys
(append (list (local-file "./key.pub"))
%default-authorized-guix-keys)))))))
Cela suppose que le fichier key.pub contient la clé de signature de
guix.example.org
. Avec ce changement dans le fichier de
configuration de votre système d’exploitation (disons
/etc/config.scm), vous pouvez reconfigurer et redémarrer le service
guix-daemon
ou redémarrer pour que les changements prennent effet :
$ sudo guix system reconfigure /etc/config.scm $ sudo herd restart guix-daemon
Si vous utilisez Guix sur une « distro externe », vous suivrez plutôt les étapes suivantes pour avoir des substituts de serveurs supplémentaires :
guix-daemon
; pour
systemd, c’est normalement /etc/systemd/system/guix-daemon.service.
Ajouter l’option --substitute-urls à la ligne de command
guix-daemon
et listez les URL qui vous intéressent
(voir guix-daemon --substitute-urls
) :
… --substitute-urls='https://guix.example.org https://bordeaux.guix.gnu.org https://ci.guix.gnu.org'
systemctl daemon-reload systemctl restart guix-daemon.service
guix archive
) :
guix archive --authorize < key.pub
De nouveau, cela suppose que key.pub contient la clé publique que
guix.example.org
utilise pour signer les substituts.
Maintenant vous êtes paré ! Les substituts seront téléchargés de préférence
à partir de https://guix.example.org
, avec
bordeaux.guix.gnu.org
puis ci.guix.gnu.org
en réserve. Évidemment vous pouvez lister autant de serveurs de substituts
que vous voulez, avec l’inconvénient que la recherche de substituts sera
ralentie si vous devez contacter trop de serveurs.
Troubleshooting : To diagnose problems, you can run
guix weather
. For example, running:guix weather coreutilsnot only tells you which of the currently-configured servers has substitutes for the
coreutils
package, it also reports whether one of these servers is unauthorized. Voir Invoquerguix weather
, for more information.
Remarquez qu’il à des situations où vous pourriez vouloir ajouter l’URL d’un serveur de substitut sans autoriser sa clé. Voir Authentification des substituts, pour comprendre ce point délicat.
Suivant: Paramètres de serveur mandataire, Précédent: Récupérer des substituts d’autres serveurs, Monter: Substituts [Table des matières][Index]
Guix détecte et lève une erreur lorsqu’il essaye d’utiliser un substitut qui a été modifié. De même, il ignore les substituts qui ne sont pas signés ou qui ne sont pas signés par l’une des clefs listées dans l’ACL.
Il y a une exception cependant : si un serveur non autorisé fournit des substituts qui sont identiques bit-à-bit à ceux fournis par un serveur autorisé, alors le serveur non autorisé devient disponible pour les téléchargements. Par exemple en supposant qu’on a choisi deux serveurs de substituts avec cette option :
--substitute-urls="https://a.example.org https://b.example.org"
Si l’ACL contient uniquement la clef de ‘b.example.org’, et si ‘a.example.org’ sert exactement les mêmes substituts, alors Guix téléchargera les substituts de ‘a.example.org’ parce qu’il vient en premier dans la liste et peut être considéré comme un miroir de ‘b.example.org’. En pratique, les machines de construction indépendantes produisent généralement les mêmes binaires, grâce à des constructions reproductibles au bit près (voir ci-dessous).
Lorsque vous utilisez HTTPS, le certificat X.509 du serveur n’est pas validé (en d’autre termes, le serveur n’est pas authentifié), contrairement à ce que des clients HTTPS comme des navigateurs web font habituellement. Cela est dû au fait que Guix authentifie les informations sur les substituts eux-mêmes, comme expliqué plus haut, ce dont on se soucie réellement (alors que les certificats X.509 authentifient la relation entre nom de domaine et clef publique).
Suivant: Échec de substitution, Précédent: Authentification des substituts, Monter: Substituts [Table des matières][Index]
Les substituts sont téléchargés par HTTP ou HTTPS. Les variables
d’environnement http_proxy
et https_proxy
peuvent être
initialisées dans l’environnement de guix-daemon
et sont prises en
compte pour le téléchargement des substituts. Remarquez que la valeur de
ces variables d’environnement dans l’environnement où sont exécutés
guix build
, guix package
, et d’autres commandes client
n’a absolument aucun effet.
Suivant: De la confiance en des binaires, Précédent: Paramètres de serveur mandataire, Monter: Substituts [Table des matières][Index]
Même lorsqu’un substitut pour une dérivation est disponible, la substitution échoue parfois. Cela peut arriver pour plusieurs raisons : le serveur de substitut peut être hors ligne, le substitut a récemment été supprimé du serveur, la connexion peut avoir été interrompue, etc.
Lorsque les substituts sont activés et qu’un substitut pour une dérivation
est disponible, mais que la tentative de substitution échoue, Guix essaiera
de construire la dérivation localement si --fallback a été passé en
argument (voir common build option --fallback
).
Plus spécifiquement, si cet option n’a pas été passée en argument, alors
aucune construction locale n’est effectuée et la dérivation est considérée
comme étant en échec. Cependant, si --fallback est passé en
argument, alors Guix essaiera de construire la dérivation localement et
l’échec ou le succès de la dérivation dépend de l’échec ou du succès de la
construction locale. Remarquez que lorsque les substituts sont désactivés
ou qu’aucun substitut n’est disponible pour la dérivation en question, une
construction locale sera toujours effectuée, indépendamment du fait
que l’argument --fallback ait été ou non passé.
Pour se donner une idée du nombre de substituts disponibles maintenant, vous
pouvez essayer de lancer la commande guix weather
(voir Invoquer guix weather
). Cette command fournit des statistiques sur les substituts
fournis par un serveur.
Précédent: Échec de substitution, Monter: Substituts [Table des matières][Index]
De nos jours, le contrôle individuel sur son utilisation propre de
l’informatique est à la merci d’institutions, de sociétés et de groupes avec
assez de pouvoir et de détermination pour contourner les infrastructures
informatiques et exploiter leurs faiblesses. Bien qu’utiliser les
substituts soit pratique, nous encourageons chacun·e à construire aussi par
soi-même, voire à faire tourner sa propre ferme de construction, pour que
les serveurs de substituts du projet deviennent une cible moins
intéressante. Une façon d’aider est de publier les logiciels que vous
construisez avec guix publish
pour que les autres aient plus de
choix de serveurs où télécharger les substituts (voir Invoquer guix publish
).
Guix possède les fondations pour maximiser la reproductibilité logicielle
(voir Fonctionnalités). Dans la plupart des cas, des constructions
indépendantes d’un paquet donnée ou d’une dérivation devrait donner des
résultats identiques au bit près. Ainsi, à travers un ensemble de
constructions de paquets indépendantes il est possible de renforcer
l’intégrité du système. La commande guix challenge
a pour but
d’aider les utilisateur·rices à tester les serveurs de substituts et à aider
les développeur·euses à trouver les constructions de paquets
non-déterministes (voir Invoquer guix challenge
). De même, l’option
--check de guix build
permet à chaque personne de
vérifier si les substituts précédemment installés sont authentiques en les
reconstruisant localement (voir guix build
--check
).
À l’avenir, nous aimerions que Guix puisse publier et recevoir des binaires d’autres personnes, de manière pair-à-pair. Si vous voulez discuter de ce projet, rejoignez-nous sur guix-devel@gnu.org.
Suivant: Invoking guix locate
, Précédent: Substituts, Monter: Gestion de paquets [Table des matières][Index]
Souvent, les paquets définis dans Guix ont une seule sortie —
c.-à-d. que le paquet source conduit à exactement un répertoire dans le
dépôt. Lorsque vous lancez guix install glibc
, vous installez la
sortie par défaut du paquet GNU libc ; la sortie par défaut est appelée
out
mais son nom peut être omis comme le montre cette commande. Dans
ce cas particulier, la sortie par défaut de glibc
contient tous les
fichiers d’en-tête C, les bibliothèques partagées, les bibliothèques
statiques, la documentation Info et les autres fichiers de support.
Parfois il est plus approprié de séparer les divers types de fichiers
produits par un même paquet source en plusieurs sorties. Par exemple, la
bibliothèque C GLib (utilisée par GTK+ et des paquets associés) installe
plus de 20 Mo de documentation de référence dans des pages HTML. Pour
préserver l’espace disque des utilisateurs qui n’en ont pas besoin, la
documentation va dans une sortie séparée nommée doc
. Pour installer
la sortie principale de GLib, qui contient tout sauf la documentation, on
devrait lancer :
guix install glib
La commande pour installer la documentation est :
guix install glib:doc
Bien que la syntaxe avec des deux-points fonctionne pour la spécification
des sorties des paquets sur la ligne de commande, cela ne fonctionnera pas
si vous utilisez une variable de paquet dans le code Scheme. Par
exemple, pour ajouter la documentation de glib
aux paquets installés
dans un operating-system
(voir Référence de operating-system
),
vous devez utiliser à la place une liste de deux éléments. Le premier
élément est la variable de paquet. Le second est le nom de la sortie
à sélectionner (une chaine) :
(use-modules (gnu packages glib)) ;; glib-with-documentation est le symbole Guile pour le paquet glib (operating-system ... (packages (append (list (list glib-with-documentation "doc")) %base-packages)))
Certains paquets installent des programmes avec des « empreintes dépendances
» différentes. Par exemple le paquet WordNet installe à la fois les outils
en ligne de commande et les interfaces graphiques (GUI). La première ne
dépend que de la bibliothèque C, alors que cette dernière dépend de Tcl/Tk
et des bibliothèques X sous-jacentes. Dans ce cas, nous laissons les outils
en ligne de commande dans la sortie par défaut et l’interface graphique dans
une sortie séparée. Cela permet aux utilisateurs qui n’ont pas besoin
d’interface graphique de gagner de la place. La commande guix
size
peut aider à trouver ces situations (voir Invoquer guix size
). guix graph
peut aussi être utile (voir Invoque guix graph
).
Il y a plusieurs paquets à sorties multiples dans la distribution GNU.
D’autres noms de sorties conventionnels sont lib
pour les
bibliothèques et éventuellement les fichiers d’en-tête, bin
pour les
programmes indépendants et debug
pour les informations de débogage
(voir Installer les fichiers de débogage). Les sorties d’un paquet sont listés
dans la troisième colonne de la sortie de guix package
--list-available
(voir Invoquer guix package
).
Suivant: Invoquer guix gc
, Précédent: Des paquets avec plusieurs résultats, Monter: Gestion de paquets [Table des matières][Index]
guix locate
There’s so much free software out there that sooner or later, you will need
to search for packages. The guix search
command that we’ve seen
before (voir Invoquer guix package
) lets you search by keywords:
guix search video editor
Sometimes, you instead want to find which package provides a given file, and
this is where guix locate
comes in. Here is how you can find
which package provides the ls
command:
$ guix locate ls coreutils@9.1 /gnu/store/…-coreutils-9.1/bin/ls
Of course the command works for any file, not just commands:
$ guix locate unistr.h icu4c@71.1 /gnu/store/…/include/unicode/unistr.h libunistring@1.0 /gnu/store/…/include/unistr.h
You may also specify glob patterns with wildcards. For example, here is how you would search for packages providing .service files:
$ guix locate -g '*.service' man-db@2.11.1 …/lib/systemd/system/man-db.service wpa-supplicant@2.10 …/system-services/fi.w1.wpa_supplicant1.service
The guix locate
command relies on a database that maps file names
to package names. By default, it automatically creates that database if it
does not exist yet by traversing packages available locally, which
can take a few minutes (depending on the size of your store and the speed of
your storage device).
Remarque : For now,
guix locate
builds its database based on purely local knowledge—meaning that you will not find packages that never reached your store. Eventually it will support downloading a pre-built database so you can potentially find more packages.
By default, guix locate
first tries to look for a system-wide
database, usually under /var/cache/guix/locate; if it does not exist
or is too old, it falls back to the per-user database, by default under
~/.cache/guix/locate. On a multi-user system, administrators may
want to periodically update the system-wide database so that all users can
benefit from it, for instance by setting up
package-database-service-type
(voir package-database-service-type
).
La syntaxe générale est :
guix locate [options…] file…
... where file is the name of a file to search for (specifically, the “base name” of the file: files whose parent directories are called file are not matched).
Les options disponibles sont les suivantes :
--glob
-g
Interpret file… as glob patterns—patterns that may include wildcards, such as ‘*.scm’ to denote all files ending in ‘.scm’.
--stats
Display database statistics.
--update
-u
Update the file database.
By default, the database is automatically updated when it is too old.
--clear
Clear the database and re-populate it.
This option lets you start anew, ensuring old data is removed from the
database, which also avoids having an endlessly growing database. By
default guix locate
automatically does that periodically, though
infrequently.
--database=file
Use file as the database, creating it if necessary.
By default, guix locate
picks the database under
~/.cache/guix or /var/cache/guix, whichever is the most recent
one.
--method=method
-m method
Use method to select the set of packages to index. Possible values are:
manifests
This is the default method: it works by traversing profiles on the machine and recording packages it encounters—packages you or other users of the machine installed, directly or indirectly. It is fast but it can miss other packages available in the store but not referred to by any profile.
store
This is a slower but more exhaustive method: it checks among all the existing packages those that are available in the store and records them.
Suivant: Invoquer guix pull
, Précédent: Invoking guix locate
, Monter: Gestion de paquets [Table des matières][Index]
guix gc
Les paquets qui sont installés mais pas utilisés peuvent être glanés.
La commande guix gc
permet aux utilisateurs de lancer
explicitement le ramasse-miettes pour récupérer de l’espace dans le
répertoire /gnu/store. C’est la seule manière de supprimer
des fichiers de /gnu/store — supprimer des fichiers ou des
répertoires à la main peut le casser de manière impossible à réparer !
Le ramasse-miettes a un ensemble de racines connues : tout fichier
dans /gnu/store atteignable depuis une racine est considéré comme
utilisé et ne peut pas être supprimé ; tous les autres fichiers sont
considérés comme inutilisés et peuvent être supprimés. L’ensemble des
racines du ramasse-miettes (ou « racines du GC » pour faire court) inclue
les profils par défaut des utilisateurs ; par défaut les liens symboliques
sous /var/guix/gcroots représentent ces racines du GC. De nouvelles
racines du GC peuvent être ajoutées avec la guix build -- root
par
exemple (voir Invoquer guix build
). La commande guix gc
--list-roots
permet de les lister.
Avant de lancer guix gc --collect-garbage
pour faire de la place,
c’est souvent utile de supprimer les anciennes génération des profils
utilisateurs ; de cette façon les anciennes constructions de paquets
référencées par ces générations peuvent être glanées. Cela se fait en
lançant guix package --delete-generations
(voir Invoquer guix package
).
Nous recommandons de lancer le ramasse-miettes régulièrement ou lorsque vous avez besoin d’espace disque. Par exemple pour garantir qu’au moins 5 Go d’espace reste libre sur votre disque, lancez simplement :
guix gc -F 5G
Il est parfaitement possible de le lancer comme une tâche périodique
non-interactive (voir Exécution de tâches planifiées pour apprendre comment
paramétrer une telle tâche). Lancer guix gc
sans argument
ramassera autant de miettes que possible mais ça n’est pas le plus pratique
: vous pourriez vous retrouver à reconstruire ou re-télécharger des
logiciels « inutilisés » du point de vu du GC mais qui sont nécessaires pour
construire d’autres logiciels — p. ex. la chaîne de compilation.
La commande guix gc
a trois modes d’opération : elle peut être
utilisée pour glaner des fichiers inutilisés (par défaut), pour supprimer
des fichiers spécifiques (l’option --delete), pour afficher des
informations sur le ramasse-miettes ou pour des requêtes plus avancées. Les
options du ramasse-miettes sont :
--collect-garbage[=min]
-C [min]
Ramasse les miettes — c.-à-d. les fichiers inaccessibles de /gnu/store et ses sous-répertoires. C’est l’opération par défaut lorsqu’aucune option n’est spécifiée.
Lorsque min est donné, s’arrêter une fois que min octets ont été
collectés. min peut être un nombre d’octets ou inclure un suffixe
d’unité, comme MiB
pour mébioctet et GB
pour gigaoctet
(voir size specifications dans GNU Coreutils).
Lorsque min est omis, tout glaner.
--free-space=libre
-F libre
Glaner jusqu’à ce que libre espace soit disponible dans
/gnu/store si possible ; libre est une quantité de stockage
comme 500MiB
comme décrit ci-dessus.
Lorsque libre ou plus est disponible dans /gnu/store ne rien faire et s’arrêter immédiatement.
--delete-generations[=durée]
-d [durée]
Avant de commencer le glanage, supprimer toutes les générations plus vielles que durée, pour tous les profils utilisateurs et générations de l’environnement personnel ; lorsque cela est lancé en root, cela s’applique à tous les profils de tous les utilisateurs.
Par exemple, cette commande supprime toutes les générations de tous vos profils plus vieilles que 2 mois (sauf s’il s’agit de la génération actuelle) puis libère de l’espace jusqu’à atteindre au moins 10 Go d’espace libre :
guix gc -d 2m -F 10G
--delete
-D
Essayer de supprimer tous les fichiers et les répertoires du dépôt spécifiés en argument. Cela échoue si certains des fichiers ne sont pas dans le dépôt ou s’ils sont toujours utilisés.
--list-failures
Lister les éléments du dépôt qui correspondent à des échecs de construction.
Cela n’affiche rien à moins que le démon n’ait été démarré avec --cache-failures (voir --cache-failures).
--list-roots
Lister les racines du GC appartenant à l’utilisateur ; lorsque la commande est lancée en root, lister toutes les racines du GC.
--list-busy
Liste des éléments de stockage utilisés par les processus en cours d’exécution. Ces éléments de stockage sont effectivement considérés comme des racines GC : ils ne peuvent pas être supprimés.
--clear-failures
Supprimer les éléments du dépôt spécifiés du cache des constructions échouées.
De nouveau, cette option ne fait de sens que lorsque le démon est démarré avec --cache-failures. Autrement elle ne fait rien.
--list-dead
Montrer la liste des fichiers et des répertoires inutilisés encore présents dans le dépôt — c.-à-d. les fichiers et les répertoires qui ne sont plus atteignables par aucune racine.
--list-live
Montrer la liste des fichiers et des répertoires du dépôt utilisés.
En plus, les références entre les fichiers existants du dépôt peuvent être demandés :
--references
¶--referrers
Lister les références (respectivement les référents) des fichiers du dépôt en argument.
--requisites
¶-R
Lister les prérequis des fichiers du dépôt passés en argument. Les prérequis sont le fichier du dépôt lui-même, leur références et les références de ces références, récursivement. En d’autre termes, la liste retournée est la closure transitive des fichiers du dépôt.
Voir Invoquer guix size
pour un outil pour surveiller la taille de la
closure d’un élément. Voir Invoque guix graph
pour un outil pour
visualiser le graphe des références.
--derivers
¶Renvoie les dérivations menant aux éléments du dépôt donnés (voir Dérivations).
Par exemple cette commande :
guix gc --derivers $(uix package -I ^emacs$ | cut -f4)
renvoie les fichiers .drv menant au paquet emacs
installé dans
votre profil.
Remarquez qu’il peut n’y avoir aucun fichier .drv par exemple quand ces fichiers ont été glanés. Il peut aussi y avoir plus d’un fichier .drv correspondant à cause de dérivations à sortie fixées.
Enfin, les options suivantes vous permettent de vérifier l’intégrité du dépôt et de contrôler l’utilisation du disque.
Vérifier l’intégrité du dépôt.
Par défaut, s’assurer que tous les éléments du dépôt marqués comme valides dans la base de données du démon existent bien dans /gnu/store.
Lorsqu’elle est fournie, l’option doit être une liste séparée par des
virgule de l’un ou plus parmi contents
et repair
.
Lorsque vous passez --verify=contents, le démon calcul le hash du contenu de chaque élément du dépôt et le compare au hash de sa base de données. Les différences de hash sont rapportées comme des corruptions de données. Comme elle traverse tous les fichiers du dépôt, cette commande peut prendre très longtemps pour terminer, surtout sur un système avec un disque lent.
Utiliser --verify=repair ou --verify=contents,repair fait
que le démon essaie de réparer les objets du dépôt corrompus en récupérant
leurs substituts (voir Substituts). Comme la réparation n’est pas
atomique et donc potentiellement dangereuse, elle n’est disponible que pour
l’administrateur système. Une alternative plus légère lorsque vous
connaissez exactement quelle entrée est corrompue consiste à lancer
guix build --repair
(voir Invoquer guix build
).
Optimiser le dépôt en liant en dur les fichiers identiques — c’est la déduplication.
Le démon effectue une déduplication après chaque import d’archive ou construction réussie, à moins qu’il n’ait été lancé avec --disable-deduplication (voir --disable-deduplication). Ainsi, cette option est surtout utile lorsque le démon tourne avec --disable-deduplication.
Guix utilise une base de données sqlite pour garder la trace des éléments du
dépôt (voir Le dépôt). Avec le temps il est possible que la base de
données grossisse et soit fragmentée. En conséquence, vous pourriez vouloir
effacer l’espace libéré et recoller les pages partiellement utilisées dans
la base de données laissées par la suppression des paquets ou après le
lancement du ramasse-miettes. Lancer sudo guix gc
--vacuum-database
verrouillera la base de données et lancera un
VACUUM
du dépôt, pour défragmenter la base de données et libérer les
pages vides, et déverrouillera la base une fois l’opération terminée.
Suivant: Invoquer guix time-machine
, Précédent: Invoquer guix gc
, Monter: Gestion de paquets [Table des matières][Index]
guix pull
Les paquets sont installés ou mis à jour vers la dernière version disponible
dans la distribution active sur votre machine locale. Pour mettre à jour
cette distribution, en même temps que les outils Guix, vous devez lancer
guix pull
; la commande télécharge le dernier code source de Guix
ainsi que des descriptions de paquets, et le déploie. Le code source est
téléchargé depuis un dépôt Git, par
défaut le dépôt officiel de GNU Guix, bien que cela puisse être
personnalisé. guix pull
garantit que le code téléchargé est
authentique en vérifiant que les commits sont signés par les
développeur·euses de Guix.
Specifically, guix pull
downloads code from the channels
(voir Canaux) specified by one of the following, in this order:
channels
field of
guix-configuration
);
%default-channels
.
À la fin, guix package
utilisera les paquets et les versions des
paquets de la copie de Guix tout juste récupérée. Non seulement ça, mais
toutes les commandes Guix et les modules Scheme seront aussi récupérés
depuis la dernière version. Les nouvelles sous-commandes de guix
ajoutés par la mise à jour sont aussi maintenant disponibles.
Chaque utilisateur peut mettre à jour sa copie de Guix avec guix
pull
et l’effet est limité à l’utilisateur qui a lancé guix
pull
. Par exemple, lorsque l’utilisateur root
lance guix
pull
, cela n’a pas d’effet sur la version de Guix que voit alice
et
vice-versa.
Le résultat après avoir lancé guix pull
est un profil
disponible sous ~/.config/guix/current contenant la dernière version
de Guix.
L’option --list-generations ou -l liste les anciennes
générations produites par guix pull
, avec des détails sur leur
origine :
$ guix pull -l Génération 1 10 juin 2018 00:18:18 guix 65956ad URL du dépôt : https://git.savannah.gnu.org/git/guix.git branche : origin/master commit : 65956ad3526ba09e1f7a40722c96c6ef7c0936fe Génération 2 11 juin 2018 11:02:49 guix e0cc7f6 URL du dépôt : https://git.savannah.gnu.org/git/guix.git branche : origin/master commit : e0cc7f669bec22c37481dd03a7941c7d11a64f1d Génération 3 13 juin 2018 23:31:07 (actuelle) guix 844cc1c URL du dépôt : https://git.savannah.gnu.org/git/guix.git branche : origin/master commit : 844cc1c8f394f03b404c5bb3aee086922373490c
Voir guix describe
, pour d’autres
manières de décrire le statut actuel de Guix.
Ce profil ~/.config/guix/current
fonctionne comme les profils créés
par guix package
(voir Invoquer guix package
). C’est-à-dire
que vous pouvez lister les générations, revenir en arrière à une génération
précédente — c.-à-d. la version de Guix précédente — etc. :
$ guix pull --roll-back passé de la génération 3 à 2 $ guix pull --delete-generations=1 supperssion de /var/guix/profiles/per-user/charlie/current-guix-1-link
Vous pouvez aussi utiliser guix package
(voir Invoquer guix package
) pour contrôler le profil en le nommant explicitement :
$ guix package -p ~/.config/guix/current --roll-back passé de la génération 3 à 2 $ guix package -p ~/.config/guix/current --delete-generations=1 suppression de /var/guix/profiles/per-user/charlie/current-guix-1-link
La commande guix pull
est typiquement invoquée sans arguments mais
elle prend en charge les options suivantes :
--url=url
--commit=commit
--branch=branche
Télécharger le code pour le canal guix
depuis l’url spécifié,
au commit donné (un commit Git valide représenté par une chaîne
hexadécimale ou le nom d’une étiquette) ou à la branche branch.
Ces options sont fournies pour votre confort, mais vous pouvez aussi spécifier votre configuration dans le fichier ~/.config/guix/channels.scm ou en utilisant l’option --channels (voir plus bas).
--channels=file
-C file
Lit la liste des canaux dans file plutôt que dans ~/.config/guix/channels.scm ou /etc/guix/channels.scm. file doit contenir un code Scheme qui s’évalue en une liste d’objets de canaux. Voir Canaux pour plus d’informations.
--no-channel-files
-q
Inhibit loading of the user and system channel files, ~/.config/guix/channels.scm and /etc/guix/channels.scm.
--news
-N
Affiche les nouvelles écrites par les auteurs des canaux pour leurs utilisateurs et utilisatrices depuis la génération précédente (voir Writing Channel News). Lorsque vous passez --details, affiche aussi les nouveaux paquets et les paquets mis à jour.
Vous pouvez consulter ces informations pour les générations précédentes avec
guix pull -l
.
--list-generations[=motif]
-l [motif]
Liste toutes les générations de ~/.config/guix/current ou, si
motif est fournit, le sous-ensemble des générations qui correspondent
à motif. La syntaxe de motif est la même qu’avec guix
package --list-generations
(voir Invoquer guix package
).
Par défaut, cela affiche les informations sur les canaux utilisés à chaque révision et les nouvelles associées. Si vous passez l’option --details, cela affichera la liste des paquets ajoutés et mis à jour à chaque génération par rapport à la précédente.
--details
Demande à --list-generations ou --news d’afficher plus d’informations sur la différence entre les générations successives, voir plus haut.
--roll-back
¶Revenir à la génération précédente de ~/.config/guix/current c.-à-d. défaire la dernière transaction.
--switch-generation=motif
¶-S motif
Basculer vers une génération particulière définie par le motif.
Le motif peut être soit un numéro de génération soit un nombre précédé de « + » ou « - ». Ce dernier signifie : se déplacer en avant ou en arrière d’un nombre donné de générations. Par exemple, si vous voulez retourner à la dernière génération après --roll-back, utilisez --switch-generation=+1.
--delete-generations[=motif]
-d [motif]
Lorsque motif est omis, supprimer toutes les générations en dehors de l’actuelle.
Cette commande accepte les même motifs que --list-generations. Lorsque motif est spécifié, supprime les générations correspondantes. Lorsque motif spécifie une durée, les générations plus anciennes que la durée spécifiée correspondent. Par exemple --delete-generations=1m supprime les générations vieilles de plus d’un mois.
Si la génération actuelle correspond, elle n’est pas supprimée.
Remarquez que supprimer des générations empêche de revenir en arrière vers elles. Ainsi, cette commande doit être utilisée avec précaution.
Voir Invoquer guix describe
, pour une manière d’afficher des informations
sur la génération actuelle uniquement.
--profile=profil
-p profil
Utiliser le profil à la place de ~/.config/guix/current.
--dry-run
-n
Montrer quels commits des canaux seraient utilisés et ce qui serait construit ou substitué mais ne pas le faire vraiment.
--allow-downgrades
Permet d’extraire des révisions de canaux plus anciennes ou sans rapport avec celles qui sont actuellement utilisées.
Par défaut, guix pull
protège contre les attaques dites de
"downgrade", par lesquelles le dépôt Git d’un canal serait réinitialisé à
une révision antérieure ou sans rapport avec lui-même, ce qui pourrait vous
conduire à installer des versions plus anciennes de paquets logiciels, ou
connues pour être vulnérables.
Remarque : Assurez-vous de comprendre les implications de sa sécurité avant d’utiliser --allow-downgrades.
--disable-authentication
Permet de "tirer" le code du canal sans l’authentifier.
Par défaut, guix pull
authentifie le code téléchargé depuis les
canaux en vérifiant que ses commits sont signés par les développeur·euses,
et renvoie une erreur si ce n’est pas le cas. Cette option lui enjoint de ne
pas effectuer une telle vérification.
Remarque : Assurez-vous de comprendre les implications de sa sécurité avant d’utiliser --disable-authentication.
--system=système
-s système
Tenter de construire pour le système — p. ex. i686-linux
—
plutôt que pour le type de système de l’hôte de construction.
--bootstrap
Utiliser le programme d’amorçage Guile pour construire la dernière version de Guix. Cette option n’est utile qu’aux personnes qui développent Guix.
Le mécanisme de canaux vous permet de dire à guix pull
quels
répertoires et branches récupérer, ainsi que les dépôts
supplémentaires contenant des modules de paquets qui devraient être
déployés. Voir Canaux pour plus d’information.
En plus, guix pull
supporte toutes les options de construction
communes (voir Options de construction communes).
Suivant: Inférieurs, Précédent: Invoquer guix pull
, Monter: Gestion de paquets [Table des matières][Index]
guix time-machine
La commande guix time-machine
donne accès à d’autres révisions de
Guix, par exemple pour installer d’anciennes versions de paquets, ou pour
reproduire un calcul dans un environnement identique. La révision de Guix à
utiliser est définie par un commit ou par un fichier de description de canal
créé par guix describe
(voir Invoquer guix describe
).
Supposons que vous vouliez voyager en ces jours de novembre 2020 où la
version 1.2.0 de Guix a été publiée et que, une fois que vous y êtes, vous
lanciez le guile
de cette époque :
guix time-machine --commit=v1.2.0 -- \ environment -C --ad-hoc guile -- guile
La commande ci-dessus récupère Guix 1.2.0 et lance sa commande
guix environment
pour démarrer un environnement dans un conteneur
qui lance guile
(guix environment
a depuis été remplacé
par guix shell
; voir Invoquer guix shell
). C’est comme
conduire une DeLorean12 ! La première invocation de guix time-machine
peut être
coûteuse. Elle doit télécharger voire construire un grand nombre de
paquets. Heureusement le résultat est mis en cache et les commandes
suivantes qui ciblent le même commit sont presque instantanées.
As for guix pull
, in the absence of any options,
time-machine
fetches the latest commits of the channels specified
in ~/.config/guix/channels.scm, /etc/guix/channels.scm, or the
default channels; the -q option lets you ignore these configuration
files. The command:
guix time-machine -q -- build hello
will thus build the package hello
as defined in the main branch of
Guix, without any additional channel, which is in general a newer revision
of Guix than you have installed. Time travel works in both directions!
Remarque : L’histoire de Guix est immuable et
guix time-machine
fournit exactement les mêmes logiciels que ceux de la révision de Guix spécifique. Naturellement, aucun correctif de sécurité n’est fournit pour les anciennes versions de Guix ou ses canaux. Utiliserguix time-machine
sans précaution ouvre la porte à des vulnérabilités de sécurité. Voir --allow-downgrades.
guix time-machine
raises an error when attempting to travel to
commits older than “v0.16.0” (commit ‘4a0b87f0’), dated Dec. 2018.
This is one of the oldest commits supporting the channel mechanism that
makes “time travel” possible.
Remarque : Although it should technically be possible to travel to such an old commit, the ease to do so will largely depend on the availability of binary substitutes. When traveling to a distant past, some packages may not easily build from source anymore. One such example are old versions of OpenSSL whose tests would fail after a certain date. This particular problem can be worked around by running a virtual build machine with its clock set to the right time (voir Virtual Build Machines).
La syntaxe générale est :
guix time-machine options… -- commande arg…
où command et arg… sont passés sans modification à la
commande guix
de la révision spécifiée. Les options qui
définissent cette révision sont les mêmes que pour la commande guix
pull
(voir Invoquer guix pull
) :
--url=url
--commit=commit
--branch=branche
Utiliser le canal guix
depuis l’url spécifiée, au commit
donné (un commit Git valide représenté par une chaîne hexadécimale ou le nom
d’une étiquette) ou à la branche branch.
--channels=file
-C file
Lit la liste des canaux dans file. file doit contenir un code Scheme qui s’évalue en une liste d’objets de canaux. Voir Canaux pour plus d’informations.
--no-channel-files
-q
Inhibit loading of the user and system channel files, ~/.config/guix/channels.scm and /etc/guix/channels.scm.
Thus, guix time-machine -q
is equivalent to the following Bash
command, using the “process substitution” syntax (voir Process
Substitution dans The GNU Bash Reference Manual):
guix time-machine -C <(echo %default-channels) …
Remarquez que guix time-machine
peut lancer des constructions de
canaux et de leurs dépendances, et qu’elles peuvent être contrôlées avec les
options de construction communes (voir Options de construction communes).
If guix time-machine
is executed without any command, it prints
the file name of the profile that would be used to execute the command.
This is sometimes useful if you need to get store file name of the
profile—e.g., when you want to guix copy
it.
Suivant: Invoquer guix describe
, Précédent: Invoquer guix time-machine
, Monter: Gestion de paquets [Table des matières][Index]
Remarque : La fonctionnalité décrite ici est un « démonstrateur technique » à la version b2bd56f. Ainsi, l’interface est sujette à changements.
Parfois vous pourriez avoir à mélanger des paquets de votre révision de Guix avec des paquets disponibles dans une révision différente de Guix. Les inférieurs de Guix vous permettent d’accomplir cette tâche en composant différentes versions de Guix de manière arbitraire.
Techniquement, un « inférieur » est surtout un processus Guix séparé
connecté à votre processus Guix principal à travers un REPL (voir Invoquer guix repl
). Le module (guix inferior)
vous permet de créer des
inférieurs et de communiquer avec eux. Il fournit aussi une interface de
haut-niveau pour naviguer dans les paquets d’un inférieur — des paquets
inférieurs — et les manipuler.
Lorsqu’on les combine avec des canaux (voir Canaux), les inférieurs
fournissent une manière simple d’interagir avec un révision de Guix
séparée. Par exemple, disons que vous souhaitiez installer dans votre
profil le paquet guile actuel, avec le guile-json
d’une ancienne
révision de Guix — peut-être parce que la nouvelle version de
guile-json
a une API incompatible et que vous voulez lancer du code
avec l’ancienne API. Pour cela, vous pourriez écrire un manifeste à
utiliser avec guix package --manifest
(voir Écrire un manifeste) ;
dans ce manifeste, vous créeriez un inférieur pour l’ancienne révision de
Guix qui vous intéresse et vous chercheriez le paquet guile-json
dans
l’inférieur :
(use-modules (guix inferior) (guix channels) (srfi srfi-1)) ;pour « first » (define channels ;; L'ancienne révision depuis laquelle on veut ;; extraire guile-json. (list (channel (name 'guix) (url "https://git.savannah.gnu.org/git/guix.git") (commit "65956ad3526ba09e1f7a40722c96c6ef7c0936fe")))) (define inferior ;; Un inférieur représentant la révision ci-dessus. (inferior-for-channels channels)) ;; Maintenant on crée un manifeste avec le paquet « guile » actuel ;; et l'ancien paquet « guile-json ». (packages->manifest (list (first (lookup-inferior-packages inferior "guile-json")) (specification->package "guile")))
Durant la première exécution, guix package --manifest
pourrait
avoir besoin de construire le canal que vous avez spécifié avant de créer
l’inférieur ; les exécutions suivantes seront bien plus rapides parce que la
révision de Guix sera déjà en cache.
Le module (guix inferior)
fournit les procédures suivantes pour
ouvrir un inférieur :
Renvoie un inférieur pour channels, une liste de canaux. Elle utilise le cache dans cache-directory, où les entrées peuvent être glanées après ttl secondes. Cette procédure ouvre une nouvelle connexion au démon de construction.
Elle a pour effet de bord de construire ou de substituer des binaires pour channels, ce qui peut prendre du temps.
Ouvre le Guix inférieur dans directory et lance
directory/command repl
ou équivalent. Renvoie #f
si l’inférieur n’a pas pu être lancé.
Les procédures listées plus bas vous permettent d’obtenir et de manipuler des paquets inférieurs.
Renvoie la liste des paquets connus de l’inférieur inferior.
Renvoie la liste triée des paquets inférieurs qui correspondent à name dans inferior, avec le plus haut numéro de version en premier. Si version est vrai, renvoie seulement les paquets avec un numéro de version préfixé par version.
Renvoie vrai si obj est un paquet inférieur.
Ces procédures sont la contrepartie des accesseurs des enregistrements de
paquets (voir Référence de package
). La plupart fonctionne en effectuant
des requêtes à l’inférieur dont provient package, donc l’inférieur
doit toujours être disponible lorsque vous appelez ces procédures.
Les paquets inférieurs peuvent être utilisés de manière transparente comme
tout autre paquet ou objet simili-fichier dans des G-expressions
(voir G-Expressions). Ils sont aussi gérés de manière transparente par
la procédure packages->manifest
, qui est typiquement utilisée dans
des manifestes (voir l’option --manifest
de guix package
). Ainsi, vous pouvez insérer un paquet inférieur
à peu près n’importe où vous utiliseriez un paquet normal : dans des
manifestes, dans le champ packages
de votre déclaration
operating-system
, etc.
Suivant: Invoquer guix archive
, Précédent: Inférieurs, Monter: Gestion de paquets [Table des matières][Index]
guix describe
Souvent vous voudrez répondre à des questions comme « quelle révision de
Guix j’utilise ? » ou « quels canaux est-ce que j’utilise ? ». C’est une
information utile dans de nombreuses situations : si vous voulez
répliquer un environnement sur une machine différente ou un compte
utilisateur, si vous voulez rapporter un bogue ou pour déterminer quel
changement dans les canaux que vous utilisez l’a causé ou si vous voulez
enregistrer l’état de votre système pour le reproduire. La commande
guix describe
répond à ces questions.
Lorsqu’elle est lancée depuis un guix
mis à jour avec
guix pull
, guix describe
affiche les canaux qui ont été
construits, avec l’URL de leur dépôt et l’ID de leur commit
(voir Canaux) :
$ guix describe Generation 10 03 sep. 2018 17:32:44 (actuelle) guix e0fa68c URL du dépôt : https://git.savannah.gnu.org/git/guix.git branche : master commit : e0fa68c7718fffd33d81af415279d6ddb518f727
Si vous connaissez bien le système de contrôle de version Git, cela
ressemble en essence à git describe
; la sortie est aussi
similaire à celle de guix pull --list-generations
, mais limitée à
la génération actuelle (voir l’option
--list-generations). Comme l’ID de commit de Git ci-dessus se
réfère sans aucune ambiguïté à un instantané de Guix, cette information est
tout ce dont vous avez besoin pour décrire la révision de Guix que vous
utilisez et pour la répliquer.
Pour rendre plus facile la réplication de Guix, guix describe
peut
aussi renvoyer une liste de canaux plutôt que la description lisible par un
humain au-dessus :
$ guix describe -f channels (list (channel (name 'guix) (url "https://git.savannah.gnu.org/git/guix.git") (commit "e0fa68c7718fffd33d81af415279d6ddb518f727"))) (introduction (make-channel-introduction "9edb3f66fd807b096b48283debdcddccfea34bad" (openpgp-fingerprint "BBB0 2DDF 2CEA F6A8 0D1D E643 A2A0 6DF2 A33A 54FA")))))
Vous pouvez sauvegarder ceci dans un fichier et le donner à guix
pull -C
sur une autre machine ou plus tard, ce qui instantiera
exactement la même révision de Guix (voir l’option -C). À partir de là, comme vous pouvez déployer la même
révision de Guix, vous pouvez aussi bien répliquer un environnement
logiciel complet. Nous pensons humblement que c’est génial, et nous
espérons que vous aimerez ça aussi !
Voici les détails des options supportées par guix describe
:
--format=format
-f format
Produire la sortie dans le format donné, parmi :
human
produire une sortie lisible par un humain ;
canaux
produire une liste de spécifications de canaux qui peut être passée à
guix pull -C
ou installée dans ~/.config/guix/channels.scm
(voir Invoquer guix pull
) ;
channels-sans-intro
comme canaux
, mais oubliez le champ introduction
; utilisez-le
pour produire une spécification de canal adaptée à la version 1.1.0 ou
antérieure de Guix–le champ introduction
concerne l’authentification
des canaux (voir Channel Authentication) et n’est pas pris en
charge par ces versions antérieures ;
json
¶produire une liste de spécifications de canaux dans le format JSON ;
recutils
produire une liste de spécifications de canaux dans le format Recutils.
--list-formats
Affiche les formats disponibles pour l’option --format.
--profile=profil
-p profil
Afficher les informations sur le profil.
Précédent: Invoquer guix describe
, Monter: Gestion de paquets [Table des matières][Index]
guix archive
La commande guix archive
permet aux utilisateurs d’exporter
des fichiers du dépôt dans une simple archive puis ensuite de les
importer sur une machine qui fait tourner Guix. En particulier, elle
permet de transférer des fichiers du dépôt d’une machine vers le dépôt d’une
autre machine.
Remarque : Si vous chercher une manière de produire des archives dans un format adapté pour des outils autres que Guix, voir Invoquer
guix pack
.
Pour exporter des fichiers du dépôt comme une archive sur la sortie standard, lancez :
guix archive --export options spécifications...
spécifications peut être soit des noms de fichiers soit des
spécifications de paquets, comme pour guix package
(voir Invoquer guix package
). Par exemple, la commande suivante crée une
archive contenant la sortie gui
du paquet git
et la sortie
principale de emacs
:
guix archive --export git:gui /gnu/store/...-emacs-24.3 > great.nar
Si les paquets spécifiés ne sont pas déjà construits, guix archive
les construit automatiquement. Le processus de construction peut être
contrôlé avec les options de construction communes (voir Options de construction communes).
Pour transférer le paquet emacs
vers une machine connectée en SSH, on
pourrait lancer :
guix archive --export -r emacs | ssh la-machine guix archive --import
De même, on peut transférer un profil utilisateur complet d’une machine à une autre comme cela :
guix archive --export -r $(readlink -f ~/.guix-profile) | \ ssh the-machine guix archive --import
Toutefois, il faut noter que, dans les deux exemples, tous les emacs
et le profil, ainsi que toutes leurs dépendances sont transférés (en raison
de l’-r), indépendamment de ce qui est déjà disponible dans le
dépôt sur la machine cible. L’option --missing peut aider à
déterminer quels sont les éléments manquants dans le dépôt cible. La
commande guix copy
simplifie et optimise tout ce processus, c’est
donc probablement ce que vous devriez utiliser dans ce cas (voir Invoquer guix copy
).
Chaque élément du dépôt est écrit dans le format archive normalisée ou
nar (décrit ci-dessous), et la sortie de guix archive
--export
(et entrée de guix archive --import
) est un nar
bundle.
Le format nar est comparable dans l’esprit au format "tar", mais avec des différences qui le rendent plus approprié à nos objectifs. Premièrement, plutôt que d’enregistrer toutes les métadonnées Unix pour chaque fichier, le format nar ne mentionne que le type de fichier (régulier, répertoire ou lien symbolique) ; les autorisations Unix et le propriétaire/groupe sont rejetés. Deuxièmement, l’ordre dans lequel les entrées de répertoire sont stockées, suit toujours celui des noms de fichiers selon leur vérification de concordance des locales C. Cela rend la production d’archives entièrement déterministe.
Ce format de lot nar est surtout la concaténation de zéro, un ou plusieurs nar avec des métadonnées pour chaque élément du dépôt qu’il contient : son nom de fichier, ses références, la dérivation correspondante et une signature numérique.
Lors de l’export, le démon signe numériquement le contenu de l’archive et cette signature est ajoutée à la fin du fichier. Lors de l’import, le démon vérifie la signature et rejette l’import en cas de signature invalide ou si la clef de signature n’est pas autorisée.
Les principales options sont :
--export
Exporter les fichiers ou les paquets spécifiés du dépôt (voir plus bas). Écrire l’archive résultante sur la sortie standard.
Les dépendances ne sont pas incluses dans la sortie à moins que --recursive ne soit passé.
-r
--recursive
En combinaison avec --export, cette option demande à guix
archive
d’inclure les dépendances des éléments donnés dans l’archive.
Ainsi, l’archive résultante est autonome : elle contient la fermeture des
éléments de dépôt exportés.
--import
Lire une archive depuis l’entrée standard et importer les fichiers inclus dans le dépôt. Annuler si l’archive a une signature invalide ou si elle est signée par une clef publique qui ne se trouve pas dans le clefs autorisées (voir --authorize plus bas).
--missing
Liste une liste de noms de fichiers du dépôt sur l’entrée standard, un par ligne, et écrit sur l’entrée standard le sous-ensemble de ces fichiers qui manquent dans le dépôt.
--generate-key[=paramètres]
¶Génére une nouvelle paire de clefs pour le démon. C’ est un prérequis avant
que les archives ne puissent être exportées avec --export. Cette
opération est habituellement instantanée mais elle peut prendre du temps
parce qu’elle doit récupérer suffisamment d’entropie pour générer la paire
de clefs. Sur Guix System, guix-service-type
prend soin de générer
cette paire de clés au premier démarrage.
La paire de clés générée est typiquement stockée dans /etc/guix, dans
signing-key.pub (clé publique) et signing-key.sec (clé privée,
qui doit rester secrète). Lorsque paramètres est omis, une clé ECDSA
utilisant la courbe Ed25519 est générée, ou pour les version de libgcrypt
avant 1.6.0, une clé RSA de 4096 bits. Autrement, paramètres peut
spécifier les paramètres genkey
adaptés pour libgcrypt
(voir gcry_pk_genkey
dans The Libgcrypt Reference Manual).
--authorize
¶Autoriser les imports signés par la clef publique passée sur l’entrée standard. La clef publique doit être au « format avancé s-expression » — c.-à-d. le même format que le fichier signing-key.pub.
La liste des clés autorisées est gardée dans un fichier modifiable par des humains dans /etc/guix/acl. Le fichier contient des « s-expressions au format avancé » et est structuré comme une liste de contrôle d’accès dans l’infrastructure à clefs publiques simple (SPKI).
--extract=répertoire
-x répertoire
Lit une archive à un seul élément telle que servie par un serveur de substituts (voir Substituts) et l’extrait dans répertoire. C’est une opération de bas niveau requise seulement dans de rares cas d’usage ; voir plus loin.
Par exemple, la commande suivante extrait le substitut pour Emacs servi par
bordeaux.guix.gnu.org
dans /tmp/emacs :
$ wget -O - \ https://bordeaux.guix.gnu.org/nar/gzip/…-emacs-24.5 \ | gunzip | guix archive -x /tmp/emacs
Les archives à un seul élément sont différentes des archives à plusieurs
éléments produites par guix archive --export
; elles contiennent
un seul élément du dépôt et elles n’embarquent pas de signature.
Ainsi cette opération ne vérifie pas de signature et sa sortie
devrait être considérée comme non sûre.
Le but principal de cette opération est de faciliter l’inspection du contenu
des archives venant de serveurs auxquels on ne fait potentiellement pas
confiance. (voir Invoquer guix challenge
).
--list
-t
Lit une archive à un seul élément telle que servie par un serveur de substituts (voir Substituts) et affiche la liste des fichiers qu’elle contient, comme dans cet exemple :
$ wget -O - \ https://bordeaux.guix.gnu.org/nar/lzip/…-emacs-26.3 \ | lzip -d | guix archive -t
Suivant: Développement, Précédent: Gestion de paquets, Monter: GNU Guix [Table des matières][Index]
Guix and its package collection are updated by running guix pull
.
By default guix pull
downloads and deploys Guix itself from the
official GNU Guix repository. This can be customized by providing a
file specifying the set of channels to pull from (voir Invoquer guix pull
). A channel specifies the URL and branch of a Git repository to be
deployed, and guix pull
can be instructed to pull from one or more
channels. In other words, channels can be used to customize and to
extend Guix, as we will see below. Guix is able to take into account
security concerns and deal with authenticated updates.
Suivant: Utiliser un canal Guix personnalisé, Monter: Canaux [Table des matières][Index]
Vous pouvez spécifier des canaux supplémentaires à utiliser. Pour
utiliser un canal, écrivez dans ~/.config/guix/channels.scm
pour dire
à guix pull
de récupérer votre canal personnel en plus des
canaux par défaut de Guix :
;; Ajouter des variantes de paquets à ceux fournis par Guix. (cons (channel (name 'my-personal-packages) (url "https://example.org/personal-packages.git")) %default-channels)
Remarquez que le bout de code au-dessus est (comme toujours !) du code
Scheme ; nous utilisons cons
pour ajouter un canal à la liste des
canaux que la variable %default-channels
représente (voir cons
and lists dans GNU Guile Reference Manual). Avec ce
fichier en place, guix pull
construit non seulement Guix mais
aussi les modules de paquets de votre propre dépôt. Le résultat dans
~/.config/guix/current est l’union de Guix et de vos propres modules
de paquets :
$ guix describe Génération 19 Aug 27 2018 16:20:48 guix d894ab8 URL du dépôt : https://git.savannah.gnu.org/git/guix.git branche : master commit : d894ab8e9bfabcefa6c49d9ba2e834dd5a73a300 variant-packages dd3df5e URL du dépôt : https://example.org/personal-packages.git branche : master commit : dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb
The output of guix describe
above shows that we’re now running
Generation 19 and that it includes both Guix and packages from the
variant-packages
channel (voir Invoquer guix describe
).
Suivant: Répliquer Guix, Précédent: Spécifier des canaux supplémentaires, Monter: Canaux [Table des matières][Index]
Le canal nommé guix
spécifie où Guix lui-même — ses outils en ligne
de commande ainsi que sa collection de paquets — seront téléchargés. Par
exemple, supposons que vous voulez effectuer les mises à jour depuis votre
propre copie du dépôt Guix sur example.org
, et plus particulièrement
depuis la branche super-hacks
. Vous pouvez écrire cette
spécification dans ~/.config/guix/channels.scm
:
;; Dit à « guix pull » d'utiliser un autre dépôt. (list (channel (name 'guix) (url "https://example.org/my-guix.git") (branch "super-hacks")))
Maintenant, guix pull
récupérera le code depuis la branche
super-hacks
du dépôt sur example.org
. La question de
l’authentification est traitée ci-dessous (voir Authentification des canaux).
Note that you can specify a local directory on the url
field above if
the channel that you intend to use resides on a local file system. However,
in this case guix
checks said directory for ownership before any
further processing. This means that if the user is not the directory owner,
but wants to use it as their default, they will then need to set it as a
safe directory in their global git configuration file. Otherwise,
guix
will refuse to even read it. Supposing your system-wide
local directory is at /src/guix.git
, you would then create a git
configuration file at ~/.gitconfig
with the following contents:
[safe] directory = /src/guix.git
This also applies to the root user unless when called with sudo
by
the directory owner.
Suivant: Customizing the System-Wide Guix, Précédent: Utiliser un canal Guix personnalisé, Monter: Canaux [Table des matières][Index]
La commande guix describe
ci-dessus montre précisément quels
commits ont été utilisés pour construire l’instance de Guix utilisée
(voir Invoquer guix describe
). Nous pouvons répliquer cette instance sur
une autre machine ou plus tard, en fournissant une spécification de canal «
épinglée » à ces commits et qui ressemble à ceci :
;; Déployer des commits précis de mes canaux préférés. (list (channel (name 'guix) (url "https://git.savannah.gnu.org/git/guix.git") (commit "6298c3ffd9654d3231a6f25390b056483e8f407c")) (channel (name 'variant-packages) (url "https://example.org/variant-packages.git") (commit "dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb")))
Pour obtenir cette spécification de canaux épinglée, le plus simple est de
lancer guix describe
et de sauvegarder sa sortie au format
channels
dans un fichier, comme ceci :
guix describe -f channels > channels.scm
Le fichier channels.scm qui en résulte peut être passé à l’option
-C de guix pull
(voir Invoquer guix pull
) ou
guix time-machine
(voir Invoquer guix time-machine
), comme dans
cet exemple :
guix time-machine -C channels.scm -- shell python -- python3
Étant donné le fichier channels.scm, la commande ci-dessus récupérera
toujours exactement la même instance de Guix, puis utilisera cette
instance pour lancer exactement le même Python (voir Invoquer guix shell
). Sur n’importe quelle machine, à n’importe quel moment, elle lance
exactement le même binaire, bit à bit.
Les canaux épinglés répondent à un problème similaire à celui des « fichiers de verrouillage » implémentés par certains outils de déploiement — ils vous permettent d’épingler et de reproduire un ensemble de paquets. Dans le cas de Guix cependant, vous épinglez en fait l’entièreté de l’ensemble de paquets défini par les commits donnés des canaux ; en fait, vous épinglez l’ensemble de Guix, avec des modules cœurs et ses outils en ligne de commande. Vous gagnez aussi la garantie forte que vous obtenez, effectivement, exactement le même environnement logiciel.
Cela vous donne des super-pouvoirs, ce qui vous permet de suivre la provenance des artefacts binaires avec un grain très fin et de reproduire les environnements logiciels à volonté — une sorte de capacité de « méta-reproductibilité », si vous voulez. Voir Inférieurs, pour une autre manière d’utiliser ces super-pouvoirs.
Suivant: Authentification des canaux, Précédent: Répliquer Guix, Monter: Canaux [Table des matières][Index]
If you’re running Guix System or building system images with it, maybe you
will want to customize the system-wide guix
it
provides—specifically, /run/current-system/profile/bin/guix. For
example, you might want to provide additional channels or to pin its
revision.
This can be done using the guix-for-channels
procedure, which returns
a package for the given channels, and using it as part of your operating
system configuration, as in this example:
(use-modules (gnu packages package-management) (guix channels)) (define my-channels ;; Channels that should be available to ;; /run/current-system/profile/bin/guix. (append (list (channel (name 'guix-science) (url "https://github.com/guix-science/guix-science") (branch "master"))) %default-channels)) (operating-system ;; … (services ;; Change the package used by 'guix-service-type'. (modify-services %base-services (guix-service-type config => (guix-configuration (inherit config) (channels my-channels) (guix (guix-for-channels my-channels)))))))
The resulting operating system will have both the guix
and the
guix-science
channels visible by default. The channels
field
of guix-configuration
above further ensures that
/etc/guix/channels.scm, which is used by guix pull
,
specifies the same set of channels (voir channels
field of guix-configuration
).
The (gnu packages package-management)
module exports the
guix-for-channels
procedure, described below.
Return a package corresponding to channels.
The result is a “regular” package, which can be used in
guix-configuration
as shown above or in any other place that expects
a package.
Suivant: Canaux avec des substituts, Précédent: Customizing the System-Wide Guix, Monter: Canaux [Table des matières][Index]
Les commandes guix pull
et guix time-machine
authenticate téléchargent et contrôlent le code récupéré sur les
canaux : elles s’assurent que chaque commit récupéré est signé par un·e
développeur·euse autorisé·e. L’objectif est de protéger contre les
modifications non autorisées du canal qui conduiraient les
utilisateur·rice·s à exécuter du code malveillant.
En tant qu’utilisateur, vous devez fournir une introduction de canal dans votre fichier de canaux afin que Guix sache comment authentifier son premier commit. Une spécification de canal, y compris son introduction, ressemble à quelque chose de ce genre :
(channel
(name 'some-channel)
(url "https://example.org/some-channel.git")
(introduction
(make-channel-introduction
"6f0d8cc0d88abb59c324b2990bfee2876016bb86"
(openpgp-fingerprint
"CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5"))))
La spécification ci-dessus indique le nom et l’URL du canal. L’appel à
make-channel-introduction
ci-dessus spécifie que l’authentification
de ce canal commence au commit 6f0d8cc…
, qui est signé par la
clé OpenPGP avec l’empreinte digitale CABB A931…
.
Pour le canal principal, appelé guix
, vous obtenez automatiquement
cette information à partir de votre installation de Guix. Pour les autres
canaux, incluez l’introduction du canal fournie par les auteurs du canal
dans votre fichier channels.scm. Assurez-vous de récupérer
l’introduction du canal à partir d’une source fiable, car c’est la base de
votre confiance.
Si vous êtes curieux·euse à propos des mécanismes d’authentification, lisez !
Suivant: Écrire de nouveaux de canaux, Précédent: Authentification des canaux, Monter: Canaux [Table des matières][Index]
Lorsque vous lancez guix pull
, Guix compilera d’abord les
définitions de tous les paquets disponibles. C’est une opération coûteuse
pour laquelle des substituts (voir Substituts) peuvent être
disponibles. L’extrait de code suivant dans channels.scm s’assure que
guix pull
utilise le dernier commit pour lequel des substituts
sont disponibles pour les définitions des paquets : pour cela, on demande au
serveur d’intégration continue https://ci.guix.gnu.org.
(use-modules (guix ci)) (list (channel-with-substitutes-available %default-guix-channel "https://ci.guix.gnu.org"))
Remarquez que cela ne signifie pas que tous les paquets que vous installerez
après avoir lancé guix pull
auront des substituts. Cela s’assure
uniquement que guix pull
n’essaiera pas de compiler les
définitions des paquets. C’est particulièrement pratique si vous utilisez
une machine avec des ressources limitées.
Suivant: Modules de paquets dans un sous-répertoire, Précédent: Canaux avec des substituts, Monter: Canaux [Table des matières][Index]
Let’s say you have a bunch of custom package variants or personal packages that you think would make little sense to contribute to the Guix project, but would like to have these packages transparently available to you at the command line. By creating a channel, you can use and publish such a package collection. This involves the following steps:
mkdir my-channel cd my-channel git init
For example, Alice might want to provide a module called (alice
packages greetings)
that will provide her favorite “hello world”
implementations. To do that Alice will create a directory corresponding to
that module name.
mkdir -p alice/packages $EDITOR alice/packages/greetings.scm git add alice/packages/greetings.scm
You can name your package modules however you like; the main constraint to
keep in mind is to avoid name clashes with other package collections, which
is why our hypothetical Alice wisely chose the (alice packages
…)
name space.
Note that you can also place modules in a sub-directory of the repository; voir Modules de paquets dans un sous-répertoire, for more info on that.
guix build
, which needs to be
told to look for modules in the Git checkout. For example, assuming
(alice packages greetings)
provides a package called
hi-from-alice
, Alice will run this command from the Git checkout:
guix build -L. hi-from-alice
... where -L.
adds the current directory to Guile’s load path
(voir Load Paths dans GNU Guile Reference Manual).
git commit
En tant qu’auteur.e d’un canal, envisagez de regrouper le nécessaire d’authentification avec votre canal afin que les utilisatrice·eur·s puissent l’authentifier. Voir Authentification des canaux, et Spécifier les autorisations des canaux, pour savoir comment les utiliser.
guix pull
(voir Invoquer guix pull
):
$EDITOR ~/.config/guix/channels.scm guix pull
Guix will now behave as if the root directory of that channel’s Git
repository had been permanently added to the Guile load path. In this
example, (alice packages greetings)
will automatically be found by
the guix
command.
Et voilà !
Attention : Before you publish your channel, we would like to share a few words of caution:
- Avant de publier un canal, envisagez de contribuer vos définitions de paquets dans Guix (voir Contribuer). Guix en tant que projet est ouvert à tous les logiciels libres de toutes sortes, et les paquets dans Guix sont déjà disponibles à tous les utilisateurs de Guix et bénéficient des processus d’assurance qualité du projet.
- Package modules and package definitions are Scheme code that uses various programming interfaces (APIs). We, Guix developers, never change APIs gratuitously, but we do not commit to freezing APIs either. When you maintain package definitions outside Guix, we consider that the compatibility burden is on you.
- Corollaire : si vous utilisez un canal externe et que le canal est cassé, merci de rapporter le problème à l’auteur du canal, pas au projet Guix.
Vous avez été prévenus ! Maintenant, nous pensons que des canaux externes sont une manière pratique d’exercer votre liberté pour augmenter la collection de paquets de Guix et de partager vos améliorations, qui sont les principes de bases du logiciel libre. Contactez-nous par courriel sur guix-devel@gnu.org si vous souhaitez discuter à ce propos.
Suivant: Déclarer des dépendances de canaux, Précédent: Écrire de nouveaux de canaux, Monter: Canaux [Table des matières][Index]
En tant qu’auteur.e d’un canal, vous voudriez garder vos modules de canal dans un sous-répertoire. Si vos modules sont dans le sous-répertoire guix, vous devez ajouter un fichier de métadonnées .guix-channel qui contient :
(channel
(version 0)
(directory "guix"))
Les modules doivent se situer dans le répertoire spécifié, car le
directory
change le load-path
(chemin de recherche) de
Guile. Par exemple, si .guix-channel a (directory "base")
,
alors un module défini comme (define-module (gnu packages fun))
doit
être situé dans base/gnu/packages/fun.scm
.
Cela permet de n’utiliser qu’une partie du dépôt comme canal, puisque Guix
s’attend à trouver des modules Guile valide en le récupérant. Par exemple,
les fichiers de configuration de machines pour guix deploy
ne sont
pas des modules Guile valides, et les traiter comme tel fera échouer
guix pull
.
Suivant: Spécifier les autorisations des canaux, Précédent: Modules de paquets dans un sous-répertoire, Monter: Canaux [Table des matières][Index]
Les auteurs de canaux peuvent décider d’augmenter une collection de paquets fournie par d’autres canaux. Ils peuvent déclarer leur canal comme dépendant d’autres canaux dans le fichier de métadonnées .guix-channel qui doit être placé à la racine de dépôt du canal.
Le fichier de métadonnées devrait contenir une S-expression simple comme cela :
(channel
(version 0)
(dependencies
(channel
(name some-collection)
(url "https://example.org/first-collection.git")
;; La partie « introduction » ci-dessous est facultative : vous la
;; fournissez pour les dépendances qui peuvent être authentifiées.
(introduction
(channel-introduction
(version 0)
(commit "a8883b58dc82e167c96506cf05095f37c2c2c6cd")
(signer "CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5"))))
(channel
(name some-other-collection)
(url "https://example.org/second-collection.git")
(branch "testing"))))
Dans l’exemple ci-dessus, ce canal est déclaré comme dépendant de deux autres canaux, qui seront récupérés automatiquement. Les modules fournis par le canal seront compilés dans un environnement où les modules de tous les canaux déclarés sont disponibles.
Pour des raisons de fiabilité et de maintenabilité, vous devriez éviter d’avoir des dépendances sur des canaux que vous ne maîtrisez pas et vous devriez ajouter le minimum de dépendances possible.
Suivant: URL primaire, Précédent: Déclarer des dépendances de canaux, Monter: Canaux [Table des matières][Index]
Comme nous l’avons vu plus haut, Guix garantit le code source qu’il récupère depuis les canaux venant de développeur·euses autorisé·es. En tant qu’auteur·e, vous devez spécifiez la liste des développeur·euses autorisé·es dans le fichier .guix-authorizations dans le dépôt Git des canaux. Le rôle de l’authentification est simple : chaque commit doit être signé par une clé listée dans le fichier .guix-authorizations de son (ses) commit(s) parent(s)13 Le fichier .guix-authorizations ressemble à ceci :
;; Fichier d'exemple '.guix-authorizations'. (authorizations (version 0) ;version actuelle du format de fichier (("AD17 A21E F8AE D8F1 CC02 DBD9 F8AE D8F1 765C 61E3" (name "alice")) ("2A39 3FFF 68F4 EF7A 3D29 12AF 68F4 EF7A 22FB B2D5" (name "bob")) ("CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5" (name "charlie"))))
Chaque empreinte digitale est suivie de paires de clés/valeurs facultatives, comme dans l’exemple ci-dessus. Actuellement, ces paires clé/valeur sont ignorées.
Ce rôle d’authentification crée un problème de poule et d’œuf : comment authentifions-nous le premier commit ? Par rapport à cela : comment traiter les canaux dont l’historique du dépôt contient des commits non signés et qui n’ont pas de.guix-authorisations ? Et comment bifurquer des canaux existants ?
L’introduction des canaux répondent à ces questions en décrivant le premier
commit d’un canal qui doit être authentifiée. La première fois qu’un canal
est récupéré avec guix pull
ou guix time-machine
, la
commande recherche le commit d’introduction et vérifie qu’il est signé par
la clé OpenPGP spécifiée. Elle authentifie ensuite les commits selon la
règle ci-dessus. L’authentification échoue si le commit cible n’est ni un
descendant ni un ancêtre du commit d’introduction.
De plus, votre canal doit fournir toutes les clés OpenPGP qui ont été
mentionnées dans les fichiers .guix-authorizations, stockés dans les
fichiers .key, qui peuvent être soit binaires soit "blindés ASCII".
Par défaut, ces fichiers .key sont recherchés dans la branche nommée
keyring
, mais vous pouvez spécifier un nom de branche différent dans
.guix-channel
de cette façon :
(channel
(version 0)
(keyring-reference "my-keyring-branch"))
En résumé, en tant qu’auteur.e d’une chaîne, il y a trois choses que vous devez faire pour permettre aux utilisateur·rice·s d’authentifier votre code :
gpg -export
et les stocker dans des fichiers .key, par
défaut dans une branche nommée keyring
(nous recommandons d’en faire
une branche orpheline).
Before pushing to your public Git repository, you can run guix git
authenticate
to verify that you did sign all the commits you are about to
push with an authorized key:
guix git authenticate commit signer
où commit et signer sont votre présentation de canal.
Voir Invoquer guix git authenticate
, pour plus de détails.
Publier un canal signé demande de la discipline : toute faute, comme un commit non signé ou un commit signée par une clé non autorisée, vont empêcher les utilisateur·rice·s de récupérer depuis votre canal—bref, c’est tout l’intérêt de l’authentification ! Faites particulièrement attention aux merges : les merge commits sont considérés comme authentiques si et seulement s’ils sont signés par une clé présente dans le fichier .guix-authorizations des branches both.
Suivant: Écrire des nouveautés de canaux, Précédent: Spécifier les autorisations des canaux, Monter: Canaux [Table des matières][Index]
Les auteur.e.s de canaux peuvent indiquer l’URL principale de leur dépôt Git de canal dans le fichier .guix-channel comme ceci :
(channel
(version 0)
(url "https://example.org/guix.git"))
Cela permet à guix pull
de déterminer si elle récupère du code
d’un miroir du canal ; lorsque c’est le cas, elle avertit l’utilisateur·rice
que le miroir pourrait être périmé et affiche l’URL primaire. De cette
façon, les utilisateur·rice·s ne peuvent pas être amené·e·s à extraire du
code d’un miroir périmé qui ne reçoit pas les mises à jour de sécurité.
Cette fonctionnalité n’a de sens que pour les dépôts authentifiés, tels que
le canal officiel guix
, pour lequel guix pull
garantit
l’authenticité du code qu’il récupère.
Précédent: URL primaire, Monter: Canaux [Table des matières][Index]
Les auteur.e.s de canaux peuvent occasionnellement vouloir communiquer à leurs utilisateur·rice·s des informations au sujet de changements importants dans le canal. Vous pourriez leur envoyer un courriel, mais ce n’est pas pratique.
Au lieu de cela, les canaux peuvent fournir un fichier de nouvelles ;
lorsque les utilisateur·rice·s du canal exécutent guix pull
, ce
fichier de nouvelles est automatiquement lu et guix pull --news
peut afficher les annonces qui correspondent aux nouveaux commits qui ont
été récupérés, le cas échéant.
Pour cela, les auteur·e·s de canaux doivent en premier lieu déclarer le nom du fichier de nouvelles dans leur fichier .guix-channel :
(channel
(version 0)
(news-file "etc/news.txt"))
Le fichier de nouvelles lui-même, etc/news.txt dans cet exemple, doit ressembler à quelque chose comme ceci :
(channel-news
(version 0)
(entry (tag "the-bug-fix")
(title (en "Fixed terrible bug")
(fr "Oh la la"))
(body (en "@emph{Good news}! It's fixed!")
(eo "Certe ĝi pli bone funkcias nun!")))
(entry (commit "bdcabe815cd28144a2d2b4bc3c5057b051fa9906")
(title (en "Added a great package")
(ca "Què vol dir guix?"))
(body (en "Don't miss the @code{hello} package!"))))
Tandis que le fichier de nouvelles utilise la syntaxe Scheme, évitez de le nommer avec une extension .scm, sinon il sera récupéré lors de la construction du canal et produira une erreur puisqu’il ne s’agit pas d’un module valide. Vous pouvez également déplacer le module du canal dans un sous-répertoire et stocker le fichier de nouvelles dans un autre répertoire.
Le fichier consiste en une liste de news entries. Chaque entrée est associée à un commit ou un tag : elle décrit les changements faits dans ce commit, éventuellement dans les commits précédents comme il faut. Les utilisateur·rice·s ne voient les entrées que la première fois qu’il·elle·s obtiennent le commit auquel l’entrée se réfère.
Le titre
doit être un résumé d’une ligne tandis que body
peut
être arbitrairement long, et les deux peuvent contenir des balises Texinfo
(voir Overview dans GNU Texinfo). Le titre et le corps sont tous
deux une liste de tuples de balises/messages de langue, ce qui permet à
guix pull
d’afficher les nouvelles dans la langue qui correspond à
la locale de l’utilisateur.
Si vous souhaitez traduire des actualités en utilisant un déroulement basé
sur gettext, vous pouvez extraire des chaînes traduisibles avec
xgettext
(voir xgettext Invocation dans GNU Gettext
Utilities). Par exemple, en supposant que vous écriviez d’abord les
entrées de nouvelles en anglais, la commande ci-dessous crée un fichier PO
contenant les chaînes à traduire :
xgettext -o news.po -l scheme -ken etc/news.txt
Pour résumer, oui, vous pourriez utiliser votre chaîne comme un blog. Mais attention, ce n’est pas tout à fait ce à quoi vos utilisateur·rice·s pourraient s’attendre.
Suivant: Interface de programmation, Précédent: Canaux, Monter: GNU Guix [Table des matières][Index]
Si vous êtes développeur de logiciels, Guix fournit des outils que vous devriez trouver utiles — indépendamment du langage dans lequel vous développez. C’est ce dont parle ce chapitre.
La commande guix shell
permet de créer des environnements
logiciels à usage unique, que ce soit pour le développement ou pour lancer
une commande sans l’installer dans votre profil. La commande guix
pack
vous permet de créer des lots applicatifs qui peuvent facilement
être distribués à des utilisateurs qui n’utilisent pas Guix.
guix shell
guix environment
guix pack
guix git authenticate
Suivant: Invoquer guix environment
, Monter: Développement [Table des matières][Index]
guix shell
Le but de guix shell
est de faciliter la création d’environnements
logiciels à usage unique, sans changer votre profil. Vous l’utiliserez
typiquement pour créer des environnement de développement ; c’est aussi une
commande pratique pour lancer des applications sans « polluer » votre
profil.
Remarque : La commande
guix shell
a été introduite récemment pour remplacerguix environment
(voir Invoquerguix environment
). Si vous connaissez déjàguix environment
, vous remarquerez qu’elle est similaire mais aussi (on l’espère) plus pratique.
La syntaxe générale est :
guix shell [options] [paquet…]
Sometimes an interactive shell session is not desired. An arbitrary command
may be invoked by placing the --
token to separate the command from
the rest of the arguments.
L’exemple suivant crée un environnement contenant Python et NumPy, en
construisant ou en téléchargeant les paquets manquants et lance la commande
python3
dans cet environnement :
guix shell python python-numpy -- python3
Note that it is necessary to include the main python
package in this
command even if it is already installed into your environment. This is so
that the shell environment knows to set PYTHONPATH
and other related
variables. The shell environment cannot check the previously installed
environment, because then it would be non-deterministic. This is true for
most libraries: their corresponding language package should be included in
the shell invocation.
Remarque :
guix shell
can be also be used as a script interpreter, also known as shebang. Here is an example self-contained Python script making use of this feature:#!/usr/bin/env -S guix shell python python-numpy -- python3 import numpy print("This is numpy", numpy.version.version)You may pass any
guix shell
option, but there’s one caveat: the Linux kernel has a limit of 127 bytes on shebang length.
Vous pouvez créer des environnements de développement comme dans l’exemple ci-dessous, qui ouvre un shell interactif contenant toutes les dépendance et les variables d’environnement requises pour travailler sur Inkscape :
guix shell --development inkscape
Sortir du shell vous replacera dans l’environnement de départ, avant d’avoir
invoqué la commande guix shell
. Au prochain lancement du
ramasse-miettes (voir Invoquer guix gc
), les paquets installés dans
l’environnement et qui ne sont plus utilisés en dehors seront possiblement
supprimés.
En plus, guix shell
essayera de faire ce que vous espérez quand il
est invoqué de manière interactive et sans arguments, comme ceci :
guix shell
S’il trouve un manifest.scm dans le répertoire de travail actuel ou
dans l’un de ses parents, il utiliser ce manifeste comme s’il avait été
passé avec --manifest
. De la même manière, s’il trouve un
guix.scm dans ces mêmes répertoire, il l’utilisera pour construire un
profil de développement comme si --development
et --file
étaient présents. Dans tous les cas, le fichier ne sera chargé que s’il
réside dans un répertoire listé dans
~/.config/guix/shell-authorized-directories. Cela permet de
facilement définir, partager et entrer dans des environnements de
développement.
Par défaut, la session shell ou la commande est lancée dans un environnement
augmenté, où les nouveaux paquets sont ajoutés aux variables
d’environnement de recherche comme PATH
. Vous pouvez à la place créer
un environnement isolé ne contenant rien d’autre que les paquets que
vous avez demandé. Passez l’option --pure pour nettoyer les
définitions des variables d’environnement qui se trouvent dans
l’environnement parent14 ; en passant --container vous pouvez aller
plus loin en démarrant un conteneur isolé du reste du système :
guix shell --container emacs gcc-toolchain
La commande ci-dessus démarre un shell interactif dans un conteneur avec
rien d’autre que emacs
, gcc-toolchain
et leurs dépendances. Le
conteneur n’a pas d’accès au réseau et ne partage pas les fichiers autres
que ceux du répertoire de travail avec son environnement. C’est utile pour
éviter d’accéder à des ressources systèmes comme /usr/bin sur les
distributions externes.
This --container option can also prove useful if you wish to run a security-sensitive application, such as a web browser, in an isolated environment. For example, the command below launches Ungoogled-Chromium in an isolated environment, which:
DISPLAY
and XAUTHORITY
XAUTHORITY
file
guix shell --container --network --no-cwd ungoogled-chromium \ --preserve='^XAUTHORITY$' --expose="${XAUTHORITY}" \ --preserve='^DISPLAY$' -- chromium
guix shell
définie la variable GUIX_ENVIRONMENT
dans le
shell qu’il crée ; sa valeur est le nom de fichier du profil de cet
environnement. Cela permet aux utilisatrice·eur·s, disons, de définir un
prompt spécifique pour les environnement de développement dans leur
.bashrc (voir Bash Startup Files dans The GNU Bash Reference
Manual) :
if [ -n "$GUIX_ENVIRONMENT" ] then export PS1="\u@\h \w [dev]\$ " fi
… ou de naviguer dans le profil :
$ ls "$GUIX_ENVIRONMENT/bin"
Les options disponibles sont résumées ci-dessous.
--check
Met en place l’environnement et vérifie si le shell peut écraser les
variables d’environnement. C’est une bonne idée d’utiliser cette option la
première fois que vous lancez guix shell
pour une session
interactive pour vous assurer que votre configuration est correcte.
Par exemple, si le shell modifie la variable d’environnement PATH
,
cela sera rapporté car vous auriez un environnement différent de celui que
vous avez demandé.
Ces problèmes indiquent en général que les fichiers de démarrage du shell modifient ces variables d’environnement de manière inattendue. Par exemple, si vous utilisez Bash, assurez-vous que les variables d’environnement sont définie ou modifiées dans ~/.bash_profile et non dans ~/.bashrc — ce premier est sourcé seulement par les shells de connexion. Voir Bash Startup Files dans le manuel de référence de Bash pour plus de détails sur les fichiers de démarrage de Bash.
--development
-D
Fait en sorte que guix shell
ajoute à l’environnement les
dépendances du paquet suivant au lieu du paquet lui-même. Vous pouvez
combiner cette option avec d’autres paquets. Par exemple, la commande
suivante démarre un shell interactif contenant les dépendances à la
construction de GNU Guile, plus Autoconf, Automake et Libtool :
guix shell -D guile autoconf automake libtool
--expression=expr
-e expr
Crée un environnement pour le paquet ou la liste de paquets en lesquels s’évalue expr.
Par exemple, lancer :
guix shell -D -e '(@ (gnu packages maths) petsc-openmpi)'
démarre un shell avec l’environnement pour cette variante spécifique du paquet PETSc.
Lancer :
guix shell -e '(@ (gnu) %base-packages)'
démarre un shell où tous les paquets de base du système sont disponibles.
Les commande au-dessus n’utilisent que les sorties par défaut des paquets donnés. Pour choisir d’autres sorties, on peut spécifier des pairs :
guix shell -e '(list (@ (gnu packages bash) bash) "include")'
Voir package->development-manifest
,
pour apprendre à écrire un fichier manifeste ou l’environnement de
développement d’un paquet.
--file=fichier
-f fichier
Crée un environnement contenant le paquet ou la liste de paquets en lesquels fichier s’évalue.
Par exemple, fichier peut contenir une définition comme celle-ci (voir Définition des paquets) :
(use-modules (guix) (gnu packages gdb) (gnu packages autotools) (gnu packages texinfo)) ;; Augment the package definition of GDB with the build tools ;; needed when developing GDB (and which are not needed when ;; simply installing it.) (package (inherit gdb) (native-inputs (modify-inputs (package-native-inputs gdb) (prepend autoconf-2.69 automake texinfo))))
Avec le fichier ci-dessus, vous pouvez entrer un environnement de développement pour GDB en lançant :
guix shell -D -f gdb-devel.scm
--manifest=fichier
-m fichier
Crée un environnement pour les paquets contenus dans l’objet manifeste renvoyé par le code Scheme dans fichier. Vous pouvez répéter cette option plusieurs fois, auquel cas les manifestes sont concaténés.
C’est similaire à l’option de même nom de guix package
(voir --manifest) et utilise les même fichiers
manifestes.
Voir Écrire un manifeste, pour des informations sur l’écriture d’un manifeste. Voir --export-manifest ci-dessous pour apprendre à obtenir un premier manifeste.
--export-manifest
Écrire un manifeste vers la sortie standard utilisable avec --manifest et qui correspond aux options de la ligne de commande données.
C’est une manière de « convertir » les arguments de la ligne de commande en un manifeste. Par exemple, imaginez que vous en ayez marre de taper de longues lignes et souhaitez avoir un manifeste équivalent à cette ligne de commande :
guix shell -D guile git emacs emacs-geiser emacs-geiser-guile
Ajoutez l’option --export-manifest à la ligne de commande ci-dessus :
guix shell --export-manifest \ -D guile git emacs emacs-geiser emacs-geiser-guile
... et vous obtiendrez un manifeste comme ceci :
(concatenate-manifests
(list (specifications->manifest
(list "git"
"emacs"
"emacs-geiser"
"emacs-geiser-guile"))
(package->development-manifest
(specification->package "guile"))))
Vous pouvez l’enregistrer dans un fichier, disons manifest.scm, et
ensuite le passer à guix shell
ou n’importe quelle commande
guix
:
guix shell -m manifest.scm
Voilà, vous avez convertit une longue ligne de commande en un manifeste ! Ce processus de conversion prend en compte les options de transformation des paquets (voir Options de transformation de paquets) et ne devrait donc pas perdre d’information.
--profile=profil
-p profil
Crée un environnement contenant les paquets installés dans
profile. Utilisez guix package
(voir Invoquer guix package
) pour créer et gérer les profils.
--pure
Réinitialisation des variables d’environnement existantes lors de la construction du nouvel environnement, sauf celles spécifiées avec l’option --preserve. (voir ci-dessous). Cela a pour effet de créer un environnement dans lequel les chemins de recherche ne contiennent que des entrées de paquets.
--preserve=regexp
-E regexp
Lorsque vous utilisez --pure, préserver les variables d’environnement qui correspondent à regexp — en d’autres termes, cela les met en « liste blanche » de variables d’environnement qui doivent être préservées. Cette option peut être répétée plusieurs fois.
guix shell --pure --preserve=^SLURM openmpi … \ -- mpirun …
Cet exemple exécute mpirun
dans un contexte où les seules
variables d’environnement définies sont PATH
, les variables
d’environnement dont le nom commence par ‘SLURM’, ainsi que les
variables « importantes » habituelles (HOME
, USER
, etc.).
--search-paths
Affiche les définitions des variables d’environnement qui composent l’environnement.
--system=système
-s système
Essaye de construire pour système — p. ex. i686-linux
.
--container
¶-C
Lance commande dans un conteneur isolé. Le répertoire de travail actuel en dehors du conteneur est monté dans le conteneur. En plus, à moins de le changer avec --user, un répertoire personnel fictif est créé pour correspondre à celui de l’utilisateur·rice actuel·le et /etc/passwd est configuré en conséquence.
Le processus de création s’exécute en tant qu’utilisateur·rice actuel·le à l’extérieur du conteneur. À l’intérieur du conteneur, il possède les mêmes UID et GID que l’utilisateur·rice actuel·le, sauf si l’option --user est passée (voir ci-dessous).
--network
-N
Pour les conteneurs, partage l’espace de nom du réseau avec le système hôte. Les conteneurs créés sans cette option n’ont accès qu’à l’interface de boucle locale.
--link-profile
-P
Pour les conteneurs, liez le profil d’environnement à ~/.guix-profile
à l’intérieur du conteneur et définissez GUIX_ENVIRONNEMENT
à cet
endroit. Cela équivaut à faire de ~/.guix-profile un lien symbolique
vers le profil réel à l’intérieur du conteneur. La liaison échouera et
interrompra l’environnement si le répertoire existe déjà, ce qui sera
certainement le cas si guix shell
a été invoqué dans le répertoire
personnel de l’utilisateur·rice.
Certains paquets sont configurés pour chercher des fichiers de configuration et des données dans ~/.guix-profile ; 15 ; --link-profile permet à ces programmes de se comporter comme attendu dans l’environnement.
--user=utilisateur
-u utilisateur
Pour les conteneurs, utilise le nom d’utilisateur utilisateur à la place de l’utilisateur actuel. L’entrée générée dans /etc/passwd dans le conteneur contiendra le nom utilisateur ; le répertoire personnel sera /home/utilisateur ; et aucune donnée GECOS ne sera copiée. En plus, l’UID et le GID dans le conteneur seront 1000. user n’a pas besoin d’exister sur le système.
En plus, tous les chemins partagés ou exposés (voir --share et --expose respectivement) dont la cible est dans le répertoire personnel de l’utilisateur·rice seront remontés relativement à /home/USER ; cela comprend le montage automatique du répertoire de travail actuel.
# exposera les chemins comme /home/toto/wd, /home/toto/test et /home/toto/target cd $HOME/wd guix shell --container --user=toto \ --expose=$HOME/test \ --expose=/tmp/target=$HOME/target
Bien que cela limite la fuite de l’identité de l’utilisateur à travers le chemin du répertoire personnel et des champs de l’utilisateur, ce n’est qu’un composant utile pour une solution d’anonymisation ou de préservation de la vie privée — pas une solution en elle-même.
--no-cwd
Pour les conteneurs, le comportement par défaut est de partager le répertoire de travail actuel avec le conteneur isolé et de passer immédiatement à ce répertoire à l’intérieur du conteneur. Si cela n’est pas souhaitable, --no-cwd fera en sorte que le répertoire de travail courant soit automatiquement partagé not et passera au répertoire personnel de l’utilisateur·rice dans le conteneur à la place. Voir aussi --user.
--expose=source[=cible]
--share=source[=cible]
Pour les conteneurs, --expose (resp. --share) expose le système de fichiers source du système hôte comme un système de fichiers target en lecture seule (resp. en lecture-écriture) dans le conteneur. Si target n’est pas spécifiée, source est utilisé comme point de montage dans le conteneur.
L’exemple ci-dessous crée un REPL Guile dans un conteneur dans lequel le répertoire personnel de l’utilisateur est accessible en lecture-seule via le répertoire /exchange :
guix shell --container --expose=$HOME=/exchange guile -- guile
--symlink=spec
-S spec
Pour les conteneurs, crée le lien symbolique spécifié par la spec, documenté dans pack-symlink-option.
--emulate-fhs
-F
Lorsqu’elle est utilisée avec --container, cette option émule une configuration qui respecte le standard de la hiérarchie des systèmes de fichiers (FHS) dans le conteneur, en fournissant /bin, /lib et d’autres répertoires et fichiers spécifiés par le FHS.
Comme Guix ne respecte pas les spécifications du FHS, cette option configure le conteneur pour mieux reproduire le comportement des autres distributions GNU/Linux. C’est utile pour reproduire d’autres environnements de développement, tester et utiliser des programmes qui s’attendent à ce que les spécifications du FHS soient suivies. Avec cette option, le conteneur inclura une version de glibc qui lira /etc/ld.so.cache dans le conteneur pour trouver le cache des bibliothèques partagées (au contraire de glibc dans l’utilisation normale de Guix) et configurera les répertoires attendu du FHS : /bin, /etc, /lib, /usr à partir du profil du conteneur.
--nesting
-W
When used with --container, provide Guix inside the container and arrange so that it can interact with the build daemon that runs outside the container. This is useful if you want, within your isolated container, to create other containers, as in this sample session:
$ guix shell -CW coreutils [env]$ guix shell -C guile -- guile -c '(display "hello!\n")' hello! [env]$ exit
The session above starts a container with coreutils
programs
available in PATH
. From there, we spawn guix shell
to
create a nested container that provides nothing but Guile.
Another example is evaluating a guix.scm file that is untrusted, as shown here:
guix shell -CW -- guix build -f guix.scm
The guix build
command as executed above can only access the
current directory.
Under the hood, the -W option does several things:
guix
invocations are
visible;
guix
command to the profile in the
container, such that guix describe
returns the same state inside
and outside the container;
guix time-machine
and guix shell
.
--rebuild-cache
¶La plupart du temps, guix shell
met en cache l’environnement pour
que les utilisations suivantes soient instantanées. Les entrées du cache
utilisées le moins récemment sont régulièrement supprimées. Le cache est
aussi invalidé lorsque vous utilisez --file ou --manifest
à chaque fois que le fichier correspondant est modifié.
L’option --rebuild-cache force l’environnement en cache à être
rafraîchi. C’est utile si vous utilisez les options --file ou
--manifest et que les fichiers guix.scm
ou
manifest.scm
ont des dépendances externes, ou si leur comportement
dépend, disons, de variables d’environnements.
--root=fichier
¶-r fichier
Fait de fichier un lien symbolique vers le profil de cet environnement, et l’enregistre comme une racine du ramasse-miettes.
C’est utile si vous souhaitez protéger votre environnement du ramasse-miettes, pour le rendre « persistent ».
Lorsque vous n’utilisez pas cette option, guix shell
met en cache
les profils pour les utilisations suivantes du même environnement soient
immédiates — vous pouvez comparer cela à l’utilisation de --root
sauf que guix shell
prend soin de régulièrement supprimer les
racines du ramasse-miettes utilisées le moins récemment.
Dans certains cas, guix shell
ne met pas les profils en cache –
p. ex. si des options de transformations comme --with-latest
sont utilisées. Dans ce cas, l’environnement n’est protégé du
ramasse-miettes que le temps de la session guix shell
. Cela
signifie que la prochaine fois que vous créerez le même environnement, vous
pourriez avoir à reconstruire ou télécharger des paquets.
Voir Invoquer guix gc
, pour en apprendre plus sur les racines du
ramasse-miettes.
En plus, guix shell
prend en charge toutes les options de
construction communes prises en charge par guix build
(voir Options de construction communes) et toutes les options de transformation de
paquets (voir Options de transformation de paquets).
Suivant: Invoquer guix pack
, Précédent: Invoquer guix shell
, Monter: Développement [Table des matières][Index]
guix environment
Le but de guix environment
est de vous aider à créer des
environnements de développement.
Avertissement d’obsolescence : La commande
guix environment
est obsolète et remplacée parguix shell
, qui effectue les même tâches mais est plus pratique à utiliser. Voir Invoquerguix shell
.Étant obsolète,
guix environment
sera supprimée à un moment, mais le projet Guix s’engage à la garder jusqu’au premier mai 2023. Contactez-nous sur guix-devel@gnu.org si vous voulez en parler.
La syntaxe générale est :
guix environment options paquet…
L’exemple suivant crée un nouveau shell préparé pour le développement de GNU Guile :
guix environment guile
Si les dépendances requises ne sont pas déjà construites, guix
environment
les construit automatiquement. L’environnement du nouveau
shell est une version améliorée de l’environnement dans lequel guix
environment
a été lancé. Il contient les chemins de recherche nécessaires
à la construction du paquet donné en plus des variables d’environnement
existantes. Pour créer un environnement « pur », dans lequel les variables
d’environnement de départ ont été nettoyées, utilisez l’option
--pure16.
Sortir d’un environnement Guix est comme sortir du shell, et cela vous
replacera dans l’ancien environnement avant d’avoir invoqué la commande
guix environment
. Au prochain lancement du ramasse-miettes
(voir Invoquer guix gc
), les paquets installés pour l’environnement
seront supprimés et ne seront plus disponibles en dehors de celui-ci.
guix environment
définie la variable GUIX_ENVIRONMENT
dans
le shell qu’il crée ; sa valeur est le nom de fichier du profil de cet
environnement. Cela permet aux utilisatrice·eur·s, disons, de définir un
prompt spécifique pour les environnement de développement dans leur
.bashrc (voir Bash Startup Files dans The GNU Bash Reference
Manual) :
if [ -n "$GUIX_ENVIRONMENT" ] then export PS1="\u@\h \w [dev]\$ " fi
… ou de naviguer dans le profil :
$ ls "$GUIX_ENVIRONMENT/bin"
De surcroît, plus d’un paquet peut être spécifié, auquel cas l’union des entrées des paquets données est utilisée. Par exemple, la commande ci-dessous crée un shell où toutes les dépendances de Guile et Emacs sont disponibles :
guix environment guile emacs
Parfois, une session shell interactive est inutile. On peut invoquer une
commande arbitraire en plaçant le jeton --
pour séparer la commande
du reste des arguments :
guix environment guile -- make -j4
Dans d’autres situations, il est plus pratique de spécifier la liste des
paquets requis dans l’environnement. Par exemple, la commande suivante
lance python
dans un environnement contenant Python 3 et
NumPy :
guix environment --ad-hoc python-numpy python -- python3
En plus, on peut vouloir les dépendance d’un paquet et aussi des paquets supplémentaires qui ne sont pas des dépendances à l’exécution ou à la construction, mais qui sont utiles au développement tout de même. À cause de cela, le tag --ad-hoc est positionnel. Les paquets qui apparaissent avant --ad-hoc sont interprétés comme les paquets dont les dépendances seront ajoutées à l’environnement. Les paquets qui apparaissent après --ad-hoc sont interprétés comme les paquets à ajouter à l’environnement directement. Par exemple, la commande suivante crée un environnement de développement pour Guix avec les paquets Git et strace en plus :
guix environment --pure guix --ad-hoc git strace
Parfois il est souhaitable d’isoler l’environnement le plus possible, pour une pureté et une reproductibilité maximale. En particulier, lorsque vous utilisez Guix sur une distribution hôte qui n’est pas le système Guix, il est souhaitable d’éviter l’accès à /usr/bin et d’autres ressources du système depuis les environnements de développement. Par exemple, la commande suivante crée un REPL Guile dans un « conteneur » où seuls le dépôt et le répertoire de travail actuel sont montés :
guix environment --ad-hoc --container guile -- guile
Remarque : L’option --container requiert Linux-libre 3.19 ou supérieur.
Un autre cas d’usage typique pour les conteneurs est de lancer des
applications sensibles à la sécurité, comme un navigateur web. Pour faire
fonctionner Eolie, nous devons exposer et partager certains fichiers et
répertoires ; nous incluons nss-certs
et exposons
/etc/ssl/certs/ pour l’authentification HTTPS ; enfin, nous
préservons la variable d’environnement DISPLAY
puisque les
applications graphiques conteneurisées ne s’afficheront pas sans elle.
guix environment --preserve='^DISPLAY$' --container --network \ --expose=/etc/machine-id \ --expose=/etc/ssl/certs/ \ --share=$HOME/.local/share/eolie/=$HOME/.local/share/eolie/ \ --ad-hoc eolie nss-certs dbus -- eolie
Les options disponibles sont résumées ci-dessous.
--check
Configure l’environnement et vérifie si le shell écraserait les variables d’environnement. Voir --check, pour plus d’informations.
--root=fichier
¶-r fichier
Fait de fichier un lien symbolique vers le profil de cet environnement, et l’enregistre comme une racine du ramasse-miettes.
C’est utile si vous souhaitez protéger votre environnement du ramasse-miettes, pour le rendre « persistent ».
Lorsque cette option est omise, l’environnement n’est protégé du
ramasse-miettes que le temps de la session guix environment
. Cela
signifie que la prochaine fois que vous créerez le même environnement, vous
pourriez avoir à reconstruire ou télécharger des paquets. Voir Invoquer guix gc
, pour plus d’informations sur les racines du GC.
--expression=expr
-e expr
Crée un environnement pour le paquet ou la liste de paquets en lesquels s’évalue expr.
Par exemple, lancer :
guix environment -e '(@ (gnu packages maths) petsc-openmpi)'
démarre un shell avec l’environnement pour cette variante spécifique du paquet PETSc.
Lancer :
guix environment --ad-hoc -e '(@ (gnu) %base-packages)'
démarre un shell où tous les paquets de base du système sont disponibles.
Les commande au-dessus n’utilisent que les sorties par défaut des paquets donnés. Pour choisir d’autres sorties, on peut spécifier des pairs :
guix environment --ad-hoc -e '(list (@ (gnu packages bash) bash) "include")'
--load=fichier
-l fichier
Crée un environnement pour le paquet ou la liste de paquets en lesquels fichier s’évalue.
Par exemple, fichier peut contenir une définition comme celle-ci (voir Définition des paquets) :
(use-modules (guix) (gnu packages gdb) (gnu packages autotools) (gnu packages texinfo)) ;; Augment the package definition of GDB with the build tools ;; needed when developing GDB (and which are not needed when ;; simply installing it.) (package (inherit gdb) (native-inputs (modify-inputs (package-native-inputs gdb) (prepend autoconf-2.69 automake texinfo))))
--manifest=fichier
-m fichier
Crée un environnement pour les paquets contenus dans l’objet manifeste renvoyé par le code Scheme dans fichier. Vous pouvez répéter cette option plusieurs fois, auquel cas les manifestes sont concaténés.
C’est similaire à l’option de même nom de guix package
(voir --manifest) et utilise les même fichiers
manifestes.
Voir guix shell --export-manifest
, pour
des informations sur la « conversion » des options de la ligne de commande
en un manifeste.
--ad-hoc
Inclut tous les paquets spécifiés dans l’environnement qui en résulte, comme si un paquet ad hoc était spécifié, avec ces paquets comme entrées. Cette option est utile pour créer un environnement rapidement sans avoir à écrire une expression de paquet contenant les entrées désirées.
Par exemple la commande :
guix environment --ad-hoc guile guile-sdl -- guile
lance guile
dans un environnement où Guile et Guile-SDDL sont
disponibles.
Remarquez que cet exemple demande implicitement la sortie par défaut de
guile
et guile-sdl
, mais il est possible de demander une
sortie spécifique — p. ex. glib:bin
demande la sortie bin
de glib
(voir Des paquets avec plusieurs résultats).
Cette option peut être composée avec le comportement par défaut de
guix environment
. Les paquets qui apparaissent avant
--ad-hoc sont interprétés comme les paquets dont les dépendances
seront ajoutées à l’environnement, le comportement par défaut. Les paquets
qui apparaissent après --ad-hoc sont interprétés comme les paquets
à ajouter à l’environnement directement.
--profile=profil
-p profil
Crée un environnement contenant les paquets installés dans
profile. Utilisez guix package
(voir Invoquer guix package
) pour créer et gérer les profils.
--pure
Réinitialisation des variables d’environnement existantes lors de la construction du nouvel environnement, sauf celles spécifiées avec l’option --preserve. (voir ci-dessous). Cela a pour effet de créer un environnement dans lequel les chemins de recherche ne contiennent que des entrées de paquets.
--preserve=regexp
-E regexp
Lorsque vous utilisez --pure, préserver les variables d’environnement qui correspondent à regexp — en d’autres termes, cela les met en « liste blanche » de variables d’environnement qui doivent être préservées. Cette option peut être répétée plusieurs fois.
guix environment --pure --preserve=^SLURM --ad-hoc openmpi … \ -- mpirun …
Cet exemple exécute mpirun
dans un contexte où les seules
variables d’environnement définies sont PATH
, les variables
d’environnement dont le nom commence par ‘SLURM’, ainsi que les
variables « importantes » habituelles (HOME
, USER
, etc.).
--search-paths
Affiche les définitions des variables d’environnement qui composent l’environnement.
--system=système
-s système
Essaye de construire pour système — p. ex. i686-linux
.
--container
¶-C
Lance commande dans un conteneur isolé. Le répertoire de travail actuel en dehors du conteneur est monté dans le conteneur. En plus, à moins de le changer avec --user, un répertoire personnel fictif est créé pour correspondre à celui de l’utilisateur·rice actuel·le et /etc/passwd est configuré en conséquence.
Le processus de création s’exécute en tant qu’utilisateur·rice actuel·le à l’extérieur du conteneur. À l’intérieur du conteneur, il possède les mêmes UID et GID que l’utilisateur·rice actuel·le, sauf si l’option --user est passée (voir ci-dessous).
--network
-N
Pour les conteneurs, partage l’espace de nom du réseau avec le système hôte. Les conteneurs créés sans cette option n’ont accès qu’à l’interface de boucle locale.
--link-profile
-P
Pour les conteneurs, liez le profil d’environnement à ~/.guix-profile
à l’intérieur du conteneur et définissez GUIX_ENVIRONNEMENT
à cet
endroit. Cela équivaut à faire de ~/.guix-profile un lien symbolique
vers le profil réel à l’intérieur du conteneur. La liaison échouera et
interrompra l’environnement si le répertoire existe déjà, ce qui sera
certainement le cas si guix environment
a été invoqué dans le
répertoire personnel de l’utilisateur·rice.
Certains paquets sont configurés pour chercher des fichiers de configuration et des données dans ~/.guix-profile ; 17 ; --link-profile permet à ces programmes de se comporter comme attendu dans l’environnement.
--user=utilisateur
-u utilisateur
Pour les conteneurs, utilise le nom d’utilisateur utilisateur à la place de l’utilisateur actuel. L’entrée générée dans /etc/passwd dans le conteneur contiendra le nom utilisateur ; le répertoire personnel sera /home/utilisateur ; et aucune donnée GECOS ne sera copiée. En plus, l’UID et le GID dans le conteneur seront 1000. user n’a pas besoin d’exister sur le système.
En plus, tous les chemins partagés ou exposés (voir --share et --expose respectivement) dont la cible est dans le répertoire personnel de l’utilisateur·rice seront remontés relativement à /home/USER ; cela comprend le montage automatique du répertoire de travail actuel.
# exposera les chemins comme /home/toto/wd, /home/toto/test et /home/toto/target cd $HOME/wd guix environment --container --user=toto \ --expose=$HOME/test \ --expose=/tmp/target=$HOME/target
Bien que cela limite la fuite de l’identité de l’utilisateur à travers le chemin du répertoire personnel et des champs de l’utilisateur, ce n’est qu’un composant utile pour une solution d’anonymisation ou de préservation de la vie privée — pas une solution en elle-même.
--no-cwd
Pour les conteneurs, le comportement par défaut est de partager le répertoire de travail actuel avec le conteneur isolé et de passer immédiatement à ce répertoire à l’intérieur du conteneur. Si cela n’est pas souhaitable, --no-cwd fera en sorte que le répertoire de travail courant soit automatiquement partagé not et passera au répertoire personnel de l’utilisateur·rice dans le conteneur à la place. Voir aussi --user.
--expose=source[=cible]
--share=source[=cible]
Pour les conteneurs, --expose (resp. --share) expose le système de fichiers source du système hôte comme un système de fichiers target en lecture seule (resp. en lecture-écriture) dans le conteneur. Si target n’est pas spécifiée, source est utilisé comme point de montage dans le conteneur.
L’exemple ci-dessous crée un REPL Guile dans un conteneur dans lequel le répertoire personnel de l’utilisateur est accessible en lecture-seule via le répertoire /exchange :
guix environment --container --expose=$HOME=/exchange --ad-hoc guile -- guile
--emulate-fhs
-F
Lorsqu’elle est utilisée avec --container, cette option émule une configuration qui respecte le standard de la hiérarchie des systèmes de fichiers (FHS) dans le conteneur, en fournissant /bin, /lib et d’autres répertoires et fichiers spécifiés par le FHS. Comme Guix ne respecte pas les spécifications du FHS, cette option configure le conteneur pour mieux reproduire le comportement des autres distributions GNU/Linux. C’est utile pour reproduire d’autres environnements de développement, tester et utiliser des programmes qui s’attendent à ce que les spécifications du FHS soient suivies. Avec cette option, le conteneur inclura une version de glibc qui lira /etc/ld.so.cache dans le conteneur pour trouver le cache des bibliothèques partagées (au contraire de glibc dans l’utilisation normale de Guix) et configurera les répertoires attendu du FHS : /bin, /etc, /lib, /usr à partir du profil du conteneur.
En plus, guix environment
prend en charge toutes les options de
construction communes prises en charge par guix build
(voir Options de construction communes) et toutes les options de transformation de
paquets (voir Options de transformation de paquets).
Suivant: La chaîne d’outils GCC, Précédent: Invoquer guix environment
, Monter: Développement [Table des matières][Index]
guix pack
Parfois vous voulez passer un logiciel à des gens qui n’ont pas (encore !)
la chance d’utiliser Guix. Vous leur diriez bien de lancer guix
package -i quelque chose
mais ce n’est pas possible dans ce cas.
C’est là que guix pack
entre en jeu.
Remarque : Si vous cherchez comment échanger des binaires entre des machines où Guix est déjà installé, voir Invoquer
guix copy
, Invoquerguix publish
, et Invoquerguix archive
.
La commande guix pack
crée un pack ou lot de logiciels
: elle crée une archive tar ou un autre type d’archive contenant les
binaires pour le logiciel qui vous intéresse ainsi que ses dépendances.
L’archive qui en résulte peut être utilisée sur toutes les machines qui
n’ont pas Guix et les gens peuvent lancer exactement les mêmes binaires que
ceux que vous avez avec Guix. Le pack lui-même est créé d’une manière
reproductible au bit près, pour que n’importe qui puisse vérifier qu’il
contient bien les résultats que vous prétendez proposer.
Par exemple, pour créer un lot contenant Guile, Emacs, Geiser et toutes leurs dépendances, vous pouvez lancer :
$ guix pack guile emacs emacs-geiser … /gnu/store/…-pack.tar.gz
Le résultat ici est une archive tar contenant un répertoire
/gnu/store avec tous les paquets nécessaires. L’archive qui en
résulte contient un profil avec les trois paquets qui vous intéressent
; le profil est le même qui celui qui aurait été créé avec guix
package -i
. C’est ce mécanisme qui est utilisé pour créer les archives tar
binaires indépendantes de Guix (voir Installation binaire).
Les utilisateurs de ce pack devraient lancer /gnu/store/…-profile/bin/guile pour lancer Guile, ce qui n’est pas très pratique. Pour éviter cela, vous pouvez créer, disons, un lien symbolique /opt/gnu/bin vers le profil :
guix pack -S /opt/gnu/bin=bin guile emacs emacs-geiser
De cette façon, les utilisateurs peuvent joyeusement taper /opt/gnu/bin/guile et profiter.
Et si le destinataire de votre pack n’a pas les privilèges root sur sa
machine, et ne peut donc pas le décompresser dans le système de fichiers
root ? Dans ce cas, vous pourriez utiliser l’option --relocatable
(voir plus bas). Cette option produit des binaires repositionnables,
ce qui signifie qu’ils peuvent être placés n’importe où dans l’arborescence
du système de fichiers : dans l’exemple au-dessus, les utilisateur·rice·s
peuvent décompresser votre archive dans leur répertoire personnel et lancer
directement ./opt/gnu/bin/guile.
Autrement, vous pouvez produire un pack au format d’image Docker avec la commande suivante :
guix pack -f docker -S /bin=bin guile guile-readline
Le résultat est une archive tar qui peut être passée à la commande
docker load
, puis à docker run
:
docker load < file docker run -ti guile-guile-readline /bin/guile
where file is the image returned by guix pack
, and
guile-guile-readline
is its “image tag”. See the
Docker
documentation for more information.
Autrement, vous pouvez produire une image SquashFS avec la commande suivante :
guix pack -f squashfs bash guile emacs emacs-geiser
Le résultat est une image de système de fichiers SquashFS qui peut soit être
montée directement soit être utilisée comme image de conteneur de système de
fichiers avec l’Singularity container
execution environment, avec des commandes comme singularity shell
ou singularity exec
.
Diverses options en ligne de commande vous permettent de personnaliser votre pack :
--format=format
-f format
Produire un pack dans le format donné.
Les formats disponibles sont :
tarball
C’est le format par défaut. Il produit une archive tar contenant tous les binaires et les liens symboliques spécifiés.
docker
This produces a tarball that follows the
Docker Image Specification. By default, the “repository name” as it
appears in the output of the docker images
command is computed
from package names passed on the command line or in the manifest file.
Alternatively, the “repository name” can also be configured via the
--image-tag option. Refer to --help-docker-format for
more information on such advanced options.
squashfs
Cela produit une image SquashFS contenant tous les binaires et liens symboliques spécifiés, ainsi que des points de montages vides pour les systèmes de fichiers virtuels comme procfs.
Remarque : Singularity requiert que vous fournissiez /bin/sh dans l’image. Pour cette raison,
guix pack -f squashfs
implique toujours-S /bin=bin
. Ainsi, votre invocationguix pack
doit toujours commencer par quelque chose comme :guix pack -f squashfs bash …Si vous oubliez le paquet
bash
(ou similaire),singularity run
etsingularity exec
vont échouer avec un message « no such file or directory » peu utile.
deb
¶Cela produit une archive Debian (un paquet avec l’extension ‘.deb’) contenant tous les binaires et les liens symboliques spécifiés, qui peut être installée sur n’importe quelle distribution GNU(/Linux) basée sur dpkg. Vous trouverez des options avancées avec l’option --help-deb-format. Elles permettent d’insérer des fichiers control pour un contrôle plus fin, comme pour activer des trigger ou fournir un script de configuration pour mainteneur pour lancer du code de configuration arbitraire à l’installation.
guix pack -f deb -C xz -S /usr/bin/hello=bin/hello hello
Remarque : Because archives produced with
guix pack
contain a collection of store items and because eachdpkg
package must not have conflicting files, in practice that means you likely won’t be able to install more than one such archive on a given system. You can nonetheless pack as many Guix packages as you want in one such archive.
Attention :
dpkg
prendra possession de tout fichier contenu dans le pack qu’il ne connaît pas. Il est peu avisé d’installer des fichiers ‘.deb’ produits par Guix sur un système où /gnu/store est partagé avec un autre logiciel, comme une installation de Guix ou d’autres packs non deb.
rpm
¶This produces an RPM archive (a package with the ‘.rpm’ file extension)
containing all the specified binaries and symbolic links, that can be
installed on top of any RPM-based GNU/Linux distribution. The RPM format
embeds checksums for every file it contains, which the rpm
command
uses to validate the integrity of the archive.
Advanced RPM-related options are revealed via the --help-rpm-format option. These options allow embedding maintainer scripts that can run before or after the installation of the RPM archive, for example.
The RPM format supports relocatable packages via the --prefix
option of the rpm
command, which can be handy to install an RPM
package to a specific prefix.
guix pack -f rpm -R -C xz -S /usr/bin/hello=bin/hello hello
sudo rpm --install --prefix=/opt /gnu/store/...-hello.rpm
Remarque : Contrary to Debian packages, conflicting but identical files in RPM packages can be installed simultaneously, which means multiple
guix pack
-produced RPM packages can usually be installed side by side without any problem.
Attention :
rpm
assumes ownership of any files contained in the pack, which means it will remove /gnu/store upon uninstalling a Guix-generated RPM package, unless the RPM package was installed with the --prefix option of therpm
command. It is unwise to install Guix-produced ‘.rpm’ packages on a system where /gnu/store is shared by other software, such as a Guix installation or other, non-rpm packs.
--relocatable
-R
Produire des binaires repositionnables — c.-à-d. des binaires que vous pouvez placer n’importe où dans l’arborescence du système de fichiers et les lancer à partir de là.
Lorsque vous passez cette option une fois, les binaires qui en résultent demandent le support des espaces de nom utilisateurs dans le noyau Linux ; lorsque vous la passez deux fois18, les binaires repositionnables utilisent PRoot si les espaces de noms ne sont pas utilisables, et ça fonctionne à peu près partout — voir plus bas pour comprendre les implications.
Par exemple, si vous créez un pack contenant Bash avec :
guix pack -RR -S /mybin=bin bash
… vous pouvez copier ce pack sur une machine qui n’a pas Guix et depuis votre répertoire personnel en tant qu’utilisateur non-privilégié, lancer :
tar xf pack.tar.gz ./mybin/sh
Dans ce shell, si vous tapez ls /gnu/store
, vous remarquerez que
/gnu/store apparaît et contient toutes les dépendances de
bash
, même si la machine n’a pas du tout de /gnu/store ! C’est
sans doute la manière la plus simple de déployer du logiciel construit avec
Guix sur une machine sans Guix.
Remarque : Par défaut ,les binaires repositionnables s’appuient sur les espaces de noms utilisateurs du noyau Linux, qui permet à des utilisateurs non-privilégiés d’effectuer des montages et de changer de racine. Les anciennes versions de Linux ne le supportait pas et certaines distributions GNU/Linux le désactive.
Pour produire des binaires repositionnables qui fonctionnent même sans espace de nom utilisatrice·eur, passez --relocatable ou -R deux fois. Dans ce cas, les binaires testeront la prise en charge des espaces de noms utilisatrice·eur·s et utiliseront PRoot s’ils ne sont pas pris en charge. Les moteurs d’exécution suivants sont pris en charge :
default
Essayez les espaces de noms utilisateur·rice·s et revenez à PRoot si les espaces de noms utilisateur·rice·s ne sont pas pris en charge (voir ci-dessous).
performance
Essayez les espaces de noms utilisateur·rice·s et revenez à Fakechroot si les espaces de noms utilisateur·rice·s ne sont pas pris en charge (voir ci-dessous).
users
Lance le programme à travers les espaces de nom utilisateur·rice et échoue s’ils ne sont pas supportés.
proot
Passez à travers PRoot. Le programme PRoot fournit la prise en charge nécessaire pour la virtualisation du système de fichier. Il y parvient en utilisant l’appel système
ptrace
sur le programme courant. Cette approche a l’avantage de fonctionner sans demander de support spécial de la part du noyau, mais occasionne un coût supplémentaire en temps pour chaque appel système effectué.fakechroot
Passez à travers Fakechroot. Fakechroot virtualise les accès au système de fichier en interceptant les appels vers les fonctions de la bibliothèque C telles que
open
,stat
,exec
, et ainsi de suite. Contrairement à PRoot, il n’engendre que très peu de coûts généraux. Cependant, il ne fonctionne pas encore tout-à-fait : par exemple, certains accès au système de fichier effectués à partir de la bibliothèque C ne sont pas interceptés, et les accès au système de fichier effectués via les appels système directs ne sont pas non plus interceptés, conduisant à un comportement erratique.Lors de l’exécution d’un programme complet, vous pouvez demander explicitement l’un des moteurs d’exécution énumérés ci-dessus en définissant en conséquence la variable d’environnement
GUIX_EXECUTION_ENGINE
.
--entry-point=commande
Utiliser commande comme point d’entrée du paquet résultant, si
le format du paquet le supporte–actuellement docker
et
squashfs
(Singularity) la supportent. command doit être
relatif au profil contenu dans le pack.
Le point d’entrée spécifie la commande que des outils comme docker
run
or singularity run
lancent automatiquement par défaut. Par
exemple, vous pouvez faire :
guix pack -f docker --entry-point=bin/guile guile
Le pack résultant peut être facilement chargé et docker run
sans
arguments supplémentaires engendrera bin/guile
:
docker load -i pack.tar.gz docker run image-id
--entry-point-argument=command
-A command
Use command as an argument to entry point of the resulting
pack. This option is only valid in conjunction with --entry-point
and can appear multiple times on the command line.
guix pack -f docker --entry-point=bin/guile --entry-point-argument="--help" guile
--max-layers=n
Specifies the maximum number of Docker image layers allowed when building an image.
guix pack -f docker --max-layers=100 guile
This option allows you to limit the number of layers in a Docker image. Docker images are comprised of multiple layers, and each layer adds to the overall size and complexity of the image. By setting a maximum number of layers, you can control the following effects:
--expression=expr
-e expr
Considérer le paquet évalué par expr.
Cela a le but identique que l’option de même nom de guix build
(voir --expression
dans guix
build
).
--manifest=fichier
-m fichier
Utiliser les paquets contenus dans l’objet manifeste renvoyé par le code Scheme dans fichier. Vous pouvez répéter cette option plusieurs fois, auquel cas les manifestes sont concaténés.
Elle a un but similaire à l’option de même nom dans guix package
(voir --manifest) et utilise les mêmes
fichiers manifeste. Ils vous permettent de définir une collection de
paquets une fois et de l’utiliser aussi bien pour créer des profils que pour
créer des archives pour des machines qui n’ont pas Guix d’installé.
Remarquez que vous pouvez spécifier soit un fichier manifeste,
soit une liste de paquet, mais pas les deux.
Voir Écrire un manifeste pour des informations sur l’écriture d’un
manifeste. Voir guix shell
--export-manifest
, pour des informations sur la « conversion » des options
de la ligne de commande en un manifeste.
--system=système
-s système
Tenter de construire pour le système — p. ex. i686-linux
—
plutôt que pour le type de système de l’hôte de construction.
--target=triplet
¶Effectuer une compilation croisée pour triplet qui doit être un
triplet GNU valide, comme ""aarch64-linux-gnu""
(voir GNU configuration triplets dans Autoconf).
--compression=outil
-C outil
Compresser l’archive résultante avec outil — l’un des outils parmi
gzip
, zstd
, bzip2
, xz
, lzip
, ou
none
pour aucune compression.
--symlink=spec
-S spec
Ajouter les liens symboliques spécifiés par spec dans le pack. Cette option peut apparaître plusieurs fois.
spec a la forme source=cible
, où source est
le lien symbolique qui sera créé et cible est la cible du lien.
Par exemple, -S /opt/gnu/bin=bin
crée un lien symbolique
/opt/gnu/bin qui pointe vers le sous-répertoire bin du profil.
--save-provenance
Sauvegarder les informations de provenance des paquets passés sur la ligne de commande. Les informations de provenance contiennent l’URL et le commit des canaux utilisés (voir Canaux).
Les informations de provenance sont sauvegardées dans le fichier /gnu/store/…-profile/manifest du pack, avec les métadonnées de paquets habituelles — le nom et la version de chaque paquet, leurs entrées propagées, etc. Ce sont des informations utiles pour le destinataire du pack, qui sait alors comment le pack a (normalement) été obtenu.
Cette option n’est pas activée par défaut car, comme l’horodatage, les informations de provenance ne contribuent en rien au processus de construction. En d’autres termes, il y a une infinité d’URL et d’ID de commit qui permettent d’obtenir le même pack. Enregistrer de telles métadonnées « silencieuses » dans la sortie casse donc éventuellement la propriété de reproductibilité au bit près.
--root=fichier
¶-r fichier
Fait de fichier un lien symbolique vers le résultat, et l’enregistre en tant que racine du ramasse-miettes.
--localstatedir
--profile-name=nom
Inclus le « répertoire d’état local », /var/guix, dans le lot qui en
résulte, et notamment le profil
/var/guix/profiles/per-user/root/nom — par défaut nom est
guix-profile
, ce qui correspond à ~root/.guix-profile.
/var/guix contient la base de données du dépôt (voir Le dépôt)
ainsi que les racines du ramasse-miettes (voir Invoquer guix gc
). Le
fournir dans le pack signifie que le dépôt et « complet » et gérable par
Guix ; ne pas le fournir dans le pack signifie que le dépôt est « mort » :
aucun élément ne peut être ajouté ni enlevé après l’extraction du pack.
Un cas d’utilisation est l’archive binaire indépendante de Guix (voir Installation binaire).
--derivation
-d
Affiche le nom de la dérivation que le pack construit.
--bootstrap
Utiliser les programmes d’amorçage pour construire le pack. Cette option n’est utile que pour les personnes qui développent Guix.
En plus, guix pack
supporte toutes les options de construction
communes (voir Options de construction communes) et toutes les options de
transformation de paquets (voir Options de transformation de paquets).
Suivant: Invoquer guix git authenticate
, Précédent: Invoquer guix pack
, Monter: Développement [Table des matières][Index]
Guix offre des paquets de compilateurs individuels comme gcc
mais si
vous avez besoin d’une chaîne de compilation complète pour compiler et lier
du code source, utilisez le paquet gcc-toolchain
. Ce paquet fournit
une chaîne d’outils complète GCC pour le développement C/C++, dont GCC
lui-même, la bibliothèque C de GNU (les en-têtes et les binaires, plus les
symboles de débogage dans la sortie debug
), Binutils et un wrapper
pour l’éditeur de liens.
Le rôle de l’enveloppe est d’inspecter les paramètres -L
et -l
passés à l’éditeur de liens, d’ajouter des arguments -rpath
correspondants et d’invoquer l’actuel éditeur de liens avec ce nouvel
ensemble d’arguments. Vous pouvez dire au wrapper de refuser de lier les
programmes à des bibliothèques en dehors du dépôt en paramétrant la variable
d’environnement GUIX_LD_WRAPPER_ALLOW_IMPURITIES
sur no
.
Le paquet gfortran-toolchain
fournit une chaîne d’outils GCC complète
pour le développement en Fortran. Pour d’autres langages, veuillez utiliser
‘guix search gcc toolchain’ (voir Invoquer guix
package).
Précédent: La chaîne d’outils GCC, Monter: Développement [Table des matières][Index]
guix git authenticate
La commande guix git authenticate
authentifie un checkout Git en
suivant la même règle que pour les canaux (voir channel authentication). C’est-à-dire qu’à partir d’un commit donné, il
s’assure que tous les commit suivants sont signés par une clé OpenPGP dont
l’empreinte digitale apparaît dans le fichier .guix-authorizations de
son ou ses commit(s) parent(s).
Vous allez trouver cette commande utile si vous maintenez un canal. Mais en fait, ce mécanisme d’authentification est utile dans un contexte plus large, Vous pourriez donc vouloir l’utiliser pour des dépôts Git qui n’ont rien à voir avec Guix.
La syntaxe générale est :
guix git authenticate commit signer [options…]
By default, this command authenticates the Git checkout in the current directory; it outputs nothing and exits with exit code zero on success and non-zero on failure. commit above denotes the first commit where authentication takes place, and signer is the OpenPGP fingerprint of public key used to sign commit. Together, they form a channel introduction (voir channel introduction). On your first successful run, the introduction is recorded in the .git/config file of your checkout, allowing you to omit them from subsequent invocations:
guix git authenticate [options…]
Should you have branches that require different introductions, you can
specify them directly in .git/config. For example, if the branch
called personal-fork
has a different introduction than other
branches, you can extend .git/config along these lines:
[guix "authentication-personal-fork"] introduction-commit = cabba936fd807b096b48283debdcddccfea3900d introduction-signer = C0FF EECA BBA9 E6A8 0D1D E643 A2A0 6DF2 A33A 54FA keyring = keyring
The first run also attempts to install pre-push and post-merge hooks, such
that guix git authenticate
is invoked as soon as you run
git push
, git pull
, and related commands; it does not
overwrite preexisting hooks though.
The command-line options described below allow you to fine-tune the process.
--repository=répertoire
-r répertoire
Ouvre le dépôt Git dans directory au lieu du répertoire courant.
--keyring=référence
-k féférence
Chargez le porte-clés OpenPGP à partir de référence, la référence
d’une branche telle que origin/keyring
ou my-keyring
. La
branche doit contenir des clés publiques OpenPGP dans des fichiers
.key, soit sous forme binaire, soit "blindée ASCII". Par défaut, le
porte-clés est chargé à partir de la branche nommée keyring
.
--end=commit
Authenticate revisions up to commit.
--stats
Affiche les statistiques sur les signatures de commits à l’issue de la procédure.
--cache-key=key
Les commits préalablement authentifiés sont mis en cache dans un fichier sous ~/.cache/guix/authentication. Cette option force le cache à être stocké dans le fichier key de ce répertoire.
--historical-authorizations=fichier
Par défaut, tout commit dont le(s) commit(s) parent(s) ne contient(nt) pas le fichier .guix-authorizations est considéré comme non authentique. En revanche, cette option considère les autorisations dans file pour tout commit dont le fichier .guix-authorizations est manquant. Le format de file est le même que celui de .guix-authorizations (au format voir .guix-autorizations).
Suivant: Utilitaires, Précédent: Développement, Monter: GNU Guix [Table des matières][Index]
GNU Guix fournit diverses interface de programmation Scheme (API) qui pour définir, construire et faire des requêtes sur des paquets. La première interface permet aux utilisateurs d’écrire des définitions de paquets de haut-niveau. Ces définitions se réfèrent à des concepts de création de paquets familiers, comme le nom et la version du paquet, son système de construction et ses dépendances. Ces définitions peuvent ensuite être transformées en actions concrètes lors de la construction.
Les actions de construction sont effectuées par le démon Guix, pour le compte des utilisateur·rice·s. Dans un environnement standard, le démon possède les droits en écriture sur le dépôt — le répertoire /gnu/store — mais pas les utilisateur·rice·s. La configuration recommandée permet aussi au démon d’effectuer la construction dans des chroots, à l’adresse des utilisateur·rice·s de construction spécifiques, pour minimiser les interférences avec le reste du système.
Il y a des API de plus bas niveau pour interagir avec le démon et le dépôt. Pour demander au démon d’effectuer une action de construction, les utilisateurs lui donnent en fait une dérivation. Une dérivation est une représentation à bas-niveau des actions de construction à entreprendre et l’environnement dans lequel elles devraient avoir lieu — les dérivations sont aux définitions de paquets ce que l’assembleur est aux programmes C. Le terme de « dérivation » vient du fait que les résultats de la construction en dérivent.
This chapter describes all these APIs in turn, starting from high-level package definitions. Voir Source Tree Structure, for a more general overview of the source code.
guix repl
Suivant: Définition des paquets, Monter: Interface de programmation [Table des matières][Index]
D’un point de vue programmatique, les définitions de paquets de la
distribution GNU sont fournies par des modules Guile dans l’espace de noms
(gnu packages …)
19 (voir Guile modules dans GNU Guile Reference
Manual). Par exemple, le module (gnu packages emacs)
exporte une
variable nommée emacs
, qui est liée à un objet <package>
(voir Définition des paquets).
L’espace de nom (gnu packages …)
est automatiquement scanné par
les outils en ligne de commande. Par exemple, lorsque vous lancez
guix install emacs
, tous les modules (gnu packages …)
sont scannés jusqu’à en trouver un qui exporte un objet de paquet dont le
nom est emacs
. Cette capacité à chercher des paquets est implémentée
dans le module (gnu packages)
.
Les utilisateur·rice·s peuvent stocker les définitions de paquets dans des
modules ayant des noms différents—par exemple, (my-packages
emacs)
20. Il y a deux façons de rendre ces définitions de
paquets visibles pour les interfaces utilisateur·rice :
-L
de guix package
et des autres
commandes (voir Options de construction communes) ou en indiquant la variable
d’environnement GUIX_PACKAGE_PATH
décrite plus bas.
guix pull
pour
qu’il l’utilise. Un canal est en substance un dépôt Git contenant des
modules de paquets. Voir Canaux, pour plus d’informations sur comment
définir et utiliser des canaux.
GUIX_PACKAGE_PATH
fonctionne comme les autres variables de chemins de
recherche :
C’est une liste séparée par des deux-points de répertoires dans lesquels trouver des modules de paquets supplémentaires. Les répertoires listés dans cette variable sont prioritaires par rapport aux paquets de la distribution.
La distribution est entièrement bootstrappée et auto-contenue :
chaque paquet est construit uniquement à partir d’autres paquets de la
distribution. La racine de ce graphe de dépendance est un petit ensemble de
binaires de bootstrap fournis par le module (gnu packages
bootstrap)
. Pour plus d’informations sur le bootstrap,
voir Bootstrapping.
Suivant: Définition de variantes de paquets, Précédent: Modules de paquets, Monter: Interface de programmation [Table des matières][Index]
L’interface de haut-niveau pour les définitions de paquets est implémentée
dans les modules (guix packages)
et (guix build-system)
. Par
exemple, la définition du paquet, ou la recette, du paquet GNU Hello
ressemble à cela :
(define-module (gnu packages hello) #:use-module (guix packages) #:use-module (guix download) #:use-module (guix build-system gnu) #:use-module (guix licenses) #:use-module (gnu packages gawk)) (define-public hello (package (name "hello") (version "2.10") (source (origin (method url-fetch) (uri (string-append "mirror://gnu/hello/hello-" version ".tar.gz")) (sha256 (base32 "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i")))) (build-system gnu-build-system) (arguments '(#:configure-flags '("--enable-silent-rules"))) (inputs (list gawk)) (synopsis "Hello, GNU world: An example GNU package") (description "Guess what GNU Hello prints!") (home-page "https://www.gnu.org/software/hello/") (license gpl3+)))
Sans être expert·e en Scheme, on peut comprendre la signification des
différents champs présents. Cette expression lie la variable hello
à
un objet <package>
, qui est en substance un enregistrement
(voir Scheme records dans GNU Guile Reference Manual). On
peut inspecter cet objet de paquet avec les procédures qui se trouvent dans
le module (guix packages)
; par exemple, (package-name hello)
renvoie — ô surprise ! — "hello"
.
Avec un peu de chance, vous pourrez importer tout ou partie de la définition
du paquet qui vous intéresse depuis un autre répertoire avec la commande
guix import
(voir Invoquer guix import
).
Dans l’exemple précédent, hello
est défini dans un module à part,
(gnu packages hello)
. Techniquement, cela n’est pas strictement
nécessaire, mais c’est pratique : tous les paquets définis dans des modules
sous (gnu packages …)
sont automatiquement connus des outils en
ligne de commande (voir Modules de paquets).
Il y a quelques points à remarquer dans la définition de paquet précédente :
source
du paquet est un objet <origin>
(voir Référence de origin
, pour la référence complète). Ici, on utilise la méthode
url-fetch
de (guix download)
, ce qui signifie que la source
est un fichier à télécharger par FTP ou HTTP.
Le préfixe mirror://gnu
demande à url-fetch
d’utiliser l’un
des miroirs GNU définis dans (guix download)
.
Le champ sha256
spécifie le hash SHA256 attendu pour le fichier
téléchargé. Il est requis et permet à Guix de vérifier l’intégrité du
fichier. La forme (base32 …)
introduit a représentation en
base32 du hash. Vous pouvez obtenir cette information avec guix
download
(voir Invoquer guix download
) et guix hash
(voir Invoquer guix hash
).
Lorsque cela est requis, la forme origin
peut aussi avec un champ
patches
qui liste les correctifs à appliquer et un champ
snippet
qui donne une expression Scheme pour modifier le code source.
build-system
spécifie la procédure pour construire le paquet
(voir Systèmes de construction). Ici, gnu-build-system
représente le système
de construction GNU familier, où les paquets peuvent être configurés,
construits et installés avec la séquence ./configure && make && make
check && make install
habituelle.
Lorsque vous commencez à empaqueter des logiciels non triviaux, vous pouvez avoir besoin d’outils pour manipuler ces phases de construction, manipuler des fichiers, etc. Voir Utilitaires de construction, pour en savoir plus.
arguments
spécifie des options pour le système de
construction (voir Systèmes de construction). Ici il est interprété par
gnu-build-system
comme une demande de lancer configure avec le
tag --enable-silent-rules.
Que sont ces apostrophes ('
) ? C’est de la syntaxe Scheme pour
introduire une liste ; '
est synonyme de la fonction quote
.
Parfois vous verrez aussi `
(un accent grave synonyme de
quasiquote
) et ,
(une virgule, synonyme de unquote
).
Voir quoting dans GNU Guile Reference Manual, pour
des détails. Ice la valeur du champ arguments
est une liste
d’arguments passés au système de construction plus tard, comme avec
apply
(voir apply
dans GNU Guile
Reference Manual).
La séquence dièse-deux-points (#:
) définie un mot-clef Scheme
(voir Keywords dans GNU Guile Reference Manual), et
#:configure-flags
est un mot-clef utilisé pour passer un argument au
système de construction (voir Coding With Keywords dans GNU Guile
Reference Manual).
inputs
spécifie les entrées du processus de construction —
c.-à-d. les dépendances à la construction ou à l’exécution du paquet.
Ici, nous ajoutons en entrée une référence à la variable gawk
;
gawk
est lui-même lié à un objet <package>
.
Remarquez que GCC, Coreutils, Bash et les autres outils essentiels n’ont pas
besoin d’être spécifiés en tant qu’entrées ici. À la place, le
gnu-build-system
est en mesure de s’assurer qu’ils sont présents
(voir Systèmes de construction).
Cependant, toutes les autres dépendances doivent être spécifiées dans le
champ inputs
. Toute dépendance qui ne serait pas spécifiée ici sera
simplement indisponible pour le processus de construction, ce qui peut mener
à un échec de la construction.
Voir Référence de package
, pour une description complète des champs
possibles.
Pour aller plus loin : Vous vous sentez intimidé·e par le langage Scheme ou vous êtes curieux·se de le découvrir ? Le livre de recettes a une petite section pour démarrer qui résume une partie de ce qui a été montré au-dessus et explique les bases. Voir Cours accéléré du langage Scheme dans le livre de recettes de GNU Guix, pour plus d’information.
Lorsqu’une définition de paquet est en place, le paquet peut enfin être
construit avec l’outil en ligne de commande guix build
(voir Invoquer guix build
), pour résoudre les échecs de construction que
vous pourriez rencontrer (voir Débogage des échecs de construction). Vous pouvez
aisément revenir à la définition du paquet avec la commande guix
edit
(voir Invoquer guix edit
). Voir Consignes d’empaquetage, pour plus
d’informations sur la manière de tester des définitions de paquets et
Invoquer guix lint
, pour des informations sur la manière de vérifier
que la définition respecte les conventions de style.
Enfin, voir Canaux pour des informations sur la manière d’étendre la
distribution en ajoutant vos propres définitions de paquets dans un « canal
».
Finalement, la mise à jour de la définition du paquet à une nouvelle version
amont peut en partie s’automatiser avec la commande guix refresh
(voir Invoquer guix refresh
).
Sous le capot, une dérivation qui correspond à un objet <package>
est
d’abord calculé par la procédure package-derivation
. Cette
dérivation est stockée dans un fichier .drv dans /gnu/store.
Les actions de construction qu’il prescrit peuvent ensuite être réalisées
par la procédure build-derivation
(voir Le dépôt).
Renvoie l’objet <derivation>
du paquet pour le système
(voir Dérivations).
paquet doit être un objet <package>
valide et système une
chaîne indiquant le type de système cible — p. ex. "x86_64-linux"
pour un système GNU x86_64 basé sur Linux. dépôt doit être une
connexion au démon, qui opère sur les dépôt (voir Le dépôt).
De manière identique, il est possible de calculer une dérivation qui effectue une compilation croisée d’un paquet pour un autre système :
Renvoie l’objet <derivation>
du paquet construit depuis
système pour cible.
cible doit être un triplet GNU valide indiquant le matériel cible et
le système d’exploitation, comme "aarch64-linux-gnu"
(voir Specifying Target Triplets dans Autoconf).
Une fois qu’on a une définition de paquet, on peut facilement définir des variantes du paquet. Voir Définition de variantes de paquets, pour plus d’informations.
Suivant: Référence de origin
, Monter: Définition des paquets [Table des matières][Index]
package
Cette section résume toutes les options disponibles dans les déclarations
package
(voir Définition des paquets).
C’est le type de donnée représentant une recette de paquets.
name
Le nom du paquet, comme une chaîne de caractères.
version
La version du paquet, comme une chaine de caractères. Voir Numéros de version, pour un guide.
source
Un objet qui indique comment le code source du paquet devrait être
récupéré. La plupart du temps, c’est un objet origin
qui indique un
fichier récupéré depuis internet (voir Référence de origin
). Il peut aussi
s’agir de tout autre objet « simili-fichier » comme un local-file
qui
indique un fichier du système de fichier local (voir local-file
).
build-system
Le système de construction qui devrait être utilisé pour construire le paquet (voir Systèmes de construction).
arguments
(par défaut : '()
)Les arguments à passer au système de construction (voir Systèmes de construction). C’est une liste qui contient typiquement une séquence de paires de clefs-valeurs, comme dans cet exemple :
(package
(name "exemple")
;; plusieurs champs omis
(arguments
(list #:tests? #f ;passer les tests
#:make-flags #~'("VERBOSE=1") ;passer les arguments à « make »
#:configure-flags #~'("--enable-frobbing"))))
L’ensemble exact des mots-clés pris en charge dépend du système de
construction (voir Systèmes de construction), mais vous trouverez qu’ils prennent
presque tous en compte #:configure-flags
, #:make-flags
,
#:tests?
et #:phases
. Le mot-clé #:phases
en
particulier vous permet de modifier l’ensemble des phases de construction
pour votre paquet (voir Phases de construction).
The REPL has dedicated commands to interactively inspect values of some of these arguments, as a convenient debugging aid (voir Utiliser Guix de manière interactive).
Notes de compatibilité : Until version 1.3.0, the
arguments
field would typically usequote
('
) orquasiquote
(`
) and no G-expressions, like so:(package ;; several fields omitted (arguments ;old-style quoted arguments '(#:tests? #f #:configure-flags '("--enable-frobbing"))))
To convert from that style to the one shown above, you can run
guix style -S arguments package
(voir Invoquerguix style
).
inputs
(par défaut : '()
) ¶native-inputs
(par défaut : '()
)propagated-inputs
(par défaut : '()
)Ces champs listent les dépendances du paquet. Chacune de ces listes est soit un paquet, une origine ou un autre « objet simili-fichier » (voir G-Expressions) ; pour spécifier la sortie de cet objet simili-fichier à utiliser, passez une liste à deux éléments où le second élément est la sortie (voir Des paquets avec plusieurs résultats, pour plus d’informations sur les sorties des paquets). Par exemple, la liste suivante spécifie trois entrées :
(list libffi libunistring `(,glib "bin")) ;la sortie « bin » de GLib
Dans l’exemple au-dessus, on utilise la sortie "out"
de libffi
et de libunistring
.
Notes de compatibilité : Jusqu’à la version 1.3.0, les listes d’entrées étaient des listes de tuples, où chaque tuple a une étiquette pour une entrée (une chaîne de caractères) comme premier élément, un paquet, une origine ou une dérivation comme deuxième élément et éventuellement le nom d’une sortie à utiliser qui est
"out"
par défaut. Par exemple, la liste ci-dessous est équivalente à celle au-dessus, mais utilise l’ancien style d’entrées :;; Ancien style d'entrées (obsolète) `(("libffi" ,libffi) ("libunistring" ,libunistring) ("glib:bin" ,glib "bin")) ;la sortie "bin" de GlibCe style est maintenant obsolète ; il est toujours pris en charge mais la prise en charge sera supprimée dans une future version. Vous ne devriez pas l’utiliser pour de nouvelles définitions de paquets. Voir Invoquer
guix style
, pour apprendre à migrer vers le nouveau style.
La distinction entre native-inputs
et inputs
est nécessaire
lorsqu’on considère la compilation croisée. Lors d’une compilation croisée,
les dépendances listées dans inputs
sont construites pour
l’architecture cible ; inversement, les dépendances listées dans
native-inputs
sont construites pour l’architecture de la machine de
construction.
native-inputs
est typiquement utilisé pour lister les outils requis à
la construction mais pas à l’exécution, comme Autoconf, Automake,
pkg-config, Gettext ou Bison. guix lint
peut rapporter des
erreurs de ce type (voir Invoquer guix lint
).
Enfin, propagated-inputs
est similaire à inputs
, mais les
paquets spécifiés seront automatiquement installés sur les profils
(voir le rôle des profils dans Guix) à côté du paquet auquel
ils appartiennent (voir guix
package
, pour savoir comment guix package
traite les entrées
propagées).
Par exemple, cela est nécessaire lors de l’empaquetage d’une bibliothèque
C/C++ qui a besoin des en-têtes d’une autre bibliothèque pour se compiler,
ou lorsqu’un fichier pkg-config fait référence à un autre via son champ
Requires
.
Un autre exemple où le propagated-inputs
est utile, c’est pour les
langues qui ne disposent pas de la possibilité d’enregistrer le chemin de
recherche à l’exécution comme le RUNPATH
des fichiers ELF ; cela
inclut Guile, Python, Perl, et plus encore. Lors de l’empaquetage de
bibliothèques écrites dans ces langages, assurez-vous qu’elles peuvent
trouver le code de bibliothèque dont elles dépendent au moment de
l’exécution en listant les dépendances d’exécution dans
propagated-inputs
plutôt que inputs
.
outputs
(par défaut : '("out")
)La liste des noms de sorties du paquet. Voir Des paquets avec plusieurs résultats, pour des exemples typiques d’utilisation de sorties supplémentaires.
native-search-paths
(par défaut : '()
)search-paths
(par défaut : '()
)Une liste d’objets search-path-specification
décrivant les variables
d’environnement de recherche de chemins que ce paquet prend en
compte. Voir Chemins de recherche, pour plus de détails sur les spécifications de
chemins de recherche.
Comme pour les entrées, la distinction entre native-search-paths
et
search-paths
n’est importante que pour la compilation croisée. Lors
d’une compilation croisée, native-search-paths
ne s’applique qu’aux
entrées natives alors que search-paths
ne s’applique qu’aux entrées
hôtes.
Les paquets comme les compilateurs croisées font attention aux entrées de la
cible — par exemple notre compilateur GCC croisé (modifié) a
CROSS_C_INCLUDE_PATH
dans search-paths
, ce qui lui permet de
trouver les fichiers .h du système cible et pas ceux des
entrées natives. Pour la plupart des paquets cependant, seul
native-search-paths
a du sens.
replacement
(par défaut : #f
)Ce champ doit être soit #f
soit un objet de paquet qui sera utilisé
comme remplaçant de ce paquet. Voir grafts, pour
plus de détails.
synopsis
Une description sur une ligne du paquet.
description
Une description plus détaillée du paquet, en tant que chaine au format Texinfo.
license
¶La licence du paquet ; une valeur tirée de (guix licenses)
ou une
liste de ces valeurs.
home-page
L’URL de la page d’accueil du paquet, en tant que chaîne de caractères.
supported-systems
(par défaut : %supported-systems
)La liste des systèmes supportés par le paquet, comme des chaînes de
caractères de la forme architecture-noyau
, par exemple
"x86_64-linux"
.
location
(par défaut : emplacement de la source de la forme package
)L’emplacement de la source du paquet. C’est utile de le remplacer lorsqu’on hérite d’un autre paquet, auquel cas ce champ n’est pas automatiquement corrigé.
Lorsque vous l’utilisez dans la portée lexicale du champ d’une définition de paquet, cet identifiant est résolu comme étant le paquet définit.
L’exemple ci-dessous montre l’ajout d’un paquet comme entrée native de lui-même pour la compilation croisée :
(package
(name "guile")
;; ...
;; Lors de la compilation croisée, Guile par exemple dépend
;; d'une version native de lui-même. On l'ajoute ici.
(native-inputs (if (%current-target-system)
(list this-package)
'())))
C’est une erreur que de se référer à this-package
en dehors de la
définition d’un paquet.
Les procédures auxiliaires suivantes vous aideront à utiliser les entrées des paquets.
Cherche name dans les entrées de package (ou les entrées
natives, propagées ou directes). Renvoie l’entrée si elle la trouve, et
#f
sinon.
name est le nom d’un paquet de dépendance. Voici comment vous pouvez l’utiliser :
(use-modules (guix packages) (gnu packages base)) (lookup-package-direct-input coreutils "gmp") ⇒ #<package gmp@6.2.1 …>
Dans cet exemple, on obtient le paquet gmp
qui fait partie des
entrées directes de coreutils
.
Parfois vous voudrez obtenir la liste des entrées requises pour
développer un paquet — toutes les entrées visibles quand le paquet
est compilé. C’est ce que la procédure package-development-inputs
renvoie.
Renvoie la liste des entrées requises par package pour le
développement sur system. Lorsque target est vrai, les entrées
renvoyées sont celles requises pour la compilation croisée de package
de system vers target, où target est un triplet comme
"aarch64-linux-gnu"
.
Remarquez que le résultat inclus à la fois les entrées explicites et
implicites — les entrées ajoutées automatiquement par le système de
construction (voir Systèmes de construction). Prenons le paquet hello
pour
illustrer :
(use-modules (gnu packages base) (guix packages)) hello ⇒ #<package hello@2.10 gnu/packages/base.scm:79 7f585d4f6790> (package-direct-inputs hello) ⇒ () (package-development-inputs hello) ⇒ (("source" …) ("tar" #<package tar@1.32 …>) …)
Dans cet exemple, package-direct-inputs
renvoie la liste vide, parce
que hello
n’a pas de dépendance explicite. À l’inverse,
package-development-inputs
inclut les entrées implicites ajoutées par
gnu-build-system
qui sont requises pour construire hello
:
tar, gzip, GCC, libc, Bash et d’autres. Pour les visualiser, guix
graph hello
montrerait les entrées explicites, alors que guix
graph -t bag hello
inclurait les entrées implicites (voir Invoque guix graph
).
Comme les paquets sont des objets Scheme réguliers qui capturent un graphe de dépendance complet et les procédures de construction associées, il est souvent utile d’écrire des procédures qui prennent un paquet et renvoient une version modifiée de celui-ci en fonction de certains paramètres. En voici quelques exemples.
Renvoie une variante de package qui utilise toolchain au lieu de
la chaîne d’outils GNU C/C++ par défaut. toolchain doit être une
liste d’entrées (tuples label/package) fournissant une fonctionnalité
équivalente, comme le paquet gcc-toolchain
.
L’exemple ci-dessous renvoie une variante du paquet hello
construit
avec GCC 10.x et le reste de la chaîne d’outils GNU (Binutils et la
bibliothèque C GNU) au lieu de la chaîne d’outils par défaut :
(let ((toolchain (specification->package "gcc-toolchain@10")))
(package-with-c-toolchain hello `(("toolchain" ,toolchain))))
La chaîne d’outils de construction fait partie des entrées implicites des paquets— elle n’est généralement pas listée comme faisant partie des différents champs "entrées" et est à la place récupérée par le système de construction. Par conséquent, cette procédure fonctionne en modifiant le système de compilation de paquet de sorte qu’il utilise toolchain au lieu des valeurs par défaut. Systèmes de construction, pour en savoir plus sur les systèmes de construction.
Précédent: Référence de package
, Monter: Définition des paquets [Table des matières][Index]
origin
Cette section documente origins. Une déclaration origin
spécifie les données qui doivent être "produites" – téléchargées,
généralement – et dont le contenu est connu à l’avance. Les origines sont
principalement utilisées pour représenter le code source des paquets
(voir Définition des paquets). Pour cette raison, le formulaire origin
permet de déclarer des correctifs à appliquer au code source original ainsi
que des bribes de code pour le modifier.
C’est le type de donnée qui représente l’origine d’un code source.
uri
Un objet contenant l’URI de la source. Le type d’objet dépend de la
method
(voir plus bas). Par exemple, avec la méthode url-fetch
de (guix download)
, les valeurs valide d’uri
sont : une URL
représentée par une chaîne de caractères, ou une liste de chaînes de
caractères.
method
Une procédure monadique qui gère l’URI donné. La procédure doit accepter au
moins trois arguments : la valeur du champ uri
et l’algorithme de
hachage et la valeur de hachage spécifiée par le champ hash
. Elle
doit renvoyer un élément du dépôt ou une dérivation dans la monade du dépôt
(voir La monade du dépôt) ; la plupart des méthodes renvoient une dérivation
à sortie fixe (voir Dérivations).
Les méthodes couramment utilisées comprennent url-fetch
, qui récupère
les données à partir d’une URL, et git-fetch
, qui récupère les
données à partir d’un dépôt Git (voir ci-dessous).
sha256
Un bytevector contenant le hachage SHA-256 de la source. Cela équivaut à
fournir un content-hash
Objet SHA256 dans le champ hash
décrit
ci-dessous.
hash
L’objet content-hash
de la source–voir ci-dessous pour savoir
comment utiliser content-hash
.
Vous pouvez obtenir cette information avec guix download
(voir Invoquer guix download
) ou guix hash
(voir Invoquer guix hash
).
file-name
(par défaut : #f
)Le nom de fichier à utiliser pour sauvegarder le fichier. Lorsqu’elle est à
#f
, une valeur par défaut raisonnable est utilisée dans la plupart
des cas. Dans le cas où la source est récupérée depuis une URL, le nom de
fichier est celui de l’URL. Pour les sources récupérées depuis un outil de
contrôle de version, il est recommandé de fournir un nom de fichier
explicitement parce que le nom par défaut n’est pas très descriptif.
patches
(par défaut : '()
)Une liste de noms de fichiers, d’origines ou d’objets simili-fichiers (voir file-like objects) qui pointent vers des correctifs à appliquer sur la source.
Cette liste de correctifs doit être inconditionnelle. En particulier, elle
ne peut pas dépendre des valeurs de %current-system
ou
%current-target-system
.
snippet
(par défaut : #f
)Une G-expression (voir G-Expressions) ou une S-expression qui sera lancée dans le répertoire des sources. C’est une manière pratique de modifier la source, parfois plus qu’un correctif.
patch-flags
(par défaut : '("-p1")
)Une liste de drapeaux à passer à la commande patch
.
patch-inputs
(par défaut : #f
)Paquets d’entrées ou dérivations pour le processus de correction.
Lorsqu’elle est à #f
, l’ensemble d’entrées habituellement nécessaire
pour appliquer des correctifs est fournit, comme GNU Patch.
modules
(par défaut : '()
)Une liste de modules Guile qui devraient être chargés pendant le processus
de correction et pendant que le lancement du code du champ snippet
.
patch-guile
(par défaut : #f
)Le paquet Guile à utiliser dans le processus de correction. Lorsqu’elle est
à #f
, une valeur par défaut raisonnable est utilisée.
Construire un objet de hash de contenu pour l’algorithme donné, et
avec valeur comme valeur de hachage. Lorsque algorithme est
omis, on suppose qu’il s’agit de sha256
.
value peut être une chaîne littérale, auquel cas elle est décodée en base32, ou il peut s’agir d’un bytevecteur.
Les options suivantes sont équivalentes :
(content-hash "05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj") (content-hash "05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj" sha256) (content-hash (base32 "05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj")) (content-hash (base64 "kkb+RPaP7uyMZmu4eXPVkM4BN8yhRd8BTHLslb6f/Rc=") sha256)
Techniquement, le content-hash
est actuellement mis en œuvre sous
forme de macro. Il effectue des contrôles de bon sens au moment de
l’expansion de la macro, lorsque cela est possible, en s’assurant par
exemple que valeur a la bonne taille pour algorithme.
Comme nous l’avons vu plus haut, la manière dont les données auxquelles une
origine se réfère exactement sont récupérées est déterminée par son champ
method
. Le module (guix download)
fournit la méthode la plus
courante, url-fetch
, décrite ci-dessous.
Renvoie une dérivation à sortie fixe qui récupère les données de url (une chaîne de caractères, ou une liste de chaînes de caractères désignant des URLs alternatives), qui est censée avoir un hash hash de type hash-algo (un symbole). Par défaut, le nom du fichier est le nom de base de l’URL ; en option, nom peut spécifier un nom de fichier différent. Lorsque executable? est vrai, rendez le fichier téléchargé exécutable.
Lorsque l’une des URL commence par mirror://
, sa partie hôte est
alors interprétée comme le nom d’un schéma de miroir, tiré de
%mirror-file.
Alternativement, lorsque l’URL commence par file://
, renvoie le nom
du fichier correspondant dans le dépôt.
De même, le module (guix git-download)
définit la méthode d’origine
git-download
, qui récupère les données d’un dépôt de contrôle de
version Git, et le type de données git-reference
pour décrire le
dépôt et la révision à récupérer.
Renvoie une dérivation à sortie fixe qui va chercher ref, un objet
<git-reference>
. La sortie est censée avoir un hash récursif
hash de type hash-algo (un symbole). Utilisez name comme
nom de fichier, ou un nom générique si #f
.
This is a variant of the git-fetch
procedure that supports the Git
LFS (Large File Storage) extension. This may be useful to pull
some binary test data to run the test suite of a package, for example.
Ce type de données représente une référence Git pour le git-fetch
à
récupérer.
url
L’URL du dépôt Git à cloner.
commit
Cette chaîne indique soit le commit à récupérer (une chaîne hexadécimale),
soit le tag à récupérer. Vous pouvez aussi utiliser une chaîne de commit «
courte » ou un identifiant dans le style de git describe
comme
v1.0.1-10-g58d7909c97
.
recursive?
(par défaut : #f
)Ce booléen indique s’il faut aller chercher récursivement les sous-modules de Git.
L’exemple ci-dessous indique la balise v2.10
du dépôt GNU Hello
:
(git-reference
(url "https://git.savannah.gnu.org/git/hello.git")
(commit "v2.10"))
C’est équivalent à la référence ci-dessous, qui nomme explicitement le commit :
(git-reference
(url "https://git.savannah.gnu.org/git/hello.git")
(commit "dc7dc56a00e48fe6f231a58f6537139fe2908fb9"))
Pour les dépôts Mercurial, le module (guix hg-download)
définit la
méthode d’origine hg-download
et le type de données
hg-reference
pour la prise en charge du système de contrôle de
version Mercurial.
Return a fixed-output derivation that fetches ref, a
<hg-reference>
object. The output is expected to have recursive hash
hash of type hash-algo (a symbol). Use name as the file
name, or a generic name if #f
.
This data type represents a Mercurial reference for hg-fetch
to
retrieve.
url
The URL of the Mercurial repository to clone.
changeset
This string denotes changeset to fetch.
For Subversion repositories, the module (guix svn-download)
defines
the svn-fetch
origin method and svn-reference
data type for
support of the Subversion version control system.
Renvoie une dérivation à sortie fixe qui va chercher ref, un objet
<svn-reference>
. La sortie est censée avoir un hash récursif
hash de type hash-algo (un symbole). Utilisez name comme
nom de fichier, ou un nom générique si #f
.
This data type represents a Subversion reference for svn-fetch
to
retrieve.
url
The URL of the Subversion repository to clone.
revision
This string denotes revision to fetch specified as a number.
recursive?
(par défaut : #f
)This Boolean indicates whether to recursively fetch Subversion “externals”.
user-name
(default: #f
)The name of an account that has read-access to the repository, if the repository isn’t public.
password
(par défaut : #f
)Password to access the Subversion repository, if required.
For Bazaar repositories, the module (guix bzr-download)
defines the
bzr-fetch
origin method and bzr-reference
data type for
support of the Bazaar version control system.
Renvoie une dérivation à sortie fixe qui va chercher ref, un objet
<bzr-reference>
. La sortie est censée avoir un hash récursif
hash de type hash-algo (un symbole). Utilisez name comme
nom de fichier, ou un nom générique si #f
.
This data type represents a Bazaar reference for bzr-fetch
to
retrieve.
url
The URL of the Bazaar repository to clone.
revision
This string denotes revision to fetch specified as a number.
For CVS repositories, the module (guix cvs-download)
defines the
cvs-fetch
origin method and cvs-reference
data type for
support of the Concurrent Versions System (CVS).
Renvoie une dérivation à sortie fixe qui va chercher ref, un objet
<cvs-reference>
. La sortie est censée avoir un hash récursif
hash de type hash-algo (un symbole). Utilisez name comme
nom de fichier, ou un nom générique si #f
.
This data type represents a CVS reference for cvs-fetch
to retrieve.
root-directory
The CVS root directory.
module
Module to fetch.
revision
Revision to fetch.
The example below denotes a version of gnu-standards to fetch:
(cvs-reference
(root-directory ":pserver:anonymous@cvs.savannah.gnu.org:/sources/gnustandards")
(module "gnustandards")
(revision "2020-11-25"))
Suivant: Écrire un manifeste, Précédent: Définition des paquets, Monter: Interface de programmation [Table des matières][Index]
L’une des choses intéressantes avec Guix est qu’à partir d’une définition, on peut facilement dériver des variantes du paquet — pour une version en amont différente, avec des dépendances différentes, des options de compilation différentes, etc. Certains de ces paquets personnalisés peuvent être définis directement par la ligne de commande (voir Options de transformation de paquets). Cette section décrit comment définir des variantes de paquets avec du code. Cela est utile dans les « manifestes » (voir Écrire un manifeste) et dans votre propre collection de paquets (voir Écrire de nouveaux de canaux), entre autres choses !
Comme nous en avons parlé plus tôt, les paquets sont des objets de première
classe dans le langage Scheme. Le module (guix packages)
fournit la
construction package
pour définir de nouveaux objets de paquets
(voir Référence de package
). La manière la plus simple de définir la
variante d’un paquet est d’utiliser le mot-clé inherit
avec
package
. Cela vous permet d’hériter la définition d’un paquet tout
en redéfinissant les champs que vous voulez.
Par exemple, étant donné la variable hello
, qui contient la
définition d’une version récente de GNU Hello, voici comment définir
une variante pour la version 2.2 (publiée en 2006, c’est vintage !) :
(use-modules (gnu packages base)) ;pour 'hello' (define hello-2.2 (package (inherit hello) (version "2.2") (source (origin (method url-fetch) (uri (string-append "mirror://gnu/hello/hello-" version ".tar.gz")) (sha256 (base32 "0lappv4slgb5spyqbh6yl5r013zv72yqg2pcl30mginf3wdqd8k9"))))))
L’exemple ci-dessus correspond à ce que font les options de transformation
des paquets --with-version et --with-source. En
substance, hello-2.2
préserve tous les champs de hello
, sauf
version
et source
, qu’il remplace. Remarquez que la variable
hello
originale est toujours là, dans le module (gnu packages
base)
, et n’est pas modifiée. Lorsque vous définissez un paquet
personnalisé comme ceci, vous ajoutez en fait une nouvelle définition
de paquet ; la version originale est toujours disponible.
Vous pouvez aussi bien définir des variantes avec un ensemble de dépendances
différent du paquet d’origine. Par exemple, le paquet gdb
par défaut
dépend de guile
, mais comme c’est une dépendance facultative, vous
pouvez définir une variante qu supprime cette dépendance de cette manière :
(use-modules (gnu packages gdb)) ; pour « gdb » (define gdb-sans-guile (package (inherit gdb) (inputs (modify-inputs (package-inputs gdb) (delete "guile")))))
La forme modify-inputs
ci-dessus supprime le paquet "guile"
du
champ inputs
de gdb
. La macro modify-inputs
est une
macro auxiliaire qui peut être utile si vous voulez supprimer, ajouter et
remplacer des paquets en entrée.
Modifie les entrées de paquet spécifiées, telles que renvoyées par
package-inputs
& co., suivant les clauses données. Chaque clause
doit avoir l’une des formes suivantes :
(delete nom…)
Supprime des entrées les paquets avec les noms donnés (chaines de caractères).
(prepend paquet…)
Ajoute les paquets au début de la liste des entrées.
(append paquet…)
Ajoute les paquets à la fin de la liste des entrées.
(replace name replacement)
Replace the package called name with replacement.
L’exemple suivant supprime les entrées GMP et ACL de Coreutils et ajoute libcap au début de la liste des entrées :
(modify-inputs (package-inputs coreutils)
(delete "gmp" "acl")
(prepend libcap))
L’exemple suivant remplace le paquet guile
des entrées de
guile-redis
avec guile-2.2
:
(modify-inputs (package-inputs guile-redis)
(replace "guile" guile-2.2))
Le dernier type de clause est append
, pour ajouter des entrées à la
fin de la liste.
Dans certains cas, vous pouvez trouver cela utile d’écrire des fonctions («
procédures », pour Scheme) qui renvoie un paquet en fonction de certains
paramètres. Par exemple, considérez la bibliothèque luasocket
pour
le langage de programmation lua. Nous voulons créer des paquets
luasocket
pour les versions majeures de Lua. Une manière de faire
est de définir une procédure qui prend un paquet Lua et renvoie un paquet
luasocket
qui en dépend :
(define (make-lua-socket name lua) ;; Renvoie un paquet luasocket construit avec LUA. (package (name name) (version "3.0") ;; plusieurs champs ont été omis (inputs (list lua)) (synopsis "Socket library for Lua"))) (define-public lua5.1-socket (make-lua-socket "lua5.1-socket" lua-5.1)) (define-public lua5.2-socket (make-lua-socket "lua5.2-socket" lua-5.2))
ici nous avons défini les paquets lua5.1-socket
et
lua5.2-socket
en appelant make-lua-socket
avec différents
arguments. Voir Procedures dans GNU Guile Reference Manual, pour
plus d’informations sur les procédures. Avoir des définitions publiques au
premier niveau pour ces deux paquets signifie qu’ils sont disponibles depuis
la ligne de commande (voir Modules de paquets).
Ce sont des variantes simples de paquets. Par simplicité, le module
(guix transformations)
fournit une interface de haut niveau qui
correspond directement aux options de transformations de paquets plus
sophistiquées (voir Options de transformation de paquets) :
Renvoie une procédure qui, lorsqu’on lui passe un objet à construire (un paquet, une dérivation, etc), applique les transformations spécifiées par opts et renvoie les objets qui en résultent. opts doit être une liste de pairs de symboles et de chaine comme dans :
((with-branch . "guile-gcrypt=master")
(without-tests . "libgcrypt"))
Chaque nom de symbole nomme une transformation et la chaine correspondante est un argument pour cette transformation.
Par exemple, un manifeste équivalent à cette commande :
guix build guix \ --with-branch=guile-gcrypt=master \ --with-debug-info=zlib
... ressemblerait à ceci :
(use-modules (guix transformations)) (define transform ;; La procédure de transformation des paquets. (options->transformation '((with-branch . "guile-gcrypt=master") (with-debug-info . "zlib")))) (packages->manifest (list (transform (specification->package "guix"))))
La procédure options->transformation
est pratique, mais elle n’est
peut-être pas aussi flexible que vous pourriez le souhaiter. Comment
est-elle implémentée ? Le lecteur attentif aura sans doute remarqué que la
plupart des options de transformation des paquets va plus loin que les
changements superficiels montrés dans les premiers exemples de cette
sections : ils font de la réécriture d’entrées, où le graphe de
dépendance d’un paquet est réécrit en remplaçant des entrées spécifiques par
d’autres.
La procédure package-input-rewriting
de (guix packages)
implémente la réécriture du graphe de dépendance, pour remplacer des paquets
dans le graphe.
Renvoie une procédure qui, lorsqu’elle est passée à un paquet, remplace ses dépendances directes et indirectes, y compris les entrées implicites lorsque deep? est vrai, selon replacements. replacements est une liste de paires de paquets ; le premier élément de chaque paire est le paquet à remplacer, et le second est le remplacement.
De manière facultative, nom-réécrit est une procédure à un argument qui prend le nom d’un paquet et renvoie son nouveau nom après l’avoir réécrit.
Regardez cet exemple :
(define libressl-instead-of-openssl ;; Cette procédure remplace OPENSSL par LIBRESSL, ;; récursivement. (package-input-rewriting `((,openssl . ,libressl)))) (define git-with-libressl (libressl-instead-of-openssl git))
Ici nous définissons d’abord une procédure de réécriture qui remplace openssl par libressl. Ensuite nous l’utilisons pour définir une variante du paquet git qui utilise libressl plutôt que openssl. cela est exactement ce que l’option en ligne de commande --with-input fait (voir --with-input).
La variante suivante de package-input-rewriting
peut repérer les
paquets à remplacer par nom à la place de leur identité.
Renvoie une procédure qui, étant donné un paquet, applique les remplacements donnés à tout le graphe du paquet, y compris les entrées implicites, à moins que deep? ne soit faux.
replacements is a list of spec/procedures pair; each spec is a package
specification such as "gcc"
or "guile@2"
, and each procedure
takes a matching package and returns a replacement for that package.
Matching packages that have the hidden?
property set are not
replaced.
L’exemple ci-dessus pourrait être réécrit de cette manière :
(define libressl-instead-of-openssl
;; Remplace tous les paquets nommés « openssl » par LibreSSL.
(package-input-rewriting/spec `(("openssl" . ,(const libressl)))))
Le différence clef est que, cette fois-ci, les paquets correspondent à la
spécification et non à l’identité. En d’autres termes, tout paquet dans le
graphe qui est appelé openssl
sera remplacé.
Une procédure plus générique pour réécrire un graphe de dépendance d’un
paquet est package-mapping
: elle supporte n’importe quel changement
dans les nœuds du graphe.
Renvoie une procédure qui, pour un paquet donné, applique proc à tous les paquets dont il dépend et renvoie le paquet résultant. La procédure arrête la récursion lorsque cut? renvoie true pour un paquet donné. Lorsque deep? est vrai, proc est également appliqué aux entrées implicites.
Tips : Understanding what a variant really looks like can be difficult as one starts combining the tools shown above. There are several ways to inspect a package before attempting to build it that can prove handy:
- You can inspect the package interactively at the REPL, for instance to view its inputs, the code of its build phases, or its configure flags (voir Utiliser Guix de manière interactive).
- When rewriting dependencies,
guix graph
can often help visualize the changes that are made (voir Invoqueguix graph
).
Suivant: Systèmes de construction, Précédent: Définition de variantes de paquets, Monter: Interface de programmation [Table des matières][Index]
Les commandes guix
vous permettent de spécifier des listes de
paquets sur la ligne de commande. C’est pratique, mais quand la ligne de
commande devient longue et moins triviale, il est plus pratique d’avoir la
liste des paquets dans ce que nous appelons un manifeste. Un manifeste
est une sorte de « nomenclature » qui définit un ensemble de
paquets. Typiquement, vous écrirez un bout de code qui construit le
manifeste, vous l’enregistrerez dans un fichier, disons manifest.scm,
puis passerez ce fichier à l’option −m (ou --manifest) que
de nombreuses commandes guix
prennent en charge. Par exemple,
voici ce à quoi un manifeste pour un simple ensemble de paquets peut
ressembler :
;; Manifeste pour trois paquets. (specifications->manifest '("gcc-toolchain" "make" "git"))
Une fois que vous avez le manifeste, vous pouvez le passer, par exemple, à
guix package
pour installer uniquement ces trois paquets dans
votre profil (voir l’option -m de guix
package
) :
guix package -m manifest.scm
... ou vous pouvez le passer à guix shell
(voir l’option -m
de guix shell
) pour créer un environnement
temporaire :
guix shell -m manifest.scm
... ou vous pouvez le passer à guix pack
de la même manière
(voir l’option -m de guix pack
). Vous
pouvez garder un manifeste sous contrôle de version, le partager avec
d’autres personnes pour qu’elles puissent facilement l’installer, etc.
Mais comment écrire votre premier manifeste ? Pour commencer, vous voudrez
peut-être écrire un manifeste qui reflète ce que vous avez déjà dans un
profil. Plutôt que de commencer par une feuille blanche, guix
package
peut générer un manifeste pour vous (voir guix package --export-manifest
) :
# Écrit dans « manifest.scm » un manifeste correspondant au profil # par défaut, ~/.guix-profile. guix package --export-manifest > manifest.scm
Ou vous voudrez peut-être « traduire » des arguments de la ligne de commande
en un manifeste. Dans ce cas, guix shell
peut aider
(voir guix shell --export-manifest
) :
# Écrit un manifeste pour les paquets spécifiés sur la ligne de commande. guix shell --export-manifest gcc-toolchain make git > manifest.scm
Dans les deux cas, l’option --export-manifest essaye de générer un manifeste fidèle ; en particulier, il prend en compte les options de transformation des paquets (voir Options de transformation de paquets).
Remarque : Les manifestes sont symboliques : ils font référence aux paquets des canaux actuellement utilisés (voir Canaux). Dans l’exemple ci-dessus,
gcc-toolchain
peut se référer à la version 11 aujourd’hui, mais pourra se référer à la version 13 dans deux ans.Si vous voulez « épingler » votre environnement logiciel à une version et une variante spécifique d’un paquet, vous devez donner des informations supplémentaires : la liste des révisions des canaux utilisés, renvoyée par
guix describe
. Voir Répliquer Guix, pour plus de détails.
Une fois que vous avez votre premier manifeste, vous voudrez peut-être le personnaliser. Comme votre manifeste est du code, vous avez maintenant accès à toutes les interfaces de programmation de Guix !
Supposons que vous souhaitiez avoir un manifeste pour déployer une variante personnalisée de GDB, le débogueur de GNU, qui ne dépend pas de Guile, avec un autre paquet. En complétant l’exemple vu dans la section précédente (voir Définition de variantes de paquets), vous pouvez écrire un manifeste de ce type :
(use-modules (guix packages) (gnu packages gdb) ;pour « gdb » (gnu packages version-control)) ;pour « git » ;; Définie une variante de GDB qui ne dépend pas de Guile. (define gdb-sans-guile (package (inherit gdb) (inputs (modify-inputs (package-inputs gdb) (delete "guile"))))) ;; Renvoie un manifeste contenant ce paquet plus Git. (packages->manifest (list gdb-sans-guile git))
Remarquez que dans cet exemple, le manifeste se réfère directement aux
variables gdb
et git
, qui sont liées à un objet package
(voir Référence de package
), au lieu d’appeler
specifications->manifest
pour rechercher les paquets par leur nom
comme nous l’avons fait précédemment. La forme use-modules
au début
nous permet d’accéder à l’interface centrale des paquets (voir Définition des paquets) et aux modules qui définissent gdb
et git
(voir Modules de paquets). Nous combinons tout cela harmonieusement — les
possibilités sont infinies, débridez votre créativité !
Le type de données pour les manifestes et les procédures auxiliaires sont
définis dans le module (guix profiles)
, qui est automatiquement
disponible pour le code passé à -m. Voici la documentation de
référence.
Type de données représentant un manifeste.
Il a actuellement un seul champ :
entries
Ce doit être une liste d’enregistrements manifest-entry
— voir plus
bas.
Type de donnée représentant une entrée d’un manifeste. Une entrée de manifeste contient les métadonnées nécessaires : un nom et une chaîne de version, l’objet (généralement un paquet) pour cette entrée, la sortie souhaitée (voir Des paquets avec plusieurs résultats) et un certain nombre d’autres informations facultatives décrites plus bas.
La plupart du temps, vous n’aurez pas à construire une entrée de manifeste
directement ; au lieu de cela, vous passerez un paquet à
package->manifest-entry
, décrit plus bas. Dans certains cas rares
cependant, vous pourriez être amené à créer des entrées de manifeste pour
des objets qui ne sont pas des paquets, comme dans cet exemple :
;; Construit manuellement une entrée de manifeste pour un objet qui n'est pas un paquet. (let ((hello (program-file "hello" #~(display "Hi!")))) (manifest-entry (name "toto") (version "42") (item (computed-file "hello-directory" #~(let ((bin (string-append #$output "/bin"))) (mkdir #$output) (mkdir bin) (symlink #$hello (string-append bin "/hello")))))))
Les champs disponibles sont les suivants :
name
version
Nom et chaine de version pour cette entrée.
item
Un paquet ou n’importe quel objet simili-fichier (voir objets de type fichier).
output
(par défaut : "out"
)Sortie de item
à utiliser, dans le cas où item
a plusieurs
sorties (voir Des paquets avec plusieurs résultats).
dependencies
(par défaut : '()
)Liste des entrées de manifeste desquelles dépend cette entrée. Lorsqu’un profil est construit, les dépendances sont ajoutées au profil.
Généralement, les entrées propagées d’un paquet (voir propagated-inputs
) ont une entrée de manifeste correspondante parmi
les dépendances de l’entrée du paquet.
search-paths
(par défaut : '()
)La liste des spécifications de chemins de recherche que cette entrée prend en compte (voir Chemins de recherche).
properties
(par défaut : '()
)Une liste de pairs de symboles et de valeurs. Lorsqu’un profil est construit, ces propriétés sont sérialisées.
Cela peut être utilisé pour intégrer des métadonnées supplémentaires — p. ex. les transformations appliquées à un paquet (voir Options de transformation de paquets).
parent
(par défaut : (delay #f)
)Une promesse pointant vers l’entrée de manifeste « parente ».
cela est utilisé comme une indication pour fournir du contexte si une erreur
liée à une entrée de manifeste provenant du champ dependencies
doit
être rapportée.
Concatène les manifestes listés dans lst et renvoie le manifeste qui en résulte.
Renvoie une entrée de manifeste pour la sortie du paquet paquet,
où sortie vaut "out"
par défaut, et avec les propriétés
properties données. Par défaut properties est la liste vide ou,
si des transformations de paquets sont appliquées à paquet, une liste
d’association représentant ces transformations, utilisable en tant
qu’argument à options->transformation
(voir options->transformation
).
Le bout de code ci-dessous construit un manifeste avec une entrée pour la
sortie par défaut et la sortie send-email
du paquet git
:
(use-modules (gnu packages version-control)) (manifest (list (package->manifest-entry git) (package->manifest-entry git "send-email")))
Renvoie une liste d’entrées de manifestes, un paquet élément listé dans paquets. Les éléments de paquets peuvent être soit des objets paquets soit des tuples paquet / chaine dénotant une sortie particulière d’un paquet.
Avec cette procédure, le manifeste ci-dessus peut être réécrit de manière plus concise :
(use-modules (gnu packages version-control)) (packages->manifest (list git `(,git "send-email")))
Renvoie un manifeste pour les entrées de développement de paquet pour système, éventuellement pour la compilation croisée vers la cible target. Les entrées de développement comprennent à la fois les entrées explicites et les entrées implicites de paquet.
Comme l’option -D de guix shell
(voir guix shell -D
), le manifeste
qui en résulte décrit l’environnement dans lequel on peut développer le
paquet. Par exemple, si vous voulez configurer un environnement de
développement pour Inkscape, avec Git pour le contrôle de version, vous
pouvez décrire cette « nomenclature » avec le manifeste suivant :
(use-modules (gnu packages inkscape) ;pour « inkscape » (gnu packages version-control)) ;pour « git » (concatenate-manifests (list (package->development-manifest inkscape) (packages->manifest (list git))))
Dans cet exemple, le manifeste de développement qui renvoie
package->development-manifest
inclus le compilateur (GCC), les
nombreuses bibliothèques qui portent le projet (Boost, GLib, GTK, etc) et
quelques outils de développement supplémentaires — ce sont les dépendances
listées par guix show inkscape
.
Enfin, le module (gnu packages)
fournit des fonctions pour construire
des manifestes. En particulier, il vous permet de rechercher des paquets par
leur nom — voir ci-dessous.
Étant données les specs, une liste de spécifications comme
"emacs@25.2"
ou "guile:debug"
, renvoie un manifeste. Les
spécifications ont le même format que celui attendu par les outils en ligne
de commande comme guix install
et guix package
(voir Invoquer guix package
).
Par exemple, elle vous permet de réécrire le manifeste avec Git que nous avons vu plus haut comme ceci :
(specifications->manifest '("git" "git:send-email"))
Remarque que nous n’avons pas à nous soucier de use-modules
,
d’importer le bon ensemble de modules et de se référer aux bonnes
variables. À la place, nous nous référons directement aux paquets de la même
manière que sur la ligne de commande, ce qui peut souvent être plus
pratique.
Suivant: Phases de construction, Précédent: Écrire un manifeste, Monter: Interface de programmation [Table des matières][Index]
Chaque définition de paquet définie un système de construction et des
arguments pour ce système de construction (voir Définition des paquets). Ce
champ build-system
représente la procédure de construction du paquet,
ainsi que des dépendances implicites pour cette procédure de construction.
Les systèmes de construction sont des objets
<build-system>
. L’interface pour les créer et les manipuler est
fournie par le module (guix build-system)
et les systèmes de
construction eux-mêmes sont exportés par des modules spécifiques.
Sous le capot, les systèmes de construction compilent d’abord des objets
paquets en sacs. Un sac est comme un paquet, mais avec moins de
décoration — en d’autres mots, un sac est une représentation à bas-niveau
d’un paquet, qui inclus toutes les entrées de ce paquet, dont certaines ont
été implicitement ajoutées par le système de construction. Cette
représentation intermédiaire est ensuite compilée en une dérivation
(voir Dérivations). Le package-with-c-toolchain
est un exemple
d’une manière de modifier les entrées implicites que le système de
construction d’un paquet récupère (voir package-with-c-toolchain
).
Les systèmes de construction acceptent une liste d’arguments
facultatifs. Dans les définitions de paquets, ils sont passés via le
champ arguments
(voir Définition des paquets). Ce sont typiquement des
arguments par mot-clef (voir keyword arguments in
Guile dans GNU Guile Reference Manual). La valeur de ces arguments est
habituellement évaluée dans la strate de construction — c.-à-d. par
un processus Guile lancé par le démon (voir Dérivations).
Le système de construction principal est le gnu-build-system
qui
implémente les procédures de construction standard pour les paquets GNU et
de nombreux autres. Il est fournit par le module (guix build-system
gnu)
.
gnu-build-system
représente le système de construction GNU et ses
variantes (voir configuration and makefile conventions dans GNU Coding Standards).
En résumé, les paquets qui l’utilisent sont configurés, construits et
installés avec la séquence ./configure && make && make check && make
install
habituelle. En pratique, des étapes supplémentaires sont souvent
requises. Toutes ces étapes sont séparées dans des phases
différentes. Voir Phases de construction pour plus d’informations sur les phases de
construction et comment les personnaliser.
En plus, ce système de construction s’assure que l’environnement « standard
» pour les paquets GNU est disponible. Cela inclus des outils comme GCC,
libc, Coreutils, Bash, Make, Diffutils, grep et sed (voir le module
(guix build-system gnu)
pour une liste complète). Nous les appelons
les entrées implicites d’un paquet parce que la définition du paquet
ne les mentionne pas.
Ce système de construction prend en charge un certain nombre de mot-clés,
qui peuvent être passés via le champ arguments
d’un paquet. Voici
certains des paramètres principaux :
#:phases
Cet argument spécifie le code du côté de la construction qui s’évalue en une liste d’association des phases de construction. Voir Phases de construction, pour plus d’informations.
#:configure-flags
C’est une liste de drapeaux (chaînes) passés au script
configure
. Voir Définition des paquets, pour un exemple.
#:make-flags
Cette liste de chaînes contient les drapeaux passés en argument aux
invocation de make
dans les phases build
, check
et
install
.
#:out-of-source?
Ce booléen, #f
par défaut, indique s’il faut lancer les constructions
dans un répertoire séparé de l’arborescence des sources.
Lorsque la valeur est vraie, la phase configure
crée un répertoire de
construction séparé, se déplace dedans et lance le script configure
à
partir de celui-ci. C’est utile pour les paquets qui en ont besoin, comme
glibc
.
#:tests?
Ce booléen, #t
par défaut, indique si la phase check
doit
lancer la suite de tests du paquet.
#:test-target
Cette chaîne, "check"
par défaut, donne le nom de la cible du
makefile à utiliser dans la phase check
.
#:parallel-build?
#:parallel-tests?
Ces booléens spécifient s’il faut construire, respectivement lancer la suite
de tests, en parallèle, avec le drapeau -j
de make
. Lorsque
la valeur est vraie, make
reçoit -jn
, où n est le
nombre spécifié dans l’option --cores de guix-daemon
ou
celle de la commande du client guix
(voir --cores).
#:validate-runpath?
Ce booléen, #t
par défaut, détermine s’il faut « valider » le
RUNPATH
des binaires ELF (les bibliothèques partagées .so
et
les exécutables) installés précédemment par la phase
install
. Voir la phase
validate-runpath
, pour plus de détails.
#:substitutable?
Ce booléen, #t
par défaut, indique si les sorties du paquet peuvent
être substituées — c.-à-d. si les utilisateur·rices peuvent obtenir des
substituts au lieu de les construire localement (voir Substituts).
#:allowed-references
#:disallowed-references
Lorsque la valeur est vraie, ces arguments doivent être une liste de dépendance qui ne doivent pas apparaître dans les dépendances des résultats de la construction. Si, à la fin de la construction, certaines de ces références sont retenues, le processus échoue.
C’est utile pour s’assurer qu’un paquet ne garde pas une référence par
erreur à ses entrées de construction, sis cela augmente par exemple la
taille de sa clôture (voir Invoquer guix size
).
La plupart des autres systèmes de construction prennent en charge ces mot-clés.
D’autres objets <build-system>
sont définis pour supporter d’autres
conventions et outils utilisés par les paquets de logiciels libres. Ils
héritent de la plupart de gnu-build-system
et diffèrent surtout dans
l’ensemble des entrées implicites ajoutées au processus de construction et
dans la liste des phases exécutées. Certains de ces systèmes de
construction sont listés ci-dessous.
This variable is exported by (guix build-system agda)
. It implements
a build procedure for Agda libraries.
It adds agda
to the set of inputs. A different Agda can be specified
with the #:agda
key.
The #:plan
key is a list of cons cells (regexp
. parameters)
, where regexp is a regexp that should match the
.agda
files to build, and parameters is an optional list of
parameters that will be passed to agda
when type-checking it.
When the library uses Haskell to generate a file containing all imports, the
convenience #:gnu-and-haskell?
can be set to #t
to add
ghc
and the standard inputs of gnu-build-system
to the input
list. You will still need to manually add a phase or tweak the
'build
phase, as in the definition of agda-stdlib
.
Cette variable est exportée par (guix build-system ant)
. Elle
implémente la procédure de construction pour les paquets Java qui peuvent
être construits avec l’outil de construction
Ant.
Elle ajoute à la fois ant
et the kit de développement Java
(JDK) fournit par le paquet icedtea
à l’ensemble des entrées. Des
paquets différents peuvent être spécifiés avec les paramètres #:ant
et #:jdk
respectivement.
Lorsque le paquet d’origine ne fournit pas de fichier de construction Ant
acceptable, le paramètre #:jar-name
peut être utilisé pour générer un
fichier de construction Ant build.xml minimal, avec des tâches pour
construire l’archive jar spécifiée. Dans ce cas, le paramètre
#:source-dir
peut être utilisé pour spécifier le sous-répertoire des
sources, par défaut « src ».
Le paramètre #:main-class
peut être utilisé avec le fichier de
construction minimal pour spécifier la classe principale du jar. Cela rend
le fichier jar exécutable. Le paramètre #:test-include
peut être
utilisé pour spécifier la liste des tests junits à lancer. Il vaut par
défaut (list "**/*Test.java")
. Le paramètre #:test-exclude
peut être utilisé pour désactiver certains tests. Sa valeur par défaut est
(list "**/Abstract*.java")
, parce que les classes abstraites ne
peuvent pas être utilisées comme des tests.
Le paramètre #:build-target
peut être utilisé pour spécifier la tâche
Ant qui devrait être lancée pendant la phase build
. Par défaut la
tâche « jar » sera lancée.
Cette variable est exportée par (guix build-system android-ndk)
.
Elle implémente une procédure de construction pour les paquets du NDK
Android (native development kit) avec des processus de construction
spécifiques à Guix.
Le système de compilation suppose que les paquets installent leurs fichiers
d’interface publique (en-tête) dans le sous-répertoire include de la
sortie out
et leurs bibliothèques dans le sous-répertoire lib
de la sortie out
.
Il est aussi supposé que l’union de toutes les dépendances d’un paquet n’a pas de fichiers en conflit.
Pour l’instant, la compilation croisée n’est pas supportées — donc pour l’instant les bibliothèques et les fichiers d’en-têtes sont supposés être des outils de l’hôte.
Ces variables, exportées par (guix build-system asdf)
, implémentent
les procédures de constructions pour les paquets en Common Lisp qui
utilisent « ASDF ». ASDF est
un dispositif de définition de systèmes pour les programmes et les
bibliothèques en Common Lisp.
Le système asdf-build-system/source
installe les paquets au format
source qui peuvent être chargés avec n’importe quelle implémentation de
common lisp, via ASDF. Les autres, comme asdf-build-system/sbcl
,
installent des binaires au format qu’un implémentation particulière
comprend. Ces systèmes de constructions peuvent aussi être utilisés pour
produire des programmes exécutables ou des images lisp qui contiennent un
ensemble de paquets pré-chargés.
Le système de construction utilise des conventions de nommage. Pour les
paquets binaires, le nom du paquet devrait être préfixé par l’implémentation
lisp, comme sbcl-
pour asdf-build-system/sbcl
.
En plus, le paquet source correspondant devrait étiquetté avec la même
convention que les paquets Python (voir Modules Python), avec le préfixe
cl-
.
Pour créer des programmes exécutables et des images, les procédures côté
construction build-program
et build-image
peuvent être
utilisées. Elles devraient être appelées dans une phase de construction
après la phase create-asdf-configuration
pour que le système qui
vient d’être construit puisse être utilisé dans l’image créée.
build-program
requiert une liste d’expressions Common Lisp dans
l’argument #:entry-program
.
Par défaut, tous les fichiers .asd présents dans les sources sont lus
pour trouver les définitions du système. Le paramètre #:asd-file
peut
être utilisé pour préciser la liste des fichiers .asd à lire. En
outre, si le paquet définit un système pour ses tests dans un fichier
séparé, il sera chargé avant l’exécution des tests s’il est spécifié par le
paramètre #:test-asd-file
. S’il n’est pas défini, les fichiers
<system>-tests.asd
, <system>-test.asd
, tests.asd
et
test.asd
seront essayés s’ils existent.
Si pour quelque raison que ce soit le paquet doit être nommé d’une manière
différente de ce que la convention de nommage suggère, ou si plusieurs
systèmes doivent être compilés, le paramètre #:asd-systems
peut être
utilisé pour spécifier la liste des noms de systèmes.
Cette variable est exportée par (guix build-system cargo)
. Elle
supporte les construction de paquets avec Cargo, le système de construction
du langage de programmation Rust.
Cela ajoute rustc
et cargo
à l’ensemble des entrées. Un autre
paquet Rust peut être spécifié avec le paramètre #:rust
.
Les dépendances régulières de cargo doivent être ajoutées à la définition du
paquet comme avec les autres paquets ; celles qui ne sont requises qu’à la
construction dans « native-inputs », les autres dans « inputs ». Si vous
devez ajouter des crates sources alors vous devez les ajouter via le
paramètre #:cargo-inputs
sous la forme d’une liste de paires de noms
et de spécifications, où la spécification peut être un paquet ou une
définition de source. Notez que la spécification doit évaluer un chemin
vers une arhive gzippée qui inclut un fichier Cargo.toml
à sa racine,
sinon elle sera ignorée. De même, les dépendances de développement de cargo
doivent être ajoutées à la définition du paquet via le paramètre
#:cargo-development-inputs
.
Dans sa phase configure
, ce système de construction mettra à
disposition de cargo toutes les entrées sources spécifiées dans les
paramètres #:cargo-inputs
et #:cargo-development-inputs
. Il
supprimera également un fichier Cargo.lock
inclus, qui sera recréé
par cargo
pendant la phase build
. La phase package
lancera cargo package
pour créer un crate source réutilisable plus
tard. La phase install
installe les binaires définis par le crate. À
moins de définir install-source? #f
elle installera aussi un crate
source et les sources décompressées pour faciliter le travail avec les
paquets rust.
Cette variable est exportée par (guix build-system chicken)
. Elle
construit des modules CHICKEN Scheme, aussi
appelés « eggs » ou « extensions ». CHICKEN génère du code source C, qui est
ensuite compilé par un compilateur C, dans ce cas GCC.
Ce système de construction ajoute chicken
aux entrées du paquet, en
plus des paquets de gnu-build-system
.
Le système de construction ne peut pas (encore) déterminer le nom de l’egg
automatiquement, donc comme avec le go-build-system
et son
#:import-path
, vous devriez définir #:egg-name
dans le champ
arguments
du paquet.
Par exemple, si vous créez un paquet pour l’egg srfi-1
:
(arguments '(#:egg-name "srfi-1"))
Les dépendances des egg doivent être définies dans propagated-inputs
,
pas inputs
parce que CHICKEN n’inclut pas de références absolues dans
les eggs compilés. Les dépendances des tests doivent aller dans
native-inputs
, comme d’habitude.
Cette variable est exportée par (guix build-system copy)
. Il prend
en charge la construction de paquets simples qui ne nécessitent pas beaucoup
de compilation, la plupart du temps juste le déplacement de fichiers.
Cela ajoute une grande partie des paquets gnu-build-system
à
l’ensemble des entrées. De ce fait, le copy-build-system
n’a pas
besoin de tout le code passe-partout souvent nécessaire pour le
trivial-build-system
.
Pour simplifier davantage le processus d’installation des fichiers, un
argument #:install-plan
est exposé pour permettre au packager de
spécifier quels fichiers vont où. Le plan d’installation est une liste de
(source cible [filtres])
. Les filtres sont
facultatifs.
#:include
, #:include-regexp
, #:exclude
,
#:exclude-regexp
, seuls les fichiers sélectionnés sont installés en
fonction des filtres. Chaque filtre est spécifié par une liste de chaînes
de caractères.
#:include
, installez tous les fichiers dont le suffixe de chemin correspond
au moins un des éléments dans la liste donnée.
#:include-regexp
, installez tous les fichiers que le
les sous-chemins correspondent à au moins une des expressions régulières de
la liste donnée.
#:exclude
et #:exclude-regexp
sont le complément de leur homologue pour l’inclusion. Sans les drapeaux
#:include
, installez tous les fichiers sauf ceux qui correspondent
aux filtres d’exclusion. Si les inclusions et les exclusions sont toutes
deux spécifiées, les exclusions sont faites en complément des inclusions.
#:output
argument
can be used to specify which output label the files should be installed to.
Dans tous les cas, les chemins relatifs à source sont préservés dans cible.
Exemples :
("toto/titi" "share/mon-app/")
: Installer titi sur share/mon-app/titi.
("toto/titi" "share/mon-app/tata")
: Installer titi sur share/mon-app/tata.
("toto/" "share/mon-app")
: Installez le contenu de toto dans share/mon-app,
par exemple, installe toto/sub/file dans
share/mon-app/sub/file.
("toto/" "share/mon-app" #:include ("sub/file"))
: Installe seulement toto/sub/file vers
share/mon-app/sub/file.
("toto/sub" "share/mon-app" #:include ("file"))
: Installe toto/sub/file vers
share/mon-app/file.
("foo/doc" "share/my-app/doc" #:output "doc")
: Install
"foo/doc" to "share/my-app/doc" within the "doc"
output.
This variable is exported by (guix build-system vim)
. It is an
extension of the copy-build-system
, installing Vim and Neovim plugins
into locations where these two text editors know to find their plugins,
using their packpaths.
Packages which are prefixed with vim-
will be installed in Vim’s
packpath, while those prefixed with neovim-
will be installed in
Neovim’s packpath. If there is a doc
directory with the plugin then
helptags will be generated automatically.
There are a couple of keywords added with the vim-build-system
:
plugin-name
it is possible to set the name of the plugin.
While by default this is set to the name and version of the package, it is
often more helpful to set this to name which the upstream author calls their
plugin. This is the name used for :packadd
from inside Vim.
install-plan
it is possible to augment the built-in
install-plan of the vim-build-system
. This is particularly helpful
if you have files which should be installed in other locations. For more
information about using the install-plan
, see the
copy-build-system
(voir copy-build-system
).
#:vim
it is possible to add this package to Vim’s packpath,
in addition to if it is added automatically because of the vim-
prefix in the package’s name.
#:neovim
it is possible to add this package to Neovim’s
packpath, in addition to if it is added automatically because of the
neovim-
prefix in the package’s name.
#:mode
it is possible to adjust the path which the plugin is
installed into. By default the plugin is installed into start
and
other options are available, including opt
. Adding a plugin into
opt
will mean you will need to run, for example, :packadd
foo
to load the foo
plugin from inside of Vim.
Cette variable est exportée par (guix build-system clojure)
. Elle
implémente une procédure de construction des paquets simple qui utilise le
bon vieux compile
de Clojure. La compilation croisée n’est pas
encore supportée.
Elle ajoute clojure
, icedtea
et zip
à l’ensemble des
entrées. Des paquets différents peuvent être spécifiés avec les paramètres
#:clojure
, #:jdk
et #:zip
.
Une liste de répertoires sources, de répertoires de tests et de noms de jar
peuvent être spécifiés avec les paramètres #:source-dirs
,
#:test-dirs
et #:jar-names
. Le répertoire de construction est
la classe principale peuvent être spécifiés avec les paramètres
#:compile-dir
et #:main-class
. Les autres paramètres sont
documentés plus bas.
Ce système de construction est une extension de ant-build-system
,
mais avec les phases suivantes modifiées :
build
Cette phase appelle compile
en Clojure pour compiler les fichiers
sources et lance jar
pour créer les fichiers jar à partir des
fichiers sources et des fichiers compilés en suivant la liste d’inclusion et
d’exclusion spécifiées dans #:aot-include
et #:aot-exclude
.
La liste d’exclusion a la priorité sur la liste d’inclusion. Ces listes
consistent en des symboles représentant des bibliothèque Clojure ou le mot
clef spécial #:all
, représentant toutes les bibliothèques Clojure
trouvées dans les répertoires des sources. Le paramètre
#:omit-source?
décide si les sources devraient être incluses dans les
fichiers jar.
check
Cette phase lance les tests en suivant les liste d’inclusion et d’exclusion
spécifiées dans #:test-include
et #:test-exclude
. Leur
signification est analogue à celle de #:aot-include
et
#:aot-exclude
, sauf que le mot-clef spécial #:all
signifie
maintenant toutes les bibliothèques Clojure trouvées dans les répertoires de
tests. Le paramètre #:tests?
décide si les tests devraient être
lancés.
install
Cette phase installe tous les fichiers jar précédemment construits.
En dehors de cela, le système de construction contient aussi la phase suivante :
install-doc
Cette phase installe tous les fichiers dans le répertoire de plus haut
niveau dont le nom correspond à %doc-regex
. On peut spécifier une
regex différente avec le paramètre #:doc-regex
. Tous les fichiers
(récursivement) dans les répertoires de documentations spécifiés dans
#:doc-dirs
sont aussi installés.
Cette variable est exportée par (guix build-system cmake)
. Elle
implémente la procédure de construction des paquets qui utilisent
l’outil de construction CMake.
Elle ajoute automatiquement le paquet cmake
à l’ensemble des
entrées. Le paquet utilisé peut être spécifié par le paramètre
#:cmake
.
Le paramètre #:configure-flags
est pris comme une liste de drapeaux à
passer à la commande cmake
. Le paramètre #:build-type
spécifie en termes abstrait les drapeaux passés au compilateur ; sa valeur
par défaut est "RelWithDebInfo"
(ce qui veut dire « mode public avec
les informations de débogage » en plus court), ce qui signifie en gros que
le code sera compilé avec -O2 -g
comme pour les paquets autoconf par
défaut.
This variable is exported by (guix build-system composer)
. It
implements the build procedure for packages using
Composer, the PHP package manager.
It automatically adds the php
package to the set of inputs. Which
package is used can be specified with the #:php
parameter.
The #:test-target
parameter is used to control which script is run
for the tests. By default, the test
script is run if it exists. If
the script does not exist, the build system will run phpunit
from the
source directory, assuming there is a phpunit.xml file.
Cette variable est exportée par (guix build-system dune)
. Elle prend
en charge la construction des paquets qui utilisent
Dune, un outil de construction pour le langage
de programmation OCaml. Elle est implémentée comme une extension de
ocaml-build-system
décrit plus bas. En tant que tel, les paramètres
#:ocaml
et #:findlib
peuvent être passés à ce système de
construction.
Elle ajoute automatiquement le paquet dune
à l’ensemble des entrées.
Le paquet utilisé peut être spécifié par le paramètre #:dune
.
Il n’y a pas de phase configure
parce que les paquets dune n’ont
habituellement pas besoin d’être configurés. Le paramètre
#:build-flags
est interprété comme une liste de drapeaux pour la
commande dune
pendant la construction.
Le paramètre #:jbuild?
peut être passé pour utiliser la commande
jbuild
à la place de la commande dune
plus récente pour la
construction d’un paquet. Sa valeur par défaut est #f
.
Le paramètre #:package
peut être passé pour spécifié un nom de
paquet, ce qui est utile lorsqu’un paquet contient plusieurs paquets et que
vous voulez n’en construire qu’un. C’est équivalent à passer l’argument
-p
à dune
.
Cette variable est exportée par (guix build-system elm)
. Elle
implémente une procédure de construction pour les paquets
Elm qui ressemble à ‘elm install’.
Le système de construction ajoute un paquet qui contient le compilateur Elm
à l’ensemble des entrées. Le paquet de compilateur par défaut (actuellement
elm-sans-reactor
) peut être remplacé avec l’argument #:elm
. En
plus, les paquets Elm requis par le système de construction lui-même sont
ajoutés en tant qu’entrées implicites s’ils ne sont pas déjà présents : pour
supprimer ce comportement, utilisez l’argument
#:implicit-elm-package-inputs?
qui est surtout utile pour
l’armorçage.
Les "dependencies"
et "test-dependencies"
du fichier
elm.json d’un paquet Elm correspondent à propagated-inputs
et
inputs
, respectivement.
Elm a besoin d’une structure particulière pour les noms des paquets :
voir Paquets elm pour plus de détails, en particulier sur les outils
fournis par (guix build-system elm)
.
Il y a actuellement quelques limites notables à elm-build-system
:
{ "type": "package"}
dans
leur fichier elm.json. Utiliser elm-build-system
pour
construire des applications Elm (qui déclarent { "type":
"application" }
est possible, mais nécessite des modifications ad-hoc des
phases de construction. Par exemple, voir les définitions de l’application
d’exemple elm-todomvc
et du paquet elm
lui-même (parce que
l’interface de la commande ‘elm reactor’ est une application Elm).
ELM_HOME
, mais cela ne fonctionne pas encore bien avec
elm-build-system
. Cette limite affecte principalement les
applications Elm, parce qu’elles spécifient les versions exactes de leurs
dépendances, alors que les paquets Elm spécifient des intervalles de
versions prises en charge. Pour contourner le problème, les applications
d’exemple mentionnées plus haut utilisent la procédure
patch-application-dependencies
fournie par (guix build
elm-build-system)
pour réécrire leur fichier elm.json pour qu’ils se
réfèrent aux versions effectivement présentes dans l’environnement de
construction. Autrement, les transformations des paquets Guix
(voir Définition de variantes de paquets) peuvent aussi réécrire tout le graphe de
dépendance d’une application.
elm-test-rs
ni
l’exécuteur elm-test
basé sur Node.js ne sont empaquetés dans Guix.
Cette variable est exportée par (guix build-system go)
. Elle
implémente la procédure pour les paquets Go utilisant les
mécanismes de construction Go standard.
L’utilisateur doit fournir une valeur à la clef #:import-path
et,
dans certains cas, #:unpack-path
. Le
chemin d’import
correspond au chemin dans le système de fichiers attendu par le script de
construction du paquet et les paquets qui s’y réfèrent et fournit une
manière unique de se référer à un paquet Go. Il est typiquement basé sur
une combinaison de l’URI du code source du paquet et d’une structure
hiérarchique du système de fichier. Dans certains cas, vous devrez extraire
le code source du paquet dans une structure de répertoires différente que
celle indiquée par le chemin d’import et #:unpack-path
devrait être
utilisé dans ces cas-là.
Les paquets qui fournissent des bibliothèques Go devraient installer leur
code source dans la sortie du paquet. La clef #:install-source?
, qui
vaut #t
par défaut, contrôle l’installation du code source. Elle
peut être mise à #f
pour les paquets qui ne fournissent que des
fichiers exécutables.
Vous pouvez effectuer une compilation croisée des paquets et si vous voulez
une architecture ou un système d’exploitation spécifique alors vous pouvez
utiliser les mot-clés #:goarch
et #:goos
pour forcer le paquet
à être construit pour l’architecture et le système d’exploitation
donnés. Vous trouverez les combinaisons connues pour Go
dans leur
documentation.
Vous pouvez utiliser le mot-clé #:go
pour spécifier le paquet du
compilateur Go avec lequel construire le paquet.
The phase check
provides a wrapper for go test
which builds a
test binary (or multiple binaries), vets the code and then runs the test
binary. Build, test and test binary flags can be provided as
#:test-flags
parameter, default is '()
. See go help
test
and go help testflag
for more details.
The key #:embed-files
, default is '()
, provides a list of
future embedded files or regexps matching files. They will be copied to
build directory after unpack
phase. See
https://pkg.go.dev/embed for more details.
Cette variable est exportée par (guix build-system glib-or-gtk)
.
Elle est conçue pour être utilisée par des paquets qui utilisent GLib ou
GTK+.
Ce système de construction ajoute les deux phases suivantes à celles
définies par gnu-build-system
:
glib-or-gtk-wrap
La phase glib-or-gtk-wrap
garantit que les programmes dans
bin/ sont capables de trouver les « schémas » GLib et
GTK+
modules. Cela est réalisé en enveloppant les programmes dans des scripts
de lancement qui définissent de manière appropriée les variables
d’environnement XDG_DATA_DIRS
et GTK_PATH
.
Il est possible d’exclure des sorties spécifiques de ce processus
d’enveloppage en listant leur nom dans le paramètre
#:glib-or-gtk-wrap-excluded-outputs
. C’est utile lorsqu’une sortie
est connue pour ne pas contenir de binaires GLib ou GTK+, et où l’enveloppe
ajouterait une dépendance inutile vers GLib et GTK+.
glib-or-gtk-compile-schemas
La phase glib-or-gtk-compile-schemas
s’assure que tous les
schémas GSettings de GLib sont compilés. La compilation est effectuée par
le programme glib-compile-schemas
. Il est fournit par le paquet
glib:bin
qui est automatiquement importé par le système de
construction. Le paquet glib
qui fournit
glib-compile-schemas
peut être spécifié avec le paramètre
#:glib
.
Ces deux phases sont exécutées après la phase install
.
Ce système de construction sert aux paquets Guile qui consistent
exclusivement en code Scheme et qui sont si simple qu’ils n’ont même pas un
makefile, sans parler d’un script configure. Il compile le code
Scheme en utilisant guild compile
(voir Compilation dans GNU Guile Reference Manual) et installe les fichiers .scm et
.go aux bons emplacements. Il installe aussi la documentation.
Ce système de construction supporte la compilation croisée en utilisant
l’option --target de guild compile
.
Les paquets construits avec guile-build-system
doivent fournir un
paquet Guile dans leur champ native-inputs
.
Cette variable est exportée par (guix build-system julia)
. Elle
implémente la procédure de compilation utilisée par les paquets
julia, qui est globalement similaire à
l’exécution de ‘julia -e 'using Pkg ; Pkg.add(package)'’ dans un
environnement où JULIA_LOAD_PATH
contient les chemins de toutes les
entrées des paquets Julia. Les tests sont effectués en appelant
/test/runtests.jl
.
Le nom et l’uuid du paquet Julia est lu dans le fichier
Project.toml. Ces valeurs peuvent être remplacées en passant
l’argument #:julia-package-name
(le nom doit être correctement
capitalisé) ou #:julia-package-uuid
.
Les paquets Julia gèrent généralement leurs dépendances binaires via
JLLWrappers.jl
, un paquet Julia qui crée un module (nommé d’après la
bibliothèque enveloppée suivie de _jll.jl
.
Pour ajouter le chemin vers les binaires _jll.jl
, vous devez corriger
les fichiers dans src/wrappers/, en remplaçant l’appel à la macro
JLLWrappers.@generate_wrapper_header
, en ajoutant un second argument
contenant le chemin du binaire dans le dépôt.
Par exemple, dans le paquets Julia MbedTLS, on ajoute un phase de construction (voir Phases de construction) pour insérer le nom de fichier absolu du paquet enveloppé MbedTLS :
(add-after 'unpack 'override-binary-path
(lambda* (#:key inputs #:allow-other-keys)
(for-each (lambda (wrapper)
(substitute* wrapper
(("generate_wrapper_header.*")
(string-append
"generate_wrapper_header(\"MbedTLS\", \""
(assoc-ref inputs "mbedtls") "\")\n"))))
;; There's a Julia file for each platform, override them all.
(find-files "src/wrappers/" "\\.jl$"))))
Certains paquets plus anciens qui n’utilisent pas encore Project.toml
nécessiteront aussi la création de ce fichier. Cela s’effectue en interne si
les arguments #:julia-package-name
et #:julia-package-uuid
sont fournis.
Cette variable est exportée par (guix build-system maven)
. Elle
implémente une procédure de construction pour les paquets
Maven. Maven est un outil de gestion des
dépendances et du cycle de vie pour Java. Un·e utilisateur·rice de Maven
spécifie les dépendances et les plugins dans un fichier pom.xml que
Maven lit. Lorsque Maven n’a pas l’une des dépendances ou l’un des plugins
dans son dépôt, il les télécharge et les utilise pour construire le paquet.
Le système de construction de maven garantit que maven n’essaiera pas de télécharger une dépendance en s’exécutant en mode hors ligne. Maven échouera si une dépendance est manquante. Avant de lancer Maven, le fichier pom.xml (et sous-projets) sont modifiés pour spécifier la version des dépendances et des plugins qui correspondent aux versions disponibles dans l’environnement de construction de guix. Les dépendances et plugins doivent être installés dans le faux dépôt maven à lib/m2, et sont liés par un lien symbolique à un dépôt approprié avant que maven ne soit lancé. Maven a pour instruction d’utiliser ce dépôt pour la construction et y installe les artefacts construits. Les fichiers modifiés sont copiés dans le répertoire lib/m2 de la sortie du paquet.
Vous pouvez spécifier un fichier pom.xml avec l’argument
#:pom-file
, ou bien laisser le système de construction utiliser le
fichier par défaut pom.xml dans les sources.
Dans le cas où vous avez besoin de spécifier manuellement une version de
dépendances, vous pouvez utiliser l’argument #:local-packages
. Il
prend une liste d’association dont la clé est le groupId du paquet et sa
valeur est une liste d’association où la clé est l’artefactId du paquet et
sa valeur est la version que vous souhaitez remplacer dans le fichier
pom.xml.
Certains paquets utilisent des dépendances ou des plugins qui ne sont pas
utiles au moment de l’exécution ou de la compilation dans Guix. Vous pouvez
modifier le fichier pom.xml pour les supprimer en utilisant
l’argument #:exclude
. Sa valeur est une liste d’association où la
clé est le groupId du plugin ou de la dépendance que vous voulez supprimer,
et la valeur est une liste d’artifactId que vous voulez supprimer.
Vous pouvez remplacer les paquets jdk
et maven
par défaut avec
l’argument correspondant, #:jdk
et #:maven
.
L’argument #:maven-plugins
est une liste de plugins maven utilisés
pendant la construction, avec le même format que le champ inputs
de
la déclaration du paquet. Sa valeur par défaut est
(default-maven-plugins)
qui est également exportée.
Cette variable est exportée par (guix build-system minetest)
. Elle
implémente une procédure de construction pour les mods de
Minetest qui consiste à copier du code
Lua, des images et d’autres ressources aux emplacements où Minetest
recherche des mods. Le système de construction minimise aussi les images PNG
et vérifie que Minetest peut charger le mod sans erreur.
Cette variable est exportée par (guix build-system minify)
. Elle
implémente une procédure de minification pour des paquets JavaScript
simples.
Elle ajoute uglify-js
à l’ensemble des entrées et l’utilise pour
compresser tous les fichiers JavaScript du répertoire src. Un
minifieur différent peut être spécifié avec le paramètre #:uglify-js
mais il est attendu que ce paquet écrive le code minifié sur la sortie
standard.
Lorsque les fichiers JavaScript d’entrée ne sont pas situés dans le
répertoire src, le paramètre #:javascript-files
peut être
utilisé pour spécifier une liste de noms de fichiers à donner au minifieur.
This variable is exported by (guix build-system mozilla)
. It sets
the --target
and --host
configuration flags to what software
developed by Mozilla expects – due to historical reasons, Mozilla software
expects --host
to be the system that is cross-compiled from and
--target
to be the system that is cross-compiled to, contrary to the
standard Autotools conventions.
Cette variable est exportée par (guix build-system ocaml)
. Elle
implémente une procédure de construction pour les paquets
OCaml qui consiste à choisir le bon ensemble de
commande à lancer pour chaque paquet. Les paquets OCaml peuvent demander
des commandes diverses pour être construit. Ce système de construction en
essaye certaines.
Lorsqu’un fichier setup.ml est présent dans le répertoire de plus
haut niveau, elle lancera ocaml setup.ml -configure
, ocaml
setup.ml -build
et ocaml setup.ml -install
. Le système de
construction supposera que ces fichiers ont été générés par
OASIS et prendra soin
d’initialiser le préfixe et d’activer les tests s’ils ne sont pas
désactivés. Vous pouvez passer des drapeaux de configuration et de
construction avec #:configure-flags
et #:build-flags
. La clef
#:test-flags
peut être passée pour changer l’ensemble des drapeaux
utilisés pour activer les tests. La clef #:use-make?
peut être
utilisée pour outrepasser ce système dans les phases de construction et
d’installation.
Lorsque le paquet a un fichier configure, il est supposé qu’il s’agit
d’un script configure écrit à la main qui demande un format différent de
celui de gnu-build-system
. Vous pouvez ajouter plus de drapeaux avec
la clef #:configure-flags
.
Lorsque le paquet a un fichier Makefile (ou #:use-make?
vaut
#t
), il sera utilisé et plus de drapeaux peuvent être passés à la
construction et l’installation avec la clef #:make-flags
.
Enfin, certains paquets n’ont pas ces fichiers mais utilisent un emplacement
plus ou moins standard pour leur système de construction. Dans ce cas, le
système de construction lancera ocaml pkg/pkg.ml
ou
pkg/build.ml
et prendra soin de fournir le chemin du module findlib
requis. Des drapeaux supplémentaires peuvent être passés via la clef
#:bulid-flags
. L’installation se fait avec
opam-installer
. Dans ce cas, le paquet opam
doit être
ajouté au champ native-inputs
de la définition du paquet.
Remarquez que la plupart des paquets OCaml supposent qu’ils seront installés
dans le même répertoire qu’OCaml, ce qui n’est pas ce que nous voulons faire
dans Guix. En particulier, ils installeront leurs fichiers .so dans
leur propre répertoire de module, ce qui est normalement correct puisqu’il
s’agit du répertoire du compilateur OCaml. Dans Guix en revanche, ces
bibliothèques ne peuvent pas y être trouvées et on utilise
CAML_LD_LIBRARY_PATH
à la place. Cette variable pointe vers
lib/ocaml/site-lib/stubslibs et c’est là où les bibliothèques
.so devraient être installées.
Cette variable est exportée par (guix build-system python)
. Elle
implémente la procédure de construction plus ou moins standard utilisée pour
les paquets Python, qui consiste à lancer python setup.py build
puis
python setup.py install --prefix=/gnu/store/…
.
Pour les paquets qui installent des programmes autonomes Python dans
bin/
, elle prend soin d’envelopper ces binaires pour que leur
variable d’environnement GUIX_PYTHONPATH
pointe vers toutes les
bibliothèques Python dont ils dépendent.
Le paquet Python utilisé pour effectuer la construction peut être spécifié
avec le paramètre #:python
. C’est une manière utile de forcer un
paquet à être construit avec une version particulière de l’interpréteur
python, ce qui peut être nécessaire si le paquet n’est compatible qu’avec
une version de l’interpréteur.
Par défaut, guix appelle setup.py
sous le contrôle de
setuptools
, tout comme pip
le fait. Certains paquets ne
sont pas compatibles avec setuptools (et pip), vous pouvez donc le
désactiver en réglant le paramètre #:use-setuptools?
sur #f
.
Si la sortie "python"
est disponible, le paquet y est installé au
lieu de la sortie "out"
par défaut. C’est utile pour les paquets qui
incluent un paquet Python seulement comme partie du logiciel, et donc qu’il
faut combiner les phases de python-build-system
avec celles d’un
autre système de construction. Les liaisons Python sont un cas courant.
C’est une variable exportée par guix build-system pyproject
. Elle est
basée sur python-build-system et ajoute la prise en charge de
pyproject.toml et PEP
517. Elle prend aussi en charge plusieurs moteurs de construction et
cadriciels de test.
L’API est un peu différente de celle de python-build-system :
#:use-setuptools?
et #:test-target
sont supprimés.
#:build-backend
est ajouté. Sa valeur par défaut est #false
et
le système essaiera de deviner le moteur approprié en fonction de
pyproject.toml.
#:test-backend
est ajouté. Sa valeur par défaut est #false
et
le système essaiera de deviner un moteur de test approprié en fonction de ce
qui est disponible dans les entrées du paquet.
#:test-flags
est ajouté. La valeur par défaut est '()
. Ces
drapeaux sont passés en argument à la commande de test. Remarquez que les
drapeaux pour la sortie verbeuse sont toujours activés pour les moteurs pris
en charge.
Il est considéré comme « expérimental » dans le sens où les détails d’implémentation ne sont pas encore figés, mais nous vous encourageons à l’essayer pour les nouveaux projets Python (même ceux qui utilisent setup.py). L’API pourrait changer mais les changements provoquant des problèmes dans le canal Guix seront gérés.
Ce système de construction finira par être obsolète et fusionné dans python-build-system, sans doute au courant de l’année 2024.
Cette variable est exportée par (guix build-system perl)
. Elle
implémente la procédure de construction standard des paquets Perl, qui
consiste soit à lancer perl Build.PL --prefix=/gnu/store/…
,
suivi de Build
et Build install
; ou à lancer perl
Makefile.PL PREFIX=/gnu/store/…
, suivi de make
et make
install
, en fonction de la présence de Build.PL
ou
Makefile.PL
dans la distribution du paquet. Le premier a la
préférence si Build.PL
et Makefile.PL
existent tous deux dans
la distribution du paquet. Cette préférence peut être inversée en
spécifiant #t
pour le paramètre #:make-maker?
.
L’invocation initiale de perl Makefile.PL
ou perl Build.PL
passe les drapeaux spécifiés par le paramètre #:make-maker-flags
ou
#:module-build-flags
, respectivement.
Le paquet Perl utilisé peut être spécifié avec #:perl
.
Cette variable est exportée par (guix build-system renpy)
. Elle
implémente la procédure de construction plus ou moins standard utilisée pour
les jeux Ren’py, qui consiste à charger #:game
une fois, et donc à
créer le bytecode pour le jeu.
Elle crée aussi un script enveloppe dans bin/
et une entrée de bureau
dans share/applications
, tous deux pouvant être utilisés pour lancer
le jeu.
Le paquet Ren’py utilisé peut être spécifié avec #:renpy
. Les jeux
peuvent aussi être installé dans des sorties différentes de « out » avec
#:output
.
Cette variable est exportée par (guix build-system qt)
. Elle est
destinée à être employée avec des applications utilisant Qt ou KDE.
Ce système de construction ajoute les deux phases suivantes à celles
définies par gnu-build-system
:
check-setup
La phase check-setup
prépare l’environnement pour l’exécution des
contrôles tels qu’ils sont couramment utilisés par les programmes de test
Qt. Pour l’instant, elle ne définit que quelques variables d’environnement
: QT_QPA_PLATFORM=offscreen
, DBUS_FATAL_WARNINGS=0
et
CTEST_OUTPUT_ON_FAILURE=1
.
Cette phase est ajoutée avant la phase check
. C’est une phase
distincte pour faciliter l’ajustement si nécessaire.
qt-wrap
La phase qt-wrap
recherche les chemins des plugins Qt5, les chemins
QML et certains XDG dans les entrées et sorties. Si un chemin est trouvé,
tous les programmes des répertoires bin/, sbin/,
libexec/ et lib/libexec/ de la sortie sont enveloppés dans des
scripts définissant les variables d’environnement nécessaires.
Il est possible d’exclure des sorties de paquets spécifiques de ce processus
d’emballage en listant leurs noms dans le paramètre
#:qt-wrap-excluded-outputs
. Ceci est utile lorsqu’une sortie est
connue pour ne pas contenir de binaires Qt, et où le wrapping ajouterait
gratuitement une dépendance de cette sortie à Qt, KDE, ou autre.
Cette phase est exécutée après la phase install
.
Cette variable est exportée par (guix build-system r)
. Elle
implémente la procédure de compilation utilisée par les paquets
R, qui consiste en substance à exécuter
‘R CMD INSTALL --library=/gnu/store/…’ dans un environnement où
R_LIBS_SITE
contient les chemins de toutes les entrées des paquets R.
Les tests sont exécutés après l’installation en utilisant la fonction R
tools::testInstalledPackage
.
Cette variable est exportée par (guix build-system rakudo)
. Elle
implémente la procédure de construction utilisée par
Rakudo pour les paquets
Perl6. Elle installe le paquet dans
/gnu/store/…/NOM-VERSION/share/perl6
et installe les binaires,
les fichiers de bibliothèques et les ressources, et enveloppe les fichiers
dans le répertoire bin/
. Les tests peuvent être passés en indiquant
#f
au paramètre tests?
.
Le paquet rakudo utilisé peut être spécifié avec rakudo
. Le paquet
perl6-tap-harness utilisé pour les tests peut être spécifié avec
#:prove6
ou supprimé en passant #f
au paramètre
with-prove6?
. Le paquet perl6-zef utilisé pour les tests et
l’installation peut être spécifié avec #:ef
ou supprimé en passant
#f
au paramètre with-zef?
.
Cette variable est exportée par (guix build-system rebar)
. Elle
implémente une procédure de construction pour
rebar3, un système de construction pour les
programmes écrits en Erlang.
Elle ajoute à la fois rebar3
et erlang
à l’ensemble des
entrées. Des paquets différents peuvent être spécifiés avec les paramètres
#:rebar
et #:erlang
, respectivement.
Ce système de construction est basé sur gnu-build-system, mais avec les phases suivantes modifiées :
unpack
Cette phase, après avoir déballé les sources comme le fait le
gnu-build-system
, vérifie qu’un fichier contents.tar.gz
existe
au plus haut niveau des sources. Si ce fichier existe, il sera aussi
déballé. Cela facilite la gestion des paquets hébergés sur
https://hex.pm/, le dépôt des paquets Erlang et Elixir.
bootstrap
configure
Il n’y a ni phase bootstrap
ni configure
parce que les paquets
erlang n’ont pas besoin d’être configurés.
build
Cette phase lance rebar3 compile
avec les drapeaux listés dans
#:rebar-flags
.
check
À moins que #:tests? #f
ne soit passé, cette phase lance rebar3
eunit
, ou une cible spécifiée avec #:test-target
, avec les drapeaux
listés dans #:rebar-flags
,
install
Cela installe les fichiers créés dans le profil default, ou un autre
profil spécifié avec #:install-profile
.
Cette variable est exportée par (guix build-system texlive)
. Elle
est utilisée pour construire des paquets TeX en mode batch avec le moteur
spécifié. Le système de construction initialise la variable TEXINPUTS
pour trouver tous les fichiers source TeX dans ses entrées.
By default it tries to run luatex
on all .ins files, and if it
fails to find any, on all .dtx files. A different engine and format
can be specified with, respectively, the #:tex-engine
and
#:tex-format
arguments. Different build targets can be specified
with the #:build-targets
argument, which expects a list of file
names.
It also generates font metrics (i.e., .tfm files) out of Metafont
files whenever possible. Likewise, it can also create TeX formats (i.e.,
.fmt files) listed in the #:create-formats
argument, and
generate a symbolic link from bin/ directory to any script located in
texmf-dist/scripts/, provided its file name is listed in
#:link-scripts
argument.
The build system adds texlive-bin
from (gnu packages tex)
to
the native inputs. It can be overridden with the #:texlive-bin
argument.
The package texlive-latex-bin
, from the same module, contains most of
the tools for building TeX Live packages; for convenience, it is also added
by default to the native inputs. However, this can be troublesome when
building a dependency of texlive-latex-bin
itself. In this
particular situation, the #:texlive-latex-bin?
argument should be set
to #f
.
Cette variable est exportée par (guix build-system ruby)
. Elle
implémenter la procédure de construction RubyGems utilisée par les paquets
Ruby qui consiste à lancer gem build
suivi de gem install
.
Le champ source
d’un paquet qui utilise ce système de construction
référence le plus souvent une archive gem, puisque c’est le format utilisé
par les personnes qui développent en Ruby quand elles publient leur
logiciel. Le système de construction décompresse l’archive gem,
éventuellement en corrigeant les sources, lance la suite de tests,
recompresse la gemme et l’installe. En plus, des répertoires et des
archives peuvent être référencés pour permettre de construire des gemmes qui
n’ont pas été publiées depuis Git ou une archive de sources traditionnelle.
Le paquet Ruby utilisé peut être spécifié avec le paramètre #:ruby
.
Une liste de drapeaux supplémentaires à passer à la commande gem
peut être spécifiée avec le paramètre #:gem-flags
.
Cette variable est exportée par (guix build-system waf)
. Elle
implémente une procédure de construction autour du script waf
. Les
phases usuelles — configure
, build
et install
— sont
implémentée en passant leur nom en argument au script waf
.
Le script waf
est exécuté par l’interpréteur Python. Le paquet
Python utilisé pour lancer le script peut être spécifié avec le paramètre
#:python
.
This variable is exported by (guix build-system zig)
. It implements
the build procedures for the Zig build system
(zig build
command).
Selecting this build system adds zig
to the package inputs, in
addition to the packages of gnu-build-system
.
There is no configure
phase because Zig packages typically do not
need to be configured. The #:zig-build-flags
parameter is a list of
flags that are passed to the zig
command during the build. The
#:zig-test-flags
parameter is a list of flags that are passed to the
zig test
command during the check
phase. The default compiler
package can be overridden with the #:zig
argument.
The optional zig-release-type
parameter declares the type of
release. Possible values are: safe
, fast
, or
small
. The default value is #f
, which causes the release flag
to be omitted from the zig
command. That results in a debug
build.
Cette variable est exportée par (guix build-system scons)
. Elle
implémente la procédure de construction utilisée par l’outil de construction
SCons. Ce système de construction lance scons
pour construire le
paquet, scons test
pour lancer les tests puis scons install
pour installer le paquet.
Des drapeaux supplémentaires à passer à scons
peuvent être spécifiés
avec le paramètre #:scons-flags
. Les cibles de construction et
d’installation par défaut peuvent être remplacées respectivement par les
paramètres #:build-targets
et #:install-targets
. La version
de Python utilisée pour exécuter SCons peut être spécifiée en sélectionnant
le paquet SCons approprié avec le paramètre #:scons
.
Cette variable est exportée par (guix build-system haskell)
. Elle
implémente la procédure de construction Cabal utilisée par les paquets
Haskell, qui consiste à lancer runhaskell Setup.hs configure
--prefix=/gnu/store/…
et runhaskell Setup.hs build
. Plutôt
que d’installer le paquets en lançant runhaskell Setup.hs install
,
pour éviter d’essayer d’enregistrer les bibliothèques dans le répertoire du
dépôt en lecture-seule du compilateur, le système de construction utilise
runhaskell Setup.hs copy
, suivi de runhaskell Setup.hs
register
. En plus, le système de construction génère la documentation du
paquet en lançant runhaskell Setup.hs haddock
, à moins que
#:haddock? #f
ne soit passé. Des paramètres facultatifs pour Haddock
peuvent être passés à l’aide du paramètre #:haddock-flags
. Si le
fichier Setup.hs
n’est pas trouvé, le système de construction
cherchera Setup.lhs
à la place.
Le compilateur Haskell utilisé peut être spécifié avec le paramètre
#:haskell
qui a pour valeur par défaut ghc
.
Cette variable est exportée par (guix build-system dub)
. Elle
implémente la procédure de construction Dub utilisée par les paquets D qui
consiste à lancer dub build
et dub run
. L’installation est
effectuée en copiant les fichiers manuellement.
Le compilateur D utilisé peut être spécifié avec le paramètre #:ldc
qui vaut par défaut ldc
.
Cette variable est exportée par (guix build-system emacs)
. Elle
implémente une procédure d’installation similaire au système de gestion de
paquet d’Emacs lui-même (voir Packages dans The GNU Emacs Manual).
Cela crée d’abord le fichier
, puis
compile tous les fichiers Emacs Lisp en bytecode. Contrairement au système
de gestion de paquets d’Emacs, les fichiers de documentation info sont
déplacés dans le répertoire standard et le fichier dir est supprimé.
Les fichiers du paquet Elisp sont directement installés sous
share/emacs/site-lisp.
package
-autoloads.el
Cette variable est exportée par (guix build-system font)
. Elle
implémente une procédure d’installation pour les paquets de polices où des
fichiers de polices TrueType, OpenType, etc. sont fournis en amont et
n’ont qu’à être copiés à leur emplacement final. Elle copie les fichiers de
polices à l’emplacement standard dans le répertoire de sortie.
Cette variable est exportée par (guix build-system meson)
. Elle
implémente la procédure de construction des paquets qui utilisent
Meson comme système de construction.
Elle ajoute à la fois Meson et Ninja à
l’ensemble des entrées, et ils peuvent être modifiés avec les paramètres
#:meson
et #:ninja
si requis.
Ce système de construction est une extension de gnu-build-system
,
mais avec les phases suivantes modifiées pour Meson :
configure
La phase lance meson
avec les drapeaux spécifiés dans
#:configure-flags
. Le drapeau --buildtype est toujours
défini à debugoptimized
à moins qu’autre chose ne soit spécifié dans
#:build-type
.
build
La phase lance ninja
pour construire le paquet en parallèle par
défaut, mais cela peut être changé avec #:parallel-build?
.
check
La phase lance ‘meson test’ avec un ensemble d’options de base qui ne
peuvent pas être modifiées. Cette base d’options peut être étendue avec
l’argument #:test-options
, par exemple pour choisir ou passer une
suite de test spécifique.
install
La phase lance ninja install
et ne peut pas être changée.
En dehors de cela, le système de construction ajoute aussi la phase suivante :
fix-runpath
Cette phase s’assure que tous les binaire peuvent trouver les bibliothèques
dont ils ont besoin. Elle cherche les bibliothèques requises dans les
sous-répertoires du paquet en construction et les ajoute au RUNPATH
là où c’est nécessaire. Elle supprime aussi les références aux
bibliothèques laissées là par la phase de construction par meson
comme les dépendances des tests, qui ne sont pas vraiment requises pour le
programme.
glib-or-gtk-wrap
Cette phase est la phase fournie par glib-or-gtk-build-system
et
n’est pas activée par défaut. Elle peut l’être avec #:glib-or-gtk?
.
glib-or-gtk-compile-schemas
Cette phase est la phase fournie par glib-or-gtk-build-system
et
n’est pas activée par défaut. Elle peut l’être avec #:glib-or-gtk?
.
linux-module-build-system
permet de construire des modules du noyau
Linux.
Ce système de construction est une extension de gnu-build-system, mais avec les phases suivantes modifiées :
configure
Cette phase configure l’environnement pour que le Makefile du noyau Linux puisse être utilisé pour construire le module du noyau externe.
build
Cette phase utilise le Makefile du noyau Linux pour construire le module du noyau externe.
install
Cette phase utilise le Makefile du noyau Linux pour installer le module du noyau externe.
Il est possible et utile de spécifier le noyau Linux à utiliser pour
construire le module (sous la forme arguments
d’un paquet utilisant
le linux-module-build-system
, utilisez la clé #:linux
pour le
spécifier).
Cette variable est exportée par (guix build-system node)
. Elle
implémente la procédure de compilation utilisée par
Node.js, qui implémente une approximation de la
commande npm install
, suivie d’une commande npm test
.
Le paquet Node.js utilisé pour interpréter les commandes npm
peut
être spécifié avec le paramètre #:node
dont la valeur par défaut est
node
.
This variable is exported by (guix build-system tree-sitter)
. It
implements procedures to compile grammars for the
Tree-sitter parsing
library. It essentially runs tree-sitter generate
to translate
grammar.js
grammars to JSON and then to C. Which it then compiles to
native code.
Tree-sitter packages may support multiple grammars, so this build system
supports a #:grammar-directories
keyword to specify a list of
locations where a grammar.js
file may be found.
Grammars sometimes depend on each other, such as C++ depending on C and TypeScript depending on JavaScript. You may use inputs to declare such dependencies.
Enfin, pour les paquets qui n’ont pas besoin de choses sophistiquées, un système de construction « trivial » est disponible. Il est trivial dans le sens où il ne fournit en gros aucun support : il n’apporte pas de dépendance implicite, et n’a pas de notion de phase de construction.
Cette variable est exportée par (guix build-system trivial)
.
Ce système de construction requiert un argument #:builder
. Cet
argument doit être une expression Scheme qui construit la sortie du paquet —
comme avec build-expression->derivation
(voir build-expression->derivation
).
Cette variable est exportée par (guix build-system channel)
.
Ce système de construction est surtout conçu pour usage interne. Pour
utiliser ce système de construction, un paquet doit avoir une spécification
de canal dans son champ source
(voir Canaux); autrement, sa
source doit être un nom de répertoire, auquel cas un argument
#:commit
supplémentaire doit être fournit pour spécifier le commit à
construire (une chaine hexadécimale).
Optionally, a #:channels
argument specifying additional channels can
be provided.
The resulting package is a Guix instance of the given channel(s), similar to
how guix time-machine
would build it.
Suivant: Utilitaires de construction, Précédent: Systèmes de construction, Monter: Interface de programmation [Table des matières][Index]
Presque tous les systèmes de construction de paquets mettent en œuvre une
notion de phase de construction : une séquence d’actions que le
système de construction exécute, lorsque vous construisez le paquet,
conduisant aux sous-produits installés dans le dépôt. Une exception notable
est le trivial-build-system
(voir Systèmes de construction) minimaliste.
Comme nous l’avons dit dans la section précédente, ces systèmes de
construction fournissent une liste de phases standards. Pour
gnu-build-system
, les phases de construction principales sont les
suivantes :
set-paths
Défini les variables d’environnement de chemins de recherche pour tous les
paquets d’entrée, dont PATH
(voir Chemins de recherche).
unpack
Décompresse l’archive des sources et se déplace dans l’arborescence des sources fraîchement extraites. Si la source est en fait un répertoire, le copie dans l’arborescence de construction et entre dans ce répertoire.
patch-source-shebangs
Corrige les shebangs (#!
) rencontrés dans les fichiers pour qu’ils se
réfèrent aux bons noms de fichiers. Par exemple, elle change
#!/bin/sh
en #!/gnu/store/…-bash-4.3/bin/sh
.
configure
Lance le script configure
avec un certain nombre d’options par
défaut, comme --prefix=/gnu/store/…, ainsi que les options
spécifiées par l’argument #:configure-flags
.
build
Lance make
avec la liste des drapeaux spécifiés avec
#:make-flags
. Si l’argument #:parallel-build?
est vrai (par
défaut), construit avec make -j
.
check
Lance make check
, ou une autre cible spécifiée par
#:test-target
, à moins que #:tests? #f
ne soit passé. Si
l’argument #:parallel-tests?
est vrai (par défaut), lance make
check -j
.
install
Lance make install
avec les drapeaux listés dans #:make-flags
.
patch-shebangs
Corrige les shebangs des fichiers exécutables installés.
strip
Nettoie les symboles de débogage dans les fichiers ELF (à moins que
#:strip-binaries?
ne soit faux), les copie dans la sortie
debug
lorsqu’elle est disponible (voir Installer les fichiers de débogage).
validate-runpath
Valide le RUNPATH
des binaires ELF, à moins que
#:validate-runpath?
ne soit faux (voir Systèmes de construction).
Cette étape de validation s’assure que toutes les bibliothèques partagées
par les binaires ELF, qui sont listées dans des entrées DT_NEEDED
de
leur segment PT_DYNAMIC
apparaissent dans l’entrée DT_RUNPATH
de ce même binaire. En d’autres termes, elle s’assure que lancer ou utiliser
ces binaires ne renvoie pas l’erreur « fichier introuvable » à
l’exécution. Voir -rpath dans The GNU Linker, pour plus
d’informations sur le RUNPATH
.
Les autres systèmes de construction ont des phases similaires, avec quelques
variations. Par exemple, cmake-build-system
a des phases de même nom,
mais sa phase configure
exécute cmake
au lieu de
./configure
. D’autres, tels que python-build-system
, ont une
liste de phases standard totalement différente. Tout ce code s’exécute
côté construction : il est évalué lorsque vous construisez réellement
le paquet, dans un processus de construction dédié engendré par le démon de
construction (voir Invoquer guix-daemon
).
Les phases de construction sont représentées sous forme de listes d’associations ou « alists » (voir Listes d’association dans Manuel de référence de GNU Guile) où chaque clé est un symbole pour le nom de la phase et la valeur associée est une procédure qui accepte un nombre arbitraire d’arguments. Par convention, ces procédures reçoivent des informations sur la construction sous la forme de paramètres nommés, qu’elles peuvent utiliser ou ignorer.
Par exemple, voici comment (guix build gnu-build-system)
définit
%standard-phases
, la variable contenant sa liste de phases de
construction21 :
;; Les phases de construction de « gnu-build-system ». (define* (unpack #:key source #:allow-other-keys) ;; Extrait l'archive des sources. (invoke "tar" "xvf" source)) (define* (configure #:key outputs #:allow-other-keys) ;; Exécute le script « configure ». Installe la sortie « out ». (let ((out (assoc-ref outputs "out"))) (invoke "./configure" (string-append "--prefix=" out)))) (define* (build #:allow-other-keys) ;; Compile. (invoke "make")) (define* (check #:key (test-target "check") (tests? #true) #:allow-other-keys) ;; Lance la suite de tests. (if tests? (invoke "make" test-target) (display "test suite not run\n"))) (define* (install #:allow-other-keys) ;; Installe les fichiers sous le préfixe spécifié à « configure ». (invoke "make" "install")) (define %standard-phases ;; La liste des phases standard (un certain nombre d'entre elles sont omises ;; par souci de concision). Chaque élément est une paire symbole/procédure. (list (cons 'unpack unpack) (cons 'configure configure) (cons 'build build) (cons 'check check) (cons 'install install)))
Cela montre comment %standard-phases
est défini comme une liste de
paires symbole/procédure (voir Pairs dans GNU Guile Reference
Manual). La première paire associe le symbole unpack
— un nom —
à la procédure unpack
; la deuxième paire définit la phase
configure
de manière similaire, et ainsi de suite. Lors de la
construction d’un paquet qui utilise gnu-build-system
avec sa liste
de phases par défaut, ces phases sont exécutées de manière séquentielle.
Vous pouvez voir le nom de chaque phase commencée et terminée dans le
journal de construction des paquets que vous construisez.
Examinons maintenant les procédures elles-mêmes. Chacune est définie par
define*
: #:key
énumère les paramètres nommés que la procédure
accepte, éventuellement avec une valeur par défaut, et
#:allow-other-keys
précise que les autres paramètres nommés sont
ignorés (voir Optional Arguments dans GNU Guile Reference Manual).
La procédure unpack
prend en compte le paramètre source
, que
le système de compilation utilise pour passer le nom de fichier de l’archive
source (ou le répertoire cloné d’un système de contrôle de version), et elle
ignore les autres paramètres. La phase configure
ne s’intéresse
qu’au paramètre outputs
, une liste d’association des noms des sorties
du paquet avec le nom de leur fichier du dépôt (voir Des paquets avec plusieurs résultats). Elle extrait le nom de fichier de out
, la sortie
par défaut, et le transmet à ./configure
comme préfixe
d’installation, ce qui signifie que make install
copiera tous les
fichiers vers ce répertoire (voir configuration and
makefile conventions dans GNU Coding Standards). build
et
install
ignorent tous leurs arguments. check
prend en compte
l’argument test-target
, qui spécifie le nom de la cible du Makefile
pour exécuter les tests ; il imprime un message et saute les tests lorsque
tests?
est faux.
La liste des phases utilisées pour un paquet particulier peut être modifiée
avec le paramètre #:phases
du système de construction. La
modification de l’ensemble des phases de construction se résume à la
création d’une nouvelle liste de phases basée sur la liste
%standard-phases
décrite ci-dessus. On peut faire cela à l’aide des
procédures standards qui manipulent des listes d’associations telles que
alist-delete
(voir SRFI-1 Association Lists dans GNU Guile
Reference Manual) ; cependant, il est plus pratique de le faire avec
modify-phases
(voir modify-phases
).
Voici un exemple de définition de paquet qui supprime la phase
configure
de %standard-phases
et insère une nouvelle phase
avant la phase build
, appelée set-prefix-in-makefile
:
(define-public example
(package
(name "example")
;; other fields omitted
(build-system gnu-build-system)
(arguments
(list
#:phases
#~(modify-phases %standard-phases
(delete 'configure)
(add-before 'build 'set-prefix-in-makefile
(lambda* (#:key inputs #:allow-other-keys)
;; Modify the makefile so that its
;; 'PREFIX' variable points to #$output and
;; 'XMLLINT' points to the correct path.
(substitute* "Makefile"
(("PREFIX =.*")
(string-append "PREFIX = " #$output "\n"))
(("XMLLINT =.*")
(string-append "XMLLINT = "
(search-input-file inputs "/bin/xmllint")
"\n"))))))))))
The new phase that is inserted is written as an anonymous procedure,
introduced with lambda*
; it looks for the xmllint executable
under a /bin directory among the package’s inputs (voir Référence de package
). It also honors the outputs
parameter we have seen
before. Voir Utilitaires de construction, for more about the helpers used by this
phase, and for more examples of modify-phases
.
Astuce : You can inspect the code associated with a package’s
#:phases
argument interactively, at the REPL (voir Utiliser Guix de manière interactive).
Keep in mind that build phases are code evaluated at the time the package is
actually built. This explains why the whole modify-phases
expression
above is quoted (it comes after the #~
or hash-tilde): it is
staged for later execution. Voir G-Expressions, for an explanation
of code staging and the code strata involved.
Suivant: Chemins de recherche, Précédent: Phases de construction, Monter: Interface de programmation [Table des matières][Index]
Dès que vous commencerez à écrire des définitions de paquets non triviales
(voir Définition des paquets) ou d’autres actions de compilation
(voir G-Expressions), vous commencerez probablement à chercher des
fonctions auxiliaires pour les actions « de type shell » — créer des
répertoires, copier et supprimer des fichiers de manière récursive,
manipuler les phases de compilation, etc. Le module (guix build
utils)
fournit de telles procédures utilitaires.
La plupart des systèmes de construction chargent (guix build utils)
(voir Systèmes de construction). Ainsi, lorsque vous écrivez des phases de
construction personnalisées pour vos définitions de paquets, vous pouvez
généralement supposer que ces procédures sont disponibles.
Lorsque vous écrivez des G-expressions, vous pouvez importer (guix
build utils)
« côté construction » en utilisant
with-imported-modules
et ensuite le rendre disponible avec la forme
use-modules
(voir Using Guile Modules dans GNU Guile Reference
Manual) :
(with-imported-modules '((guix build utils)) ;on l'importe
(computed-file "empty-tree"
#~(begin
;; On le rend disponible.
(use-modules (guix build utils))
;; On utilise sa procédure « mkdir-p » sans souci.
(mkdir-p (string-append #$output "/a/b/c")))))
Le reste de cette section est la référence pour la plupart des procédures
auxiliaires fournies par (guix build utils)
.
Cette section documente les procédures de traitement des noms de fichier du dépôt.
Renvoie le nom de répertoire du dépôt.
Renvoie vrai si fichier est dans le dépôt.
Enlevez le /gnu/store et le hash de fichier, un nom de fichier
du dépôt. Le résultat est généralement une chaîne
"paquet-version"
.
Si l’on passe nom, un nom de paquet comme "toto-0.9.1b"
, on
obtient deux valeurs : "toto"
et "0.9.1b"
. Lorsque la partie
version est indisponible, nom et #f
sont renvoyés. Le premier
trait d’union suivi d’un chiffre est considéré comme introduisant la partie
version.
Les procédures ci-dessous portent sur les fichiers et les types de fichiers.
Renvoie #t
si dir existe et est un répertoire.
Renvoie #t
si fichier existe et est exécutable.
Renvoie #t
si fichier est un lien symbolique (un « symlink »).
Renvoie #t
si fichier est, respectivement, un fichier ELF, une
archive ar
(telle qu’une bibliothèque statique .a), ou un
fichier gzip.
Si fichier est un fichier gzip, réinitialise son horodatage intégré
(comme avec gzip --no-name
) et renvoie vrai. Sinon, renvoie
#f
. Lorsque keep-mtime? est vrai, conserve la date de
modification de fichier.
Les procédures et macros suivantes permettent de créer, modifier et
supprimer des fichiers. Elles offrent des fonctionnalités comparables à
celles des utilitaires shell courants tels que mkdir -p
,
cp -r
, rm -r
et sed
. Elles complètent
l’interface de système de fichiers étendue, mais de bas niveau, de Guile
(voir POSIX dans GNU Guile Reference Manual).
Exécute corps avec répertoire comme répertoire actuel du processus.
En gros, cette macro change le répertoire actuel en répertoire avant
d’évaluer corps, en utilisant chdir
. (voir Processus dans Manuel de référence de GNU Guile). Elle revient au répertoire
initial à la sortie de la portée dynamique de corps, qu’il s’agisse
d’un retour de procédure normal ou d’une sortie non locale telle qu’une
exception.
Crée le répertoire dir et tous ses ancètres.
Crée répertoire s’il n’existe pas et y copie fichier sous le même nom.
Rend fichier inscriptible pour son propriétaire.
copy-file] [#:keep-mtime? #f] [#:keep-permissions? #t] [#:select? (const
#t)] Copy source directory to destination. Follow symlinks if
follow-symlinks? is true; otherwise, just preserve them. Call
copy-file to copy regular files. Call select?, taking two
arguments, file and stat, for each entry in source, where
file is the entry’s absolute file name and stat is the result of
lstat
(or stat
if follow-symlinks? is true); exclude
entries for which select? does not return true. When
keep-mtime? is true, keep the modification time of the files in
source on those of destination. When keep-permissions? is
true, preserve file permissions. Write verbose output to the log
port.
Efface récursivement dir, comme rm -rf
, sans suivre les
liens symboliques. Ne suit pas non plus les points de montage, à moins que
follow-mounts? ne soit vrai. Rapporte mais ignore les erreurs.
fichier par la chaîne renvoyée par body. body est évalué avec chaque match-var lié à la sous-expression de regexp positionnelle correspondante. Par exemple :
(substitute* file
(("hello")
"good morning\n")
(("toto([a-z]+)titi(.*)$" all letters end)
(string-append "tata" letters end)))
Ici, chaque fois qu’une ligne de fichier contient hello
, elle
est remplacée par good morning
. Chaque fois qu’une ligne de
fichier correspond à la deuxième regexp, all
est lié à la
correspondance complète, letters
est lié à la première
sous-expression, et end
est lié à la dernière.
Lorsque l’une des match-var est _
, aucune variable n’est liée à
la sous-chaîne de correspondance associée.
Autrement, fichier peut être une liste de noms de fichier, auquel cas ils sont tous sujets aux substitutions.
Be careful about using $
to match the end of a line; by itself it
won’t match the terminating newline of a line. For example, to match a
whole line ending with a backslash, one needs a regex like
"(.*)\\\\\n$"
.
Cette section documente les procédures pour chercher et filtrer des fichiers.
Renvoie un prédicat qui devient vrai lorsqu’on lui passe un nom de fichier dont le nom de base correspond à regexp.
Renvoie la liste des fichiers triés lexicographiquement sous dir pour
lesquels pred renvoie « vrai ». Deux arguments sont passés à
pred : le nom absolu du fichier et son tampon stat ; le prédicat par
défaut renvoie toujours « vrai ». pred peut également être une
expression régulière, auquel cas elle est équivalente à
(file-name-predicate pred)
. stat est utilisé pour
obtenir des informations sur les fichiers ; l’utilisation de lstat
signifie que les liens symboliques ne sont pas suivis. Si
directories? est vrai, alors les répertoires seront également inclus.
Si fail-on-error? est vrai, il lance une exception en cas d’erreur.
Voici quelques exemples où nous supposons que le répertoire actuel est la racine de l’arborescence des sources de Guix :
;; Liste tous les fichiers normaux dans le répertoire actuel. (find-files ".") ⇒ ("./.dir-locals.el" "./.gitignore" …) ;; Liste tous les fichiers .scm sous gnu/services. (find-files "gnu/services" "\\.scm$") ⇒ ("gnu/services/admin.scm" "gnu/services/audio.scm" …) ;; Liste les fichiers ar dans le répertoire actuel. (find-files "." (lambda (file stat) (ar-file? file))) ⇒ ("./libformat.a" "./libstore.a" …)
Renvoie le nom complet du fichier pour programme tel qu’il se trouve
dans $PATH
, ou #f
si programme n’a pas pu être trouvé.
Renvoie le nom de fichier complet de nom trouvé dans entrées ;
search-input-file
recherche les fichiers normaux et
search-input-directory
recherche les dossiers. Si nom n’est pas
trouvé, une exception est levée.
Ici, entrées doit être une liste d’association comme les variables
inputs
et native-inputs
disponibles dans les phases de
construction (voir Phases de construction).
Voici un exemple (simplifié) d’utilisation de search-input-file
dans
une phase de construction du paquet wireguard-tools
:
(add-after 'install 'wrap-wg-quick
(lambda* (#:key inputs outputs #:allow-other-keys)
(let ((coreutils (string-append (assoc-ref inputs "coreutils")
"/bin")))
(wrap-program (search-input-file outputs "bin/wg-quick")
#:sh (search-input-file inputs "bin/bash")
`("PATH" ":" prefix ,(list coreutils))))))
Vous trouverez des procédures pratiques pour invoquer des processus dans ce
module, en particulier des enveloppes pratiques autour de system*
de
Guile (voir system*
dans le manuel de référence de
Guile).
Invoque le programme avec les args donnés. Lève une exception
&invoke-error
si le code de retour n’est pas zéro ; sinon renvoie
#t
.
L’avantage par rapport à system*
c’est que vous n’avez pas besoin de
vérifier la valeur de sortie. Cela réduit le code dans les petits scripts
comme par exemple dans les phases de construction des paquets.
Renvoie vrai si c est une condition &invoke-error
.
Accède aux champs de c, une condition &invoke-error
.
Rapporte c, une condition &invoke-error
, sur port (par
défaut le port d’erreur actuel), dans un format humainement lisible.
L’utilisation habituelle ressemblerait à ceci :
(use-modules (srfi srfi-34) ;pour « guard » (guix build utils)) (guard (c ((invoke-error? c) (report-invoke-error c))) (invoke "date" "--option-imaginaire")) -| command "date" "--option-imaginaire" failed with status 1
Invoque programme avec args et capture la sortie standard et
l’erreur standard de programme. Si programme termine sans
erreur, n’affiche rien et renvoie la valeur non spécifiée ; sinon, lève une
condition d’erreur &message
qui inclut le code de statut et la sortie
de programme.
Voici un exemple :
(use-modules (srfi srfi-34) ;pour « guard » (srfi srfi-35) ;pour « message-condition? » (guix build utils)) (guard (c ((message-condition? c) (display (condition-message c)))) (invoke/quiet "date") ; tout va bien (invoke/quiet "date" "--imaginary-option")) -| 'date --imaginary-option' exited with status 1; output follows: date : option non reconnue '--imaginary-option' Saisissez « date --help » pour plus d'informations.
Le (guix build utils)
contient également des outils permettant de
manipuler les phases de construction telles qu’elles sont utilisées par les
systèmes de construction (voir Systèmes de construction). Les phases de
construction sont représentées sous forme de listes d’associations ou «
alists » (voir Association Lists dans Manuel de référence de GNU
Guile) où chaque clé est un symbole désignant la phase et où la valeur
associée est une procédure (voir Phases de construction).
Le noyau Guile et le module (srfi srfi-1)
fournissent tous deux des
outils pour manipuler les alignements. Le module (guix build utils)
complète ces outils avec des outils écrits en tenant compte des phases de
construction.
Modifie phases séquentiellement selon chaque clause, qui peut avoir l’une des formes suivantes :
(delete old-phase-name) (replace old-phase-name new-phase) (add-before old-phase-name new-phase-name new-phase) (add-after old-phase-name new-phase-name new-phase)
Où chaque phase-name ci-dessus est une expression s’évaluant en un symbole, et new-phase une expression évaluant à une procédure.
L’exemple ci-dessous est tiré de la définition du paquet grep
. Il
ajoute une phase à exécuter après la phase install
, appelée
fix-egrep-and-fgrep
. Cette phase est une procédure (lambda*
pour les procédures anonymes) qui prend un paramètre nommé #:outputs
et ignore les paramètres nommés supplémentaires (voir Optional
Arguments dans GNU Guile Reference Manual, pour en savoir plus sur
lambda*
et les arguments optionnels et nommés). La phase utilise
substitute*
pour modifier les scripts egrep et fgrep
installés afin qu’ils se réfèrent à grep
par son nom de fichier
absolu :
(modify-phases %standard-phases
(add-after 'install 'fix-egrep-and-fgrep
;; Corrige « egrep » et « fgrep » pour exécuter « grep » via son
;; nom de fichier absolu au lieu de le chercher dans $PATH.
(lambda* (#:key outputs #:allow-other-keys)
(let* ((out (assoc-ref outputs "out"))
(bin (string-append out "/bin")))
(substitute* (list (string-append bin "/egrep")
(string-append bin "/fgrep"))
(("^exec grep")
(string-append "exec " bin "/grep")))))))
Dans l’exemple ci-dessous, les phases sont modifiées de deux façons : la
phase standard configure
est supprimée, vraisemblablement parce que
le paquet n’a pas de script configure ou quelque chose de similaire,
et la phase par défaut install
est remplacée par une phase qui copie
manuellement les fichiers exécutables à installer :
(modify-phases %standard-phases
(delete 'configure) ;pas de script « configure »
(replace 'install
(lambda* (#:key outputs #:allow-other-keys)
;; Le Makefile du paquet ne fournit pas de règle « install »
;; alors on le fait nous-mêmes.
(let ((bin (string-append (assoc-ref outputs "out")
"/bin")))
(install-file "footswitch" bin)
(install-file "scythe" bin)))))
Il est courant qu’une commande ait besoin que certaines variables d’environnement soient initialisées pour fonctionner correctement, souvent des chemins de recherche (voir Chemins de recherche). Sans cela, la commande peut échouer à trouver les fichiers et les autres commandes dont elle a besoin, ou elle pourrait trouver la « mauvaise » dépendance — en dépendant de l’environnement sur lequel elle tourne. Voici quelques exemples :
PATH
;
GUILE_LOAD_PATH
et GUILE_LOAD_COMPILED_PATH
;
QT_PLUGIN_PATH
.
Pour l’auteur ou l’autrice d’un paquet, le but est de s’assurer que les
commandes fonctionnent toujours pareil plutôt que de dépendre de paramètres
externes. Une manière d’y arriver est d’envelopper les commandes dans
un petit script qui défini ces variables d’environnement, ce qui assure que
ces dépendances à l’exécution seront trouvées. L’enveloppe serait utilisée
pour initialiser PATH
, GUILE_LOAD_PATH
ou QT_PLUGIN_PATH
dans les exemple ci-dessus.
Pour faciliter cette tâche, le module (guix build utils)
fournit
quelques fonctions auxiliaires pour envelopper des commandes.
Crée une enveloppe pour programme. variables doit ressembler à ceci :
'(variable délimiteur position liste-de-répertoires)
où délimiteur est facultatif. :
sera utilisé si
délimiteur n’est pas fourni.
Par exemple, cet appel :
(wrap-program "toto"
'("PATH" ":" = ("/gnu/.../titi/bin"))
'("CERT_PATH" suffix ("/gnu/.../tata/certs"
"/qux/certs")))
copiera toto dans .toto-real et créera le fichier toto avec le contenu suivant :
#!emplacement/de/bin/bash export PATH="/gnu/.../titi/bin" export CERT_PATH="$CERT_PATH${CERT_PATH:+:}/gnu/.../tata/certs:/qux/certs" exec -a $0 emplacement/de/.foo-real "$@"
Si programme a déjà été enveloppé par wrap-program
, l’enveloppe
est agrandie avec les définitions de variables. Sinon, sh sera
utilisé comme interpréteur.
Enveloppe le script programme pour que variables soient définie
avant. Le format de variables est le même que pour la procédure
wrap-program
. Cette procédure est différente de wrap-program
car elle ne crée pas de script shell séparé. Au lieu de cela, program
est modifié directement en ajoutant un script Guile au début, qui est
interprété comme un commentaire par le langage de script.
Les commentaires à l’encodage spécifique pris en charge par Python sont recréés sur la seconde ligne.
Remarquez que cette procédure ne peut être utilisée qu’une seule fois par fichier car les scripts Guile ne sont pas pris en charge.
Suivant: Le dépôt, Précédent: Utilitaires de construction, Monter: Interface de programmation [Table des matières][Index]
De nombreux programmes et bibliothèques cherchent leurs données d’entrée dans un chemin de recherch, une liste de répertoire : les shells comme Bash cherchent des exécutables dans le chemin de recherche des commandes, un compilateur C cherche des fichiers .h dans son chemin de recherche d’en-têtes, l’interpréteur Python cheche des fichiers .py dans son chemin de recherche, le correcteur orthographique a un chemin de recherche pour les dictionnaires, et cætera.
Les chemins de recherche peuvent habituellement être définis ou remplacés
par des variables d’environnement (voir Environment Variables dans le
manuel de référence de la bibliothèque C de GNU). Par exemple, les chemins
de recherches mentionnés ci-dessus peuvent être modifiés en définissant les
variables d’environnement PATH
, C_INCLUDE_PATH
, PYTHONPATH
(ou GUIX_PYTHONPATH
) et DICPATH
— vous savez, toutes ces
variables comme PATH que vous devez paramétrer correctement sous peine de
voir les choses « non trouvée ».
Vous aurez peut-être remarqué en utilisant la ligne de commande, Guix « sait
» quelles variables d’environnement de chemin de recherche doivent être
définies et comment. Quand vous installez des paquets dans votre profil par
défaut, le fichier ~/.guix-profile/etc/profile est créé, et vous
pouvez le « sourcer » à partir du shell pour initialiser ces variables. De
même, si vous demandez à guix shell
de créer un environnement
contenant Python et NumPy, une bibliothèque Python, et que vous passez
l’option --search-paths, il vous parlera de PATH
et
GUIX_PYTHONPATH
(voir Invoquer guix shell
) :
$ guix shell python python-numpy --pure --search-paths export PATH="/gnu/store/…-profile/bin" export GUIX_PYTHONPATH="/gnu/store/…-profile/lib/python3.9/site-packages"
Si vous omettez --search-paths, il défini ces variables d’environnement directement, si bien que Python peut immédiatement trouver NumPy :
$ guix shell python python-numpy -- python3 Python 3.9.6 (default, Jan 1 1970, 00:00:01) [GCC 10.3.0] on linux Type "help", "copyright", "credits" or "license" for more information. >>> import numpy >>> numpy.version.version '1.20.3'
Pour que cela fonctionne, la définition du paquet python
déclare le chemin de recherche qui l’intéresse et sa variable
d’environnement associée, GUIX_PYTHONPATH
. Cela ressemble à ceci :
(package
(name "python")
(version "3.9.9")
;; quelques champs omis...
(native-search-paths
(list (search-path-specification
(variable "GUIX_PYTHONPATH")
(files (list "lib/python/3.9/site-packages"))))))
Ce qui ce champ native-search-paths
signifie que lorsque le paquet
python
est utilisé, la variable d’environnement GUIX_PYTHONPATH
doit être définie et inclure tous les sous-répertoires
lib/python/3.9/site-packages rencontrés dans son
environnement. (native-
signifie que, dans un environnement de
compilation croisée, seules les entrées natives seront ajoutées au chemin de
recherche ; voir search-paths
.) Dans l’exemple
NumPy ci-dessus, le profil où python
apparait contient exactement un
de ces sous-répertoires, et GUIX_PYTHONPATH
est initialisé à cette
valeur. Lorsqu’il y a plusieurs lib/python/3.9/site-packages —
c’est le cas dans l’environnement de construction des paquets — ils sont
ajoutés à GUIX_PYTHONPATH
, séparés par des deux-points (:
).
Remarque : Remarquez que
GUIX_PYTHONPATH
est spécifié dans la définition du paquetpython
, et pas dans celle depython-numpy
. C’est parce que cette variable d’environnement « appartient » à Python, pas à NumPy : Python lit effectivement la valeur de cette variable et la prend en compte.Corollaire : si vous créez un profil qui ne contient pas
python
,GUIX_PYTHONPATH
ne sera pas défini, même s’il contient des paquets qui fournissent des fichiers .py :$ guix shell python-numpy --search-paths --pure export PATH="/gnu/store/…-profile/bin"Cela a plus de sens si on considère ce profil individuellement : aucun logiciel de ce profil ne lirait
GUIX_PYTHONPATH
.
Bien sûr, il y a de nombreuses variations sur ce thème : certains paquets
prennent en compte plus d’un chemin de recherche, certains utiliser d’autres
séparateurs que le deux-points, certains accumulent plusieurs répertoires
dans leur chemin de recherche, etc. Un exemple plus complexe est le chemin
de recherche de libxml2 : la valeur de la variable d’environnement
XML_CATALOG_FILES
utilise des espaces pour séparer ses composants,
elle doit contenir une liste de fichiers catalog.xml (pas des
répertoires), qui doivent se trouver dans des sous-répertoires xml
— rien de moins. La spécification du chemin de recherche ressemble à ceci
:
(search-path-specification
(variable "XML_CATALOG_FILES")
(separator " ")
(files '("xml"))
(file-pattern "^catalog\\.xml$")
(file-type 'regular))
Ne vous inquiétez pas, les spécifications de chemins de recherche ne sont généralement pas aussi complexes.
Le module (guix search-paths)
défini le type de donnée des
spécifications de chemins de recherche et un certain nombre de procédures
auxiliaires. Vous trouverez ci-dessous la référence des spécifications de
chemins de recherche.
Le type de données représentant les spécifications de chemins de recherche.
variable
le nom de la variable d’environnement pour ce chemin de recherche (une chaine).
files
La liste des sous-répertoires (des chaines) qui devraient être ajoutés au chemin de recherche.
separator
(par défaut : ":"
)La chaine utilisée pour séparer les composants du chemin de recherche.
Un cas spécial, quand separator
vaut #f
, signifie qu’il n’y a
« qu’un composant au chemin de recherche » — en d’autres termes, le chemin
de recherche ne peut contenir plus d’un élément. C’est utile dans certains
cas, comme la variable SSL_CERT_DIR
(prise en compte par OpenSSL,
cURL, et quelques autres paquets) ou la variable ASPELL_DICT_DIR
(prise en compte par le correcteur orthographique GNU Aspell), toutes deux
devant pointer vers un unique répertoire.
file-type
(par défaut : 'directory
)Le type de fichier qui doit être trouvé — 'directory
ou
'regular
, même si cela peut aussi être n’importe quel symbole renvoyé
par stat:type
(voir stat
dans le manuel de
référence de Guile).
In the XML_CATALOG_FILES
example above, we would match regular files;
in the Python example, we would match directories.
file-pattern
(par défaut : #f
)Cela doit être soit #f
, soit une expression régulière qui spécifie
les fichiers à trouver à l’intérieur des sous-répertoires spécifiés
par le champ files
.
Again, the XML_CATALOG_FILES
example shows a situation where this is
needed.
Certains chemins de recherche ne sont pas liés à une seul paquet, mais à
plusieurs. Pour réduire la duplication, certains sont prédéfinis dans
(guix search-paths)
.
These two search paths indicate where the TR9401 catalog22 or XML catalog files can be found.
Ces deux chemins de recherche indiquent où trouver les certificats X.509 (voir Certificats X.509).
Ces chemins de recherche prédéfinis peuvent être utilisés comme dans l’exemple suivant :
(package
(name "curl")
;; certains champs sont omis ...
(native-search-paths (list $SSL_CERT_DIR $SSL_CERT_FILE)))
Comment transformer des spécifications de chemins de recherche d’un côté en
et un tas de répertoire de l’autre en un ensemble de définitions de
variables d’environnement ? C’est le travail de
evaluate-search-paths
.
Évalue search-paths, une liste de spécifications de chemins de recherche, par rapport à directories, une liste de noms de répertoires, et renvoie une liste de paires de spécification / valeur. Utilise getenv pour déterminer les paramètres actuel et rapporter seulement les paramètres qui ne sont pas déjà en place.
Le module (guix profiles)
fournit une procédure auxiliaire de
haut-niveau, load-profile
, qui met en place les variables
d’environnement d’un profil.
Suivant: Dérivations, Précédent: Chemins de recherche, Monter: Interface de programmation [Table des matières][Index]
Conceptuellement, le dépôt est l’endroit où les dérivations qui ont bien été construites sont stockées — par défaut, /gnu/store. Les sous-répertoires dans le dépôt s’appellent des éléments du dépôt ou parfois des chemins du dépôt. Le dépôt a une base de données associée qui contient des informations comme les chemins du dépôt auxquels se réfèrent chaque chemin du dépôt et la liste des éléments du dépôt valides — les résultats d’une construction réussie. Cette base de données se trouve dans localstatedir/guix/db où localstatedir est le répertoire d’états spécifié via --localstatedir à la configuration, typiquement /var.
C’est toujours le démon qui accède au dépôt pour le compte de ses
clients (voir Invoquer guix-daemon
). Pour manipuler le dépôt, les
clients se connectent au démon par un socket Unix-domain, envoient une
requête dessus et lisent le résultat — ce sont des appels de procédures
distantes, ou RPC.
Remarque : Les utilisateurs ne doivent jamais modifier les fichiers dans /gnu/store directement. Cela entraînerait des incohérences et casserait l’hypothèse d’immutabilité du modèle fonctionnel de Guix (voir Introduction).
Voir
guix gc --verify
, pour des informations sur la manière de vérifier l’intégrité du dépôt et d’essayer de réparer des modifications accidentelles.
Le module (guix store)
fournit des procédures pour se connecter au
démon et pour effectuer des RPCs. Elles sont décrites plus bas. Par
défaut, open-connection
, et donc toutes les commandes guix
se connectent au démon local ou à l’URI spécifiée par la variable
d’environnement GUIX_DAEMON_SOCKET
.
Lorsqu’elle est initialisée, la valeur de cette variable devrait être un nom de fichier ou une URI qui désigne l’extrémité du démon. Lorsque c’est un nom de fichier, il dénote un socket Unix-domain où se connecter. En plus des noms de fichiers, les schémas d’URI supportés sont :
file
unix
Pour les sockets Unix-domain. file:///var/guix/daemon-socket/socket
est équivalent à /var/guix/daemon-socket/socket.
guix
¶Ces URI dénotent des connexions par TCP/IP, sans chiffrement ni authentification de l’hôte distant. L’URI doit spécifier le nom d’hôte et éventuellement un numéro de port (par défaut 44146) :
guix://master.guix.example.org:1234
Ce paramétrage est adapté aux réseaux locaux, comme dans le cas de grappes
de serveurs, où seuls des noms de confiance peuvent se connecter au démon de
construction sur master.guix.example.org
.
L’option --listen
de guix-daemon
peut être utilisé pour lui
dire d’écouter les connexions TCP (voir --listen).
ssh
¶Ces URI vous permettent de vous connecter à un démon distant via SSH.
Cette fonctionnalité nécessite Guile-SSH (voir Prérequis) et un
binaire guile
fonctionnel dans PATH
sur la machine de
destination. Elle prend en charge l’authentification par clé publique et
GSSAPI. Une URL typique pourrait ressembler à ceci :
ssh://charlie@guix.example.org:22
Comme pour guix copy
, les fichiers de configuration du client
OpenSSH sont pris en compte (voir Invoquer guix copy
).
Des schémas d’URI supplémentaires pourraient être supportés dans le futur.
Remarque : La capacité de se connecter à un démon de construction distant est considéré comme expérimental à la version b2bd56f. Contactez-nous pour partager vos problèmes ou des suggestions que vous pourriez avoir (voir Contribuer).
Se connecte au démon à travers le socket Unix-domain à uri (une chaîne de caractères). Lorsque reserve-space? est vrai, cela demande de réserver un peu de place supplémentaire sur le système de fichiers pour que le ramasse-miette puisse opérer au cas où le disque serait plein. Renvoie un objet serveur.
file prend par défaut la valeur %default-socket-path
, qui est
l’emplacement normal compte tenu des options qui ont été passées à
configure
.
Ferme la connexion au serveur.
Cette variable est liée à un paramètre SRFI-39, qui se réfère au port où les journaux de construction et d’erreur envoyés par le démon devraient être écrits.
Les procédures qui font des RPC prennent toutes un objet serveur comme premier argument.
Renvoie #t
lorsque path désigne un élément valide du dépôt et
#f
sinon (un élément invalide peut exister sur le disque mais être
toujours invalide, par exemple parce qu’il est le résultat d’une
construction avortée ou échouée).
Une condition &store-protocol-error
est levée si path n’est pas
préfixée par le répertoire du dépôt (/gnu/store).
Ajoute text dans le fichier name dans le dépôt et renvoie son chemin. references est la liste des chemins du dépôt référencés par le chemin du dépôt qui en résulte.
Construit derivations, une liste d’objets <derivation>
, de noms
de fichiers .drv, ou de paires dérivation/sortie, en utilisant le
mode—(build-mode normal)
spécifié par défaut.
Remarque que le module (guix monads)
fournit une monade ainsi que des
version monadiques des procédures précédentes, avec le but de rendre plus
facile de travailler avec le code qui accède au dépôt (voir La monade du dépôt).
Cette section est actuellement incomplète.
Suivant: La monade du dépôt, Précédent: Le dépôt, Monter: Interface de programmation [Table des matières][Index]
Les actions de construction à bas-niveau et l’environnement dans lequel elles sont effectuées sont représentés par des dérivations. Une dérivation contient cet ensemble d’informations :
x86_64-linux
.
Les dérivations permettent aux client du démon de communiquer des actions de
construction dans le dépôt. Elles existent sous deux formes : en tant que
représentation en mémoire, à la fois côté client et démon, et en tant que
fichiers dans le dépôt dont le nom finit par .drv
— on dit que ce
sont des chemins de dérivations. Les chemins de dérivations peuvent
être passés à la procédure build-derivations
pour effectuer les
actions de construction qu’ils prescrivent (voir Le dépôt).
Des opérations comme le téléchargement de fichiers et la récupération de sources gérés par un logiciel de contrôle de version pour lesquels le hash du contenu est connu à l’avance sont modélisés par des dérivations à sortie fixe. Contrairement aux dérivation habituelles, les sorties d’une dérivation à sortie fixe sont indépendantes de ses entrées — p.ex. un code source téléchargé produit le même résultat quelque soit la méthode de téléchargement utilisée.
Les sorties des dérivations — c.-à-d. les résultats de la construction —
ont un ensemble de références, comme le rapporte le RPC
references
ou la commande guix gc --references
(voir Invoquer guix gc
). Les références sont l’ensemble des dépendances
à l’exécution des résultats de la construction. Les références sont un
sous-ensemble des entrées de la dérivation ; ce sous-ensemble est
automatiquement calculé par le démon de construction en scannant tous les
fichiers dans les sorties.
Le module (guix derivations)
fournit une représentation des
dérivations comme des objets Scheme, avec des procédures pour créer et
manipuler des dérivations. La primitive de plus bas-niveau pour créer une
dérivation est la procédure derivation
:
Construit une dérivation avec les arguments donnés et renvoie l’objet
<derivation>
obtenu.
Lorsque hash et hash-algo sont donnés, une dérivation à sortie fixe est créée — c.-à-d. une dérivation dont le résultat est connu à l’avance, comme dans le cas du téléchargement d’un fichier. Si, en plus, recursive? est vrai, alors la sortie fixe peut être un fichier exécutable ou un répertoire et hash doit être le hash d’une archive contenant la sortie.
Lorsque references-graphs est vrai, il doit s’agir d’une liste de paires de noms de fichiers et de chemins du dépôt. Dans ce cas, le graphe des références de chaque chemin du dépôt est exporté dans l’environnement de construction dans le fichier correspondant, dans un simple format texte.
Lorsque allowed-references est vrai, il doit s’agir d’une liste d’éléments du dépôt ou de sorties auxquelles la sortie de la dérivations peut faire référence. De même, disallowed-references, si vrai, doit être une liste de choses que la sortie ne doit pas référencer.
Lorsque leaked-env-vars est vrai, il doit s’agir d’une liste de
chaînes de caractères qui désignent les variables d’environnements qui
peuvent « fuiter » de l’environnement du démon dans l’environnement de
construction. Ce n’est possible que pour les dérivations à sortie fixe —
c.-à-d. lorsque hash est vrai. L’utilisation principale est de
permettre à des variables comme http_proxy
d’être passées aux
dérivations qui téléchargent des fichiers.
Lorsque local-build? est vrai, déclare que la dérivation n’est pas un bon candidat pour le déchargement et devrait plutôt être construit localement (voir Utiliser le dispositif de déchargement). C’est le cas des petites dérivations où le coût du transfert de données est plus important que les bénéfices.
Lorsque que substitutable? est faux, déclare que les substituts de la sortie de la dérivation ne devraient pas être utilisés (voir Substituts). Cela est utile par exemple pour construire des paquets qui utilisent des détails du jeu d’instruction du CPU hôte.
properties doit être une liste d’association décrivant les « propriétés » de la dérivation. Elle est gardée telle-quelle, sans être interprétée, dans la dérivation.
Voici un exemple avec un script shell comme constructeur, en supposant que store est une connexion ouverte au démon et bash pointe vers un exécutable Bash dans le dépôt :
(use-modules (guix utils) (guix store) (guix derivations)) (let ((builder ; ajoute le script Bash au dépôt (add-text-to-store store "my-builder.sh" "echo hello world > $out\n" '()))) (derivation store "toto" bash `("-e" ,builder) #:inputs `((,bash) (,builder)) #:env-vars '(("HOME" . "/homeless")))) ⇒ #<derivation /gnu/store/…-toto.drv => /gnu/store/…-toto>
Comme on pourrait s’en douter, cette primitive est difficile à utiliser
directement. Une meilleure approche est d’écrire les scripts de
construction en Scheme, bien sur ! Le mieux à faire pour cela est d’écrire
le code de construction comme une « G-expression » et de la passer à
gexp->derivation
. Pour plus d’informations, voir G-Expressions.
Il fut un temps où gexp->derivation
n’existait pas et où construire
une dérivation donc le code de construction était écrit en Scheme se faisait
avec build-expression->derivation
, documenté plus bas. Cette
procédure est maintenant obsolète, remplacée par gexp->derivation
qui
est meilleure.
Renvoie une dérivation qui exécute l’expression Scheme exp comme un
constructeur pour la dérivation name. inputs doit être une
liste de tuples (name drv-path sub-drv)
; lorsque sub-drv est
omis, "out"
est utilisé. modules est une liste de noms de
modules Guile du chemin de recherche actuel qui seront copiés dans le dépôt,
compilés et rendus disponibles dans le chemin de chargement pendant
l’exécution de exp — p. ex. ((guix build utils) (guix build
gnu-build-system))
.
exp est évaluée dans une environnement où %outputs
est lié à
une liste de paires de sortie/chemin, et où %build-inputs
est lié à
une liste de paires de chaînes de caractères et de chemin de sortie
construite à partir de inputs. Éventuellement, env-vars est une
liste de paires de chaînes de caractères spécifiant le nom et la valeur de
variables d’environnement visibles pour le constructeur. Le constructeur
termine en passant le résultat de exp à exit
; ainsi, lorsque
exp renvoie #f
, la construction est considérée en échec.
exp est construite avec guile-for-build (une dérivation).
Lorsque guile-for-build est omis où est #f
, la valeur du fluide
%guile-for-build
est utilisée à la place.
Voir la procédure derivation
pour la signification de
references-graph, allowed-references,
disallowed-references, local-build? et substitutable?.
Voici un exemple de dérivation à sortie unique qui crée un répertoire avec un fichier :
(let ((builder '(let ((out (assoc-ref %outputs "out"))) (mkdir out) ; create /gnu/store/…-goo (call-with-output-file (string-append out "/test") (lambda (p) (display '(hello guix) p)))))) (build-expression->derivation store "goo" builder)) ⇒ #<derivation /gnu/store/…-goo.drv => …>
Suivant: G-Expressions, Précédent: Dérivations, Monter: Interface de programmation [Table des matières][Index]
Les procédures qui travaillent sur le dépôt décrites dans les sections précédentes prennent toutes une connexion ouverte au démon de construction comme premier argument. Bien que le modèle sous-jacent soit fonctionnel, elles ont soit des effets de bord, soit dépendent de l’état actuel du dépôt.
Le premier point est embêtant : on doit se balader avec la connexion au démon dans toutes ces fonctions, ce qui rend impossible le fait de composer des fonctions qui ne prennent pas ce paramètre avec des fonctions qui le prennent. Le deuxième point est problématique : comme les opérations sur le dépôt ont des effets de bord ou dépendent d’états externes, elles doivent être enchaînés correctement.
C’est là que le module (guix monads)
arrive à la rescousse. Ce
module fournit un cadre pour travailler avec des monads, en
particulier une monade très utile pour notre usage, la monade du
dépôt. Les monades sont des constructions qui permettent deux choses :
associer un « contexte » avec une valeur (dans notre cas, le contexte est le
dépôt) et construire une séquence de calculs (ici les calculs comprennent
des accès au dépôt). Les valeurs dans une monade — les valeurs qui
contiennent ce contexte supplémentaire — sont appelées des valeurs
monadiques ; les procédures qui renvoient ce genre de valeur sont appelées
des procédures monadiques.
Considérez cette procédure « normale » :
(define (sh-symlink store)
;; Renvoie une dérivation qui crée un lien symbolique vers l'exécutable « bash ».
(let* ((drv (package-derivation store bash))
(out (derivation->output-path drv))
(sh (string-append out "/bin/bash")))
(build-expression->derivation store "sh"
`(symlink ,sh %output))))
En utilisant (guix monads)
et (guix gexp)
, on peut la réécrire
en une fonction monadique :
(define (sh-symlink)
;; Pareil, mais renvoie une valeur monadique.
(mlet %store-monad ((drv (package->derivation bash)))
(gexp->derivation "sh"
#~(symlink (string-append #$drv "/bin/bash")
#$output))))
Il y a plusieurs choses à remarquer avec cette deuxième version : le
paramètre store
est maintenant implicitement « enfilé » dans les
appels aux procédures monadiques package->derivation
et
gexp->derivation
, et la valeur monadique renvoyée par
package->derivation
est liée avec mlet
plutôt qu’avec un
simple let
.
Il se trouve que l’appel à package->derivation
peut même être omis
puisqu’il aura lieu implicitement, comme nous le verrons plus tard
(voir G-Expressions) :
(define (sh-symlink)
(gexp->derivation "sh"
#~(symlink (string-append #$bash "/bin/bash")
#$output)))
L’appel à la procédure monadique sh-symlink
n’a aucun effet. Comme
on pourrait le dire, « on sort d’une monade comme de la monarchie : en
l’exécutant »23. Donc, pour sortir de la monade et obtenir l’effet escompté, on
doit utiliser run-with-store
:
(run-with-store (open-connection) (sh-symlink)) ⇒ /gnu/store/...-sh-symlink
Remarquez que le module (guix monad-repl)
étend la console Guile avec
de nouvelles « commandes » pour rendre plus facile la manipulation de
procédures monadiques : run-in-store
et enter-store-monad
(voir Utiliser Guix de manière interactive). La première est utilisée pour « lancer
» une seule valeur monadique à travers le dépôt :
scheme@(guile-user)> ,run-in-store (package->derivation hello) $1 = #<derivation /gnu/store/…-hello-2.9.drv => …>
La deuxième entre dans une console récursive, où toutes les valeurs de retour sont automatiquement lancées à travers le dépôt :
scheme@(guile-user)> ,enter-store-monad store-monad@(guile-user) [1]> (package->derivation hello) $2 = #<derivation /gnu/store/…-hello-2.9.drv => …> store-monad@(guile-user) [1]> (text-file "toto" "Hello!") $3 = "/gnu/store/…-toto" store-monad@(guile-user) [1]> ,q scheme@(guile-user)>
Remarquez qu’on ne peut pas renvoyer de valeur non monadique dans la console
store-monad
.
D’autres méta-commandes sont disponibles sur la REPL, comme ,build
pour construire un objet simili-fichier (voir Utiliser Guix de manière interactive).
Les formes syntaxiques principales pour utiliser des monades en général sont
disponibles dans le module (guix monads)
et sont décrites ci-dessous.
Évalue n’importe quelle forme >>=
ou return
dans body
comme une monad.
Renvoie une valeur monadique qui encapsule val.
Lie une valeur monadique mval, en passant son « contenu » aux
procédures monadiques mproc…24. Il peut y avoir une ou plusieurs mproc
, comme dans
cet exemple :
(run-with-state (with-monad %state-monad (>>= (return 1) (lambda (x) (return (+ 1 x))) (lambda (x) (return (* 2 x))))) 'some-state) ⇒ 4 ⇒ some-state
Lie les variables var aux valeurs monadiques mval dans
body, une séquence d’expressions. Comme avec l’opérateur de liaison,
on peut réfléchir comme si on « ouvrait » la valeur non-monadique « contenue
» dans mval et comme si on faisait en sorte que var se réfère à
cette valeur pure, non-monadique, dans la portée de body. La forme
(var -> val) lie var à la valeur « normale » val,
comme let
. L’opération de liaison a lieu en séquence de la gauche
vers la droite. La dernière expression de body doit être une
expression monadique et son résultat deviendra le résultat de mlet
ou
mlet*
lorsque lancé dans la monad.
mlet*
est à mlet
ce que let*
est à let
(voir Local Bindings dans GNU Guile Reference Manual).
Lie mexp et les expressions monadiques suivantes en séquence, et renvoie le résultat de la dernière expression. Chaque expression dans la séquence doit être une expression monadique.
Cette procédure est similaire à mlet
, sauf que les valeurs de retour
des expressions monadiques sont ignorées. Dans ce sens, elle est analogue à
begin
, mais appliqué à des expressions monadiques.
Lorsque la condition est vraie, évalue la séquence des expressions
monadiques mexp0..mexp* comme dans un mbegin
. Lorsque la
condition est fausse, renvoie *unspecified*
dans la monade
actuelle. Chaque expression dans la séquence doit être une expression
monadique.
Lorsque la condition est fausse, évalue la séquence des expressions
monadiques mexp0..mexp* comme dans un mbegin
. Lorsque la
condition est vraie, renvoie *unspecified*
dans la monade
actuelle. Chaque expression dans la séquence doit être une expression
monadique.
Le module (guix monads)
fournit la monade d’état qui permet à
une valeur supplémentaire — l’état — d’être enfilée à travers les appels de
procédures.
La monade d’état. les procédure dans la monade d’état peuvent accéder et modifier l’état qui est enfilé.
Considérez l’exemple ci-dessous. La procédure square
renvoie une
valeur dans la monade d’état. Elle renvoie le carré de son argument, mais
incrémente aussi la valeur actuelle de l’état :
(define (square x) (mlet %state-monad ((count (current-state))) (mbegin %state-monad (set-current-state (+ 1 count)) (return (* x x))))) (run-with-state (sequence %state-monad (map square (iota 3))) 0) ⇒ (0 1 4) ⇒ 3
Lorsque c’est « lancé » à travers %state-monad
, nous obtenons cette
valeur d’état supplémentaire, qui est le nombre d’appels au square
.
Renvoie l’état actuel dans une valeur monadique.
Initialise l’état actuel à value et renvoie l’état précédent dans une valeur monadique.
Pousse value sur l’état actuel, qui est supposé être une liste, et renvoie l’état précédent dans une valeur monadique.
Récupère (pop) une valeur dans l’état actuel et la renvoie comme une valeur monadique. L’état est supposé être une liste.
Lance la valeur monadique mval avec state comme valeur initiale. Renvoie deux valeurs : la valeur du résultat et l’état du résultat.
L’interface principale avec la monade du dépôt, fournit par le module
(guix store)
, est la suivante.
La monade du dépôt — un alias pour %state-monad
.
Les valeurs dans la monade du dépôt encapsulent les accès vers le dépôt.
Lorsque son effet est nécessaire, une valeur de la monade du dépôt doit être
« évaluée » en la passant à la procédure run-with-store
(voir
ci-dessous).
Lance mval, une valeur monadique dans la monade du dépôt, dans store, une connexion ouvert au dépôt.
Renvoie une valeur monadique correspondant au nom de fichier dans le dépôt du fichier contenant text, une chaîne de caractères. references est une liste d’éléments du dépôt auxquels le fichier texte en résultat se réfère ; c’est la liste vide par défaut.
Renvoie une valeur monadique correspondant au nom de fichier absolu dans le dépôt du fichier contenant data, un vecteur d’octets. references est une liste d’éléments du dépôt auxquels le fichier binaire en résultat se réfère ; c’est la liste vide par défaut.
Renvoie le nom de file une fois ajouté au dépôt. Utilise name comme nom dans le dépôt ou le nom de fichier de file si name est omis.
Lorsque recursive? est vraie, le contenu de file est ajouté récursivement ; si file désigne un fichier simple et que recursive? est vrai, son contenu est ajouté et ses bits de permissions sont préservés.
Lorsque recursive? est vraie, appelle (select? file
stat)
pour chaque répertoire où file est le nom de fichier
absolu de l’entrée et stat est le résultat de lstat
; à
l’exception des entrées pour lesquelles select? ne renvoie pas vrai.
L’exemple ci-dessous ajoute un fichier au dépôt, sous deux noms différents :
(run-with-store (open-connection) (mlet %store-monad ((a (interned-file "README")) (b (interned-file "README" "LEGU-MIN"))) (return (list a b)))) ⇒ ("/gnu/store/rwm…-README" "/gnu/store/44i…-LEGU-MIN")
Le module (guix packages)
exporte les procédures monadiques liées aux
paquets suivantes :
Renvoie une valeur monadique qui contient le nom de fichier absolu de file dans le répertoire output de package. Lorsque file est omis, renvoie le nom du répertoire output de package. Lorsque target est vrai, l’utilise comme un triplet de cible pour la compilation croisée.
Notez que cette procédure ne permet pas de construire package. Ainsi, le résultat peut ou non désigner un fichier existant. Nous vous recommandons de ne pas utiliser cette procédure si vous ne savez pas ce que vous faites.
Version monadique de package-derivation
et
package-cross-derivation
(voir Définition des paquets).
Suivant: Invoquer guix repl
, Précédent: La monade du dépôt, Monter: Interface de programmation [Table des matières][Index]
On a donc des « dérivations » qui représentent une séquence d’actions de
construction à effectuer pour produire un élément du dépôt
(voir Dérivations). Ces actions de construction sont effectuées
lorsqu’on demande au démon de construire effectivement les dérivations ;
elles sont lancées par le démon dans un conteneur (voir Invoquer guix-daemon
).
Ça ne devrait pas vous surprendre, mais nous aimons écrire ces actions de
construction en Scheme. Lorsqu’on fait ça, on fini avec deux strates
de code Scheme25 : le « code hôte » — le code qui définit
les paquets, parle au démon, etc. — et le « code côté construction » — le
code qui effectue effectivement les actions de construction, comme créer des
répertoires, invoquer make
, etc. (voir Phases de construction).
Pour décrire une dérivation et ses actions de construction, on a typiquement
besoin d’intégrer le code de construction dans le code hôte. Ça revient à
manipuler le code de construction comme de la donnée, et l’homoiconicité de
Scheme — le code a une représentation directe en tant que donnée — est très
utile pour cela. Mais on a besoin de plus que le mécanisme de
quasiquote
en Scheme pour construire des expressions de construction.
Le module (guix gexp)
implémente les G-expressions, une forme
de S-expression adaptée aux expressions de construction. Les G-expression,
ou gexps, consistent en gros en trois formes syntaxiques :
gexp
, ungexp
et ungexp-splicing
(ou plus simplement :
#~
, #$
et #$@
), qui sont comparable à
quasiquote
, unquote
et unquote-splicing
respectivement
(voir quasiquote
dans GNU Guile Reference
Manual). Cependant il y a des différences majeures :
Ce mécanisme n’est pas limité aux paquets et aux objets de dérivation : Des
compilateurs capables d’ « abaisser » d’autres objets de haut niveau
vers des dérivations ou des fichiers dans le dépôt peuvent être définis, de
sorte que ces objets peuvent également être insérés dans des gexps. Par
exemple, un type utile d’objets de haut niveau pouvant être insérés dans un
gexp est celui des « objets de type fichier », qui permettent d’ajouter
facilement des fichiers au dépôt et d’y faire référence dans des dérivations
et autres (voir local-file
et plain-file
ci-dessous).
Pour illustrer cette idée, voici un exemple de gexp :
(define build-exp
#~(begin
(mkdir #$output)
(chdir #$output)
(symlink (string-append #$coreutils "/bin/ls")
"list-files")))
Cette gexp peut être passée à gexp->derivation
; on obtient une
dérivation qui construit un répertoire contenant exactement un lien
symbolique à /gnu/store/…-coreutils-8.22/bin/ls :
(gexp->derivation "the-thing" build-exp)
Comme on pourrait s’y attendre, la chaîne
"/gnu/store/…-coreutils-8.22"
est substituée à la place de la
référence au paquet coreutils dans le code de construction final, et
coreutils est automatiquement devenu une entrée de la dérivation. De
même, #$output
(équivalent à (ungexp output)
) est remplacé par
une chaîne de caractères contenant le nom du répertoire de la sortie de la
dérivation.
Dans le contexte d’une compilation croisée, il est utile de distinguer entre
des références à la construction native d’un paquet — qui peut être
lancé par l’hôte — et des références à la construction croisée d’un paquet.
Pour cela, #+
joue le même rôle que #$
, mais référence une
construction native d’un paquet :
(gexp->derivation "vi"
#~(begin
(mkdir #$output)
(mkdir (string-append #$output "/bin"))
(system* (string-append #+coreutils "/bin/ln")
"-s"
(string-append #$emacs "/bin/emacs")
(string-append #$output "/bin/vi")))
#:target "aarch64-linux-gnu")
Dans l’exemple ci-dessus, la construction native de coreutils est
utilisée, pour que ln
puisse effectivement être lancé sur l’hôte ;
mais ensuite la construction croisée d’emacs est utilisée.
Une autre fonctionnalité, ce sont les modules importés : parfois vous
voudriez pouvoir utiliser certains modules Guile de « l’environnement hôte »
dans la gexp, donc ces modules devraient être importés dans «
l’environnement de construction ». La forme with-imported-modules
vous permet d’exprimer ça :
(let ((build (with-imported-modules '((guix build utils))
#~(begin
(use-modules (guix build utils))
(mkdir-p (string-append #$output "/bin"))))))
(gexp->derivation "empty-dir"
#~(begin
#$build
(display "success!\n")
#t)))
Dans cet exemple, le module (guix build utils)
est automatiquement
récupéré dans l’environnement de construction isolé de notre gexp, pour que
(use-modules (guix build utils))
fonctionne comme on s’y attendrait.
Typiquement, vous voudriez que la closure complète du module soit
importé — c.-à-d. le module lui-même et tous les modules dont il dépend —
plutôt que seulement le module ; sinon, une tentative de chargement du
module échouera à cause des modules dépendants manquants. La procédure
source-module-closure
calcule la closure d’un module en cherchant
dans ses en-têtes sources, ce qui est pratique dans ce cas :
(use-modules (guix modules)) ;pour 'source-module-closure' (with-imported-modules (source-module-closure '((guix build utils) (gnu build image))) (gexp->derivation "something-with-vms" #~(begin (use-modules (guix build utils) (gnu build image)) …)))
Dans la même idée, parfois vous pouvez souhaiter importer non seulement des
modules en Scheme pur, mais aussi des « extensions » comme des liaisons
Guile de bibliothèques C ou d’autres paquet « complets ». Disons que vous
voulez utiliser le paquet guile-json
du côté de la construction,
voici comme procéder :
(use-modules (gnu packages guile)) ;pour 'guile-json' (with-extensions (list guile-json) (gexp->derivation "something-with-json" #~(begin (use-modules (json)) …)))
La forme syntaxique pour construire des gexps est résumée ci-dessous.
Renvoie une G-expression contenant exp. exp peut contenir une ou plusieurs de ces formes :
#$obj
(ungexp obj)
Introduit une référence à obj. obj peut être d’un des types
supportés, par exemple un paquet ou une dérivation, auquel cas la forme
ungexp
est remplacée par le nom de fichier de sa sortie — p. ex.
"/gnu/store/…-coreutils-8.22
.
Si boj est une liste, elle est traversée et les références aux objets supportés sont substitués de manière similaire.
Si obj est une autre gexp, son contenu est inséré et ses dépendances sont ajoutées à celle de la gexp qui l’entoure.
Si obj est un autre type d’objet, il est inséré tel quel.
#$obj:output
(ungexp obj output)
Cette forme est similaire à la précédente, mais se réfère explicitement à la sortie output de l’objet obj — c’est utile lorsque obj produit plusieurs sorties (voir Des paquets avec plusieurs résultats).
Sometimes a gexp unconditionally refers to the "out"
output, but the
user of that gexp would still like to insert a reference to another output.
The gexp-input
procedure aims to address that. Voir gexp-input.
#+obj
#+obj:output
(ungexp-native obj)
(ungexp-native obj output)
Comme ungexp
, mais produit une référence à la construction
native de obj lorsqu’elle est utilisée dans une compilation
croisée.
#$output[:output]
(ungexp output [output])
Insère une référence à la sortie output de la dérivation, ou à la sortie principale lorsque output est omis.
Cela ne fait du sens que pour les gexps passées à gexp->derivation
.
#$@lst
(ungexp-splicing lst)
Comme au dessus, mais recolle (splice) le contenu de lst dans la liste qui la contient.
#+@lst
(ungexp-native-splicing lst)
Comme au dessus, mais se réfère à la construction native des objets listés dans lst.
Les G-expressions créées par gexp
ou #~
sont des objets
d’exécution du type gexp?
(voir ci-dessous).
Marque les gexps définies dans body… comme requérant modules dans leur environnement d’exécution.
Chaque élément dans module peut être le nom d’un module, comme
(guix build utils)
ou le nom d’un module suivi d’une flèche, suivie
d’un objet simili-fichier :
`((guix build utils) (guix gcrypt) ((guix config) => ,(scheme-file "config.scm" #~(define-module …))))
Dans l’exemple au dessus, les deux premiers modules sont récupérés dans le chemin de recherche, et le dernier est créé à partir d’un objet simili-fichier.
Cette forme a une portée lexicale : elle a un effet sur les gexp directement définies dans body…, mais pas sur celles définies dans des procédures appelées par body….
Marque les gexps définies dans body… comme requérant
extensions dans leur environnement de construction et d’exécution.
extensions est typiquement une liste d’objets paquets comme définis
dans le module (gnu packages guile)
.
Concrètement, les paquets listés dans extensions sont ajoutés au chemin de chargement lors de la compilation des modules importés dans body… ; ils sont aussi ajoutés au chemin de chargement de la gexp renvoyée par body….
Renvoie #t
si obj est une G-expression.
Les G-expressions sont conçues pour être écrites sur le disque, soit en tant que code pour construire une dérivation, soit en tant que fichier normal dans le dépôt. Les procédures monadiques suivantes vous permettent de faire cela (voir La monade du dépôt, pour plus d’information sur les monads).
%load-path
] [#:effective-version "2. 2"] [#:references-graphs #f] [#:allowed-references #f] [#:disallowed-references #f] [#:leaked-env-vars #f] [#:script-name (string-append name "-builder")] [#:deprecation-warnings #f] [#:local-build ? #f] [#:substituable ? #t] [#:properties '()] [#:guile-for-build #f]Renvoie une dérivation name qui exécute exp (un gexp) avec guile-for-build (une dérivation) sur system ; exp est stocké dans un fichier appelé script-name. Lorsque target est vrai, il est utilisé comme le triplet cible de compilation croisée pour les paquets auxquels exp fait référence.
modules est devenu obsolète en faveur de
with-imported-modules
. Sa signification est de rendre modules
disponibles dans le contexte d’évaluation de exp ; modules est
une liste de noms de modules Guile qui sont cherchés dans module-path
pour les copier dans le dépôt, les compiler et les rendre disponibles dans
le chemin de chargement pendant l’exécution de exp — p. ex.
((guix build utils) (guix build gnu-build-system))
.
effective-version détermine la chaîne à utiliser lors d’ajout
d’extensions de exp (voir with-extensions
) au chemin de
recherche — p. ex. "2.2"
.
graft? détermine si les paquets référencés par exp devraient être greffés si possible.
Lorsque references-graphs est vrai, il doit s’agir d’une liste de tuples de la forme suivante :
(file-name obj) (file-name obj output) (file-name gexp-input) (file-name store-item)
La partie droite des éléments de references-graphs est automatiquement transformée en une entrée du processus de construction exp. Dans l’environnement de construction, chaque file-name contient le graphe des références de l’élément correspondant, dans un format texte simple.
allowed-references doit soit être #f
, soit une liste de noms de
sorties ou de paquets. Dans ce dernier cas, la liste dénote les éléments du
dépôt auxquels le résultat a le droit de faire référence. Toute référence à
un autre élément du dépôt conduira à une erreur à la construction. Comme
pour disallowed-references, qui peut lister des éléments qui ne
doivent pas être référencés par les sorties.
deprecation-warnings détermine s’il faut afficher les avertissement
d’obsolescence à la compilation de modules. Il peut valoir #f
,
t
ou 'detailed
.
Les autres arguments sont les mêmes que pour derivation
(voir Dérivations).
Les procédures local-file
, plain-file
, computed-file
,
program-file
et scheme-file
ci-dessous renvoient des
objets simili-fichiers. C’est-à-dire, lorsqu’ils sont unquotés dans
une G-expression, ces objets donnent un fichier dans le dépôt. Considérez
cette G-expression :
#~(system* #$(file-append glibc "/sbin/nscd") "-f" #$(local-file "/tmp/my-nscd.conf"))
Ici, l’effet est « d’internaliser » /tmp/my-nscd.conf en le copiant
dans le dépôt. Une fois étendu, par exemple via gexp->derivation
, la
G-expression se réfère à cette copie dans /gnu/store ; ainsi,
modifier ou supprimer le fichier dans /tmp n’a aucun effet sur ce que
fait la G-expression. plain-file
peut être utilisé de la même
manière ; elle est seulement différente par le fait que le contenu du
fichier est passé directement par une chaîne de caractères.
Renvoie un objet représentant le fichier local file à ajouter au magasin ; cet objet peut être utilisé dans un gexp. Si file est une chaîne littérale désignant un nom de fichier relatif, il est recherché par rapport au fichier source où il apparaît ; si file n’est pas une chaîne littérale, il est recherché par rapport au répertoire de travail courant au moment de l’exécution. file sera ajouté au dépôt sous name–par défaut le nom de base de file.
Lorsque recursive? est vraie, le contenu de file est ajouté récursivement ; si file désigne un fichier simple et que recursive? est vrai, son contenu est ajouté et ses bits de permissions sont préservés.
Lorsque recursive? est vraie, appelle (select? file
stat)
pour chaque répertoire où file est le nom de fichier
absolu de l’entrée et stat est le résultat de lstat
; à
l’exception des entrées pour lesquelles select? ne renvoie pas vrai.
file can be wrapped in the assume-valid-file-name
syntactic
keyword. When this is done, there will not be a warning when
local-file
is used with a non-literal path. The path is still looked
up relative to the current working directory at run time. Wrapping is done
like this:
(define alice-key-file-path "alice.pub") ;; ... (local-file (assume-valid-file-name alice-key-file-path))
file can be wrapped in the assume-source-relative-file-name
syntactic keyword. When this is done, the file name will be looked up
relative to the source file where it appears even when it is not a string
literal.
C’est la version déclarative de la procédure monadique interned-file
(voir interned-file
).
Renvoie un objet représentant un fichier texte nommé name avec pour contenu content (une chaîne de caractères ou un vecteur d’octets) à ajouter un dépôt.
C’est la version déclarative de text-file
.
Renvoie un objet représentant l’élément du dépôt name, un fichier ou
un répertoire calculé par gexp. Lorsque local-build? est vrai
(par défaut), la dérivation est construite localement. options est
une liste d’arguments supplémentaires à passer à gexp->derivation
.
C’est la version déclarative de gexp->derivation
.
Renvoie un script exécutable name qui exécute exp en utilisant guile, avec les modules importés de exp dans son chemin de recherche. Recherchez les modules de exp dans module-path.
L’exemple ci-dessous construit un script qui invoque simplement la commande
ls
:
(use-modules (guix gexp) (gnu packages base)) (gexp->script "list-files" #~(execl #$(file-append coreutils "/bin/ls") "ls"))
Lorsqu’elle est « lancée » à travers le dépôt (voir run-with-store
), on obtient une dérivation qui produit une fichier
exécutable /gnu/store/…-list-files qui ressemble à :
#!/gnu/store/…-guile-2.0.11/bin/guile -ds !# (execl "/gnu/store/…-coreutils-8.22"/bin/ls" "ls")
Renvoie un objet représentant un élément du dépôt name qui lance gexp. guile est le paquet Guile à utiliser pour exécuter le script. Les modules importés par gexp sont recherchés dans module-path.
C’est la version déclarative de gexp->script
.
Renvoie une dérivation qui construit un fichier name contenant exp. Lorsque splice? est vrai, exp est considéré comme une liste d’expressions qui seront splicée dans le fichier qui en résulte.
Lorsque set-load-path? est vrai, émet du code dans le fichier de
résultat pour initialiser %load-path
et %load-compiled-path
pour prendre en compte les modules importés de exp. Les modules de
exp sont trouvés dans module-path.
Le fichier qui en résulte retient les références à toutes les dépendances de exp ou un sous-ensemble.
file name that contains exp. guile is the Guile package used to produce that file.
C’est la version déclarative de gexp->file
.
Renvoie une valeur monadique qui construit un ficher texte contenant text. text peut lister, en plus de chaînes de caractères, des objet de n’importe quel type qui peut être utilisé dans une gexp : des paquets, des dérivations, des fichiers objet locaux, etc. Le fichier du dépôt qui en résulte en retient toutes les références.
Cette variante devrait être préférée à text-file
lorsque vous
souhaitez créer des fichiers qui référencent le dépôt. Cela est le cas
typiquement lorsque vous construisez un fichier de configuration qui
contient des noms de fichiers du dépôt, comme ceci :
(define (profile.sh)
;; Renvoie le nom d'un script shell dans le dépôt qui initialise
;; la variable d'environnement « PATH ».
(text-file* "profile.sh"
"export PATH=" coreutils "/bin:"
grep "/bin:" sed "/bin\n"))
Dans cet exemple, le fichier /gnu/store/…-profile.sh qui en résulte référence coreutils, grep et sed, ce qui les empêche d’être glanés tant que le script est accessible.
Renvoie un objet représentant le fichier du dépôt name contenant text. text est une séquence de chaînes de caractères et de fichiers simili-objets, comme dans :
(mixed-text-file "profile"
"export PATH=" coreutils "/bin:" grep "/bin")
C’est la version déclarative de text-file*
.
Renvoie un <computed-file>
qui construit un répertoire qui contient
tous les fichiers de files. Chaque élément de files doit être
une paire où le premier élément est le nom de fichier à utiliser dans le
nouveau répertoire et le second élément est une gexp dénotant le fichier
cible. Voici un exemple :
(file-union "etc"
`(("hosts" ,(plain-file "hosts"
"127.0.0.1 localhost"))
("bashrc" ,(plain-file "bashrc"
"alias ls='ls --color=auto'"))))
Cela crée un répertoire etc
contenant ces deux fichiers.
Renvoie un répertoire qui est l’union de things, où things est une liste d’objets simili-fichiers qui dénotent des répertoires. Par exemple :
(directory-union "guile+emacs" (list guile emacs))
crée un répertoire qui est l’union des paquets guile
et emacs
.
Renvoie un objet simili-fichier qui correspond à la concaténation de obj et suffix où obj est un objet abaissable et chaque suffix est une chaîne de caractères.
Par exemple, considérez cette gexp :
(gexp->script "run-uname"
#~(system* #$(file-append coreutils
"/bin/uname")))
On peut obtenir le même effet avec :
(gexp->script "run-uname"
#~(system* (string-append #$coreutils
"/bin/uname")))
Il y a une différence cependant : dans le cas file-append
, le script
qui en résulte contient le nom de fichier absolu comme une chaîne de
caractère alors que dans le deuxième cas, le script contient une expression
(string-append …)
pour construire le nom de fichier à
l’exécution.
Lier system au système actuellement visé—par exemple,
"x86_64-linux"
—dans body.
Dans le second cas, lier également target à la cible de compilation
croisée actuelle–un triplet GNU tel que "arm-linux-gnueabihf"
—ou
#f
si nous ne faisons pas de compilation croisée.
let-system
est utile occasionellement dans le cas où l’objet raccordé
au gexp dépend de la cible sur le système cible, comme dans cet exemple :
#~(system* #+(let-system system (cond ((string-prefix? "armhf-" system) (file-append qemu "/bin/qemu-system-arm")) ((string-prefix? "x86_64-" system) (file-append qemu "/bin/qemu-system-x86_64")) (else (error "dunno!")))) "-net" "user" #$image)
Cette macro est similaire à la forme parameterize
pour les
paramètres liés dynamiquement (voir Parameters dans GNU Guile
Reference Manual). La principale différence est qu’il prend effet lorsque
l’objet de type fichier renvoyé par exp est abaissé à un élément de
dérivation ou de stockage.
Une utilisation typique de with-parameters
consiste à forcer le
système en vigueur pour un objet donné :
(with-parameters ((%current-system "i686-linux"))
coreutils)
L’exemple ci-dessus renvoie un objet qui correspond à la version i686 de
Coreutils, quelle que soit la valeur actuelle de %current-système
.
Return a gexp input record for the given output of file-like
object obj, with #:native?
determining whether this is a native
reference (as with ungexp-native
) or not.
This procedure is helpful when you want to pass a reference to a specific output of an object to some procedure that may not know about that output. For example, assume you have this procedure, which takes one file-like object:
(define (make-symlink target)
(computed-file "the-symlink"
#~(symlink #$target #$output)))
Here make-symlink
can only ever refer to the default output of
target—the "out"
output (voir Des paquets avec plusieurs résultats). To have it refer to, say, the "lib"
output of the
hwloc
package, you can call it like so:
(make-symlink (gexp-input hwloc "lib"))
You can also compose it like any other file-like object:
(make-symlink
(file-append (gexp-input hwloc "lib") "/lib/libhwloc.so"))
Bien sûr, en plus de gexps inclues dans le code « hôte », certains modules
contiennent des outils de construction. Pour savoir facilement qu’ils sont
à utiliser dans la strate de construction, ces modules sont gardés dans
l’espace de nom (guix build …)
.
En interne, les objets de haut-niveau sont abaissés, avec leur
compilateur, soit en des dérivations, soit en des objets du dépôt. Par
exemple, abaisser un paquet crée une dérivation, et abaisser un
plain-file
crée un élément du dépôt. Cela est effectué par la
procédure monadique lower-object
.
Renvoie comme valeur dans %store-monad
la dérivation ou l’élément de
dépôt correspondant à obj pour system, en effectuant une
compilation croisée pour target si target est vrai. obj
doit être un objet auquel est associé un compilateur gexp, tel qu’un
<package>
.
Il peut parfois être utile de convertir une G-expression en
S-expression. Par exemple, certains outils d’analyse statique de style (dits
« linters », voir Invoquer guix lint
) vérifient les phases de compilation
des paquets pour détecter des problèmes potentiels. Cette conversion peut
être réalisée avec cette procédure. Toutefois, certaines informations
peuvent être perdues au cours de l’opération. Plus spécifiquement, les
objets abaissables seront remplacés silencieusement par un objet arbitraire
– pour l’instant la liste (*approximate*)
, mais cela pourrait
changer.
Suivant: Utiliser Guix de manière interactive, Précédent: G-Expressions, Monter: Interface de programmation [Table des matières][Index]
guix repl
La commande guix repl
facilite la programmation de Guix dans Guile
en lançant une boucle Guile read-eval-print. (REPL) pour la
programmation interactive (voir Using Guile Interactively dans GNU
Guile Reference Manual), ou en exécutant des scripts Guile (voir (GNU Guile Reference Manual)guile). Par rapport au simple
lancement de la commande guile
, guix repl
garantit que
tous les modules Guix et toutes ses dépendances sont disponibles dans le
chemin de recherche.
La syntaxe générale est :
guix repl option fichier args]
Lorsqu’un argument file est fourni, file est exécuté comme un script Guile :
guix repl mon-script.scm
Pour passer des arguments au script, utilisez --
pour éviter qu’ils
ne soient interprétés comme des arguments pour guix repl
lui-même
:
guix repl -- mon-script.scm --input=toto.txt
Pour rendre exécutable un script directement depuis le shell, en utilisant l’exécutable guix qui se trouve dans le chemin de recherche utilisateur·rice, ajoutez les deux lignes suivantes en haut du script :
#!/usr/bin/env -S guix repl --
!#
Pour écrire un script qui lance une REPL interactive directement depuis le
shell, utilisez le drapeau --interactive
:
#!/usr/bin/env -S guix repl --interactive
!#
En l’absence d’un argument de nom de fichier, une REPL guile est lancé, ce qui permet de l’utiliser de manière interactive (voir Utiliser Guix de manière interactive) :
$ guix repl scheme@(guile-user)> ,use (gnu packages base) scheme@(guile-user)> coreutils $1 = #<package coreutils@8.29 gnu/packages/base.scm:327 3e28300>
En plus, guix repl
implémente un protocole REPL simple lisible par
une machine à utiliser avec (guix inferior)
, un dispositif pour
interagir avec des inférieurs, des processus séparés qui font tourner
une version potentiellement différente de Guix.
Les options disponibles sont les suivantes :
--list-types
Affiche les options de TYPE pour guix repl --type=TYPE
et
quitte.
--type=type
-t type
Démarrer un REPL du type donné, qui peut être l’un de ces types :
guile
C’est la valeur par défaut. Elle démarre un REPL Guile standard fonctionnel.
machine
Démarre un REPL qui utilise le protocole lisible par machine. C’est le
protocole que parle le module (guix inferior)
.
--listen=extrémité
Par défaut, guix repl
lit depuis l’entrée standard et écrit sur la
sortie standard. Lorsque cette option est passée, il écoutera plutôt les
connexions sur endpoint. Voici un exemple d’options valides :
--listen=tcp:37146
Accepte les connexions sur localhost, sur le port 31.
--listen=unix:/tmp/socket
Accepte les connexions sur le socket Unix-domain /tmp/socket.
--interactive
-i
Lance la REPL interactive après avoir exécuté file.
--load-path=répertoire
-L répertoire
Ajoute répertoire au début du chemin de recherche de module de paquets (voir Modules de paquets).
Cela permet à des utilisateurs de définir leur propres paquets et les rendre disponibles au script ou au REPL.
-q
Inhiber le chargement du fichier ~/.guile. Par défaut, ce fichier de
configuration est chargé lors de la création d’un fichier
guile
. REPL.
Précédent: Invoquer guix repl
, Monter: Interface de programmation [Table des matières][Index]
La commande guix repl
vous donne accès à une
boucle-lecture-évalutation-affichage (BLÉA ou REPL en anglais)
chaleureuse et amicale (voir Invoquer guix repl
). Si vous commencez la
programmation avec Guix — pour définir vos propres paquets, écrire des
manifestes, définir des services pour le système Guix ou Guix Home, etc —
vous la trouverez sans doute pratique pour jouer avec vos idées sur la REPL.
Si vous utilisez Emacs, le moyen le plus pratique pour cela est d’utiliser
Geiser (voir La configuration parfaite), mais vous n’avez pas besoin d’utiliser
Emacs pour profiter de la REPL. Lorsque vous utilisez guix repl
ou guile
dans un terminal, nous vous recommandons d’utiliser
Readline pour la complétion et Colorized pour avoir une sortie colorée. Pour
cela, vous pouvez lancer :
guix install guile guile-readline guile-colorized
… puis créer un fichier .guile dans votre répertoire personnel, contenant ceci :
(use-modules (ice-9 readline) (ice-9 colorized)) (activate-readline) (activate-colorized)
La REPL vous permet d’évaluer du code Scheme ; vous tapez une expression Scheme sur l’invite, et la REPL affiche ce en quoi elle s’évalue :
$ guix repl scheme@(guix-user)> (+ 2 3) $1 = 5 scheme@(guix-user)> (string-append "a" "b") $2 = "ab"
Ça devient plus intéressant quand vous commencez à jouer avec Guix sur la
REPL. La première chose à faire est « d’importer » le module (guix)
,
qui vous donne accès à la partie principale de l’interface de programmation,
et peut-être à un ensemble de modules Guix utiles. Vous pouvez taper
(use-modules (guix))
, ce qui est du code Scheme valide pour importer
un module (voir Using Guile Modules dans manuel de référence de GNU
Guile), mais la REPL fournit la commande use
comme raccourci
(voir REPL Commands dans manuel de référence de GNU Guile) :
scheme@(guix-user)> ,use (guix) scheme@(guix-user)> ,use (gnu packages base)
Remarquez que les commandes de la REPL sont introduites par une virgule. Une
commande REPL comme use
n’est pas du code Scheme valide, elle est
interprétée de manière spéciale par la REPL.
Guix étend la REPL Guile avec des commandes supplémentaires pour votre
confort. Parmi celles-ci, la commande build
est pratique : elle
s’assure que l’objet simili-fichier donné est construit, en le construisant
si nécessaire, et renvoie le nom de fichier de sa sortie. Dans l’exemple
ci-dessous, nous construisons les paquets coreutils
et grep
,
ainsi qu’un « fichiers calculé » (voir computed-file
), et nous utilisons la procédure scandir
pour
lister les fichiers du répertoire /bin
de Grep :
scheme@(guix-user)> ,build coreutils $1 = "/gnu/store/…-coreutils-8.32-debug" $2 = "/gnu/store/…-coreutils-8.32" scheme@(guix-user)> ,build grep $3 = "/gnu/store/…-grep-3.6" scheme@(guix-user)> ,build (computed-file "x" #~(mkdir #$output)) construction de /gnu/store/…-x.drv... $4 = "/gnu/store/…-x" scheme@(guix-user)> ,use(ice-9 ftw) scheme@(guix-user)> (scandir (string-append $3 "/bin")) $5 = ("." ".." "egrep" "fgrep" "grep")
As a packager, you may be willing to inspect the build phases or flags of a given package; this is particularly useful when relying a lot on inheritance to define package variants (voir Définition de variantes de paquets) or when package arguments are a result of some computation, both of which can make it harder to foresee what ends up in the package arguments. Additional commands let you inspect those package arguments:
scheme@(guix-user)> ,phases grep $1 = (modify-phases %standard-phases (add-after 'install 'fix-egrep-and-fgrep (lambda* (#:key outputs #:allow-other-keys) (let* ((out (assoc-ref outputs "out")) (bin (string-append out "/bin"))) (substitute* (list (string-append bin "/egrep") (string-append bin "/fgrep")) (("^exec grep") (string-append "exec " bin "/grep"))))))) scheme@(guix-user)> ,configure-flags findutils $2 = (list "--localstatedir=/var") scheme@(guix-user)> ,make-flags binutils $3 = '("MAKEINFO=true")
À plus bas niveau, une commande utile est lower
: elle prend un objet
simili-fichier et l’« abaisse » en une dérivation (voir Dérivations) ou
un fichier du dépôt :
scheme@(guix-user)> ,lower grep $6 = #<derivation /gnu/store/…-grep-3.6.drv => /gnu/store/…-grep-3.6 7f0e639115f0> scheme@(guix-user)> ,lower (plain-file "x" "Hello!") $7 = "/gnu/store/…-x"
La liste complète des commandes de la REPL se trouvent en tapant ,help
guix
et est donnée ci-dessous pour référence.
Abaisse objet et le construit s’il n’est pas déjà construit, et renvoie le nom de fichier de ses sorties.
Abaisse objet en une dérivation ou un nom de fichier du dépôt et le renvoie.
Change la verbosité des construction à niveau.
C’est similaire à l’option en ligne de commande --verbosity (voir Options de construction communes) : le niveau 0 signifie le silence total, le niveau 1 montre les événements de construction et les niveaux plus élevés affichent les journaux de construction.
These REPL commands return the value of one element of the arguments
field of package (voir Référence de package
): the first one show the
staged code associated with #:phases
(voir Phases de construction), the
second shows the code for #:configure-flags
, and ,make-flags
returns the code for #:make-flags
.
Lance exp, une expression monadique dans la monade du dépôt. Voir La monade du dépôt, pour plus d’information.
Entre dans une nouvelle REPL pour évaluer des expressions monadiques
(voir La monade du dépôt). Vous pouvez quitter la REPL « interne » en tapant
,q
.
Suivant: Architectures externes, Précédent: Interface de programmation, Monter: GNU Guix [Table des matières][Index]
Cette section décrit les utilitaires en ligne de commande de Guix. certains sont surtout faits pour les personnes qui écrivent de nouvelles définitions de paquets tandis que d’autres sont plus utiles pour une utilisation générale. Ils complètent l’interface de programmation Scheme de Guix d’une manière pratique.
guix build
guix edit
guix download
guix hash
guix import
guix refresh
guix style
guix lint
guix size
guix graph
guix publish
guix challenge
guix copy
guix container
guix weather
guix processes
Suivant: Invoquer guix edit
, Monter: Utilitaires [Table des matières][Index]
guix build
La commande guix build
construit des paquets ou des dérivations et
leurs dépendances et affiche les chemins du dépôt qui en résulte. Remarquez
qu’elle ne modifie pas le profil de l’utilisateur — c’est le travail de la
commande guix package
(voir Invoquer guix package
). Ainsi,
elle est surtout utile pour les personnes qui développent la distribution.
La syntaxe générale est :
guix build options package-or-derivation…
Par exemple, la commande suivante construit la dernière version d’Emacs et de Guile, affiche leur journaux de construction et enfin affiche les répertoires des résultats :
guix build emacs guile
De même, la commande suivante construit tous les paquets disponibles :
guix build --quiet --keep-going \ $(guix package -A | awk '{ print $1 "@" $2 }')
package-or-derivation peut être soit le nom d’un paquet trouvé dans la
distribution logicielle comme coreutils
, soit coreutils@8.20
,
soit une dérivation comme /gnu/store/…-coreutils-8.19.drv.
Dans le premier cas, la commande cherchera un paquet avec le nom
correspondant (et éventuellement la version) dans les modules de la
distribution GNU (voir Modules de paquets).
Autrement, l’option --expression peut être utilisée pour spécifier une expression Scheme qui s’évalue en un paquet ; c’est utile lorsqu’il est nécessaire de faire la distinction entre plusieurs paquets ou variantes de paquets portant le même nom.
Il peut y avoir aucune, une ou plusieurs options. Les options disponibles sont décrites dans les sous-sections ci-dessous.
Suivant: Options de transformation de paquets, Monter: Invoquer guix build
[Table des matières][Index]
Un certain nombre d’options qui contrôlent le processus de construction sont
communes avec guix build
et les autres commandes qui peuvent
générer des constructions, comme guix package
ou guix
archive
. Voici ces options :
--load-path=répertoire
-L répertoire
Ajoute répertoire au début du chemin de recherche de module de paquets (voir Modules de paquets).
Cela permet à des utilisateurs de définir leur propres paquets et les rendre disponibles aux outils en ligne de commande.
--keep-failed
-K
Garde l’arborescence de construction des constructions en échec. Ainsi, si une construction échoue, son arborescence de construction est préservée dans /tmp, dans un répertoire dont le nom est affiché à la fin du journal de construction. Cela est utile pour déboguer des échecs de construction. Voir Débogage des échecs de construction, pour des astuces sur la manière de déboguer des problèmes de construction.
Cette option implique --no-offload, et elle n’a pas d’effet quand
elle est connectée à un démon distant avec une guix://
URI
(voir the GUIX_DAEMON_SOCKET
variable).
--keep-going
-k
Continue lorsque certaines dérivations échouent ; ne s’arrête que lorsque toutes les constructions ont soit réussies, soit échouées.
Le comportement par défaut est de s’arrêter dès qu’une des dérivations spécifiées échoue.
--dry-run
-n
Ne pas construire les dérivations.
--fallback
Lorsque la substitution d’un binaire pré-compilé échoue, construit les paquets localement à la place (voir Échec de substitution).
--substitute-urls=urls
Considère urls comme une liste d’URL de sources de substituts séparés
par des espaces, et remplace la liste par défaut d’URL de
guix-daemon
(voir guix-daemon
URLs).
Cela signifie que les substituts peuvent être téléchargés depuis urls, tant qu’ils sont signés par une clef autorisée par l’administrateur système (voir Substituts).
Lorsque urls est la chaîne vide, cela a pour effet de désactiver la substitution.
--no-substitutes
Ne pas utiliser de substitut pour les résultats de la construction. C’est-à-dire, toujours construire localement plutôt que de permettre le téléchargement de binaires pré-construits (voir Substituts).
--no-grafts
Ne par « greffer » les paquets. En pratique, cela signifie que les mises à jour des paquets disponibles comme des greffes ne sont pas appliquées. Voir Mises à jour de sécurité, pour plus d’information sur les greffes.
--rounds=n
Construit chaque dérivation n fois d’affilé, et renvoie une erreur si les constructions consécutives ne sont pas identiques bit-à-bit.
Cela est une manière utile pour détecter des processus de construction non
déterministes. Les processus de construction non déterministes sont
problématiques car ils rendent pratiquement impossible la
vérification par les utilisateurs de l’authenticité de binaires
tiers. Voir Invoquer guix challenge
, pour plus d’informations.
Lorsqu’utilisé avec --keep-failed, la sortie différente est gardée dans le dépôt sous /gnu/store/…-check. Cela rend plus facile l’étude des différences entre les deux résultats.
--no-offload
N’essaye pas de décharger les constructions vers d’autres machines (voir Utiliser le dispositif de déchargement). C’est-à-dire que tout sera construit localement au lieu de décharger les constructions à une machine distante.
--max-silent-time=secondes
Lorsque le processus de construction ou de substitution restent silencieux pendant plus de secondes, le terminer et rapporter une erreur de construction.
Par défaut, le paramètre du démon est pris en compte (voir --max-silent-time).
--timeout=secondes
De même, lorsque le processus de construction ou de substitution dure plus de secondes, le terminer et rapporter une erreur de construction.
Par défaut, le paramètre du démon est pris en compte (voir --timeout).
-v [niveau]
--verbosity=niveau
Utiliser le niveau de verbosité, en tant qu’entier. 0 signifie qu’aucune sortie n’est produite, 1 signifie une sortie silencieuse ; 2 est similaire à 1 mais affiche aussi les URL des téléchargements ; 3 montre tous les journaux de construction sur la sortie d’erreur standard.
--cores=n
-c n
Permet d’utiliser jusqu’à n cœurs du CPU pour la construction. La
valeur spéciale 0
signifie autant de cœurs que possible.
--max-jobs=n
-M n
Permettre au maximum à n de construire des jobs en parallèle.
Voir --max-jobs, pour plus de détails sur
cette option et l’option équivalente guix-daemon
.
--debug=niveau
Produire une sortie de débogage qui provient du démon de construction. niveau doit être un entier entre 0 et 5 ; plus grand est ce nombre, plus verbeuse sera la sortie. Indiquer un niveau de 4 ou plus peut être utile pour déboguer des problèmes d’installation avec le démon de construction.
Sous le capot, guix build
est surtout une interface à la procédure
package-derivation
du module (guix packages)
, et à la
procédure build-derivations
du module (guix derivations)
.
En plus des options passées explicitement par la ligne de commande,
guix build
et les autres commandes guix
qui peuvent
effectuer des constructions prennent en compte la variable d’environnement
GUIX_BUILD_OPTIONS
.
Les utilisateurs peuvent définir cette variable à une liste d’options de la
ligne de commande qui seront automatiquement utilisées par guix
build
et les autres commandes guix
qui peuvent effectuer des
constructions, comme dans l’exemple suivant :
$ export GUIX_BUILD_OPTIONS="--no-substitutes -c 2 -L /toto/titi"
Ces options sont analysées indépendamment, et le résultat est ajouté aux options de la ligne de commande analysées.
Suivant: Options de construction supplémentaires, Précédent: Options de construction communes, Monter: Invoquer guix build
[Table des matières][Index]
Un autre ensemble d’options de la ligne de commande supportés par
guix build
et aussi guix package
sont les options
de transformation de paquets. Ce sont des options qui rendent possible la
définition de variantes de paquets — par exemple, des paquets
construit à partir de sources différentes. C’est une manière simple de
créer des paquets personnalisés à la volée sans avoir à taper les
définitions de variantes de paquets (voir Définition des paquets).
Les options de transformation des paquets sont préservées dans les mises à
jour : guix upgrade
tente d’appliquer aux paquets mis à jour les
options de transformation initialement utilisées lors de la création du
profil.
Les options disponibles sont énumérées ci-dessous. La plupart des commandes les prennent en charge, ainsi qu’une option --help-transform qui liste toutes les options disponibles et un synopsis (ces options ne sont pas affichées dans la sortie --help par souci de concision).
--tune[=cpu]
Utilise les versions des paquets marqués comme « réglables » optimisées pour
cpu. Lorsque cpu est native
, ou s’il est omis, règle pour
le CPU sur lequel la commande guix
est lancée.
Les noms de cpu valides sont ceux reconnus par le compilateur
sous-jacent, par défaut la collection de compilateurs de GNU (GCC). Sur les
processurs x86_64, cela comprend les noms des CPU comme nehalem
,
haswell
et skylake
(voir -march
dans Using the GNU Compiler Collection (GCC)).
Au fur et à mesure de la sortie de nouvelles générations de CPU, de nouvelles instructions sont ajoutées à l’ensemble d’instruction standard de l’architecture (ISA), en particulier des instructions pour le calcul parallèle instruction-unique/données-multiples (SIMD). Par exemple, alors que les CPU Core2 et Skylake implémentent tous deux l’ISA x86_64, seul ce dernier prend en charge les instructions SIMD AVX2.
Le principal bénéfice attendu de --tune est que les programmes
peuvent utiliser ces fonctionnalités SIMD et qu’ils n’ont pas déjà un
mécanisme pour choisir le bon code optimisé à l’exécution. Les paquets qui
possèdent la propriété tunable?
sont considérés comme des
paquets réglables par l’option --tune ; une définition de
paquet avec la bonne propriété ressemble à ceci :
(package
(name "hello-simd")
;; ...
;; Ce paquet peut bénéficier des extensions SIMD donc
;; on le marque « réglable ».
(properties '((tunable? . #t))))
Les autres paquets ne sont pas considérés comme réglables. Cela permet à Guix d’utiliser des binaires génériques dans le cas où le réglage pour un CPU particulier ne donnera probablement aucun avantage.
Les paquets réglés sont construits avec -march=CPU
; sous le
capot, l’option -march est passée à l’enveloppe par une enveloppe
du compilateur. Comme la machine de construction peut ne pas être capable de
lancer du code pour la micro-architecture CPU cible, la suite de tests n’est
pas lancée lors de la construction d’un paquet réglé.
Pour réduire les reconstructions au minimum, les paquets réglés sont greffés sur les paquets qui en dépendent (voir grafts). Ainsi, utiliser --no-grafts annule l’effet de --tune.
Nous appelons cette technique le multi-versionement des paquets : on peut construire plusieurs variantes d’un paquet réglable, une pour chaque variante de CPU. C’est la contrepartie à gros grain du multi-versionement fonctionnel implémenté par la chaine d’outils de GNU (voir Function Multiversioning dans Using the GNU Compiler Collection (GCC)).
--with-source=source
--with-source=paquet=source
--with-source=paquet@version=source
Utilise source comme la source de paquet, et version comme
son numéro de version. source doit être un nom de fichier ou une URL,
comme pour guix download
(voir Invoquer guix download
).
Lorsque paquet est omis, la commande utilisera le nom de paquet
spécifié par la base de source — p. ex. si source est
/src/guix-2.0.10.tar.gz
, le paquet correspondant est guile
.
De même, lorsque version est omis, la chaîne de version est inférée à
partir de source ; dans l’exemple précédent, il s’agit de
2.0.10
.
Cette option permet aux utilisateurs d’essayer des version des paquets
différentes de celles fournies par la distribution. L’exemple ci-dessous
télécharge ed-1.7.tar.g depuis un miroir GNU et l’utilise comme
source pour le paquet ed
:
guix build ed --with-source=mirror://gnu/ed/ed-1.4.tar.gz
En tant que développeur·euse, --with-source permet de tester facilement des version bêta, et même de vérifier leur impact sur les paquets qui en dépendent :
guix build elogind --with-source=…/shepherd-0.9.0rc1.tar.gz
… ou pour construire un dépôt de gestion de version dans un environnement vierge :
$ git clone git://git.sv.gnu.org/guix.git $ guix build guix --with-source=guix@1.0=./guix
--with-input=paquet=remplaçant
Remplace la dépendance sur paquet par une dépendance à
remplaçant. paquet doit être un nom de paquet et
remplaçant doit être une spécification de paquet comme guile
ou
guile@1.8
.
Par exemple, la commande suivante construit Guix, mais remplace sa
dépendance à la version stable actuelle de Guile par une dépendance à une
ancienne version de Guile, guile@2.2
:
guix build --with-input=guile=guile@2.2 guix
C’est un remplacement récursif profond. Donc dans cet exemple, à la fois
guix
et ses dépendances guile-json
(qui dépend aussi de
guile
) sont reconstruits avec guile@2.2
.
This is implemented using the package-input-rewriting/spec
Scheme
procedure (voir package-input-rewriting/spec
).
--with-graft=paquet=remplaçant
Cette option est similaire à --with-input mais avec une différence importante : plutôt que de reconstruire la chaîne de dépendance complète, remplaçant est construit puis greffé sur les binaires qui référençaient initialement paquet. Voir Mises à jour de sécurité, pour plus d’information sur les greffes.
Par exemple, la commande ci-dessous greffe la version 3.5.4 de GnuTLS sur Wget et toutes ses dépendances, en remplaçant les références à la version actuelle de GnuTLS à laquelle ils se réfèrent actuellement :
guix build --with-graft=gnutls=gnutls@3.5.4 wget
Cela a l’avantage d’être bien plus rapide que de tout reconstruire. Mais il y a un piège : cela ne fonctionne que si paquet et remplaçant sont strictement compatibles — par exemple, s’ils fournissent une bibliothèque, l’interface binaire applicative (ABI) de ces bibliothèques doivent être compatibles. Si remplaçant est incompatible avec paquet, alors le paquet qui en résulte peut devenir inutilisable. À utiliser avec précaution !
--with-debug-info=paquet
Construire paquet de manière à préserver ses informations de débogage
et les greffer sur les paquets qui en dépendent. Cela est utile si
paquet ne fournit pas déjà les informations de débogage sous forme de
sortie debug
(voir Installer les fichiers de débogage).
Par exemple, supposons que vous subissiez un plantage de Inkscape et que
vous vouliez voir ce qui se passe dans GLib, une bibliothèque au fond du
graphe de dépendance d’Inkscape. GLib n’a pas de sortie debug
, donc
le débogage est difficile. Heureusement, vous reconstruisez la GLib avec
les informations de débogage et vous l’installez dans Inkscape :
guix install inkscape --with-debug-info=glib
Seule GLib doit être recompilée, ce qui prend un temps raisonnable. Voir Installer les fichiers de débogage, pour plus d’informations.
Remarque : Sous le capot, cette option fonctionne en passant par le ‘#:strip-binaries ? #f’ au système de construction du paquet qui nous intéresse (voir Systèmes de construction). La plupart des systèmes de compilation supportent cette option, mais certains ne le font pas. Dans ce cas, une erreur se produit.
De même, si un paquet C/C++ est construit sans
-g
(ce qui est rarement le cas), les informations de débogage resteront indisponibles même si#:strip-binaries?
est faux.
--with-c-toolchain=package=toolchain
Cette option modifie la compilation de package et de tout ce qui en dépend afin qu’ils soient construits avec toolchain au lieu de la chaîne d’outils GNU par défaut pour C/C++.
Regardez cet exemple :
guix build octave-cli \ --with-c-toolchain=fftw=gcc-toolchain@10 \ --with-c-toolchain=fftwf=gcc-toolchain@10
La commande ci-dessus construit une variante des paquets fftw
et
fftwf
en utilisant la version 10 de gcc-toolchain
au lieu de
la chaîne d’outils par défaut, puis construit une variante de l’interface en
ligne de commande GNU Octave en les utilisant. GNU Octave
lui-même est également construit avec gcc-toolchain@10
.
Cet autre exemple construit la bibliothèque Hardware Locality (hwloc
)
et ses dépendances jusqu’à intel-mpi-benchmarks
avec le compilateur
Clang C :
guix build --with-c-toolchain=hwloc=clang-toolchain \ intel-mpi-benchmarks
Remarque : Il peut y avoir des incompatibilités d’interface binaire d’application (ABI) entre les chaînes d’outils. Cela est particulièrement vrai pour la bibliothèque standard C++ et les bibliothèques de support d’exécution telles que celle d’OpenMP. En reconstruisant toutes les dépendances avec la même chaîne d’outils, --with-c-toolchain minimise les risques d’incompatibilité mais ne peut pas les éliminer entièrement. Choisissez package judicieusement.
--with-git-url=paquet=url
¶Construire paquet depuis le dernier commit de la branche master
du dépôt sur url. Les sous-modules Git du dépôt sont récupérés,
récursivement.
Par exemple, la commande suivante construit la bibliothèque Python NumPy avec le dernier commit de la branche master de Python lui-même :
guix build python-numpy \ --with-git-url=python=https://github.com/python/cpython
Cette option peut aussi être combinée avec --with-branch ou --with-commit (voir plus bas).
Évidemment, comme cela utilise le dernier commit d’une branche donnée, le résultat d’une telle commande varie avec le temps. Néanmoins c’est une manière pratique pour reconstruire des piles logicielles entières avec le dernier commit d’un ou plusieurs paquets. C’est particulièrement pratique dans le contexte d’une intégration continue.
Les clones sont gardés dans un cache dans ~/.cache/guix/checkouts pour accélérer les accès consécutifs au même dépôt. Vous pourriez vouloir le nettoyer de temps en temps pour récupérer de l’espace disque.
--with-branch=paquet=branche
Construire paquet à partir du dernier commit de la branche. Si
le champ source
de paquet est une origine avec la méthode
git-fetch
(voir Référence de origin
) ou un objet git-checkout
,
l’URL du dépôt est récupérée à partir de cette source
. Sinon, vous
devez utiliser --with-git-url pour spécifier l’URL du dépôt Git.
Par exemple, la commande suivante construit guile-sqlite3
à partir du
dernier commit de sa branche master
, puis construit guix
(qui
en dépend) et cuirass
(qui dépend de guix
) avec cette
construction spécifique de guile-sqlite3
:
guix build --with-branch=guile-sqlite3=master cuirass
--with-commit=paquet=commit
Cela est similaire à --with-branch, sauf qu’elle construite à
partir de commit au lieu du sommet d’une branche. commit doit
être un identifiant SHA1 de commit Git valide, un tag ou un identifiant dans
le style de git describe
comme 1.0-3-gabc123
.
--with-patch=paquet=fichier
Ajoute fichier à la liste des correctifs appliqués à paquet, où
paquet est une spécification comme python@3.8
ou
glibc
. fichier doit contenir un correctif ; il est appliqué
avec les drapeaux spécifiés dans l’origin
de paquet
(voir Référence de origin
), qui par défaut inclus -p1
voir patch
Directories dans Comparing and Merging Files).
Par exemple, la commande ci-dessous reconstruit Coreutils avec la bibliothèque C de GNU (glibc) corrigée avec le correctif donné :
guix build coreutils --with-patch=glibc=./glibc-frob.patch
Dans cet exemple, glibc lui-meme ainsi que tout ce qui mène à Coreutils dans le graphe des dépendances est reconstruit.
--with-configure-flag=package=flag
Append flag to the configure flags of package, where
package is a spec such as guile@3.0
or glibc
. The
build system of package must support the #:configure-flags
argument.
For example, the command below builds GNU Hello with the configure flag
--disable-nls
:
guix build hello --with-configure-flag=hello=--disable-nls
The following command passes an extra flag to cmake
as it builds
lapack
:
guix build lapack \ --with-configure-flag=lapack=-DBUILD_SHARED_LIBS=OFF
Remarque : Under the hood, this option works by passing the ‘#:configure-flags’ argument to the build system of the package of interest (voir Systèmes de construction). Most build systems support that option but some do not. In that case, an error is raised.
--with-latest=paquet
--with-version=paquet=version
Alors vous aimez les toutes dernières technologies ? L’option
--with-latest est faite pour vous ! Elle remplace les occurrence de
paquet dans le graphe des dépendances avec sa toute dernière version
en amont, telle que rapportée par guix refresh
(voir Invoquer guix refresh
).
Elle fait cela en déterminant la dernière version publiée en amont (si possible), en la téléchargeant et en l’authentifiant si elle propose une signature OpenPGP.
Par exemple, la commande ci-dessous construit Guix avec la dernière version de Guile-JSON :
guix build guix --with-latest=guile-json
L’option --with-version fonctionne de manière identique sauf qu’il vous laisse spécifier la version spécifique, en supposant que cette version existe en amont. Par exemple, pour créer un environnement de développement avec SciPy construit avec la version 1.22.4 de NumPy (en sautant sa suite de tests parce que, bon, on ne va pas attendre aussi longtemps), vous pourriez lancer :
guix shell python python-scipy --with-version=python-numpy=1.22.4
Attention : Comme ils dépende du code source publié à un certain moment sur les serveurs en amont, les déploiements qui utilisent --with-latest et --with-version peuvent ne pas être reproductibles : la source peut disparaître ou être modifiée en place sur les serveurs.
Pour déployer d’anciennes versions sans compromis avec la reproductibilité, voir
guix time-machine
.
Il y a des limites. Déjà, dans les cas où l’outil ne peut pas ou ne sait pas comment authentifier le code source, vous risquez de charger du code malveillant ; un avertissement est émis dans ce cas. Ensuite, cette option change simplement la source utilisée dans les définitions existantes des paquets, ce qui n’est pas toujours suffisant : il peut y avoir des dépendances supplémentaires qui doivent être ajoutées, des correctifs à appliquer, et plus généralement tout le travail d’assurance qualité que les développeurs de Guix font habituellement sera absent.
On vous aura prévenu ! Lorsque vous pouvez accepter ces limitations, c’est une méthode pour rester à la hauteur qui a du punch ! Nous vous encourageons à soumettre des correctifs pour les définitions des paquets quand vous aurez testé une mise à jour avec --with-latest (voir Contribuer).
--without-tests=paquet
Construire paquet sans lancer la suite de tests. Cela peut être utile dans les situations où vous voulez éviter la longue série de tests d’un paquet intermédiaire, ou si une suite de tests de paquet échoue dans un mode non déterministe. Il doit être utilisé avec précaution car l’exécution de la suite de tests est un bon moyen de s’assurer qu’un paquet fonctionne comme prévu.
L’arrêt des tests conduit à un autre élément du dépôt. Par conséquent, lorsque vous utilisez cette option, tout ce qui dépend de paquet doit être reconstruit, comme dans cet exemple :
guix install --without-tests=python python-notebook
La commande ci-dessus installe python-notebook
par dessus
python
, construit sans exécuter sa suite de tests. Pour ce faire,
elle reconstruit également tout ce qui dépend de python
, y compris
python-notebook
lui-même.
En interne, --without-tests repose sur le changement de l’option
#:tests?
de la phase check
d’un paquet (voir Systèmes de construction). Notez que certains paquets utilisent une phase check
personnalisée qui ne respecte pas le paramètre #:tests? #f
. Par
conséquent, --without-tests n’a aucun effet sur ces paquets.
Vous vous demandez comme faire la même chose dans du code Scheme, par exemple dans votre manifeste, ou comme écrire votre propre transformation de paquets ? Voir Définition de variantes de paquets, pour un aperçu des interfaces de programmation disponibles.
Suivant: Débogage des échecs de construction, Précédent: Options de transformation de paquets, Monter: Invoquer guix build
[Table des matières][Index]
Les options de la ligne de commande ci-dessous sont spécifiques à
guix build
.
--quiet
-q
Construire silencieusement, sans afficher les journaux de construction ; c’est équivalent à --verbosity=0. À la fin, le journal de construction est gardé dans /var (ou similaire) et on peut toujours l’y trouver avec l’option --log-file.
--file=fichier
-f fichier
Construit le paquet, la dérivation ou l’objet simili-fichier en lequel le code dans file s’évalue (voir file-like objects).
Par exemple, file peut contenir une définition de paquet comme ceci (voir Définition des paquets) :
(use-modules (guix) (guix build-system gnu) (guix licenses)) (package (name "hello") (version "2.10") (source (origin (method url-fetch) (uri (string-append "mirror://gnu/hello/hello-" version ".tar.gz")) (sha256 (base32 "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i")))) (build-system gnu-build-system) (synopsis "Hello, GNU world: An example GNU package") (description "Guess what GNU Hello prints!") (home-page "http://www.gnu.org/software/hello/") (license gpl3+))
file peut également contenir une représentation JSON d’une ou
plusieurs définitions de paquets. L’exécution de guix build -f
sur
hello.json avec le contenu suivant entraînerait la construction des
paquets myhello
et greeter
:
[ { "name": "myhello", "version": "2.10", "source": "mirror://gnu/hello/hello-2.10.tar.gz", "build-system": "gnu", "arguments": { "tests?": false }, "home-page": "https://www.gnu.org/software/hello/", "synopsis": "Hello, GNU world: An example GNU package", "description": "GNU Hello prints a greeting.", "license": "GPL-3.0+", "native-inputs": ["gettext"] }, { "name": "greeter", "version": "1.0", "source": "mirror://gnu/hello/hello-2.10.tar.gz", "build-system": "gnu", "arguments": { "test-target": "foo", "parallel-build?": false }, "home-page": "https://example.com/", "synopsis": "Greeter using GNU Hello", "description": "This is a wrapper around GNU Hello.", "license": "GPL-3.0+", "inputs": ["myhello", "hello"] } ]
--manifest=manifest
-m manifest
Construire tous les paquets listés dans un manifest donné (voir --manifest).
--expression=expr
-e expr
Construit le paquet ou la dérivation en lequel expr s’évalue.
Par exemple, expr peut être (@ (gnu packages guile)
guile-1.8)
, qui désigne sans ambiguïté cette variante spécifique de la
version 1.8 de Guile.
Autrement, exp peut être une G-expression, auquel cas elle est
utilisée comme un programme de construction passé à gexp->derivation
(voir G-Expressions).
Enfin, expr peut se référer à une procédure monadique à au moins un
argument (voir La monade du dépôt). La procédure doit renvoyer une
dérivation comme une valeur monadique, qui est ensuite lancée à travers
run-with-store
.
--source
-S
Construit les dérivation source des paquets, plutôt que des paquets eux-mêmes.
Par exemple, guix build -S gcc
renvoie quelque chose comme
/gnu/store/…-gcc-4.7.2.tar.bz2, qui est l’archive des sources
de GCC.
L’archive des sources renvoyée est le résultat de l’application des
correctifs et des extraits de code éventuels spécifiés dans le champ
origin
du paquet (voir Définition des paquets).
Comme avec les autres dérivations, le résultat de la construction des sources peut être vérifié avec l’option --check (voir vérification de la construction). C’est utile pour valider que les source (éventuellement déjà construites ou substituées, donc en cache) correspondent au hash déclaré.
Notez que guix build -S
compile seulement les sources des paquets
spécifiés. Les sources de dépendances statiquement liées ne sont pas
incluses et sont en elles-mêmes insuffisantes pour reproduire les paquets.
--sources
Récupère et renvoie la source de package-or-derivation et toute ses dépendances, récursivement. C’est pratique pour obtenir une copie locale de tous les codes sources requis pour construire packages, ce qui vous permet de les construire plus tard même sans accès au réseau. C’est une extension de l’option --source et elle peut accepter l’un des arguments facultatifs suivants :
paquet
Cette valeur fait que l’option --sources se comporte comme l’option --source.
all
Construit les dérivations des sources de tous les paquets, dont les sources
qui pourraient être listées dans inputs
. C’est la valeur par défaut.
$ guix build --sources tzdata The following derivations will be built: /gnu/store/…-tzdata2015b.tar.gz.drv /gnu/store/…-tzcode2015b.tar.gz.drv
transitive
Construire les dérivations des sources de tous les paquets, ainsi que toutes celles des entrées transitives des paquets. On peut par exemple utiliser cette option pour précharger les sources des paquets pour les construire plus tard hors ligne.
$ guix build --sources=transitive tzdata The following derivations will be built: /gnu/store/…-tzcode2015b.tar.gz.drv /gnu/store/…-findutils-4.4.2.tar.xz.drv /gnu/store/…-grep-2.21.tar.xz.drv /gnu/store/…-coreutils-8.23.tar.xz.drv /gnu/store/…-make-4.1.tar.xz.drv /gnu/store/…-bash-4.3.tar.xz.drv …
--system=système
-s système
Essayer de construire pour system — p. ex. i686-linux
— au
lieu du type de système de l’hôte. La commande guix build
vous
permet de répéter cette option plusieurs fois, auquel cas elle construit
pour tous les systèmes spécifiés ; les autres commandes ignorent les options
-s supplémentaires.
Remarque : Le drapeau --system est utilisé pour une compilation native et ne doit pas être confondu avec une compilation croisée. Voir --target ci-dessous pour des informations sur la compilation croisée.
Un exemple d’utilisation de ceci sur les systèmes Linux, qui peut émuler
différentes personnalités. Par exemple, passer --system=i686-linux
sur un système x86_64-linux
ou --system=armhf-linux sur un
système aarch64-linux
vous permet de construire des paquets dans un
environnement 32-bit complet.
Remarque : La possibilité de construire pour un système
armhf-linux
est activé sans condition sur les machinesaarch64-linux
, bien que certaines puces aarch64 n’en soient pas capables, comme les ThunderX.
De même, lorsque l’émulation transparente avec QEMU et binfnmt_misc
est activée (voir qemu-binfmt-service-type
), vous pouvez construire pour n’importe
quel système pour lequel un gestionnaire QEMU binfmt_misc
est
installé.
Les constructions pour un autre système que celui de la machine que vous utilisez peuvent aussi être déchargées à une machine distante de la bonne architecture. Voir Utiliser le dispositif de déchargement, pour plus d’information sur le déchargement.
--target=triplet
¶Effectuer une compilation croisée pour triplet qui doit être un
triplet GNU valide, comme "aarch64-linux-gnu"
(voir GNU configuration triplets dans Autoconf).
--list-systems
Liste tous les systèmes pris en charge, qui peuvent être passés en argument à --system.
--list-targets
Liste toutes les cibles prises en charge, qui peuvent être passées en argument à --target.
--check
¶Reconstruit les package-or-derivation, qui sont déjà disponibles dans le dépôt et lève une erreur si les résultats des constructions ne sont pas identiques bit-à-bit.
Ce mécanisme vous permet de vérifier si les substituts précédemment
installés sont authentiques (voir Substituts) ou si le résultat de la
construction d’un paquet est déterministe. Voir Invoquer guix challenge
pour plus d’informations et pour les outils.
Lorsqu’utilisé avec --keep-failed, la sortie différente est gardée dans le dépôt sous /gnu/store/…-check. Cela rend plus facile l’étude des différences entre les deux résultats.
--repair
¶Essaye de réparer les éléments du dépôt spécifiés, s’ils sont corrompus, en les téléchargeant ou en les construisant à nouveau.
Cette opération n’est pas atomique et donc restreinte à l’utilisateur
root
.
--derivations
-d
Renvoie les chemins de dérivation, et non les chemins de sortie, des paquets donnés.
--root=fichier
¶-r fichier
Fait de fichier un lien symbolique vers le résultat, et l’enregistre en tant que racine du ramasse-miettes.
En conséquence, les résultats de cette invocation de guix build
sont protégés du ramasse-miettes jusqu’à ce que fichier soit
supprimé. Lorsque cette option est omise, les constructions sont
susceptibles d’être glanées.
--log-file
¶Renvoie les noms des journaux de construction ou les URL des package-or-derivation donnés ou lève une erreur si les journaux de construction sont absents.
Cela fonctionne indépendamment de la manière dont les paquets ou les dérivations sont spécifiées. Par exemple, les invocations suivantes sont équivalentes :
guix build --log-file $(guix build -d guile) guix build --log-file $(guix build guile) guix build --log-file guile guix build --log-file -e '(@ (gnu packages guile) guile-2.0)'
If a log is unavailable locally, and unless --no-substitutes is passed, the command looks for a corresponding log on one of the substitute servers.
Donc par exemple, imaginons que vous souhaitiez voir le journal de
construction de GDB sur aarch64
, mais que vous n’avez qu’une machine
x86_64
:
$ guix build --log-file gdb -s aarch64-linux https://bordeaux.guix.gnu.org/log/…-gdb-7.10
Vous pouvez accéder librement à une vaste bibliothèque de journaux de construction !
Précédent: Options de construction supplémentaires, Monter: Invoquer guix build
[Table des matières][Index]
Lors de la définition d’un nouveau paquet (voir Définition des paquets), vous passerez probablement du temps à déboguer et modifier la construction jusqu’à ce que ça marche. Pour cela, vous devez effectuer les commandes de construction vous-même dans un environnement le plus proche possible de celui qu’utilise le démon de construction.
Pour cela, la première chose à faire est d’utiliser l’option
--keep-failed ou -K de guix build
, qui gardera
la construction échouée de l’arborescence dans /tmp ou le répertoire
spécifié par TMPDIR
(voir --keep-failed).
À partir de là, vous pouvez vous déplacer dans l’arborescence de
construction et sourcer le fichier environment-variables, qui
contient toutes les variables d’environnement qui étaient définies lorsque
la construction a échoué. Disons que vous déboguez un échec de construction
dans le paquet toto
; une session typique ressemblerait à cela :
$ guix build toto -K … build fails $ cd /tmp/guix-build-toto.drv-0 $ source ./environment-variables $ cd toto-1.2
Maintenant, vous pouvez invoquer les commandes comme si vous étiez le démon (presque) et corriger le processus de construction.
Parfois il arrive que, par exemple, les tests d’un paquet réussissent lorsque vous les lancez manuellement mais échouent quand ils sont lancés par le démon. Cela peut arriver parce que le démon tourne dans un conteneur où, contrairement à notre environnement au-dessus, l’accès réseau est indisponible, /bin/sh n’existe pas, etc. (voir Réglages de l’environnement de construction).
Dans ce cas, vous pourriez avoir besoin de lancer le processus de construction dans un conteneur similaire à celui que le démon crée :
$ guix build -K toto … $ cd /tmp/guix-build-toto.drv-0 $ guix shell --no-grafts -C -D toto strace gdb [env]# source ./environment-variables [env]# cd toto-1.2
Ici, guix shell -C
crée un conteneur et démarre un nouveau shell à
l’intérieur (voir Invoquer guix shell
). La partie strace gdb
ajoute les commandes strace
et gdb
dans le conteneur, ce
qui pourrait s’avérer utile pour le débogage. L’option --no-grafts
s’assure qu’on obtienne le même environnement, avec des paquets non greffés
(voir Mises à jour de sécurité, pour plus d’informations sur les greffes).
Pour obtenir un conteneur plus proche de ce qui serait utilisé par le démon de construction, on peut enlever /bin/sh :
[env]# rm /bin/sh
(Ne vous inquiétez pas, c’est sans danger : tout cela se passe dans un
conteneur jetable créé par guix shell
.)
La commande strace
n’est probablement pas dans le chemin de
recherche, mais on peut lancer :
[env]# $GUIX_ENVIRONMENT/bin/strace -f -o log make check
De cette manière, non seulement vous aurez reproduit les variables d’environnement utilisées par le démon, mais vous lancerez aussi le processus de construction dans un conteneur similaire à celui utilisé par le démon.
Suivant: Invoquer guix download
, Précédent: Invoquer guix build
, Monter: Utilitaires [Table des matières][Index]
guix edit
Tant de paquets, tant de fichiers source ! La commande guix edit
facilite la vie des utilisateurs et des empaqueteurs en plaçant leur éditeur
sur le fichier source qui contient la définition des paquets spécifiés. Par
exemple :
guix edit gcc@4.9 vim
lance le programme spécifié dans la variable d’environnement VISUAL
ou
dans la variable d’environnement EDITOR
pour visionner la recette de
GCC 4.9.3 et celle de Vim.
Si vous utilisez une copie du dépôt Git de Guix (voir Construire depuis Git),
ou que vous avez créé vos propres paquets dans GUIX_PACKAGE_PATH
(voir Modules de paquets), vous pourrez modifier les recettes des paquets.
Sinon, vous pourrez examiner les recettes en lecture-seule des paquets
actuellement dans le dépôt.
Au lieu de GUIX_PACKAGE_PATH
, l’option de la ligne de commande
--load-path=directory (ou en bref -L
directory) vous permet d’ajouter directory au début du chemin
de recherche du module de paquet et donc de rendre vos propres paquets
visibles.
Suivant: Invoquer guix hash
, Précédent: Invoquer guix edit
, Monter: Utilitaires [Table des matières][Index]
guix download
Lorsqu’on écrit une définition de paquet, on a généralement besoin de
télécharger une archive des sources, calculer son hash SHA256 et écrire ce
hash dans la définition du paquet (voir Définition des paquets). L’outil
guix download
aide à cette tâche : il télécharge un fichier à
l’URL donné, l’ajoute au dépôt et affiche à la fois son nom dans le dépôt et
son hash SHA56.
Le fait que le fichier téléchargé soit ajouté au dépôt économise la bande
passante : quand on construit ensuite le paquet nouvellement défini avec
guix build
, l’archive des sources n’a pas besoin d’être à nouveau
téléchargée puisqu’elle se trouve déjà dans le dépôt. C’est aussi une
manière pratique de garder des fichiers temporairement, qui pourront ensuite
être supprimés (voir Invoquer guix gc
).
La commande guix download
supporte les mêmes URI que celles
utilisées dans les définitions de paquets. En particulier, elle supporte
les URI mirror://
. Les URI http
(HTTP sur TLS) sont
supportées si les liaisons Guile de GnuTLS sont disponibles dans
l’environnement de l’utilisateur ; si elle ne sont pas disponibles, une
erreur est renvoyée. Voir how to install the GnuTLS
bindings for Guile dans GnuTLS-Guile, pour plus d’informations.
guix download
vérifie les certificats du serveur HTTPS en
chargeant les autorités de certification X.509 depuis le répertoire vers
lequel pointe la variable d’environnement SSL_CERT_DIR
(voir Certificats X.509), à moins que --no-check-certificate ne soit utilisé.
Alternatively, guix download
can also retrieve a Git repository,
possibly a specific commit, tag, or branch.
Les options suivantes sont disponibles :
--hash=algorithme
-H algorithme
Calcule un hash en utilisant l’algorithme spécifié. Voir Invoquer guix hash
, pour plus d’ informations.
--format=fmt
-f fmt
Écrit le hash dans le format spécifié par fmt. Pour plus
d’informations sur les valeurs valides pour fmt, voir Invoquer guix hash
.
--no-check-certificate
Ne pas valider les certificats HTTPS des serveurs.
Lorsque vous utilisez cette option, vous n’avez absolument aucune garanti que vous communiquez avec le serveur authentique responsable de l’URL donnée, ce qui vous rend vulnérable à des attaques de « l’homme du milieu ».
--output=fichier
-o fichier
Enregistre le fichier téléchargé dans fichier plutôt que de l’ajouter au dépôt.
--git
-g
Checkout the Git repository at the latest commit on the default branch.
--commit=commit-or-tag
Checkout the Git repository at commit-or-tag.
commit-or-tag can be either a tag or a commit defined in the Git repository.
--branch=branche
Checkout the Git repository at branch.
The repository will be checked out at the latest commit of branch, which must be a valid branch of the Git repository.
--recursive
-r
Recursively clone the Git repository.
Suivant: Invoquer guix import
, Précédent: Invoquer guix download
, Monter: Utilitaires [Table des matières][Index]
guix hash
La commande guix hash
calcule le hash d’un fichier. C’est surtout
un outil pour simplifier la vie des contributeur·rice·s à la distribution :
elle calcule le hash cryptographique d’un ou plusieurs fichiers, qui peut
être utilisé dans la définition d’ un paquet (voir Définition des paquets).
La syntaxe générale est :
guix hash option fichier …
Lorsque fichier est -
(un tiret), guix hash
calcul le
hash des données lues depuis l’entrée standard. guix hash
a les
options suivantes :
--hash=algorithme
-H algorithme
Calcule un hash en utilisant l’ algorithme spécifié, sha256
par
défaut.
algorithm doit être le nom de l’ algorithme d’un hash cryptographique
supporté par Libgcrypt via Guile-Gcrypt—par exemple, sha512
ou
sha3-256
(voir Hash Functions dans Guile-Gcrypt
Reference Manual).
--format=fmt
-f fmt
Écrit le hash dans le format spécifié par fmt.
Formats supportés : base64
, nix-base32
, base32
,
base16
(hex
et hexadecimal
peuvent être utilisés).
Si l’option --format n’est pas spécifiée, guix hash
affichera le hash en nix-base32
. Cette représentation est utilisée
dans les définitions des paquets.
--recursive
-r
L’option --recursive est obsolète et remplacée par --serializer=nar (voir plus bas) ; -r reste accepté car c’est un raccourci pratique.
--serializer=type
-S type
Calcule le hash sur fichier avec la sérialisation type.
type peut être l’une des valeurs suivantes :
none
C’est la valeur par défaut : elle calcule le hash du contenu d’un fichier.
nar
Calcul le hash d’une « archive normalisée » (ou « nar ») contenant
fichier, dont ses enfants si c’est un répertoire. Certaines
métadonnées de fichier fait partie de l’archive ; par exemple lorsque
fichier est un fichier normal, le hash est différent que le
fichier soit exécutable ou non. Les métadonnées comme un horodatage
n’ont aucun impact sur le hash (voir Invoquer guix archive
pour plus de
détails sur le format nar).
git
Calcule le hash d’un fichier ou d’un répertoire comme une arborescence Git, suivant la même méthode que le système de contrôle de version Git.
--exclude-vcs
-x
Conjointement avec --recursive, exclut les répertoires de système de contrôle de version (.bzr, .git, .hg, etc.).
Par exemple, voici comment calculer le hash d’un dépôt Git, ce qui est utile
avec la méthode git-fetch
(voir Référence de origin
) :
$ git clone http://example.org/toto.git $ cd toto $ guix hash -x --serializer=nar .
Suivant: Invoquer guix refresh
, Précédent: Invoquer guix hash
, Monter: Utilitaires [Table des matières][Index]
guix import
La commande guix import
est utile pour les gens qui voudraient
ajouter un paquet à la distribution avec aussi peu de travail que possible —
une demande légitime. La commande connaît quelques dépôts logiciels d’où
elle peut « importer » des métadonnées de paquets. Le résultat est une
définition de paquet, ou un modèle de définition, dans le format reconnu par
Guix (voir Définition des paquets).
La syntaxe générale est :
guix import [global-options…] importer package [options…]
importer specifies the source from which to import package metadata,
and options specifies a package identifier and other options specific
to importer. guix import
itself has the following
global-options:
--insert=file
-i file
Insert the package definition(s) that the importer generated into the specified file, either in alphabetical order among existing package definitions, or at the end of the file otherwise.
Certains des importeurs s’appuient sur la capacité d’exécuter la commande
gpgv
. Pour ceux-ci, GnuPG doit être installé dans $PATH
;
exécuter guix install gnupg
si nécessaire.
Actuellement, les « importeurs » disponibles sont :
gnu
Importe des métadonnées d’un paquet GNU donné. Cela fournit un modèle pour la dernière version de ce paquet GNU, avec le hash de son archive, le synopsis et la description canonique.
Les informations supplémentaires comme les dépendances du paquet et sa licence doivent être renseignées manuellement.
Par exemple, la commande suivante renvoie une définition de paquets pour GNU Hello :
guix import gnu hello
Les options spécifiques sont :
--key-download=politique
Comme pour guix refresh
, spécifie la politique de gestion des
clefs OpenPGP manquantes lors de la vérification de la signature d’un
paquet. Voir --key-download
.
pypi
¶Importe des métadonnées depuis l’index des
paquets Python. Les informations sont récupérées à partir de la
description en JSON disponible sur pypi.python.org
et inclus
généralement toutes les informations utiles, dont les dépendances des
paquets. Pour une efficacité maximale, il est recommandé d’installer
l’utilitaire unzip
, pour que l’importateur puisse dézipper les
wheels Python et récupérer les informations contenues à l’intérieur.
La commande ci-dessous importe les métadonnées de la dernière version du
paquet Python itsdangerous
:
guix import pypi itsdangerous
Vous pouvez aussi demander une version spécifique :
guix import pypi itsdangerous@1.1.0
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
gem
¶Importe des métadonnées de RubyGems. Les
informations sont récupérées au format JSON disponible sur
rubygems.org
et inclut les informations les plus utiles, comme les
dépendances à l’exécution. Il y a des cependant quelques restrictions. Les
métadonnées ne distinguent pas synopsis et description, donc la même chaîne
est utilisée pour les deux champs. En plus, les détails des dépendances non
Ruby requises pour construire des extensions natives sont indisponibles et
laissé en exercice à l’empaqueteur.
La commande ci-dessous importe les métadonnées pour le paquet Ruby
rails
:
guix import gem rails
Vous pouvez aussi demander une version spécifique :
guix import gem rails@7.0.4
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
minetest
¶Importe des métadonnées de ContentDB. Les informations sont récupérées au format JSON disponible à travers l’API de ContentDB et inclus les informations les plus utiles, dont les dépendances. Il y a cependant quelques limitations. L’information de licence est souvent incomplète. Le hash de commit est parfois oublié. Les descriptions sont au format Markdown mais Guix utilise plutôt Texinfo. Les packs de textures et les jeux ne sont pas pris en charge.
La commande ci-dessous importe les métadonnées pour le mod Mesecons de Jeija :
guix import minetest Jeija/mesecons
Vous pouvez aussi ne pas indiquer le nom de l’auteur :
guix import minetest mesecons
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
cpan
¶Importe des métadonnées de MetaCPAN. Les
informations sont récupérées au format JSON disponible à travers
l’API de MetaCPAN et inclus les
informations les plus utiles, comme les dépendances des modules.
L’information sur les licences doit être vérifiée avec attention. Si Perl
est disponible dans le dépôt, alors l’utilitaire corelist
sera
utiliser pour exclure les modules du cœur de la distribution Perl de la
liste des dépendances.
La commande ci-dessous importe des métadonnées pour le module Acme ::Boolean Perl :
guix import cpan Acme::Boolean
cran
¶Importe des métadonnées de CRAN, le dépôt central de l’environnement statistique et graphique GNU R.
L’ information est extraite du fichier DESCRIPTION du paquet.
La commande ci-dessous importe les métadonnées du paquet Cairo R :
guix import cran Cairo
Vous pouvez aussi demander une version spécifique :
guix import cran rasterVis@0.50.3
Lorsque l’option --recursive est utilisée, l’importateur traversera le graphe des dépendances du paquet en amont récursivement et générera des expressions de paquets pour tous ceux qui ne sont pas déjà dans Guix.
Lorsque vous ajoutez --style=specification, l’importateur générera des définitions de paquets dont les entrées sont les spécifications des paquets au lieu de références au variables des paquets. C’est utile lorsque des définitions de paquets doivent être ajoutées à des modules utilisateurs, comme la liste des modules de paquets n’a pas besoin d’être changée. La valeur par défaut est --style=variable.
Lorsque vous ajoutez --prefix=license:, l’outil d’import ajoutera
license:
au début du nom des licences, ce qui permet d’importer
(guix licenses)
avec un préfixe.
Lorsque --archive=bioconductor est ajoutée, les métadonnées sont importées depuis Bioconductor, un répertoire de paquets R pour l’analyse et la compréhension de données génomiques volumineuses en bioinformatique.
Les informations sont extraites du fichier DESCRIPTION du paquet contenu dans l’archive du paquet.
La commande ci-dessous importe les métadonnées pour le paquet R GenomicRanges :
guix import cran --archive=bioconductor GenomicRanges
Enfin, vous pouvez aussi importer des paquets R qui n’ont pas encore été publiés sur CRAN ou Bioconductor tant qu’ils ne sont pas dans le dépôt Git. Utilisez --archive=git suivi par l’URL du dépôt Git :
guix import cran --archive=git https://github.com/immunogenomics/harmony
texlive
¶Importe les informations de paquets TeX à partir de la base de données TeX Live pour les paquets TeX qui font partie de la distribution TeX Live.
Information about the package is obtained from the TeX Live package
database, a plain text file that is included in the texlive-scripts
package. The source code is downloaded from possibly multiple locations in
the SVN repository of the Tex Live project. Note that therefore SVN must be
installed and in $PATH
; run guix install subversion
if needed.
La commande ci-dessous importe les métadonnées du paquet TeX
fontspec
:
guix import texlive fontspec
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
json
¶Importe des métadonnées d’un fichier JSON local. Considérez l’exemple suivant d’une définition de paquet au format JSON :
{ "name": "hello", "version": "2.10", "source": "mirror://gnu/hello/hello-2.10.tar.gz", "build-system": "gnu", "home-page": "https://www.gnu.org/software/hello/", "synopsis": "Hello, GNU world: An example GNU package", "description": "GNU Hello prints a greeting.", "license": "GPL-3.0+", "native-inputs": ["gettext"] }
Les noms des champs sont les mêmes que pour les enregistrements de
<package>
(Voir Définition des paquets). Les référence à d’autres
paquets sont fournies comme des listes JSON de chaînes de spécifications de
paquets comme guile
ou guile@2.0
.
L’importateur supporte aussi une définition plus explicite des sources avec
les champs habituels pour les enregistrements <origin>
:
{ … "source": { "method": "url-fetch", "uri": "mirror://gnu/hello/hello-2.10.tar.gz", "sha256": { "base32": "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i" } } … }
La commande ci-dessous lit les métadonnées du fichier JSON hello.json
et renvoie une expression de paquet :
guix import json hello.json
hackage
¶Importe les métadonnées de l’archive de paquets centrale de la communauté Haskell, Hackage. Les informations sont récupérées depuis les fichiers Cabal et incluent toutes les informations utiles, dont les dépendances des paquets.
Les options spécifiques sont :
--stdin
-s
Lit un fichier Cabal depuis l’entrée standard.
--no-test-dependencies
-t
N’inclut pas les dépendances requises uniquement par les suites de tests.
--cabal-environment=alist
-e alist
alist est une alist Scheme qui définie l’environnement dans lequel les
conditions de Cabal sont évaluées. Les clefs acceptées sont : os
,
arch
, impl
et une représentation sous forme de chaîne de
caractères du nom d’un drapeau. La valeur associée à un drapeau doit être
le symbole true
ou false
. La valeur associée aux autres clefs
doivent se conformer avec la définition du format de fichiers Cabal. La
valeur par défaut associée avec les clefs os
, arch
et
impl
sont respectivement ‘linux’, ‘x86_64’ et ‘ghc’.
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
La commande ci-dessous importe les métadonnées pour la dernière version du
paquet HTTP Haskell sans inclure les dépendances de test et en spécifiant la
valeur du drapeau ‘network-uri’ comme false
:
guix import hackage -t -e "'((\"network-uri\" . false))" HTTP
Une version spécifique du paquet peut éventuellement être spécifiée en faisant suivre le nom du paquet par un arobase et un numéro de version comme dans l’exemple suivant :
guix import hackage mtl@2.1.3.1
stackage
¶L’importateur stackage
est une enveloppe autour de l’importateur
hackage
. Il prend un nom de paquet, recherche la version incluse
dans une version au support étendu (LTS) de Stackage et utilise l’importateur hackage
pour récupérer les
métadonnées. Remarquez que c’est à vous de choisir une version LTS
compatible avec le compilateur GHC utilisé par Guix.
Les options spécifiques sont :
--no-test-dependencies
-t
N’inclut pas les dépendances requises uniquement par les suites de tests.
--lts-version=version
-l version
version est la version LTS désirée. Si elle est omise, la dernière version est utilisée.
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
La commande ci-dessous importe les métadonnées pour le paquet HTTP Haskell inclus dans la version 7.18 de LTS Stackage :
guix import stackage --lts-version=7.18 HTTP
elpa
¶Importe les métadonnées du dépôt de paquets ELPA (Emacs Lisp Package Archive) (voir Packages dans The GNU Emacs Manual).
Les options spécifiques sont :
--archive=repo
-a repo
repo identifie le dépôt d’archive depuis lequel récupérer les informations. Actuellement les dépôts supportés et leurs identifiants sont :
gnu
. C’est la valeur par défaut.
Les paquets de elpa.gnu.org
avec l’une des clefs contenues dans le
porte-clef GnuPG share/emacs/25.1/etc/package-keyring.gpg (ou
similaire) dans le paquet emacs
(voir ELPA
package signatures dans The GNU Emacs Manual).
nongnu
.
melpa-stable
.
melpa
.
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
crate
¶Importer les métadonnées du dépôt de paquets Rust crates.io crates.io, comme dans cet exemple :
guix import crate blake2-rfc
L’importeur crate vous permet aussi de spécifier une version de chaînes de caractères :
guix import crate constant-time-eq@0.1.0
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
--recursive-dev-dependencies
If --recursive-dev-dependencies is specified, also the recursively imported packages contain their development dependencies, which are recursively imported as well.
--allow-yanked
If no non-yanked version of a crate is available, use the latest yanked version instead instead of aborting.
elm
¶Importer les métadonnées du dépôt de paquets Elm package.elm-lang.org, comme dans cet exemple :
guix import elm elm-explorations/webgl
L’importeur Elm vous permet aussi de spécifier une version de chaînes de caractères :
guix import elm elm-explorations/webgl@1.1.3
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
npm-binary
¶Import metadata from the npm Registry, as in this example:
guix import npm-binary buffer-crc32
The npm-binary importer also allows you to specify a version string:
guix import npm-binary buffer-crc32@1.0.0
Remarque : Generated package expressions skip the build step of the
node-build-system
. As such, generated package expressions often refer to transpiled or generated files, instead of being built from source.
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
opam
¶Importe les métadonnées du répertoire de paquets OPAM utilisé par la communauté OCaml.
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
composer
¶Import metadata from the Composer package archive used by the PHP community, as in this example:
guix import composer phpunit/phpunit
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
--repo
Par défaut on recherche les paquets dans le dépôt OPAM officiel. Cette option, qui peut être utilisée plusieurs fois en même temps, vous permet d’ajouter d’autres dépôts dans lesquelles on recherchera les paquets. Les arguments valide sont :
opam
,
coq
(équivalent à coq-released
), coq-core-dev
,
coq-extra-dev
ou grew
.
opam repository add
(par exemple, l’URL équivalent au nom
opam
plus haut serait https://opam.ocaml.org).
Les dépôts sont passés à cette commande par ordre de préférence. Les dépôts
supplémentaires ne remplaceront pas le dépôt opam
par défaut, qui est
toujours gardé en dernier recours.
Ainsi, remarquez que les versions ne sont pas comparées entre dépôts. Le premier dépôt (de gauche à droite) qui a au moins une version d’un paquet donné prendra le pas sur les autres, et la version importée sera la plus récente trouvée dans ce dépôt uniquement.
go
¶Importe les métadonnées d’un module Go avec proxy.golang.org.
guix import go gopkg.in/yaml.v2
Il est possible d’utiliser la spécification d’un paquet avec le suffixe
@VERSION
pour importer une version spécifique.
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
--pin-versions
Lorsque vous utilisez cette option, l’importateur préserve les versions exactes des modules Go de dépendance au lieu d’utiliser leur dernière version disponible. C’est utile si vous essayez d’importer un paquet qui dépend récursivement de versions antérieures de lui-même pour la construction. Lorsque vous utilisez ce mode, le symbole du paquet sera créé en ajoutant la version à son nom, pour que plusieurs version du même paquet puissent coexister.
egg
¶Importe les métadonnées pour des « eggs » CHICKEN. L’information est récupérée dans les fichiers PACKAGE.egg trouvés dans le dépôt git eggs-5-all. Toutefois, il ne fournit pas toutes les informations dont vous avez besoin, il n’y a pas de champ “description” et les licences utilisées ne sont pas toujours précises (BSD est souvent employée à la place de BSD-N).
guix import egg sourcehut
Vous pouvez aussi demander une version spécifique :
guix import egg arrays@1.0
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
hexpm
¶Importer les métadonnées du dépôt de paquets Erlang et Elixir hex.pm hex.pm, comme dans cet exemple :
guix import hexpm stun
L’importateur essaye de déterminer le système de construction utilisé par le paquet.
L’importeur hexpm vous permet aussi de spécifier une version de chaînes de caractères :
guix import hexpm cf@0.3.0
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
La structure du code de guix import
est modulaire. Il serait
utile d’avoir plus d’importateurs pour d’autres formats de paquets et votre
aide est la bienvenue sur ce sujet (voir Contribuer).
Suivant: Invoquer guix style
, Précédent: Invoquer guix import
, Monter: Utilitaires [Table des matières][Index]
guix refresh
La commande guix refresh
s’adresse avant tout aux personnes qui
écrivent des paquets. En tant qu’utilisateur·rice, vous pourriez être
intéressé·e par l’option --with-latest qui peut vous conférer les
superpouvoirs de mettre à jour les paquets, et qui est construite à partir
de guix refresh
(voir --with-latest). Par défaut, guix refresh
rapporte les
paquets fournis par la distribution qui sont en retard par rapport aux
dernières versions disponibles en amont, comme ceci :
$ guix refresh gnu/packages/gettext.scm :29 :13 : gettext serait mis à jour de 0.18.1.1 à 0.18.2.1 gnu/packages/glib.scm :77:12 : glib serait mis à jour de 2.34.3 à 2.37.0
On peut aussi spécifier des paquets à prendre en compte, auquel cas un avertissement est émis pour les paquets qui ne sont pas mis à jour :
$ guix refresh coreutils guile guile-ssh gnu/packages/ssh.scm:205:2 : avertissement : aucun gestionnaire de mise à jour pour guile-ssh gnu/packages/guile.scm:136:12 : guile serait mis à jour de 2.0.12 à 2.0.13
guix refresh
navigue le dépôt amont de chaque paquet et détermine
le numéro de version le plus élevé parmi les versions publiées. La commande
sait comment mettre à jour certains types de paquets : les paquets GNU, les
paquets ELPA, etc. — voir la documentation pour --type ci-dessous.
Il y a beaucoup de paquet cependant pour lesquels il manque une méthode pour
déterminer si une nouvelle version est disponible en amont. Cependant, le
mécanisme est extensible, alors n’hésitez pas à nous contacter pour ajouter
une nouvelle méthode !
--recursive
Considère les paquets spécifiés et tous les paquets dont ils dépendent.
$ guix refresh --recursive coreutils gnu/packages/acl.scm:40:13: acl would be upgraded from 2.2.53 to 2.3.1 gnu/packages/m4.scm:30:12: 1.4.18 is already the latest version of m4 gnu/packages/xml.scm:68:2: warning: no updater for expat gnu/packages/multiprecision.scm:40:12: 6.1.2 is already the latest version of gmp …
Si pour n’importe quelle raison vous ne voulez pas mettre à jour vers la dernière version, vous pouvez mettre à jour vers une version spécifique en ajoutant un signe égal et le numéro de version désiré à la fin de la spécification du paquet. Remarquez que tous les programmes de mise à jour ne le prennent pas en charge. Une erreur est rapportée quand un programme de mise à jour ne peut pas rafraîchir vers la version spécifiée.
$ guix refresh guile gnu/packages/guile.scm:392:2: guile serait mis à jour de 3.0.3 vers 3.0.5 $ guix refresh -u guile=3.0.4 … gnu/packages/guile.scm:392:2: guile : mise à jour de la version 3.0.3 vers la version 3.0.4... … $ guix refresh -u guile@2.0=2.0.12 … gnu/packages/guile.scm:147:2: guile : mise à jour de la version 2.0.10 vers la version 2.0.12... …
In some specific cases, you may have many packages specified via a manifest or a module selection which should all be updated together; for these cases, the --target-version option can be provided to have them all refreshed to the same version, as shown in the examples below:
$ guix refresh qtbase qtdeclarative --target-version=6.5.2 gnu/packages/qt.scm:1248:13: qtdeclarative would be upgraded from 6.3.2 to 6.5.2 gnu/packages/qt.scm:584:2: qtbase would be upgraded from 6.3.2 to 6.5.2
$ guix refresh --manifest=qt5-manifest.scm --target-version=5.15.10 gnu/packages/qt.scm:1173:13: qtxmlpatterns would be upgraded from 5.15.8 to 5.15.10 gnu/packages/qt.scm:1202:13: qtdeclarative would be upgraded from 5.15.8 to 5.15.10 gnu/packages/qt.scm:1762:13: qtserialbus would be upgraded from 5.15.8 to 5.15.10 gnu/packages/qt.scm:2070:13: qtquickcontrols2 would be upgraded from 5.15.8 to 5.15.10 …
Parfois les noms en amont diffèrent du nom de paquet utilisé par Guix et
guix refresh
a besoin d’un peu d’aide. La plupart des
gestionnaires de mise à jour prennent en compte la propriété
upstream-name
dans les définitions de paquets, ce qui peut être
utilisé à cette fin :
(define-public network-manager
(package
(name "network-manager")
;; …
(properties '((upstream-name . "NetworkManager")))))
When passed --update, it modifies distribution source files to
update the version numbers and source code hashes of those package
definitions, as well as possibly their inputs (voir Définition des paquets).
This is achieved by downloading each package’s latest source tarball and its
associated OpenPGP signature, authenticating the downloaded tarball against
its signature using gpgv
, and finally computing its hash—note
that GnuPG must be installed and in $PATH
; run guix install
gnupg
if needed.
Quand la clé publique utilisée pour signer l’archive est manquante depuis le
trousseau de clés utilisateur·rice, une tentative est faite de la récupérer
automatiquement depuis un serveur de clé publique ; en cas de succès, la clé
est ajoutée au trousseau de l’utilisateur·rice ; sinon, guix
refresh
renvoie une erreur.
Les options suivantes sont supportées :
--expression=expr
-e expr
Considérer le paquet évalué par expr.
C’est utile pour précisément se référer à un paquet, comme dans cet exemple :
guix refresh -l -e '(@@ (gnu packages commencement) glibc-final)'
Cette commande liste les dépendances de la libc « finale » (presque tous les paquets).
--update
-u
Update distribution source files (package definitions) in place. This is usually run from a checkout of the Guix source tree (voir Lancer Guix avant qu’il ne soit installé):
./pre-inst-env guix refresh -s non-core -u
Voir Définition des paquets, for more information on package definitions. You can also run it on packages from a third-party channel:
guix refresh -L /path/to/channel -u package
Voir Écrire de nouveaux de canaux, on how to create a channel.
This command updates the version and source code hash of the package. Depending on the updater being used, it can also update the various ‘inputs’ fields of the package. In some cases, the updater might get inputs wrong—it might not know about an extra input that’s necessary, or it might add an input that should be avoided.
To address that, packagers can add properties stating inputs that should be
added to those found by the updater or inputs that should be ignored: the
updater-extra-inputs
and updater-ignored-inputs
properties
pertain to “regular” inputs, and there are equivalent properties for
‘native’ and ‘propagated’ inputs. In the example below, we tell
the updater that we need ‘openmpi’ as an additional input:
(define-public python-mpi4py
(package
(name "python-mpi4py")
;; …
(inputs (list openmpi))
(properties
'((updater-extra-inputs . ("openmpi"))))))
That way, guix refresh -u python-mpi4py
will leave the
‘openmpi’ input, even if it is not among the inputs it would normally
add.
--select=[subset]
-s subset
Select all the packages in subset, one of core
, non-core
or module:name
.
Le sous-ensemble core
se réfère à tous les paquets du cœur de la
distribution — c.-à-d. les paquets qui sont utilisés pour construire «
tout le reste ». Cela comprend GCC, libc, Binutils, Bash, etc.
Habituellement, changer l’un de ces paquets dans la distribution implique de
reconstruire tous les autres. Ainsi, ces mises à jour sont une nuisance
pour les utilisateurs, en terme de temps de compilation et de bande passante
utilisés pour effectuer la mise à jour.
Le sous-ensemble non-core
se réfère au reste des paquets. C’est
habituellement utile dans les cas où une mise à jour des paquets du cœur
serait dérangeante.
The module:name
subset refers to all the packages in a
specified guile module. The module can be specified as module:guile
or module:(gnu packages guile)
, the former is a shorthand for the
later.
--manifest=fichier
-m fichier
Choisi tous les paquets du manifeste dans file. C’est utile pour vérifier qu’aucun des paquets du manifeste utilisateur ne peut être mis à jour.
--type=updater
-t updater
Chois uniquement les paquets pris en charge par updater (éventuellement une liste de gestionnaires de mise à jour séparés par des virgules). Actuellement, updater peut être l’une des valeurs suivantes :
gnu
le gestionnaire de mise à jour pour les paquets GNU ;
savannah
le gestionnaire de mise à jour pour les paquets hébergés sur Savannah ;
sourceforge
le gestionnaire de mise à jour pour les paquets hébergés sur SourceForge ;
gnome
le gestionnaire de mise à jour pour les paquets GNOME ;
kde
le gestionnaire de mise à jour pour les paquets KDE ;
xorg
le gestionnaire de mise à jour pour les paquets X.org ;
kernel.org
le gestionnaire de mise à jour pour les paquets hébergés sur kernel.org ;
egg
le gestionnaire de mise à jour pour les paquets Egg ;
elpa
le gestionnaire de mise à jour pour les paquets ELPA ;
cran
le gestionnaire de mise à jour pour les paquets CRAN ;
bioconductor
le gestionnaire de mise à jour pour les paquets Bioconductor ;
cpan
le gestionnaire de mise à jour pour les paquets CPAN ;
pypi
le gestionnaire de mise à jour pour les paquets PyPI.
gem
le gestionnaire de mise à jour pour les paquets RubyGems.
github
le gestionnaire de mise à jour pour les paquets GitHub.
hackage
le gestionnaire de mise à jour pour les paquets Hackage.
stackage
le gestionnaire de mise à jour pour les paquets Stackage.
crate
le gestionnaire de mise à jour pour les paquets Crates.
launchpad
le gestionnaire de mise à jour pour les paquets Launchpad.
generic-html
un gestionnaire de mise à jour qui visite la page HTML où l’archive des
sources est hébergée, lorsque c’est possible, ou la page HTML spécifiée par
la propriété release-monitoring-url
du paquet.
generic-git
un gestionnarie de mise à jour générique pour les paquets hébergés sur des dépôts Git. Il essaye d’analyser les noms de tag Git de manière astucieuse, mais s’il ne parvient pas à analyser le nom d’un tag et à comparer les tags correctement, il est possible de définir les propriétés suivantes pour un paquet.
release-tag-prefix
: une expression régulière pour repérer le préfixe dans
le nom d’un tag.
release-tag-suffix
: une expression régulière pour repérer le suffixe dans
le nom d’un tag.
release-tag-version-delimiter
: une chaîne de caractères utilisée comme délimitation dans
le nom d’un tag pour séparer les numéros de version.
accept-pre-releases
: par défaut, le gestionnaire de mise à jour ignorera
les pré-versions ; pour lui faire chercher aussi les pré-versions, assignez
à cette propriété la valeur #t
.
(package
(name "toto")
;; ...
(properties
'((release-tag-prefix . "^release0-")
(release-tag-suffix . "[a-z]?$")
(release-tag-version-delimiter . ":"))))
Par exemple, la commande suivante ne vérifie que les mises à jour des
paquets Emacs hébergés sur elpa.gnu.org
et les paquets CRAN :
$ guix refresh --type=elpa,cran gnu/packages/statistics.scm:819:13 : r-testthat serait mis à jour de 0.10.0 à 0.11.0 gnu/packages/emacs.scm:856:13 : emacs-auctex serait mis à jour de 11.88.6 à 11.88.9
--list-updaters
Liste les gestionnaires de mises à jour disponibles et quitte (voir --type ci-dessus).
Pour chaque gestionnaire, affiche le pourcentage de paquets qu’il couvre ; à la fin, affiche le pourcentage de paquets couverts par tous les gestionnaires.
En plus, on peut passer à guix refresh
un ou plusieurs noms de
paquets, comme dans cet exemple :
$ ./pre-inst-env guix refresh -u emacs idutils gcc@4.8
La commande ci-dessus met à jour spécifiquement les paquets emacs
et
idutils
. L’option --select n’aurait aucun effet dans ce
cas. Vous voudrez aussi sans doute mettre à jour les définitions qui
correspondent aux paquets installés dans votre profil :
$ ./pre-inst-env guix refresh -u \ $(guix package --list-installed | cut -f1)
Pour déterminer s’il faut mettre à jour un paquet, il est parfois pratique
de savoir quels paquets seraient affectés par la mise à jour pour pouvoir
vérifier la compatibilité. Pour cela l’option suivante peut être utilisée
avec un ou plusieurs noms de paquets passés à guix refresh
:
--list-dependent
-l
Liste les paquets de plus haut-niveau qui devraient être reconstruits après la mise à jour d’un ou plusieurs paquets.
Voir le type reverse-package
de guix
graph
, pour des informations sur la manière de visualiser la liste des
paquets dépendant d’un autre.
Sachez que l’option --list-dependent n’a qu’une approche approximative sur les reconstructions qui seraient nécessaires à la suite d’une mise à jour. D’autres reconstructions peuvent être nécessaires dans certaines circonstances.
$ guix refresh --list-dependent flex Construire les 120 paquets suivants s'assure que les 213 paquets dépendants sont reconstruits : hop@2.4.0 emacs-geiser@0.13 notmuch@0.18 mu@0.9.9.5 cflow@1.4 idutils@4.6 …
La commande ci-dessus liste un ensemble de paquets qui peuvent être
construits pour vérifier la compatibilité d’une mise à jour de flex
.
--list-transitive
-T
Lister tous les paquets dont un paquet ou plus dépendent.
$ guix refresh --list-transitive flex flex@2.6.4 depends on the following 25 packages: perl@5.28.0 help2man@1.47.6 bison@3.0.5 indent@2.2.10 tar@1.30 gzip@1.9 bzip2@1.0.6 xz@5.2.4 file@5.33 …
La commande ci-dessus liste un ensemble de paquets qui, lorsqu’ils sont
modifiés, causent la reconstruction de flex
.
Les options suivante peuvent être utilisées pour personnaliser les opérations avec GnuPG :
--gpg=commande
Utilise commande comme la commande de GnuPG 2.x. commande est
recherchée dans PATH
.
--keyring=fichier
Utilise fichier comme porte-clefs pour les clefs amont. fichier
doit être dans le format keybox. Les fichiers Keybox ont d’habitude
un nom qui fini par .kbx et GNU Privacy Guard (GPG) peut
manipuler ces fichiers (voir kbxutil
dans Using the
Privacy Guard, pour plus d’informations sur un outil pour manipuler des
fichiers keybox).
Lorsque cette option est omise, guix refresh
utilise
~/.config/guix/upstream/trustedkeys.kbx comme trousseau pour les clés
de signature en amont. Les signatures OpenPGP sont vérifiées avec ces clés
; les clés manquantes sont aussi téléchargées dans ce trousseau (voir
--key-download plus bas).
Vous pouvez exporter les clefs de votre porte-clefs GPG par défaut dans un fichier keybox avec une commande telle que :
gpg --export rms@gnu.org | kbxutil --import-openpgp >> mykeyring.kbx
De même, vous pouvez récupérer des clefs dans un fichier keybox spécifique comme ceci :
gpg --no-default-keyring --keyring mykeyring.kbx \ --recv-keys 3CE464558A84FDC69DB40CFB090B11993D9AEBB5
Voir --keyring dans Using the GNU Privacy Guard pour plus d’informations sur l’option --keyring de GPG.
--key-download=politique
Gère les clefs OpenPGP manquantes d’après la politique, qui peut être l’une des suivantes :
always
Toujours télécharger les clefs manquantes depuis un serveur de clefs et les ajouter au porte-clefs de l’utilisateur.
never
Ne jamais essayer de télécharger les clefs OpenPGP manquante. Quitter à la place.
interactive
Lorsqu’on rencontre un paquet signé par une clef OpenPGP inconnue, demander à l’utilisateur s’il souhaite la télécharger ou non. C’est le comportement par défaut.
--key-server=host
Utiliser host comme serveur de clefs OpenPGP lors de l’importe d’une clef publique.
--load-path=répertoire
-L répertoire
Ajoute répertoire au début du chemin de recherche de module de paquets (voir Modules de paquets).
Cela permet à des utilisateurs de définir leur propres paquets et les rendre disponibles aux outils en ligne de commande.
Le gestionnaire de mises à jour github
utilise
GitHub API pour faire des requêtes
sur les nouvelles versions. Lorsqu’elle est utilisé de manière répétée, par
exemple lorsque vous vérifiez tous les paquets, GitHub finira par refuser de
répondre à d’autres requêtes de l’API. Par défaut 60 requêtes à l’heure
sont autorisées, et une vérification complète de tous les paquets GitHub
dans Guix demande bien plus que cela. L’authentification avec GitHub à
travers l’utilisation d’un jeton d’API lève ces limites. Pour utiliser un
jeton de l’API, initialisez la variable d’environnement
GUIX_GITHUB_TOKEN
avec un jeton que vous vous serez procuré sur
https://github.com/settings/tokens ou autrement.
Suivant: Invoquer guix lint
, Précédent: Invoquer guix refresh
, Monter: Utilitaires [Table des matières][Index]
guix style
La commande guix style
aide aussi bien les utilisateur·ices que
les auteur·ices de paquets à présenter leurs définitions de paquets et leurs
fichiers de configuration suivant la toute dernière mode. Elle peut aussi
bien reformater des fichiers entiers, avec l’option --whole-file,
qu’appliquer des règles de style spécifiques à des définitions de
paquets individuelles. La commande fournit actuellement les règles
stylistiques suivantes :
La manière dont les entrées des paquets sont écrites est en phase de
transition (voir Référence de package
, pour plus d’information sur les
entrées des paquets). Jusqu’à la version 1.3.0, les entrées des paquets
étaient écrites avec l’« ancien style », où chaque entrée était associée à
une étiquette explicite, la plupart du temps le nom du paquet :
(package
;; …
;; L'« ancien style » (obsolète).
(inputs `(("libunistring" ,libunistring)
("libffi" ,libffi))))
Aujourd’hui, l’ancien style est obsolète et le style de préférence ressemble à ceci :
De la même manière, l’utilisation de alist-delete
et compagnie pour
manipuler les entrées est maintenant obsolète en faveur de
modify-inputs
(voir Définition de variantes de paquets, pour plus
d’information sur modify-inputs
).
Dans la grande majorité des cas, c’est un changement purement mécanique de
la syntaxe qui ne provoque même pas de reconstruction du paquet. Lancer
guix style -S inputs
peut le faire pour vous, que vous travailliez
sur des paquets dans Guix ou dans un canal externe.
La syntaxe générale est :
guix style [options] paquet…
Cela fait analyser et réécrire la définition des paquet… à
guix style
ou, si paquet est omis, de tous les
paquets. Les options --styling ou -S vous permettent de
choisir la règle de style, la règle par défaut est format
— voir
plus bas.
Pour reformater des fichiers sources complets, la syntaxe est :
guix style --whole-file fichier…
Les options disponibles sont listées ci-dessous.
--dry-run
-n
Montre les emplacement dans les fichiers sources qui seraient modifiés mais sans les modifier.
--whole-file
-f
Reformate entièrement les fichiers donnés. Dans ce cas, les arguments suivants sont interprétés comme des noms de fichiers (plutôt que des noms de paquets), et l’option --styling n’a aucun effet.
Par exemple, voici comme vous pouvez reformater votre configuration de système d’exploitation (vous devez avoir les permissions en écriture sur le fichier) :
guix style -f /etc/config.scm
--alphabetical-sort
-A
Place the top-level package definitions in the given files in alphabetical order. Package definitions with matching names are placed with versions in descending order. This option only has an effect in combination with --whole-file.
--styling=règle
-S règle
Applique la règle, l’une des règles de style suivantes :
format
Formate les définitions de paquets données — c’est la règle de style par défaut. Par exemple, la personne qui crée un paquet et qui utilise le Guix du checkout (voir Lancer Guix avant qu’il ne soit installé) peut vouloir reformater la définition du paquet Coreutils de cette manière :
./pre-inst-env guix style coreutils
inputs
Réécrit les entrées du paquet en le « nouveau style », décrit plus
haut. Vous pouvez réécrire les entrées d’un paquet toto
dans votre
propre canal de cette manière :
guix style -L ~/mon/canal -S inputs toto
La réécriture s’effectue de manière prudente : les commentaires sont préservés et le processus s’arrête s’il n’arrive pas à comprendre le code du champ inputs. L’option --input-simplification décrite plus bas fournit un contrôle plus fin sur les entrées qui devraient être simplifiées.
arguments
Rewrite package arguments to use G-expressions (voir G-Expressions). For example, consider this package definition:
(define-public my-package
(package
;; …
(arguments ;old-style quoted arguments
'(#:make-flags '("V=1")
#:phases (modify-phases %standard-phases
(delete 'build))))))
Running guix style -S arguments
on this package would rewrite its
arguments
field like to:
(define-public my-package
(package
;; …
(arguments
(list #:make-flags #~'("V=1")
#:phases #~(modify-phases %standard-phases
(delete 'build))))))
Note that changes made by the arguments
rule do not entail a rebuild
of the affected packages. Furthermore, if a package definition happens to
be using G-expressions already, guix style
leaves it unchanged.
--list-stylings
-l
Liste et décrit les règles de style puis quitte.
--load-path=répertoire
-L répertoire
Ajoute répertoire au début du chemin de recherche de module de paquets (voir Modules de paquets).
--expression=expr
-e expr
Reformate le paquet évalué par expr.
Par exemple, lancer :
guix style -e '(@ (gnu packages gcc) gcc-5)'
modifie le style de la définition du paquet gcc-5
.
--input-simplification=politique
Lorsque vous utilisez la règle de style inputs
, avec ‘-S
inputs’, cette option spécifie la politique de simplification des entrées du
paquet dans le cas où les étiquettes des entrées ne correspondent pas au nom
du paquet. La politique peut être l’une des suivantes :
silent
Simplifie les entrées seulement si le changement est « silencieux », ce qui signifie que le paquet n’a pas besoin d’être reconstruit (sa dérivation reste inchangée).
safe
Simplifie les entrées seulement si c’est « sûr » : le paquet peut avoir besoin d’être reconstruit, mais on est sûr que le changement n’aura aucun effet observable.
always
Simplifie les entrées même si les étiquettes des entrées ne correspondent pas au nom du paquet, et même si le changement peut avoir un effet observable.
La valeur par défaut est silent
, ce qui signifie que les
simplifications des entrées n’entraine aucune reconstruction de paquet.
Suivant: Invoquer guix size
, Précédent: Invoquer guix style
, Monter: Utilitaires [Table des matières][Index]
guix lint
La commande guix lint
est conçue pour aider les développeur·euses
à éviter des erreurs communes et à utiliser un style cohérent lors de
l’écriture de recettes de paquets. Elle lance des vérifications sur un
ensemble de paquets donnés pour trouver des erreurs communes dans leur
définition. Les vérifieurs disponibles comprennent (voir
--list-checkers pour une liste complète) :
synopsis
description
Vérifie certaines règles typographiques et stylistiques dans les descriptions et les synopsis.
inputs-should-be-native
Identifie les entrées qui devraient sans doute plutôt être des entrées natives.
source
home-page
mirror-url
github-url
source-file-name
Sonde les URL home-page
et source
et rapporte celles qui sont
invalides. Suggère une URL en mirror://
lorsque c’est possible. Si
l’URL de source
redirige vers une URL GitHub, recommande d’utiliser
l’URL GitHub. Vérifie que le nom du fichier source a un sens, p. ex.
qu’il ne s’agisse pas juste d’un numéro de version ou « git-checkout », sans
avoir déclaré un file-name
(voir Référence de origin
).
source-unstable-tarball
Analyse l’URL source
pour déterminer si une archive de GitHub est
autogénérée ou s’il s’agit d’une archive de publication. Malheureusement
les archives autogénérées de GitHub sont parfois régénérées.
dérivation
Vérifiez que la dérivation des paquets donnés peut être calculée avec succès pour tous les systèmes pris en charge (voir Dérivations).
profile-collisions
Vérifiez si l’installation des paquets donnés dans un profil risque
d’entraîner des collisions. Des collisions se produisent lorsque plusieurs
paquets portant le même nom mais avec une version différente ou un nom de
fichier de stockage différent sont propagés. Voir propagated-inputs
, pour plus d’informations sur les entrées
propagées.
archivage
¶Vérifie si le code source du paquet est archivé à Software Heritage.
Lorsque le code source non archivé provient d’un système de contrôle de
version (VCS)—par exemple, il est obtenu avec git-fetch
, envoyez au
Software Heritage une requête « save » afin qu’il l’archive éventuellement.
Cela garantit que le code source restera disponible à long terme et que Guix
peut se retourner vers le Software Heritage si le code source disparaît de
son hôte d’origine. L’état des demandes récentes de « sauvegarde » peut
être consulté en
ligne.
Quand le code source est une archive obtenue avec url-fetch
, cela
affiche simplement un message quand il n’est pas archivé. Au moment où nous
écrivons ces lignes, le Software Heritage n’autorise pas les demandes de
sauvegarde d’archives arbitraires ; nous travaillons sur les moyens de
garantir que le code source non-VCS soit également archivé.
Software Heritage
limits the
request rate per IP address. Quand la limite est atteinte, guix
lint
affiche un message et le vérificateur archival
arrête de faire
quoi que ce soit jusqu’à ce que cette limite soit réinitialisée.
cve
¶Rapporte les vulnérabilités connues trouvées dans les bases de données CVE (Common Vulnerabilities and Exposures) de l’année en cours et de l’année précédente published by the US NIST.
Pour voir les informations sur une vulnérabilité en particulier, visitez les pages :
https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-ANNÉE-ABCD
’
https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-ANNÉE-ABCD
’
où CVE-ANNÉE-ABCD
est l’identifiant CVE — p. ex.
CVE-2015-7554
.
On peut spécifier dans les recettes des paquets le nom Common Platform Enumeration (CPE) et la version du paquet s’ils diffèrent du nom et de la version que Guix utilise, comme dans cet exemple :
(package
(name "grub")
;; …
;; CPE nomme ce paquet "grub2".
(properties '((cpe-name . "grub2")
(cpe-version . "2.3"))))
Certaines entrées dans la base de données CVE ne spécifient pas la version du paquet auquel elles s’appliquent et lui restera donc attachée pour toujours. Les développeur·euses qui trouvent des alertes CVE et ont vérifié qu’elles peuvent être ignorées peuvent les déclarer comme dans cet exemple :
(package
(name "t1lib")
;; …
;; Ces CVE ne s'appliquent plus et peuvent être ignorée sans problème.
(properties `((lint-hidden-cve . ("CVE-2011-0433"
"CVE-2011-1553"
"CVE-2011-1554"
"CVE-2011-5244")))))
formatting
Avertit de problèmes de formatage du code source évidents : des espaces en fin de ligne, des tabulations, etc.
input-labels
Rapport les étiquettes de l’ancien style qui ne correspondent pas au nom du
paquet. Cela a pour but d’aider à migrer de « l’ancien style
». Voir Référence de package
, pour plus d’information sur les entrées des
paquets et les styles d’entrées. Voir Invoquer guix style
, pour la manière
de migrer vers le nouveau style.
La syntaxe générale est :
guix lint options package…
Si aucun paquet n’est donné par la ligne de commande, tous les paquets seront vérifiés. Les options peuvent contenir aucune ou plus des options suivantes :
--list-checkers
-l
Liste et décrit tous les vérificateurs disponibles qui seront lancés sur les paquets puis quitte.
--checkers
-c
N’active que les vérificateurs spécifiés dans une liste de noms séparés par des virgules parmi la liste renvoyée par --list-checkers.
--exclude
-x
Ne désactive que les vérifications spécifiés dans une liste de noms séparés par des virgules, en utilisant les noms de --list-checkers.
--expression=expr
-e expr
Considérer le paquet évalué par expr.
C’est utile pour désigner des paquets sans ambiguïté, comme dans cet exemple :
guix lint -c archival -e '(@ (gnu packages guile) guile-3.0)'
--no-network
-n
N’active que les vérificateurs qui ne dépendent pas d’un accès réseau.
--load-path=répertoire
-L répertoire
Ajoute répertoire au début du chemin de recherche de module de paquets (voir Modules de paquets).
Cela permet à des utilisateurs de définir leur propres paquets et les rendre disponibles aux outils en ligne de commande.
Suivant: Invoque guix graph
, Précédent: Invoquer guix lint
, Monter: Utilitaires [Table des matières][Index]
guix size
La commande guix size
aide à dresser un profil de l’utilisation de
l’espace disque par les paquets. Il est facile de négliger l’impact d’une
dépendance supplémentaire ajoutée à un paquet, ou l’impact de l’utilisation
d’une sortie unique pour un paquet qui pourrait être facilement séparé
(voir Des paquets avec plusieurs résultats). Ce sont ces problèmes que
guix size
peut typiquement mettre en valeur.
On peut passer un ou plusieurs spécifications de paquets à la commande,
comme gcc@4.8
ou guile:debug
, ou un nom de fichier dans le
dépôt. Regardez cet exemple :
$ guix size coreutils store item total self /gnu/store/…-gcc-5.5.0-lib 60.4 30.1 38.1% /gnu/store/…-glibc-2.27 30.3 28.8 36.6% /gnu/store/…-coreutils-8.28 78.9 15.0 19.0% /gnu/store/…-gmp-6.1.2 63.1 2.7 3.4% /gnu/store/…-bash-static-4.4.12 1.5 1.5 1.9% /gnu/store/…-acl-2.2.52 61.1 0.4 0.5% /gnu/store/…-attr-2.4.47 60.6 0.2 0.3% /gnu/store/…-libcap-2.25 60.5 0.2 0.2% total: 78.9 MiB
Les éléments du dépôt listés ici constituent la clôture transitive de Coreutils — c.-à-d. Coreutils et toutes ses dépendances, récursivement — comme ce qui serait renvoyé par :
$ guix gc -R /gnu/store/…-coreutils-8.23
Ici, la sortie possède trois colonnes à côté de chaque élément du dépôt. La première colonne, nommée « total », montre la taille en mébioctet (Mio) de la clôture de l’élément du dépôt — c’est-à-dire sa propre taille plus la taille de ses dépendances. La colonne suivante, nommée « lui-même », montre la taille de l’élément lui-même. La dernière colonne montre le ration de la taille de l’élément lui-même par rapport à celle de tous les éléments montrés.
Dans cet exemple, on voit que la clôture de Coreutils pèse 79 Mio, dont la plupart est dû à la libc et aux bibliothèques à l’exécution de GCC (ce n’est pas un problème en soit que la libc et les bibliothèques de GCC représentent une grande part de la clôture parce qu’elles sont toujours disponibles sur le système de toute façon).
Comme la commande accepte également les noms de fichiers de dépôt, il est facile d’évaluer la taille d’un résultat de construction :
guix size $(guix system build config.scm)
Lorsque les paquets passés à guix size
sont disponibles dans le
dépôt26, guix size
demande au démon de
déterminer ses dépendances, et mesure sa taille dans le dépôt, comme avec
du -ms --apparent-size
(voir du invocation dans GNU
Coreutils).
Lorsque les paquets donnés ne sont pas dans le dépôt, guix
size
rapporte les informations en se basant sur les substituts disponibles
(voir Substituts). Cela permet de profiler l’utilisation du disque des
éléments du dépôt même s’ils ne sont pas sur le disque, mais disponibles à
distance.
Vous pouvez aussi spécifier plusieurs noms de paquets :
$ guix size coreutils grep sed bash store item total self /gnu/store/…-coreutils-8.24 77.8 13.8 13.4% /gnu/store/…-grep-2.22 73.1 0.8 0.8% /gnu/store/…-bash-4.3.42 72.3 4.7 4.6% /gnu/store/…-readline-6.3 67.6 1.2 1.2% … total: 102.3 MiB
Dans cet exemple on voit que la combinaison des quatre paquets prend 102.3 Mio en tout, ce qui est bien moins que la somme des clôtures puisqu’ils ont beaucoup de dépendances en commun.
En regardant le profil renvoyé par guix size
, vous pouvez vous
demander pourquoi un paquet donné apparaît dans le profil. Pour le
comprendre, vous pouvez utiliser guix graph --path -t references
pour afficher le chemin le plus court entre les deux paquets
(voir Invoque guix graph
).
Les options disponibles sont :
Utilise les informations de substituts de urls.
Voir the same option for guix build
.
Trie les lignes en fonction de la clef, l’une des options suivantes :
lui-même
la taille de chaque élément (par défaut) ;
closure
la taille totale de la clôture de l’élément.
Écrit un schéma de l’utilisation du disque au format PNG dans fichier.
Pour l’exemple au-dessus, le schéma ressemble à ceci :
Cette option requiert l’installation de
Guile-Charting et
qu’il soit visible dans le chemin de recherche des modules Guile. Lorsque
ce n’est pas le cas, guix size
plante en essayant de le charger.
Considère les paquets pour système — p. ex. x86_64-linux
.
Ajoute répertoire au début du chemin de recherche de module de paquets (voir Modules de paquets).
Cela permet à des utilisateurs de définir leur propres paquets et les rendre disponibles aux outils en ligne de commande.
Suivant: Invoquer guix publish
, Précédent: Invoquer guix size
, Monter: Utilitaires [Table des matières][Index]
guix graph
Les paquets et leurs dépendances forment un graphe, plus précisément
un graphe orienté acyclique (DAG). Il peut vite devenir difficile d’avoir
une représentation mentale du DAG d’un paquet, donc la commande
guix graph
fournit une représentation visuelle du DAG. Par
défaut, guix graph
émet un représentation du DAG dans le format
d’entrée de Graphviz, pour que sa sortie
puisse être passée directement à la commande dot
de Graphviz.
Elle peut aussi émettre une page HTML avec du code Javascript pour afficher
un « diagramme d’accords » dans un navigateur Web, grâce à la bibliothèque
d3.js, ou émettre des requêtes Cypher pour
construire un graphe dans une base de donnée de graphes supportant le
langage de requêtes openCypher. Avec
l’option --path, elle affiche simplement le chemin le plus court
entre deux paquets. La syntaxe générale est :
guix graph options paquet…
Par exemple, la commande suivante génère un fichier PDF représentant le DAG du paquet pour GNU Core Utilities, qui montre ses dépendances à la compilation :
guix graph coreutils | dot -Tpdf > dag.pdf
La sortie ressemble à ceci :
Joli petit graphe, non ?
Vous pouvez trouver plus amusant de naviguer dans le graphe interactivement
avec xdot
(du paquet xdot
) :
guix graph coreutils | xdot -
Mais il y a plus qu’un seul graphe ! Celui au-dessus est concis : c’est le
graphe des objets paquets, en omettant les entrées implicites comme GCC,
libc, grep, etc. Il est souvent utile d’avoir ces graphes concis, mais
parfois on veut voir plus de détails. guix graph
supporte
plusieurs types de graphes, qui vous permettent de choisir le niveau de
détails :
paquet
C’est le type par défaut utilisé dans l’exemple plus haut. Il montre le DAG des objets paquets, sans les dépendances implicites. C’est concis, mais omet pas mal de détails.
reverse-package
Cela montre le DAG inversé des paquets. Par exemple :
guix graph --type=reverse-package ocaml
... crée le graphe des paquets qui dépendent explicitement d’OCaml
(si vous êtes aussi intéressé·e dans le cas où OCaml représente une
dépendance implicite, voir reverse-bag
ci-dessous).
Remarquez que pour les paquets du cœur de la distribution, cela crée des
graphes énormes. Si vous voulez seulement voir le nombre de paquets qui
dépendent d’un paquet donnés, utilisez guix refresh
--list-dependent
(voir --list-dependent).
bag-emerged
C’est le DAG du paquet, avec les entrées implicites.
Par exemple, la commande suivante :
guix graph --type=bag-emerged coreutils
… montre ce graphe plus gros :
En bas du graphe, on voit toutes les entrées implicites de
gnu-build-system (voir gnu-build-system
).
Maintenant, remarquez que les dépendances de ces entrées implicites — c’est-à-dire les dépendances de bootstrap (voir Bootstrapping) — ne sont pas affichées, pour rester concis.
bag
Comme bag-emerged
mais cette fois inclus toutes les dépendances de
bootstrap.
bag-with-origins
Comme bag
, mais montre aussi les origines et leurs dépendances.
reverse-bag
Cela montre le DAG inverse des paquets. Contrairement à
reverse-package
, il montre aussi les dépendance implicites. Par
exemple :
guix graph -t reverse-bag dune
… crée le graphe des tous les paquets qui dépendent de Dune, directement
ou indirectement. Comme Dune est une dépendance implicite de
nombreux paquets via dune-build-system
, cela montre un plus grand
nombre de paquets, alors que reverse-package
en montrerait très peu,
voir aucun.
dérivation
C’est la représentation lu plus détaillée : elle montre le DAG des dérivations (voir Dérivations) et des éléments du dépôt. Comparé à la représentation ci-dessus, beaucoup plus de nœuds sont visibles, dont les scripts de construction, les correctifs, les modules Guile, etc.
Pour ce type de graphe, il est aussi possible de passer un nom de fichier .drv à la place d’un nom de paquet, comme dans :
guix graph -t derivation $(guix system build -d my-config.scm)
module
C’est le graphe des modules de paquets (voir Modules de paquets). Par
exemple, la commande suivante montre le graphe des modules de paquets qui
définissent le paquet guile
:
guix graph -t module guile | xdot -
Tous les types ci-dessus correspondent aux dépendances à la construction. Le type de graphe suivant représente les dépendances à l’exécution :
references
C’est le graphe des references d’une sortie d’un paquet, telles que
renvoyées par guix gc --references
(voir Invoquer guix gc
).
Si la sortie du paquet donnée n’est pas disponible dans le dépôt,
guix graph
essayera d’obtenir les informations sur les dépendances
à travers les substituts.
Vous pouvez aussi passer un nom de fichier du dépôt plutôt qu’un nom de paquet. Par exemple, la commande ci-dessous produit le graphe des références de votre profile (qui peut être gros !) :
guix graph -t references $(readlink -f ~/.guix-profile)
referrers
C’est le graphe des référents d’un élément du dépôt, tels que renvoyés
par guix gc --referrers
(voir Invoquer guix gc
).
Cela repose exclusivement sur les informations de votre dépôt. Par exemple,
supposons que Inkscape est actuellement disponible dans 10 profils sur votre
machine ; guix graph -t referrers inkscape
montrera le graphe dont
la racine est Inkscape avec 10 profils qui y sont liés.
Cela peut aider à déterminer ce qui empêche un élément du dépôt d’être glané.
Souvent, le graphe du paquet qui vous intéresse ne tient pas sur votre
écran, et de toute façon tout ce que vous voulez savoir c’est
pourquoi ce paquet dépend en fait d’un paquet apparemment sans
rapport. L’option --path indique à guix graph
d’afficher
le chemin le plus court entre deux paquets (ou dérivations, ou éléments du
dépôt, etc.) :
$ guix graph --path emacs libunistring emacs@26.3 mailutils@3.9 libunistring@0.9.10 $ guix graph --path -t derivation emacs libunistring /gnu/store/…-emacs-26.3.drv /gnu/store/…-mailutils-3.9.drv /gnu/store/…-libunistring-0.9.10.drv $ guix graph --path -t references emacs libunistring /gnu/store/…-emacs-26.3 /gnu/store/…-libidn2-2.2.0 /gnu/store/…-libunistring-0.9.10
Parfois vous voudrez quand même visualiser le graphe mais préférerez le
recouper afin qu’il puisse être affiché. Un moyen pour ce faire est l’option
--max-depth (ou -M), qui vous laisse spécifier la
profondeur maximale du graphe. Dans l’exemple ci-dessous, nous visualisons
seulement libreoffice
et les nœuds dont la distance à
libreoffice
est au plus 2 :
guix graph -M 2 libreoffice | xdot -f fdp -
Attention hein, c’est encore un sacré plat de spaghetti, mais au moins
dot
peut en faire un rendu rapide et il est possible de le
parcourir un peu.
Les options disponibles sont les suivantes :
Produit un graphe en sortie de type type où type doit être l’un des types au-dessus.
Liste les types de graphes supportés.
Produit un graphe avec le moteur choisi.
Liste les moteurs de graphes supportés.
Actuellement les moteurs disponibles sont Graphviz et d3.js.
Affiche le chemin le plus court entre deux nœuds du type spécifié par
--type. L’exemple ci-dessous montre le chemin le plus court entre
libreoffice
et llvm
correspondant aux références de
libreoffice
:
$ guix graph --path -t references libreoffice llvm /gnu/store/…-libreoffice-6.4.2.2 /gnu/store/…-libepoxy-1.5.4 /gnu/store/…-mesa-19.3.4 /gnu/store/…-llvm-9.0.1
Considérer le paquet évalué par expr.
C’est utile pour précisément se référer à un paquet, comme dans cet exemple :
guix graph -e '(@@ (gnu packages commencement) gnu-make-final)'
Affiche le graphe pour système — p. ex. i686-linux
.
Le graphe de dépendance des paquets est la plupart du temps indépendant de l’architecture, mais il y a quelques parties qui dépendent de l’architecture que cette option vous permet de visualiser.
Ajoute répertoire au début du chemin de recherche de module de paquets (voir Modules de paquets).
Cela permet à des utilisateurs de définir leur propres paquets et les rendre disponibles aux outils en ligne de commande.
En plus de cela, guix graph
prend en charge toutes les options
habituelles de transformation des paquets (voir Options de transformation de paquets). Il est ainsi facile de voir l’effet d’une transformation de
réécriture de graphe telle que --with-input. Par exemple, la
commande ci-dessous produit le graphe de git
une fois que
openssl
a été remplacé par libressl
partout dans le graphe :
guix graph git --with-input=openssl=libressl
Tant de possibilités, tant de plaisir !
Suivant: Invoquer guix challenge
, Précédent: Invoque guix graph
, Monter: Utilitaires [Table des matières][Index]
guix publish
Le but de guix publish
est de vous permettre de partager
facilement votre dépôt avec d’autres personnes qui peuvent ensuite
l’utiliser comme serveur de substituts (voir Substituts).
Lorsque guix publish
est lancé, il crée un serveur HTTP qui permet
à n’importe qui avec un accès réseau d’y récupérer des substituts. Cela
signifie que toutes les machines qui font tourner Guix peuvent aussi agir
comme une ferme de construction, puisque l’interface HTTP est compatible
avec Cuirass, le logiciel derrière la ferme de construction
bordeaux.guix.gnu.org
.
Pour des raisons de sécurité, chaque substitut est signé, ce qui permet aux
destinataires de vérifier leur authenticité et leur intégrité
(voir Substituts). Parce que guix publish
utilise la clé de
signature du système, qui n’est lisible que par l’administrateur système, il
doit être lancé en root ; l’option --user
lui fait abandonner les
privilèges de root dès le début.
La paire de clefs pour les signatures doit être générée avant de lancer
guix publish
, avec guix archive --generate-key
(voir Invoquer guix archive
).
Lorsque vous passez l’option --advertise, le serveur annonce sa disponibilité sur le réseau local en utilisant le DNS multicast (mDNS) et le protocole de découvert de service DNS (DNS-SD), actuellement via Guile-Avahi (voir Using Avahi in Guile Scheme Programs).
La syntaxe générale est :
guix publish options…
Lancer guix publish
sans arguments supplémentaires lancera un
serveur HTTP sur le port 8080 :
guix publish
guix publish
peut aussi être démarré avec le protocole d’«
activation par socket » de systemd (voir make-systemd-constructor
dans le manuel de GNU Shepherd).
Une fois qu’un serveur de publication a été autorisé, le démon peut télécharger des substituts à partir de lui. Voir Récupérer des substituts d’autres serveurs.
Par défaut, guix publish
compresse les archives à la volée quand
il les sert. Ce mode « à la volée » est pratique puisqu’il ne demande
aucune configuration et est disponible immédiatement. Cependant, lorsqu’il
s’agit de servir beaucoup de clients, nous recommandons d’utiliser l’option
--cache, qui active le cache des archives avant de les envoyer aux
clients — voir les détails plus bas. La commande guix weather
fournit un manière pratique de vérifier ce qu’un serveur fournit
(voir Invoquer guix weather
).
En bonus, guix publish
sert aussi un miroir adressé par le contenu
des fichiers source référencées dans les enregistrements origin
(voir Référence de origin
). Par exemple, en supposant que guix
publish
tourne sur example.org
, l’URL suivante renverra le fichier
brut hello-2.10.tar.gz avec le hash SHA256 donné (représenté sous le
format nix-base32
, voir Invoquer guix hash
) :
http://example.org/file/hello-2.10.tar.gz/sha256/0ssi1…ndq1i
Évidemment, ces URL ne fonctionnent que pour des fichiers dans le dépôt ; dans les autres cas, elles renvoie une erreur 404 (« Introuvable »).
Les journaux de construction sont disponibles à partir des URL /log
comme ceci :
http://example.org/log/gwspk…-guile-2.2.3
Lorsque guix-daemon
est configuré pour sauvegarder les journaux de
construction compressés, comme c’est le cas par défaut (voir Invoquer guix-daemon
), les URL /log
renvoient le journal compressé tel-quel,
avec une en-tête Content-Type
et/ou Content-Encoding
appropriée. Nous recommandons de lancer guix-daemon
avec
--log-compression=gzip parce que les navigateurs web les
décompressent automatiquement, ce qui n’est pas le cas avec la compression
bzip2.
Les options suivantes sont disponibles :
--port=port
-p port
Écoute les requêtes HTTP sur le port.
--listen=hôte
Écoute sur l’interface réseau de hôte. Par défaut, la commande accepte les connexions de n’importe quelle interface.
--user=utilisateur
-u utilisateur
Charge les privilèges de utilisateur le plus vite possible — c.-à-d. une fois que la socket du serveur est ouverte et que la clef de signature a été lue.
--compression[=méthode[:niveau]]
-C [méthode[:niveau]]
Compresser les données en utilisant les method et level donnés.
method est l’un des codes lzip
, zstd
ou gzip
;
lorsque method est omis, gzip
est utilisé.
Lorsque level est égal à zéro, désactivez la compression. La plage de 1 à 9 correspond à différents niveaux de compression : 1 est le plus rapide, et 9 est le meilleur (gourmand en CPU). Le niveau par défaut est 3.
Habituellement, lzip
compresse notablement mieux que gzip
pour
une légère augmentation de l’utilisation du CPU. voir
benchmarks on the lzip Web
page. Cependant, lzip
permet un faible débit à la décompression (de
l’ordre de 50 Mio/s sur du matériel récent), ce qui peut être le
facteur limitant pour quelqu’un qui télécharge sur un réseau rapide.
Le ratio de compression de zstd
est entre celui de lzip
et
celui de gzip
; son avantage principal est sa
high vitesse de décompression.
À moins que --cache ne soit utilisé, la compression se fait à la
volée et les flux compressés ne sont pas cachés. Ainsi, pour réduire la
charge sur la machine qui fait tourner guix publish
, c’est une
bonne idée de choisir un niveau de compression faible, de lancer
guix publish
derrière un serveur de cache ou d’utiliser
--cache. Utilise --cache a l’avantage qu’il permet à
guix publish
d’ajouter l’en-tête HTTP Content-Length
à sa
réponse.
Cette option peut être répétée, auquel cas chaque substitut est compressé en utilisant toutes les méthodes sélectionnées, et toutes sont annoncées. Cette option est utile lorsque les utilisateur·rice·s ne supportent pas toutes les méthodes de compression : il·elle·s peuvent sélectionner celle qu’elles supportent.
--cache=répertoire
-c répertoire
Cache les archives et les métadonnées (les URL .narinfo
) dans
répertoire et ne sert que les archives dans ce cache.
Lorsque cette option est omise, les archives et les métadonnées sont crées à
la volée. Cela réduit la bande passante disponible, surtout quand la
compression est activée puisqu’elle pourrait être limitée par le CPU. Un
autre inconvénient au mode par défaut est que la taille des archives n’est
pas connue à l’avance, donc guix publish
n’ajoute pas l’en-tête
Content-Length
à ses réponses, ce qui empêche les clients de savoir
la quantité de données à télécharger.
À l’inverse, lorsque --cache est utilisée, la première requête pour
un élément du dépôt (via une URL .narinfo
) déclenche une tâche de
fond pour créer l’archive — en calculant son .narinfo
et en
compressant l’archive au besoin. Une fois l’archive en cache dans
répertoire, les requêtes suivantes réussissent et sont servies
directement depuis le cache, ce qui garanti que les clients ont la meilleure
bande passante possible.
Cette première requête .narinfo
renvoie quand même 200, si l’élément
du dépôt est « assez petit », sous la limite de contournement du cache —
voir --cache-bypass-threshold plus bas. De cette manière, les
clients n’ont pas besoin d’attendre que l’archive soit prête. Pour les
éléments plus gros, la première requête .narinfo
renvoie 404, ce qui
signifie que les clients doivent attendre jusqu’à ce que l’archive soit
prête.
Le processus de création est effectué par des threads de travail. Par défaut, un thread par cœur du CPU est créé, mais cela peut être personnalisé. Voir --workers plus bas.
Lorsque l’option --ttl est utilisée, les entrées cachées sont automatiquement supprimées lorsqu’elles expirent.
--workers=N
Lorsque --cache est utilisée, demande l’allocation de N thread de travail pour créer les archives.
--ttl=ttl
Produit des en-têtes HTTP Cache-Control
qui annoncent une durée de
vie (TTL) de ttl. ttl peut dénoter une durée : 5d
signifie 5 jours, 1m
signifie un mois, etc.
Cela permet au Guix de l’utilisateur de garder les informations en cache
pendant ttl. Cependant, remarquez que guix publish
ne garanti
pas lui-même que les éléments du dépôt qu’il fournit seront toujours
disponible pendant la durée ttl.
En plus, lorsque --cache est utilisée, les entrées cachées qui n’ont pas été demandé depuis ttl et n’ont pas d’élément correspondant dans le dépôt peuvent être supprimées.
--negative-ttl=ttl
Produit de la même manière des en-têtes HTTP Cache-Control
pour
annoncer la durée de vie (TLL) d’une recherche négative — des entrées
du dépôt manquantes, pour lesquelles une erreur 404 est renvoyée. Par
défaut, aucun TTL négatif n’est annoncé.
Ce paramètre peut aider à ajuster la charge du serveur et la latence des substituts en demandant aux clients coopératifs d’être plus ou moins patients quand un élément du dépôt manque.
--cache-bypass-threshold=taille
Avec --cache, les éléments du dépôt plus petits que taille
sont immédiatement disponibles, même s’ils ne sont pas en cache.
taille est une taille en octets, ou peut utiliser un suffixe comme
M
pour les mégaoctets, etc. La valeur par défaut est 10M
.
Le « contournement du cache » vous permet de réduire le délai de publication pour les clients au prix d’utilisation accrue des I/O et du CPU sur le serveur : en fonction des accès clients, ces éléments peuvent être créés plusieurs fois avant qu’une copie ne soit disponible dans le cache.
Augmenter la limite peut être utile pour les sites qui ont peu d’utilisateurs, ou pour garantir que les utilisateurs reçoivent les substituts même pour les éléments qui ne sont pas populaires.
--nar-path=chemin
Utilise chemin comme préfixe des URL de fichier « nar » (voir normalized archives).
Par défaut, les nars sont présents à l’URL comme
/nar/gzip/…-coreutils-8.25
. Cette option vous permet de
changer la partie /nar
en chemin.
--public-key=fichier
--private-key=fichier
Utilise les fichiers spécifiques comme pair de clefs utilisées pour signer les éléments avant de les publier.
Les fichiers doivent correspondre à la même pair de clefs (la clef privée
est utilisée pour signer et la clef publique est seulement ajouté aux
métadonnées de la signature). Ils doivent contenir les clefs dans le format
s-expression canonique produit par guix archive --generate-key
(voir Invoquer guix archive
). Par défaut,
/etc/guix/signing-key.pub et /etc/guix/signing-key.sec sont
utilisés.
--repl[=port]
-r [port]
Crée un serveur REPL Guile (voir REPL Servers dans GNU Guile
Reference Manual) sur pport (37146 par défaut). C’est surtout utile
pour déboguer un serveur guix publish
qui tourne.
Activer guix publish
sur un système Guix est vraiment une seule
ligne : instanciez simplement un service guix-publish-service-type
dans le champs services
de votre déclaration operating-system
(voir guix-publish-service-type
).
Si vous utilisez plutôt Guix sur une « distro étrangère », suivez ces instructions :
# ln -s ~root/.guix-profile/lib/systemd/system/guix-publish.service \ /etc/systemd/system/ # systemctl start guix-publish && systemctl enable guix-publish
# ln -s ~root/.guix-profile/lib/upstart/system/guix-publish.conf /etc/init/ # start guix-publish
Suivant: Invoquer guix copy
, Précédent: Invoquer guix publish
, Monter: Utilitaires [Table des matières][Index]
guix challenge
Est-ce que les binaires fournis par ce serveur correspondent réellement au
code source qu’il dit avoir construit ? Est-ce que le processus de
construction d’un paquet est déterministe ? Ce sont les question auxquelles
la commande guix challenge
essaye de répondre.
La première question est évidemment importante : avant d’utiliser un serveur de substituts (voir Substituts), il vaut mieux vérifier qu’il fournit les bons binaires et donc le défier. La deuxième est ce qui permet la première : si les constructions des paquets sont déterministes alors des constructions indépendantes du paquet devraient donner le même résultat, bit à bit ; si un serveur fournit un binaire différent de celui obtenu localement, il peut être soit corrompu, soit malveillant.
On sait que le hash qui apparaît dans /gnu/store est le hash de
toutes les entrées du processus qui construit le fichier ou le répertoire —
les compilateurs, les bibliothèques, les scripts de construction,
etc. (voir Introduction). En supposant que les processus de construction
sont déterministes, un nom de fichier dans le dépôt devrait correspondre
exactement à une sortie de construction. guix challenge
vérifie
si il y a bien effectivement une seule correspondance en comparant les
sorties de plusieurs constructions indépendantes d’un élément du dépôt
donné.
La sortie de la commande ressemble à :
$ guix challenge \ --substitute-urls="https://bordeaux.guix.gnu.org https://guix.example.org" \ openssl git pius coreutils grep mise à jour des substituts depuis 'https://bordeaux.guix.gnu.org'... 100.0% mise à jour des substituts depuis 'https://guix.example.org'... 100.0% le contenu de /gnu/store/…-openssl-1.0.2d diffère : empreinte locale : 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q https://bordeaux.guix.gnu.org/nar/…-openssl-1.0.2d : 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q https://guix.example.org/nar/…-openssl-1.0.2d : 1zy4fmaaqcnjrzzajkdn3f5gmjk754b43qkq47llbyak9z0qjyim fichiers différents : /lib/libcrypto.so.1.1 /lib/libssl.so.1.1 le contenu de /gnu/store/…-git-2.5.0 diffère : empreinte locale : 00p3bmryhjxrhpn2gxs2fy0a15lnip05l97205pgbk5ra395hyha https://bordeaux.guix.gnu.org/nar/…-git-2.5.0 : 069nb85bv4d4a6slrwjdy8v1cn4cwspm3kdbmyb81d6zckj3nq9f https://guix.example.org/nar/…-git-2.5.0 : 0mdqa9w1p6cmli6976v4wi0sw9r4p5prkj7lzfd1877wk11c9c73 fichier différent : /libexec/git-core/git-fsck le contenu de /gnu/store/…-pius-2.1.1 diffère : empreinte locale : 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax https://bordeaux.guix.gnu.org/nar/…-pius-2.1.1 : 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax https://guix.example.org/nar/…-pius-2.1.1 : 1cy25x1a4fzq5rk0pmvc8xhwyffnqz95h2bpvqsz2mpvlbccy0gs fichier différent: /share/man/man1/pius.1.gz … 5 éléments du dépôt ont été analysés : - 2 (40.0%) étaient identiques - 3 (60.0%) étaient différents - 0 (0.0%) étaient impossibles à évaluer
Dans cet exemple, guix challenge
demande à tous les serveurs de
substituts les cinq paquets spécifiés sur la ligne de commande. Il rapporte
ensuite les éléments du dépôt pour lesquels les serveurs obtiennent un
résultat différent de la construction locale (si elle existe) ou différent
entre eux ; ici, les lignes ‘empreinte locale’ indiquent que le
résultat d’une construction locale était disponible pour chacun des paquets
et montre son empreinte.
Dans l’exemple, guix.example.org
obtient toujours une réponse
différente. Inversement, bordeaux.guix.gnu.org
est d’accord
avec les constructions locale, sauf dans le cas de Git. Cela peut indiquer
que le processus de construction de Git est non-déterministe, ce qui
signifie que sa sortie diffère en fonction de divers choses que Guix ne
contrôle pas parfaitement, malgré l’isolation des constructions
(voir Fonctionnalités). Les sources les plus communes de non-déterminisme
comprennent l’ajout d’horodatage dans les résultats des constructions,
l’inclusion de nombres aléatoires et des listes de fichiers ordonnés par
numéro d’inœud. Voir https://reproducible-builds.org/docs/, pour
plus d’informations.
Pour trouver ce qui ne va pas avec ce binaire Git, l’approche la plus facile est de lancer :
guix challenge git \ --diff=diffoscope \ --substitute-urls="https://bordeaux.guix.gnu.org https://guix.example.org"
Cela invoque automatiquement diffoscope
, qui affiche des
informations détaillées sur les fichiers qui diffèrent.
Autrement, nous pouvons faire quelque chose comme dans ces lignes
(voir Invoquer guix archive
) :
$ wget -q -O - https://bordeaux.guix.gnu.org/nar/lzip/…-git-2.5.0 \ | lzip -d | guix archive -x /tmp/git $ diff -ur --no-dereference /gnu/store/…-git.2.5.0 /tmp/git
Cette commande montre les différences entre les fichiers qui résultent de la
construction locale et des fichiers qui résultent de la construction sur
bordeaux.guix.gnu.org
(voir Comparing and Merging
Files dans Comparing and Merging Files). La commande
diff
fonctionne bien avec des fichiers texte. Lorsque des
fichiers binaires diffèrent cependant, Diffoscope est une meilleure option. C’est un outil qui aide à visualiser
les différences entre toute sorte de fichiers.
Une fois que vous avez fait ce travail, vous pourrez dire si les différences
sont dues au non-déterminisme du processus de construction ou à la
malhonnêteté du serveur. Nous avons fait beaucoup d’effort pour éliminer
les sources de non-déterminisme dans les paquets pour rendre plus facile la
vérification des substituts, mais bien sûr, c’est un processus qui
n’implique pas que Guix, mais une grande partie de la communauté des
logiciels libres. Pendant ce temps, guix challenge
est un outil
pour aider à corriger le problème.
Si vous écrivez un paquet pour Guix, nous vous encourageons à vérifier si
bordeaux.guix.gnu.org
et d’autres serveurs de substituts
obtiennent le même résultat que vous avec :
guix challenge paquet
La syntaxe générale est :
guix challenge options argument…
où argument est une spécification de paquet comme guile@2.0
ou
glibc:debug
ou, autrement, un nom de fichier du dépôt renvoyé, par
exemple, par guix build
ou guix gc --list-live
.
Lorsqu’une différence est trouvée entre l’empreinte d’un élément construit localement et celle d’un substitut fourni par un serveur, ou parmi les substituts fournis par différents serveurs, la commande l’affiche comme dans l’exemple ci-dessus et sa valeur de sortie est 2 (les autres valeurs différentes de 0 indiquent d’autres sortes d’erreurs).
L’option qui compte est :
--substitute-urls=urls
Considère urls comme la liste des URL des sources de substituts séparés par des espaces avec lesquels comparer les paquets locaux.
--diff=mode
En cas d’inadéquation, montre les différences en fonction de mode, l’un des :
simple
(par défaut)Montrer la liste des fichiers qui diffèrent.
diffoscope
Invoque Diffoscope, en lui passant deux répertoires dont le contenu ne correspond pas.
Quand command est un nom de fichier absolu, lancez command au lieu de Diffoscope.
none
Ne donnez pas plus de détails sur les différences.
Ainsi, à moins que l’option --diff=none ne soit passée,
guix challenge
télécharge les éléments du store à partir des
serveurs de substitut donnés afin de pouvoir les comparer.
--verbose
-v
Montre des détails sur les correspondances (contenu identique) en plus des informations sur différences.
Suivant: Invoquer guix container
, Précédent: Invoquer guix challenge
, Monter: Utilitaires [Table des matières][Index]
guix copy
La commande guix copy
copie des éléments du dépôt d’une machine
vers le dépôt d’une autre machine à travers une connexion SSH27. Par exemple, la commande suivante copie le paquet
coreutils
, le profil utilisateur et toutes leurs dépendances sur
hôte, en tant qu’utilisateur utilisateur :
guix copy --to=utilisateur@hôte \ coreutils $(readlink -f ~/.guix-profile)
Si certains éléments à copier sont déjà présents sur hôte, ils ne sont pas envoyés.
La commande ci-dessous récupère libreoffice
et gimp
depuis
hôte, en supposant qu’ils y sont présents :
guix copy --from=hôte libreoffice gimp
La connexion SSH est établie avec le client Guile-SSH, qui set compatible avec OpenSSH : il prend en compte ~/.ssh/known_hosts et ~/.ssh/config et utilise l’agent SSH pour l’authentification.
La clef utilisée pour signer les éléments qui sont envoyés doit être
acceptée par la machine distante. De même, la clef utilisée pour la machine
distante depuis laquelle vous récupérez des éléments doit être dans
/etc/guix/acl pour qu’ils soient acceptés par votre propre démon.
Voir Invoquer guix archive
, pour plus d’informations sur
l’authentification des éléments du dépôt.
La syntaxe générale est :
guix copy [--to=spec|--from=spec] items…
Vous devez toujours spécifier l’une des options suivantes :
--to=spec
--from=spec
Spécifie l’hôte où envoyer ou d’où recevoir les éléments. spec doit
être une spécification SSH comme example.org
,
charlie@example.org
ou charlie@example.org:2222
.
L’option items peut être des noms de paquets, comme gimp
ou des
éléments du dépôt comme /gnu/store/…-idutils-4.6.
Lorsque vous spécifiez le nom d’un paquet à envoyer, il est d’abord construit au besoin, sauf si l’option --dry-run est spécifiée. Les options de construction communes sont supportées (voir Options de construction communes).
Suivant: Invoquer guix weather
, Précédent: Invoquer guix copy
, Monter: Utilitaires [Table des matières][Index]
guix container
Remarque : À la version b2bd56f, cet outil est toujours expérimental. L’interface est sujette à changement radicaux dans le futur.
Le but de guix container
est de manipuler des processus qui
tournent dans un environnement séparé, connus sous le nom de « conteneur »,
typiquement créés par les commandes guix shell
(voir Invoquer guix shell
) et guix system container
(voir Invoquer guix system
).
La syntaxe générale est :
guix container action options…
action spécifie les opérations à effectuer avec un conteneur, et options spécifie les arguments spécifiques au contexte pour l’action.
Les actions suivantes sont disponibles :
exec
Exécute une commande dans le contexte d’un conteneur lancé.
La syntaxe est :
guix container exec pid programme arguments…
pid spécifie le PID du conteneur lancé. programme spécifie le nom du fichier exécutable dans le système de fichiers racine du conteneur. arguments sont les options supplémentaires à passer à programme.
La commande suivante lance un shell de connexion interactif dans un
conteneur Guix System, démarré par guix system container
et dont
le PID est 9001 :
guix container exec 9001 /run/current-system/profile/bin/bash --login
Remarquez que pid ne peut pas être le processus parent d’un conteneur. Ce doit être le PID 1 du conteneur ou l’un de ses processus fils.
Suivant: Invoquer guix processes
, Précédent: Invoquer guix container
, Monter: Utilitaires [Table des matières][Index]
guix weather
Occasionally you’re grumpy because substitutes are lacking and you end up
building packages by yourself (voir Substituts). The guix
weather
command reports on substitute availability on the specified servers
so you can have an idea of whether you’ll be grumpy today. It can sometimes
be useful info as a user, but it is primarily useful to people running
guix publish
(voir Invoquer guix publish
). Sometimes
substitutes are available but they are not authorized on your system;
guix weather
reports it so you can authorize them if you want
(voir Récupérer des substituts d’autres serveurs).
Voici un exemple :
$ guix weather --substitute-urls=https://guix.example.org calcul de 5,872 dérivations de paquets pour x86_64-linux… recherche de 6,128 éléments du dépôt sur https://guix.example.org… mise à jour des substituts depuis 'https://guix.example.org'... 100.0% https://guix.example.org 43.4% substituts disponibles (2,658 sur 6,128) 7,032.5 Mo de fichiers nar (compressés) 19,824.2 Mo sur le disque (décompressés) 0.030 secondes par requêtes (182.9 secondes au total) 33.5 requêtes par seconde 9.8% (342 sur 3,470) des éléments manquants sont dans la queue 867 constructions dans la queue x86_64-linux : 518 (59.7%) i686-linux : 221 (25.5%) aarch64-linux : 128 (14.8%) vitesse de construction : 23.41 constructions par heure x86_64-linux : 11.16 constructions par heure i686-linux : 6.03 constructions par heure aarch64-linux : 6.41 constructions par heure
Comme vous pouvez le voir, elle rapporte le pourcentage des paquets pour
lesquels des substituts sont disponibles sur le serveur — indépendamment du
fait que les substituts soient activés, et indépendamment du fait que la
clef de signature du serveur soit autorisée. Elle rapporte aussi la taille
des archives compressées (« nars ») fournies par le serveur, la taille des
éléments du dépôt correspondant dans le dépôt (en supposant que la
déduplication soit désactivée) et la vitesse du serveur. La deuxième partie
donne des statistiques sur l’intégration continue (CI), si le serveur le
supporte. En plus, avec l’option --coverage, guix
weather
peut lister les substituts de paquets « importants » qui font
défaut sur le serveur (voir plus bas).
Pour cela, guix weather
récupère par HTTP(S) les métadonnées
(narinfos de tous les éléments du dépôts pertinents. Comme
guix challenge
, il ignore les signatures de ces substituts, ce qui
n’est pas dangereux puisque la commande ne fait que récupérer des
statistiques et n’installe pas ces substituts.
La syntaxe générale est :
guix weather options… [paquets…]
Lorsque packages est omis, guix weather
vérifie la
disponibilité de substituts pour all les paquets, ou pour ceux
spécifiés avec --manifest ; sinon, il ne prend en compte que les
paquets spécifiés. Il est également possible d’interroger des types de
systèmes spécifiques avec --system. guix weather
sort
avec un code non nul lorsque la fraction des substituts disponibles est
inférieure à 100%.
Les options disponibles sont listées ci-dessous.
--substitute-urls=urls
urls is the space-separated list of substitute server URLs to query.
When this option is omitted, the URLs specified with the
--substitute-urls option of guix-daemon
are used or, as a
last resort, the default set of substitute URLs.
--system=système
-s système
Effectue des requêtes pour les substituts système — p. ex.
aarch64-linux
. Cette option peut être répétée, auquel cas
guix weather
demandera les substituts de plusieurs types de
systèmes.
--manifest=fichier
Plutôt que de demander des substituts pour tous les paquets, demande
uniquement les paquets spécifiés dans fichier. fichier doit
contenir un manifeste comme avec l’option -m
de guix
package
(voir Invoquer guix package
).
Cette option peut être répétée plusieurs fois, auquel cas les manifestes sont concaténés.
--expression=expr
-e expr
Considérer le paquet évalué par expr.
A typical use case for this option is specifying a package that is hidden and thus cannot be referred to in the usual way, as in this example:
guix weather -e '(@@ (gnu packages rust) rust-bootstrap)'
This option can be repeated.
--coverage[=count]
-c [count]
Rapporte la couverture des substituts pour les paquets : liste les paquets avec au moins count autres paquets qui en dépendent (zéro par défaut) pour lesquels il n’y a pas de substitut. Les paquets qui en dépendent ne sont pas listés : si b dépend de a et que a n’a pas de substitut, seul a est listé, même si b n’a habituellement pas de substitut non plus. Le résultat ressemble à cela :
$ guix weather --substitute-urls=https://bordeaux.guix.gnu.org https://ci.guix.gnu.org -c 10 calcul de 8 983 dérivations de paquets pour x86_64-linux… recherche de 9 343 éléments du dépôt sur https://bordeaux.guix.gnu.org https://ci.guix.gnu.org… mise à jour des substituts depuis « https://bordeaux.guix.gnu.org https://ci.guix.gnu.org »… 100,0 % https://bordeaux.guix.gnu.org https://ci.guix.gnu.org 64.7 % des substituts sont disponibles (6,047 sur 9,343) … 2502 paquets ne sont pas sur « https://bordeaux.guix.gnu.org https://ci.guix.gnu.org » pour « x86_64-linux », parmi lesquels : 58 kcoreaddons@5.49.0 /gnu/store/…-kcoreaddons-5.49.0 46 qgpgme@1.11.1 /gnu/store/…-qgpgme-1.11.1 37 perl-http-cookiejar@0.008 /gnu/store/…-perl-http-cookiejar-0.008 …
Ce que montre cet exemple est que kcoreaddons
et probablement les 58
paquets qui en dépendent n’ont pas de substituts sur
bordeaux.guix.gnu.org
; de même pour qgpgme
et les 46
paquets qui en dépendent.
Si vous êtes un développeur de Guix, ou si vous prenez soin de cette ferme de construction, vous voudrez sans doute inspecter plus finement ces paquets : ils peuvent simplement avoir échoué à la construction.
--display-missing
Afficher la liste des articles du magasin pour lesquels il manque des substituts.
Précédent: Invoquer guix weather
, Monter: Utilitaires [Table des matières][Index]
guix processes
La commande guix processes
peut être utile pour les
développeur·euses ou les personnes qui administrent des systèmes, surtout
sur des machines multi-utilisateur·rice et sur les fermes de construction :
elle liste les sessions actuelles (les connexions au démon), ainsi que des
informations sur les processus en question28. Voici un
exemple des informations qu’elle renvoie :
$ sudo guix processes SessionPID: 19002 ClientPID: 19090 ClientCommand: guix shell python SessionPID: 19402 ClientPID: 19367 ClientCommand: guix publish -u guix-publish -p 3000 -C 9 … SessionPID: 19444 ClientPID: 19419 ClientCommand: cuirass --cache-directory /var/cache/cuirass … LockHeld: /gnu/store/…-perl-ipc-cmd-0.96.lock LockHeld: /gnu/store/…-python-six-bootstrap-1.11.0.lock LockHeld: /gnu/store/…-libjpeg-turbo-2.0.0.lock ChildPID: 20495 ChildCommand: guix offload x86_64-linux 7200 1 28800 ChildPID: 27733 ChildCommand: guix offload x86_64-linux 7200 1 28800 ChildPID: 27793 ChildCommand: guix offload x86_64-linux 7200 1 28800
Dans cet exemple, on voit que guix-daemon
a trois clients
directs : guix shell
, guix publish
et l’outil
d’intégration continue Cuirass ; leur identifiant de processus (PID) est
donné par le champ ClientPID
. Le champ SessionPID
fournit le
PID du sous-processus guix-daemon
de cette session particulière.
Le champs LockHeld
montre quels éléments du dépôt sont actuellement
verrouillés par cette session, ce qui correspond aux éléments du dépôt qui
sont en train d’être construits ou d’être substitués (le champ
LockHeld
n’est pas montré si guix processes
n’est pas lancé
en root). Enfin, en regardant les champs ChildPID
et
ChildCommand
, on comprend que ces trois constructions sont déchargées
(voir Utiliser le dispositif de déchargement).
La sortie est dans le format Recutils pour qu’on puisse utiliser la commande
recsel
pour sélectionner les sessions qui nous intéressent
(voir Selection Expressions dans GNU recutils manual). Par
exemple, la commande montre la ligne de commande et le PID du client qui
effectue la construction d’un paquet Perl :
$ sudo guix processes | \ recsel -p ClientPID,ClientCommand -e 'LockHeld ~ "perl"' ClientPID: 19419 ClientCommand: cuirass --cache-directory /var/cache/cuirass …
Des options supplémentaires sont listées ci-dessous.
--format=format
-f format
Produire la sortie dans le format donné, parmi :
recutils
L’option par défaut. Elle affiche un ensemble d’enregistrement Session
recutils qui incluent chacun ChildProcess
comme champ.
normalized
Normalise les enregistrements de sortie en ensembles d’enregistrement
(voir Record Sets dans GNU recutils manual). La normalisation en
ensembles d’enregistrement permet de faire des jointures entre plusieurs
types d’enregistrement. L’exemple ci-dessous liste le PID de chaque
ChildProcess
et le PID associé pour Session
qui lance
ChildProcess
où la Session
a été démarrée avec guix
build
.
$ guix processes --format=normalized | \ recsel \ -j Session \ -t ChildProcess \ -p Session.PID,PID \ -e 'Session.ClientCommand ~ "guix build"' PID: 4435 Session_PID: 4278 PID: 4554 Session_PID: 4278 PID: 4646 Session_PID: 4278
Suivant: Configuration du système, Précédent: Utilitaires, Monter: GNU Guix [Table des matières][Index]
vous pouvez cibler des ordinateurs d’architectures CPU différentes lors de
la production de paquets (voir Invoquer guix package
), de lots applicatif
(voir Invoquer guix pack
) ou de systèmes complets (voir Invoquer guix system
).
GNU Guix prend en charge deux mécanismes distincts pour cibles des architectures externes :
Suivant: Constructions natives, Monter: Architectures externes [Table des matières][Index]
Les commandes qui prennent en charge la compilation croisée proposent les options --list-target et --target.
L’option --list-targets liste toutes les cibles prises en charge qui peuvent être passées en argument à --target.
$ guix build --list-targets Les cibles disponibles sont : - aarch64-linux-gnu - arm-linux-gnueabihf - avr - i586-pc-gnu - i686-linux-gnu - i686-w64-mingw32 - mips64el-linux-gnu - or1k-elf - powerpc-linux-gnu - powerpc64le-linux-gnu - riscv64-linux-gnu - x86_64-linux-gnu - x86_64-linux-gnux32 - x86_64-w64-mingw32 - xtensa-ath9k-elf
Les cibles sont spécifiées comme des triplets GNU (voir GNU configuration triplets dans Autoconf).
Ces triplets sont passés à GCC et aux autres compilateurs sous-jacent éventuellement impliqués dans la construction d’un paquet, d’une image système et de toute autre sortie de GNU Guix.
$ guix build --target=aarch64-linux-gnu hello /gnu/store/9926by9qrxa91ijkhw9ndgwp4bn24g9h-hello-2.12 $ file /gnu/store/9926by9qrxa91ijkhw9ndgwp4bn24g9h-hello-2.12/bin/hello /gnu/store/9926by9qrxa91ijkhw9ndgwp4bn24g9h-hello-2.12/bin/hello: ELF 64-bit LSB executable, ARM aarch64 …
Le principal avantage de la compilation croisée est qu’il n’y a pas de ralentissement par rapport à l’émulation avec QEMU. Il y a cependant de plus grands risque que certains paquets échouent à compiler de manière croisée car seuls quelques utilisateurs et utilisatrices utilisent ce mécanisme de manière intensive.
Précédent: Compilation croisée, Monter: Architectures externes [Table des matières][Index]
Les commandes qui prennent en charge l’imitation d’un système spécifique proposent les options --list-systems et --system.
L’option --list-systems liste tous les systèmes pris en charge qui peuvent être passés en argument à --system.
$ guix build --list-systems Les systèmes disponibles sont : - x86_64-linux [current] - aarch64-linux - armhf-linux - i586-gnu - i686-linux - mips64el-linux - powerpc-linux - powerpc64le-linux - riscv64-linux $ guix build --system=i686-linux hello /gnu/store/cc0km35s8x2z4pmwkrqqjx46i8b1i3gm-hello-2.12 $ file /gnu/store/cc0km35s8x2z4pmwkrqqjx46i8b1i3gm-hello-2.12/bin/hello /gnu/store/cc0km35s8x2z4pmwkrqqjx46i8b1i3gm-hello-2.12/bin/hello: ELF 32-bit LSB executable, Intel 80386 …
Dans l’exemple ci-dessus, le système actuel est x86_64-linux. Le paquet hello est cependant construit pour le système i686-linux.
C’est possible parce que le jeu d’instruction CPU i686 est un sous-ensemble de x86_64, d’où le fait que les binaires ciblant i686 puissent tourner sur x86_64.
Toujours dans le contexte de l’exemple précédent, si on choisit le système
aarch64-linux que la commande guix build
--system=aarch64-linux hello
doit construire des dérivations, une étape
supplémentaire est nécessaire.
Les binaires qui cibles aarch64-linux ne peuvent pas tourner directement sur un système x86_64-linux. Une couche d’émulation est requise. Le démon GNU Guix peut utiliser le mécanisme binfmt_misc du noyau Linux pour cela. En résumé, le noyau Linux peut laisser l’exécution d’un binaire qui cible une plateforme externe, ici aarch64-linux à un programme en espace utilisateur, typiquement un émulateur.
Il existe un service qui configure QEMU en tant que moteur pour le mécanisme
binfnmt_misc
(voir qemu-binfmt-service-type
). Sur les distributions externes basées sur
Debian, l’alternative consiste à installer le paquet
qemu-user-static
.
Si le mécanisme binfmt_misc
n’est pas correctement mis en place, la
construction échouera de cette façon :
$ guix build --system=armhf-linux hello --check … unsupported-platform /gnu/store/jjn969pijv7hff62025yxpfmc8zy0aq0-hello-2.12.drv aarch64-linux while setting up the build environment: a `aarch64-linux' is required to build `/gnu/store/jjn969pijv7hff62025yxpfmc8zy0aq0-hello-2.12.drv', but I am a `x86_64-linux'…
alors que, avec le mécanisme binfmt_misc
correctement lié à QEMU, on
peut s’attendre à voir :
$ guix build --system=armhf-linux hello --check /gnu/store/13xz4nghg39wpymivlwghy08yzj97hlj-hello-2.12
Le principal avantage de la construction native par rapport à la compilation croisée est que plus de paquets seront susceptibles de se construire correctement. Cependant cela a un prix : la compilation prise en charge par QEMU est bien plus lente que la compilation croisée, car chaque instruction doit être émulée.
La disponibilité des substituts pour l’architecture ciblée par l’option
--system
peut atténuer ce problème. Une autre manière de le
contourner est d’installer GNU Guix sur une machine dont le CPU prend en
charge le jeu d’instruction cible, et de la configurer en tant que machine
de déchargement (voir Utiliser le dispositif de déchargement).
Suivant: Corriger les problèmes du système, Précédent: Architectures externes, Monter: GNU Guix [Table des matières][Index]
Guix System utilise un mécanisme de configuration du système cohérent. On veut dire par là que tous les aspects de la configuration globale du système — comme la disponibilité des services système, la configuration des fuseaux horaires, des paramètres linguistiques et des comptes utilisateurs — sont déclarés à un seul endroit. Une telle configuration système peut être instanciée, c’est-à-dire entrer en vigueur.
L’un des avantages de placer toute la configuration du système sous le contrôle de Guix est de permettre les mises à jour transactionnelles du système ce qui rend possible le fait de revenir en arrière à une instanciation précédent du système, si quelque chose se passait mal avec le nouveau (voir Fonctionnalités). Un autre avantage est de rendre facile la réplication de la même configuration sur plusieurs machines différentes ou à différents moments dans le temps, sans avoir à recourir à des outils d’administrations supplémentaires au-dessus des outils du système.
Cette section décrit ce mécanisme. Tout d’abord nous nous concentrons sur le point de vue de l’administrateur système en expliquant comment le système est configuré et instancié. Ensuite nous montrons comment ce mécanisme peut être étendu, par exemple pour supporter de nouveaux services systèmes.
operating-system
guix system
guix deploy
Suivant: Utiliser le système de configuration, Monter: Configuration du système [Table des matières][Index]
You’re reading this section probably because you have just installed Guix
System (voir Installation du système) and would like to know where to go from
here. If you’re already familiar with GNU/Linux system administration, the
way Guix System is configured is very different from what you’re used to:
you won’t install a system service by running guix install
, you
won’t configure services by modifying files under /etc, and you won’t
create user accounts by invoking useradd
; instead, all these
aspects are spelled out in a system configuration file.
The first step with Guix System is thus to write the system configuration file; luckily, system installation already generated one for you and stored it under /etc/config.scm.
Remarque : You can store your system configuration file anywhere you like—it doesn’t have to be at /etc/config.scm. It’s a good idea to keep it under version control, for instance in a Git repository.
The entire configuration of the system—user accounts, system services, timezone, locale settings—is declared in this file, which follows this template:
(use-modules (gnu)) (use-package-modules …) (use-service-modules …) (operating-system (host-name …) (timezone …) (locale …) (bootloader …) (file-systems …) (users …) (packages …) (services …))
This configuration file is in fact a Scheme program; the first lines pull in
modules providing variables you might need in the rest of the file—e.g.,
packages, services, etc. The operating-system
form declares the
system configuration as a record with a number of fields.
Voir Utiliser le système de configuration, to view complete examples and learn
what to put in there.
The second step, once you have this configuration file, is to test it. Of
course, you can skip this step if you’re feeling lucky—you choose! To do
that, pass your configuration file to guix system vm
(no need to
be root, you can do that as a regular user):
guix system vm /etc/config.scm
This command returns the name of a shell script that starts a virtual machine (VM) running the system as described in the configuration file:
/gnu/store/…-run-vm.sh
In this VM, you can log in as root
with no password. That’s a good
way to check that your configuration file is correct and that it gives the
expected result, without touching your system. Voir Invoquer guix system
,
for more information.
Remarque : When using
guix system vm
, aspects tied to your hardware such as file systems and mapped devices are overridden because they cannot be meaningfully tested in the VM. Other aspects such as static network configuration (voirstatic-networking-service-type
) are not overridden but they may not work inside the VM.
The third step, once you’re happy with your configuration, is to instantiate it—make this configuration effective on your system. To do that, run:
sudo guix system reconfigure /etc/config.scm
This operation is transactional: either it succeeds and you end up with an upgraded system, or it fails and nothing has changed. Note that it does not restart system services that were already running. Thus, to upgrade those services, you have to reboot or to explicitly restart them; for example, to restart the secure shell (SSH) daemon, you would run:
sudo herd restart sshd
Remarque : System services are managed by the Shepherd (voir Jump Start dans The GNU Shepherd Manual). The
herd
command lets you inspect, start, and stop services. To view the status of services, run:sudo herd statusTo view detailed information about a given service, add its name to the command:
sudo herd status sshdVoir Services, for more information.
The system records its provenance—the configuration file and channels that were used to deploy it. You can view it like so:
guix system describe
Additionally, guix system reconfigure
preserves previous system
generations, which you can list:
guix system list-generations
Crucially, that means that you can always roll back to an earlier generation should something go wrong! When you eventually reboot, you’ll notice a sub-menu in the bootloader that reads “Old system generations”: it’s what allows you to boot an older generation of your system, should the latest generation be “broken” or otherwise unsatisfying. You can also “permanently” roll back, like so:
sudo guix system roll-back
Alternatively, you can use guix system switch-generation
to switch
to a specific generation.
Once in a while, you’ll want to delete old generations that you do not need
anymore to allow garbage collection to free space (voir Invoquer guix gc
). For example, to remove generations older than 4 months, run:
sudo guix system delete-generations 4m
From there on, anytime you want to change something in the system
configuration, be it adding a user account or changing parameters of a
service, you will first update your configuration file and then run
guix system reconfigure
as shown above.
Likewise, to upgrade system software, you first fetch an up-to-date
Guix and then reconfigure your system with that new Guix:
guix pull sudo guix system reconfigure /etc/config.scm
We recommend doing that regularly so that your system includes the latest security updates (voir Mises à jour de sécurité).
Remarque :
sudo guix
runs your user’sguix
command and not root’s, becausesudo
leavesPATH
unchanged.La différence est importante ici, car
guix pull
met à jour la commandeguix
et les définitions de paquets uniquement pour l’utilisateur sous lequel elle est exécutée. Cela signifie que si vous choisissez d’utiliser la commandeguix system reconfigure
dans le shell de connexion de root, vous devrez utiliser séparément la commandeguix pull
.
That’s it! If you’re getting started with Guix entirely, voir Guide de démarrage. The next sections dive in more detail into the crux of the matter: system configuration.
Suivant: Référence de operating-system
, Précédent: Guide de démarrage, Monter: Configuration du système [Table des matières][Index]
The previous section showed the overall workflow you would follow when administering a Guix System machine (voir Guide de démarrage). Let’s now see in more detail what goes into the system configuration file.
The operating system is configured by providing an operating-system
declaration in a file that can then be passed to the guix system
command (voir Invoquer guix system
), as we’ve seen before. A simple
setup, with the default Linux-Libre kernel, initial RAM disk, and a couple
of system services added to those provided by default looks like this:
;; -*- mode: scheme; -*- ;; This is an operating system configuration template ;; for a "bare bones" setup, with no X11 display server. (use-modules (gnu)) (use-service-modules networking ssh) (use-package-modules screen ssh) (operating-system (host-name "komputilo") (timezone "Europe/Berlin") (locale "en_US.utf8") ;; Boot in "legacy" BIOS mode, assuming /dev/sdX is the ;; target hard disk, and "my-root" is the label of the target ;; root file system. (bootloader (bootloader-configuration (bootloader grub-bootloader) (targets '("/dev/sdX")))) ;; It's fitting to support the equally bare bones ‘-nographic’ ;; QEMU option, which also nicely sidesteps forcing QWERTY. (kernel-arguments (list "console=ttyS0,115200")) (file-systems (cons (file-system (device (file-system-label "my-root")) (mount-point "/") (type "ext4")) %base-file-systems)) ;; This is where user accounts are specified. The "root" ;; account is implicit, and is initially created with the ;; empty password. (users (cons (user-account (name "alice") (comment "Bob's sister") (group "users") ;; Adding the account to the "wheel" group ;; makes it a sudoer. Adding it to "audio" ;; and "video" allows the user to play sound ;; and access the webcam. (supplementary-groups '("wheel" "audio" "video"))) %base-user-accounts)) ;; Globally-installed packages. (packages (cons screen %base-packages)) ;; Add services to the baseline: a DHCP client and an SSH ;; server. You may wish to add an NTP service here. (services (append (list (service dhcp-client-service-type) (service openssh-service-type (openssh-configuration (openssh openssh-sans-x) (port-number 2222)))) %base-services)))
The configuration is declarative. It is code in the Scheme programming
language; the whole (operating-system …)
expression produces a
record with a number of fields. Some of the fields defined
above, such as host-name
and bootloader
, are mandatory.
Others, such as packages
and services
, can be omitted, in
which case they get a default value. Voir Référence de operating-system
, for
details about all the available fields.
Below we discuss the meaning of some of the most important fields.
Troubleshooting : The configuration file is a Scheme program and you might get the syntax or semantics wrong as you get started. Syntactic issues such as misplaced parentheses can often be identified by reformatting your file:
guix style -f config.scmThe Cookbook has a short section to get started with the Scheme programming language that explains the fundamentals, which you will find helpful when hacking your configuration. Voir A Scheme Crash Course dans GNU Guix Cookbook.
Le champ bootloader
décrit la méthode qui sera utilisée pour démarrer
votre système. Les machines basées sur les processeurs Intel peuvent
démarrer dans l’ancien mode BIOS, comme dans l’exemple au-dessus.
Cependant, les machines plus récentes s’appuient sur l’UEFI (Unified
Extensible Firmware Interface) pour démarrer. Dans ce cas, le champ
bootloader
devrait contenir quelque chose comme cela :
(bootloader-configuration
(bootloader grub-efi-bootloader)
(targets '("/boot/efi")))
Voir Configuration du chargeur d’amorçage, pour plus d’informations sur les options de configuration disponibles.
Le champ packages
liste les paquets qui seront visibles sur tout le
système, pour tous les comptes utilisateur·rice·s — c.-à-d. dans la
variable d’environnement PATH
de tous les utilisateur·rice·s — en plus
des profils utilisateur·rice·s (voir Invoquer guix package
). La variable
%base-packages fournit tous les outils qu’on pourrait attendre pour
les tâches de base de l’administrateur·rice et de l’utilisateur·rice — dont
les GNU Core Utilities, les GNU Networking Utilities, l’éditeur de texte
léger mg
, find
, grep
, etc. L’exemple
ci-dessus ajoute GNU Screen à ces paquets, récupéré depuis le module
(gnu packages screen)
(voir Modules de paquets). Vous pouvez
utiliser la syntaxe (list package output)
pour ajouter une sortie
spécifique d’un paquet :
(use-modules (gnu packages)) (use-modules (gnu packages dns)) (operating-system ;; ... (packages (cons (list isc-bind "utils") %base-packages)))
Se référer aux paquets par le nom de leur variable, comme isc-bind
ci-dessus, a l’avantage d’être sans ambigüité ; cela permet aussi de se
rendre rapidement compte de coquilles quand on a des « variables non liées
». L’inconvénient est qu’on a besoin de savoir dans quel module est défini
le paquet, et de modifier la ligne use-package-modules
en
conséquence. Pour éviter cela, on peut utiliser la procédure
specification->package
du module (gnu packages)
, qui renvoie
le meilleur paquet pour un nom donné ou un nom et une version :
(use-modules (gnu packages)) (operating-system ;; ... (packages (append (map specification->package '("tcpdump" "htop" "gnupg@2.0")) %base-packages)))
When a package has more than one output it can be a challenge to refer to a
specific output instead of just to the standard out
output. For
these situations one can use the specifications->packages
procedure
from the (gnu packages)
module. For example:
(use-modules (gnu packages)) (operating-system ;; ... (packages (append (specifications->packages '("git" "git:send-email")) %base-packages)))
Le champ services
liste les services système à rendre
disponible lorsque le système démarre (voir Services). La déclaration
operating-system
au-dessus spécifie que, en plus des services de
base, on veut que le démon ssh OpenSSH écoute sur le port 2222
(voir openssh-service-type
). Sous le capot,
openssh-service-type
s’arrange pour que sshd
soit lancé avec
les bonnes options de la ligne de commande, éventuellement en générant des
fichiers de configuration (voir Définir des services).
Parfois, plutôt que d’utiliser les services de base tels-quels, on peut
vouloir les personnaliser. Pour cela, utilisez modify-services
(voir modify-services
) pour modifier la liste.
Par exemple, supposons que vous souhaitiez modifier guix-daemon
et
Mingetty (l’écran de connexion en console) dans la liste
%base-services
(voir %base-services
). Pour
cela, vous pouvez écrire ce qui suit dans votre déclaration de système
d’exploitation :
(define %my-services ;; ma propre liste de services. (modify-services %base-services (guix-service-type config => (guix-configuration (inherit config) ;; Récupérer les substituts depuis example.org. (substitute-urls (list "https://example.org/guix" "https://ci.guix.gnu.org")))) (mingetty-service-type config => (mingetty-configuration (inherit config) ;; Connexion automatique en tant que « guest ». (auto-login "guest"))))) (operating-system ;; … (services %my-services))
Cela modifie la configuration — c.-à-d. les paramètres du service — de
l’instance de guix-service-type
, et de toutes les instances de
mingetty-service-type
dans la liste %base-services
(voir voir le livre de recettes pour
apprendre à connecter quelqu’un automatiquement sur un TTY donné dans GNU Guix Cookbook)). Remarquez comment on fait cela :
d’abord, on s’arrange pour que la configuration de départ soit liée à
l’identifiant config
dans body puis on écrit body pour
qu’il s’évalue en la configuration désirée. En particulier, remarquez
comment on utilise inherit
pour créer une nouvelle configuration qui
a les même valeurs que l’ancienne configuration, avec seulement quelques
modifications.
La configuration pour une utilisation de « bureau » typique, avec une partition racine chiffrée, a fichier d’échange sur la partition racine, le serveur d’affichage X11, GNOME et Xfce (les utilisateurs peuvent choisir l’environnement de bureau sur l’écran de connexion en appuyant sur F1), la gestion du réseau, la gestion de l’énergie, et bien plus, ressemblerait à ceci :
;; -*- mode: scheme; -*- ;; This is an operating system configuration template ;; for a "desktop" setup with GNOME and Xfce where the ;; root partition is encrypted with LUKS, and a swap file. (use-modules (gnu) (gnu system nss) (guix utils)) (use-service-modules desktop sddm xorg) (use-package-modules gnome) (operating-system (host-name "antelope") (timezone "Europe/Paris") (locale "en_US.utf8") ;; Choose US English keyboard layout. The "altgr-intl" ;; variant provides dead keys for accented characters. (keyboard-layout (keyboard-layout "us" "altgr-intl")) ;; Use the UEFI variant of GRUB with the EFI System ;; Partition mounted on /boot/efi. (bootloader (bootloader-configuration (bootloader grub-efi-bootloader) (targets '("/boot/efi")) (keyboard-layout keyboard-layout))) ;; Specify a mapped device for the encrypted root partition. ;; The UUID is that returned by 'cryptsetup luksUUID'. (mapped-devices (list (mapped-device (source (uuid "12345678-1234-1234-1234-123456789abc")) (target "my-root") (type luks-device-mapping)))) (file-systems (append (list (file-system (device (file-system-label "my-root")) (mount-point "/") (type "ext4") (dependencies mapped-devices)) (file-system (device (uuid "1234-ABCD" 'fat)) (mount-point "/boot/efi") (type "vfat"))) %base-file-systems)) ;; Specify a swap file for the system, which resides on the ;; root file system. (swap-devices (list (swap-space (target "/swapfile")))) ;; Create user `bob' with `alice' as its initial password. (users (cons (user-account (name "bob") (comment "Alice's brother") (password (crypt "alice" "$6$abc")) (group "students") (supplementary-groups '("wheel" "netdev" "audio" "video"))) %base-user-accounts)) ;; Add the `students' group (groups (cons* (user-group (name "students")) %base-groups)) ;; This is where we specify system-wide packages. (packages (append (list ;; for user mounts gvfs) %base-packages)) ;; Add GNOME and Xfce---we can choose at the log-in screen ;; by clicking the gear. Use the "desktop" services, which ;; include the X11 log-in service, networking with ;; NetworkManager, and more. (services (if (target-x86-64?) (append (list (service gnome-desktop-service-type) (service xfce-desktop-service-type) (set-xorg-configuration (xorg-configuration (keyboard-layout keyboard-layout)))) %desktop-services) ;; FIXME: Since GDM depends on Rust (gdm -> gnome-shell -> gjs ;; -> mozjs -> rust) and Rust is currently unavailable on ;; non-x86_64 platforms, we use SDDM and Mate here instead of ;; GNOME and GDM. (append (list (service mate-desktop-service-type) (service xfce-desktop-service-type) (set-xorg-configuration (xorg-configuration (keyboard-layout keyboard-layout)) sddm-service-type)) %desktop-services))) ;; Allow resolution of '.local' host names with mDNS. (name-service-switch %mdns-host-lookup-nss))
Un système graphique avec un choix de gestionnaires de fenêtres légers plutôt que des environnement de bureaux complets ressemblerait à cela :
;; -*- mode: scheme; -*- ;; This is an operating system configuration template ;; for a "desktop" setup without full-blown desktop ;; environments. (use-modules (gnu) (gnu system nss)) (use-service-modules desktop) (use-package-modules bootloaders emacs emacs-xyz ratpoison suckless wm xorg) (operating-system (host-name "antelope") (timezone "Europe/Paris") (locale "en_US.utf8") ;; Use the UEFI variant of GRUB with the EFI System ;; Partition mounted on /boot/efi. (bootloader (bootloader-configuration (bootloader grub-efi-bootloader) (targets '("/boot/efi")))) ;; Assume the target root file system is labelled "my-root", ;; and the EFI System Partition has UUID 1234-ABCD. (file-systems (append (list (file-system (device (file-system-label "my-root")) (mount-point "/") (type "ext4")) (file-system (device (uuid "1234-ABCD" 'fat)) (mount-point "/boot/efi") (type "vfat"))) %base-file-systems)) (users (cons (user-account (name "alice") (comment "Bob's sister") (group "users") (supplementary-groups '("wheel" "netdev" "audio" "video"))) %base-user-accounts)) ;; Add a bunch of window managers; we can choose one at ;; the log-in screen with F1. (packages (append (list ;; window managers ratpoison i3-wm i3status dmenu emacs emacs-exwm emacs-desktop-environment ;; terminal emulator xterm) %base-packages)) ;; Use the "desktop" services, which include the X11 ;; log-in service, networking with NetworkManager, and more. (services %desktop-services) ;; Allow resolution of '.local' host names with mDNS. (name-service-switch %mdns-host-lookup-nss))
Cet exemple se réfère au système de fichier /boot/efi par son UUID,
1234-ABCD
. Remplacez cet UUID par le bon UUID de votre système,
renvoyé par la commande blkid
.
Voir Services de bureaux, for the exact list of services provided by
%desktop-services
.
Encore une fois, %desktop-services
n’est qu’une liste d’objets
service. Si vous voulez enlever des services de là, vous pouvez le faire
avec des procédures pour les listes (voir SRFI-1 Filtering and
Partitioning dans GNU Guile Reference Manual). Par exemple,
l’expression suivante renvoie une liste qui contient tous les services dans
%desktop-services
sauf le service Avahi :
(remove (lambda (service)
(eq? (service-kind service) avahi-service-type))
%desktop-services)
Autrement, la macro modify-services
peut être utilisée :
As you work on your system configuration, you might wonder why some system service doesn’t show up or why the system is not as you expected. There are several ways to inspect and troubleshoot problems.
First, you can inspect the dependency graph of Shepherd services like so:
guix system shepherd-graph /etc/config.scm | \ guix shell xdot -- xdot -
This lets you visualize the Shepherd services as defined in
/etc/config.scm. Each box is a service as would be shown by
sudo herd status
on the running system, and each arrow denotes a
dependency (in the sense that if service A depends on B, then
B must be started before A).
Not all “services” are Shepherd services though, since Guix System uses a broader definition of the term (voir Services). To visualize system services and their relations at a higher level, run:
guix system extension-graph /etc/config.scm | \ guix shell xdot -- xdot -
This lets you view the service extension graph: how services “extend” each other, for instance by contributing to their configuration. Voir Composition de services, to understand the meaning of this graph.
Last, you may also find it useful to inspect your system configuration at the REPL (voir Utiliser Guix de manière interactive). Here is an example session:
$ guix repl scheme@(guix-user)> ,use (gnu) scheme@(guix-user)> (define os (load "config.scm")) scheme@(guix-user)> ,pp (map service-kind (operating-system-services os)) $1 = (#<service-type localed cabba93> …)
Voir Référence de service, to learn about the Scheme interface to manipulate and inspect services.
Assuming the operating-system
declaration is stored in the
config.scm file, the sudo guix system reconfigure
config.scm
command instantiates that configuration, and makes it the
default boot entry. Voir Guide de démarrage, for an
overview.
Pour changer la configuration du système, on met normalement à jour ce
fichier et on relance guix system reconfigure
. On ne devrait
jamais avoir à modifier de fichiers dans /etc ou à lancer des
commandes qui modifient l’état du système comme useradd
ou
grub-install
. En fait, vous devez les éviter parce que non
seulement ça annulerait vos garanties, mais ça empêcherait aussi de revenir
à des versions précédents du système, si vous en avez besoin.
Au niveau Scheme, la grosse déclaration operating-system
est
instanciée avec la procédure monadique suivante (voir La monade du dépôt) :
Renvoie une dérivation qui construit os, un objet
operating-system
(voir Dérivations).
La sortie de la dérivation est un répertoire qui se réfère à tous les paquets et d’autres fichiers supports requis pour instancier os.
Cette procédure est fournie par le module (gnu system)
. Avec
(gnu services)
(voir Services), ce module contient les entrailles
du système Guix. Ouvrez-le un jour !
Suivant: Systèmes de fichiers, Précédent: Utiliser le système de configuration, Monter: Configuration du système [Table des matières][Index]
operating-system
Cette section résume toutes les options disponibles dans les déclarations
operating-system
(voir Utiliser le système de configuration).
C’est le type de données représentant une configuration d’un système d’exploitation. On veut dire par là toute la configuration globale du système, mais pas la configuration par utilisateur (voir Utiliser le système de configuration).
kernel
(par défaut : linux-libre
)L’objet du paquet du système d’exploitation à utiliser29.
hurd
(par défaut : #f
)L’objet du paquet du hurd à être lancé par le noyau. Lorsque ce champ est
défini, produire un système d’exploitation GNU/Hurd. Dans ce cas,
kernel
doit également être défini sur le paquet gnumach
— le
micro-noyau sur lequel tourne le Hurd.
Attention : Cette fonction est expérimentale et seulement prise en charge pour les images de disques.
kernel-loadable-modules
(par défault : ’())Une liste d’objets (généralement des paquets) pour collecter les modules de
noyau chargeables depuis - par exemple (liste ddcci-driver-linux)
.
server-arguments
(par défaut : %default-kernel-arguments
)Liste de chaînes ou de gexps représentant des arguments supplémentaires à
passer sur la ligne de commande du noyau — p. ex.
("console=ttyS0")
.
bootloader
L’objet de configuration du chargeur d’amorçage. Voir Configuration du chargeur d’amorçage.
label
C’est l’étiquette (une chaîne de caractères) comme elle apparaît dans l’entrée du menu du chargeur d’amorçage. L’étiquette par défaut inclus le nom du noyau et sa version.
keyboard-layout
(par défaut : #f
)Ce champ spécifie la disposition du clavier à utiliser dans la console. Il
peut être soit #f
, auquel cas la disposition par défaut est utilisée
(habituellement anglais américain), ou un enregistrement
<keyboard-layout>
. Voir Disposition du clavier, pour plus d’informations.
Cette disposition du clavier est effective dès que le noyau démarre. Par
exemple, c’est la disposition du clavier effective lorsque vous saisissez la
phrase de passe de votre système de fichier racine sur une partition
utilisant luks-device-mapping
(voir Périphériques mappés).
Remarque : Cela ne spécifie pas la disposition clavier utilisée par le chargeur d’amorçage, ni celle utilisée par le serveur d’affichage graphique. Voir Configuration du chargeur d’amorçage, pour plus d’information sur la manière de spécifier la disposition du clavier pour le chargeur d’amorçage. Voir Système de fenêtrage X, pour plus d’informations sur la manière de spécifier la disposition du clavier utilisée par le système de fenêtrage X.
initrd-modules
(par défaut : %base-initrd-modules
) ¶La liste des modules du noyau linux requis dans l’image disque de RAM initiale. Voir Disque de RAM initial.
initrd
(par défaut : base-initrd
)Une procédure qui renvoie un disque de RAM initial pour le noyau Linux. Ce champ est fournit pour pouvoir personnaliser son système à bas-niveau et n’est que rarement utile dans le cas général. Voir Disque de RAM initial.
firmware
(par défaut : %base-firmware
) ¶Liste les paquets de microgiciels chargeables pour le noyau de système d’exploitation.
La valeur par défaut contient les microgiciels requis pour les périphériques
WiFi Atheros et Broadcom (modules ath9k
et b43-open
de
Linux-libre, respectivement). Voir Considérations matérielles, pour plus
d’info sur les périphériques supportés.
host-name
Le nom d’hôte.
mapped-devices
(par défaut : '()
)Une liste de périphériques mappés. Voir Périphériques mappés.
file-systems
Une liste de systèmes de fichiers. Voir Systèmes de fichiers.
swap-devices
(par défaut : '()
) ¶Une liste de d’espaces d’échanges. Voir Espace d’échange.
users
(par défaut : %base-user-accounts
)groups
(par défaut : %base-groups
)Liste les comptes utilisateurs et les groupes. Voir Comptes utilisateurs.
Si la liste users
n’a pas de compte lié à l’UID 0, un compte «
root » avec l’UID 0 est automatiquement ajouté.
skeletons
(par défaut : (default-skeletons)
)Une liste de « couples » de noms de fichiers cibles/objets de type fichier (voir objets de type fichier). Ce sont les fichiers squelettes qui seront ajoutés au répertoire d’accueil des comptes utilisatrice·eur·s nouvellement créés.
Par exemple, un valeur valide ressemblerait à cela :
`((".bashrc" ,(plain-file "bashrc" "echo Hello\n")) (".guile" ,(plain-file "guile" "(use-modules (ice-9 readline)) (activate-readline)")))
issue
(par défaut : %default-issue
)Une chaîne qui dénote le contenu du fichier /etc/issue qui est affiché lorsqu’un utilisateur se connecte sur la console.
packages
(par défaut : %base-packages
)Une liste de paquets à installer dans le profil global, qui est accessible à partir de /run/current-system/profile. Chaque élément est soit une variable de paquet, soit un tuple de paquet/sortie. Voici un exemple simple des deux :
(cons* git ; la sortie "out" par défaut (list git "send-email") ; une autre sortie de git %base-packages) ; l'ensemble par défaut
L’ensemble par défaut contient les utilitaires de base et c’est une bonne
pratique d’installer les utilitaires non essentiels dans les profils
utilisateurs (voir Invoquer guix package
).
timezone
(par défaut : "Etc/UTC"
)Une chaîne identifiant un fuseau horaire — p. ex. "Europe/Paris"
.
Vous pouvez lancer la commande tzselect
pour trouver le fuseau
horaire correspondant à votre région. Si vous choisissez un nom de fuseau
horaire invalide, guix system
échouera.
locale
(par défaut : "en_US.utf8"
)Le nom du paramètre régional par défaut (voir Locale Names dans The GNU C Library Reference Manual). Voir Régionalisation, pour plus d’informations.
locale-definitions
(par défaut : %default-locale-definitions
)La liste des définitions de locales à compiler et qui devraient être utilisées à l’exécution. Voir Régionalisation.
locale-libcs
(par défaut : (list glibc)
)La liste des paquets GNU libc dont les données des paramètres linguistiques sont utilisées pour construire les définitions des paramètres linguistiques. Voir Régionalisation, pour des considérations sur la compatibilité qui justifient cette option.
name-service-switch
(par défaut : %default-nss
)La configuration de NSS de la libc (name service switch) — un objet
<name-service-switch>
. Voir Name Service Switch, pour des détails.
services
(par défaut : %base-services
)Une liste d’objets services qui dénotent les services du système. Voir Services.
essential-services
(par défaut : …)The list of “essential services”—i.e., things like instances of
system-service-type
(voir Référence de service) and
host-name-service-type
, which are derived from the operating system
definition itself. As a user you should never need to touch this
field.
pam-services
(par défaut : (base-pam-services)
) ¶Services PAM (pluggable authentication module) Linux.
privileged-programs
(default: %default-privileged-programs
)Liste de <privileged-program>
. Voir Privileged Programs, pour plus
d’informations.
sudoers-file
(par défaut : %sudoers-specification
) ¶Le contenu du fichier /etc/sudoers comme un objet simili-fichier
(voir local-file
et plain-file
).
Ce fichier spécifier quels utilisateurs peuvent utiliser la commande
sudo
, ce qu’ils ont le droit de faire, et quels privilèges ils
peuvent gagner. La valeur par défaut est que seul root
et les
membres du groupe wheel
peuvent utiliser sudo
.
Lorsqu’il est utilisée dans la portée lexicale de la définition d’un du système d’exploitation, cet identifiant est résolu comme étant le système d’exploitation définit.
L’exemple ci-dessous montre le référencement au système d’exploitation
définit dans la définition du champ label
:
(use-modules (gnu) (guix)) (operating-system ;; ... (label (package-full-name (operating-system-kernel this-operating-system))))
C’est une erreur que de se référer à this-operating-system
en dehors
de la définition d’un système d’exploitation.
Suivant: Périphériques mappés, Précédent: Référence de operating-system
, Monter: Configuration du système [Table des matières][Index]
La liste des systèmes de fichiers à monter est spécifiée dans le champ
file-systems
de la déclaration de système d’exploitation
(voir Utiliser le système de configuration). Chaque système de fichier est
déclaré avec la forme file-system
, comme ceci :
(file-system
(mount-point "/home")
(device "/dev/sda3")
(type "ext4"))
Comme d’habitude, certains de ces champs sont obligatoire — comme le montre l’exemple au-dessus — alors que d’autres peuvent être omis. Ils sont décrits plus bas.
Les objets de ce type représentent des systèmes de fichiers à monter. Ils contiennent les membres suivants :
type
C’est une chaîne de caractères spécifiant le type du système de fichier —
p. ex. "ext4"
.
mount-point
Désigne l’emplacement où le système de fichier sera monté.
device
Ce champ nomme le système de fichier « source ». il peut être l’une de ces trois choses : une étiquette de système de fichiers, un UUID de système de fichier ou le nom d’un nœud dans /dev. Les étiquettes et les UUID offrent une manière de se référer à des systèmes de fichiers sans avoir à coder en dur le nom de périphérique30.
Les étiquettes de systèmes de fichiers sont crées avec la procédure
file-system-label
, les UUID avec uuid
et les nœuds de
/dev sont de simples chaînes de caractères. Voici un exemple d’un
système de fichiers référencé par son étiquette, donnée par la commande
e2label
:
(file-system
(mount-point "/home")
(type "ext4")
(device (file-system-label "my-home")))
Les UUID sont convertis à partir de leur représentation en chaîne de
caractères (montrée par la commande tune2fs -l
) en utilisant la
forme uuid
31,
comme ceci :
(file-system
(mount-point "/home")
(type "ext4")
(device (uuid "4dab5feb-d176-45de-b287-9b0a6e4c01cb")))
Lorsque la source d’un système de fichiers est un périphérique mappé
(voir Périphériques mappés), sont champ device
doit se référer au
nom du périphérique mappé — p. ex. "/dev/mapper/root-partition".
Cela est requis pour que le système sache que monter ce système de fichier
dépend de la présence du périphérique mappé correspondant.
flags
(par défaut : '()
)C’est une liste de symboles qui désignent des drapeaux de montage. Les
drapeaux reconnus sont read-only
, bind-mount
, no-dev
(interdit l’accès aux fichiers spéciaux), no-suid
(ignore les bits
setuid et setgid), no-atime
(ne met pas à jour les heures d’accès aux
fichiers), no-diratime
(pareil mais pour les répertoires uniquement),
strict-atime
(met à jour les heures d’accès aux fichiers),
lazy-time
(ne met à jour les heures que dans la version mémoire des
inœuds de fichiers), no-exec
(interdit l’exécution de programmes), et
shared
(partage le montage). Voir Mount-Unmount-Remount dans The GNU C Library Reference Manual, pour plus d’informations sur ces
drapeaux.
options
(par défaut : #f
)C’est soit #f
, soit une chaine qui dénote les options de montage
passées au pilote de système de fichiers. Voir Mount-Unmount-Remount dans le manuel de référence de la bibliothèque C de GNU pour plus de
détails.
Lancez man 8 mount
pour voir les options des divers systèmes de
fichiers, mais sachez que les « options de montage » indépendantes du
système de fichiers sont en fait des drapeaux, et appartiennent au champ
flags
décrit plus haut.
Les procédures file-system-options->alist
et
alist->file-system-options
de (gnu system file-systems)
peuvent être utilisées pour convertir des options de systèmes de fichiers
données sous forme de liste d’association en représentation de chaîne de
caractères, et vice-versa.
mount?
(par défaut : #t
)Cette valeur indique s’il faut monter automatiquement le système de fichier
au démarrage du système. Lorsque la valeur est #f
, le système de
fichier reçoit une entrée dans /etc/fstab (lue par la commande
mount
) mais n’est pas monté automatiquement.
needed-for-boot?
(par défaut : #f
)Cette valeur booléenne indique si le système de fichier est nécessaire au démarrage. Si c’est vrai alors le système de fichier est monté au chargement du disque de RAM initial. C’est toujours le cas par exemple du système de fichiers racine.
check?
(par défaut : #t
)Cette valeur booléenne indique si le système de fichier devrait être vérifié avant de le monter. Comment et quand cela se produit peut être réglé plus en détail avec les options suivantes.
skip-check-if-clean?
(par défaut : #t
)Lorsqu’il a la valeur vrai, ce booléen indique qu’une vérification de
système de fichier initiée par check?
peut terminer prématurément si
le système de fichier est marqué comme « propre », ce qui signifie qu’il a
préalablement été démonté correctement and ne devrait contenir aucune
erreur.
Lui affecter la valeur faux imposera toujours une vérification de cohérence
complète si check?
est à vrai. Cela peut prendre très longtemps et
n’est pas recommandé sur des systèmes sains—en fait, cela pourrait même
réduire la fiabilité !
À l’inverse, certains systèmes de fichiers primitifs comme fat
ne
gardent pas trace des arrêts propres et exécuteront une vérification
complète sans tenir compte de la valeur de cette option.
repair
(par défaut : 'preen
)Quand check?
trouve des erreurs, il peut (essayer de) les réparer
pour poursuivre le démarrage. Cette option contrôle dans quel cas et de
quelle manière appliquer cette stratégie.
À la valeur faux, il essayera de pas modifier le système de fichier du
tout. Vérifier certains systèmes de fichiers comme jfs
peut quand
même provoquer des écritures sur le périphérique pour rejouer le
journal. Aucune réparation ne sera tentée.
Si la valeur #t
est renseignée, il essayera de récupérer toute erreur
qu’il trouvera et supposera qu’il peut répondre « oui » à toutes les
questions. Cela corrigera la plupart des erreurs, mais peut s’avérer risqué.
Si elle vaut 'preen
, il ne réparera que les erreurs qui peuvent être
corrigées sans risque en l’absence d’intervention humaine. Ce que cela
signifie est laissé à l’appréciation des personnes qui développent chaque
système de fichier et peut être équivalent à « aucune » ou « toutes ».
create-mount-point?
(par défaut : #f
)Lorsque cette valeur est vraie, le point de montage est créé s’il n’existe pas déjà.
mount-may-fail?
(par défaut : #t
)Lorsque cela est vrai, indique que le montage de ce système de fichiers peut
échouer, mais cela ne doit pas être considéré comme une erreur. Ceci est
utile dans des cas inhabituels ; un exemple de ceci est efivarfs
, un
système de fichiers qui ne peut être monté que sur des systèmes EFI/UEFI.
dependencies
(par défaut : '()
)C’est une liste d’objets <file-system>
ou <mapped-device>
qui
représentent les systèmes de fichiers qui doivent être montés ou les
périphériques mappés qui doivent être ouverts avant (et monté ou fermés
après) celui-ci.
Par exemple, considérons une hiérarchie de montage : /sys/fs/cgroup est une dépendance de /sys/fs/cgroup/cpu et /sys/fs/cgroup/memory.
Un autre exemple est un système de fichier qui dépend d’un périphérique mappé, par exemple pour une partition chiffrée (voir Périphériques mappés).
shepherd-requirements
(default: '()
)This is a list of symbols denoting Shepherd requirements that must be met before mounting the file system.
As an example, an NFS file system would typically have a requirement for
networking
.
Typically, file systems are mounted before most other Shepherd services are
started. However, file systems with a non-empty shepherd-requirements field
are mounted after Shepherd services have begun. Any Shepherd service that
depends on a file system with a non-empty shepherd-requirements field must
depend on it directly and not on the generic symbol file-systems
.
Cette procédure renvoie un label de système de fichiers opaque à partir de str, une chaîne de caractères :
(file-system-label "home") ⇒ #<file-system-label "home">
Les étiquettes de systèmes de fichiers sont utilisées pour faire référence aux systèmes de fichiers par étiquette plutôt que par nom de dispositif. Voir ci-dessus pour des exemples.
Le module (gnu system file-systems)
exporte les variables utiles
suivantes.
Ce sont les systèmes de fichiers essentiels qui sont requis sur les systèmes
normaux, comme %pseudo-terminal-file-system
et
%immutable-store
(voir plus bas). Les déclarations de systèmes
d’exploitation devraient au moins les contenir.
C’est le système de fichier monté sur /dev/pts. Il supporte les
pseudo-terminaux créés via openpty
et les fonctions similaires
(voir Pseudo-Terminals dans The GNU C Library Reference Manual). Les
pseudo-terminaux sont utilisés par les émulateurs de terminaux comme
xterm
.
Ce système de fichier est monté dans /dev/shm et est utilisé pour le
partage de mémoire entre processus (voir shm_open
dans The GNU C Library Reference Manual).
Ce système de fichiers effectue un « montage lié » en lecture-seule de
/gnu/store, ce qui en fait un répertoire en lecture-seule pour tous
les utilisateurs dont root
. Cela évite que des logiciels qui
tournent en root
ou des administrateurs systèmes ne modifient
accidentellement le dépôt.
Le démon lui-même est toujours capable d’écrire dans le dépôt : il est remonté en lecture-écriture dans son propre « espace de nom ».
Le système de fichiers binfmt_misc
, qui permet de gérer n’importe
quel type de fichiers exécutables à déléguer en espace utilisateur. Cela
demande que le module du noyau binfmt.ko
soit chargé.
Le système de fichiers fusectl
, qui permet à des utilisateurs non
privilégiés de monter et de démonter des systèmes de fichiers FUSE en espace
utilisateur. Cela requiert que le module du noyau fuse.ko
soit
chargé.
Le module (gnu system uuid)
fournit les outils pour traiter les «
identifiants uniques » de système de fichier (UUIDs).
Renvoie un objet UUID (identifiant unique) opaque du type donné (un symbole) en analysant str (une chaîne) :
(uuid "4dab5feb-d176-45de-b287-9b0a6e4c01cb") ⇒ #<uuid> type: dce bv: …> (uuid "1234-ABCD" 'fat) ⇒ #<uuid> type: fat bv: …>
type peut être l’un des codes suivants : dce
, iso9660
,
fat
, ntfs
, ou l’un des synonymes les plus courants.
Les UUIDs sont un autre moyen de faire référence sans ambiguïté aux systèmes de fichiers dans la configuration du système d’exploitation. Voir les exemples ci-dessus.
Monter: Systèmes de fichiers [Table des matières][Index]
Btrfs a des particularités, comme les sous-volumes, qui méritent d’être expliquées plus en détail. La section suivante tente de couvrir les utilisations de base ainsi que les utilisations complexes d’un système de fichiers Btrfs avec le système Guix.
Dans son usage le plus simple, un système de fichier Btrfs peut être décrit, par exemple, par :
(file-system
(mount-point "/home")
(type "btrfs")
(device (file-system-label "my-home")))
L’exemple ci-dessous est plus complexe, car il utilise un sous-volume de
Btrfs, nommé rootfs
. Le système de fichiers Btrfs parent est appelé
my-btrfs-pool
, et se trouve sur un périphérique crypté (d’où la
dépendance à l’égard de mapped-devices
) :
(file-system
(device (file-system-label "my-btrfs-pool"))
(mount-point "/")
(type "btrfs")
(options "subvol=rootfs")
(dependencies mapped-devices))
Certains chargeurs d’amorçage, par exemple GRUB, ne montent une partition
Btrfs qu’à son niveau supérieur au début du démarrage, et s’appuient sur
leur configuration pour se référer au chemin correct du sous-volume à
l’intérieur de ce niveau supérieur. Les chargeurs d’amorçage fonctionnant
de cette manière produisent généralement leur configuration sur un système
en cours d’exécution où les partitions Btrfs sont déjà montées et où les
informations sur les sous-volumes sont facilement disponibles. Par exemple,
grub-mkconfig
, la commande de générateur de configuration livrée
avec GRUB, lit /proc/self/mountinfo pour déterminer le chemin de
niveau supérieur d’un sous-volume.
Guix System produit une configuration de bootloader en utilisant la configuration du système d’exploitation comme seule entrée ; il est donc nécessaire d’extraire le nom du sous-volume sur lequel vit /gnu/store (s’il existe) de cette configuration du système d’exploitation. Pour mieux illustrer cela, considérons un sous-volume nommé "rootfs" qui contient les données du système de fichiers racine. Dans une telle situation, le chargeur de démarrage GRUB ne verrait que le niveau supérieur de la partition Btrfs de la racine, par exemple :
/ (niveau supérieur) ├── rootfs (répertoire des sous-volumes) ├── gnu (répertoire normal) ├── store (répertoire normal) [...]
Ainsi, le nom du sous-volume doit être précédé du chemin /gnu/store du noyau, des binaires initrd et de tout autre fichier mentionné dans la configuration GRUB qui doit être trouvé au début du démarrage.
L’exemple suivant montre une hiérarchie imbriquée de sous-volumes et de répertoires :
/ (niveau supérieur) ├── rootfs (sous-volume) ├── gnu (répertoire normal) ├── store (sous-volume) [...]
Ce scénario fonctionnerait sans monter le sous-volume « store ». Le montage
de "rootfs" est suffisant, puisque le nom du sous-volume correspond à son
point de montage prévu dans la hiérarchie du système de fichiers. Une autre
solution consiste à faire référence au sous-volume « store » en définissant
l’option subvol
soit /rootfs/gnu/store
soit
rootfs/gnu/store
.
Enfin, un exemple plus élaboré de sous-volumes imbriqués :
/ (niveau supérieur) ├── root-snapshots (sous-volume) ├── root-current (sous-volume) ├── guix-store (sous-volume) [...]
Ici, le sous-volume « guix-store » ne correspond pas à son point de montage
prévu, il est donc nécessaire de le monter. Le sous-volume doit être
entièrement spécifié, en passant son nom de fichier à l’option
subvol
. Par exemple, le sous-volume « guix-store » peut être monté
sur /gnu/store en utilisant une déclaration de système de fichiers
telle que :
(file-system
(device (file-system-label "btrfs-pool-1"))
(mount-point "/gnu/store")
(type "btrfs")
(options "subvol=root-snapshots/root-current/guix-store,\
compress-force=zstd,space_cache=v2"))
Suivant: Espace d’échange, Précédent: Systèmes de fichiers, Monter: Configuration du système [Table des matières][Index]
Le noyau Linux a une notion de mappage de périphériques : un
périphérique bloc, comme une partition sur un disque dur, peut être
mappé sur un autre périphérique, typiquement dans /dev/mapper
,
avec des calculs supplémentaires sur les données qui naviguent entre les
deux32. Un exemple typique est le mappage
de périphériques chiffrés : toutes les écritures sont sur le périphérique
mappé sont chiffrées, toutes les lectures déchiffrées, de manière
transparente. Guix étend cette notion en considérant que tout périphérique
ou ensemble de périphériques qui sont transformés d’une certaine
manière créent un nouveau périphérique ; par exemple, les périphériques RAID
sont obtenus en assemblant plusieurs autres périphériques, comme des
disque ou des partitions, en un nouveau périphérique en tant qu’unique
partition.
Les périphériques mappés sont déclarés avec la forme mapped-device
,
définie comme suit ; par exemple, voir ci-dessous.
Les objets de ce type représentent des mappages de périphériques qui seront effectués au démarrage du système.
source
C’est soit une chaîne qui spécifie le nom d’un périphérique bloc à projeter,
comme "/dev/sda3"
, soit une liste de plusieurs périphériques à
assembler pour en créer un nouveau. Dans le cas de LVM, c’est une chaîne
spécifiant le nom du groupe de volume à projeter.
target
Cette chaîne spécifie le nom du périphérique mappé qui en résulte. Pour les
mappeurs noyaux comme les périphériques chiffrés de type
luks-device-mapping
, spécifier "ma-partition"
crée le
périphérique "/dev/mapper/ma-partition"
. Pour les périphériques RAID
de type raid-device-mapping
, il faut donner le nom complet comme
"/dev/md0"
. Les volumes logiques LVM de type
lvm-device-mapping
doivent être spécifiés comme étant
"VGNAME-LVNAME"
.
targets
Cette liste de chaînes spécifie les noms des périphériques projetés s’il y en a plusieurs. Le format est identique à target.
type
Ce doit être un objets mapped-device-kind
, qui spécifie comment
source est mappés sur target.
Cela définie les périphériques blocs chiffrés en LUKS avec
cryptsetup
du paquet du même nom. Elle s’appuie sur le module du
noyau Linux dm-crypt
.
Return a luks-device-mapping
object, which defines LUKS block device
encryption using the cryptsetup
command from the package with the
same name. It relies on the dm-crypt
Linux kernel module.
If key-file
is provided, unlocking is first attempted using that key
file. This has an advantage of not requiring a password entry, so it can be
used (for example) to unlock RAID arrays automatically on boot. If key file
unlock fails, password unlock is attempted as well. Key file is not stored
in the store and needs to be available at the given location at the time of
the unlock attempt.
;; Following definition would be equivalent to running: ;; cryptsetup open --key-file /crypto.key /dev/sdb1 data (mapped-device (source "/dev/sdb1) (target "data) (type (luks-device-mapping-with-options #:key-file "/crypto.key")))
Cela définie un périphérique RAID qui est assemblé avec la commande
mdadm
du paquet du même nom. Elle nécessite un module noyau Linux
approprié pour le niveau RAID chargé, comme raid456
pour RAID-4,
RAID-5 et RAID-6 ou raid10
pour RAID-10.
Cela définie un ou plusieurs volumes logiques pour le
Gestionnaire de Volume Logique
(LVM) de Linux. Le groupe de volume est activé par la commande
vgchange
du paquet lvm2
.
L’exemple suivant spécifie un mappage de /dev/sda3 vers
/dev/mapper/home avec LUKS —
Linux Unified Key Setup, un
mécanisme standard pour chiffrer les disques. Le périphérique
/dev/mapper/home peut ensuite être utilisé comme device
d’une
déclaration file-system
(voir Systèmes de fichiers).
(mapped-device
(source "/dev/sda3")
(target "home")
(type luks-device-mapping))
Autrement, pour devenir indépendant du numéro de périphérique, on peut obtenir l’UUID LUKS (l’identifiant unique) du périphérique source avec une commande comme :
cryptsetup luksUUID /dev/sda3
et l’utiliser ainsi :
(mapped-device
(source (uuid "cb67fc72-0d54-4c88-9d4b-b225f30b0f44"))
(target "home")
(type luks-device-mapping))
Il est aussi désirable de chiffrer l’espace d’échange, puisque l’espace d’échange peut contenir des données sensibles. Une manière de faire cela est d’utiliser un fichier d’échange dans un système de fichiers sur un périphérique mappé avec un chiffrement LUKS. De cette manière, le fichier d’échange est chiffré parce que tout le périphérique est chiffré. Voir Espace d’échange ou Voir Disk Partitioning, pour un exemple.
Un périphérique RAID formé des partitions /dev/sda1 et /dev/sdb1 peut être déclaré ainsi :
(mapped-device
(source (list "/dev/sda1" "/dev/sdb1"))
(target "/dev/md0")
(type raid-device-mapping))
Le périphérique /dev/md0 peut ensuite être utilisé comme
device
d’une déclaration file-system
(voir Systèmes de fichiers).
Remarquez que le niveau de RAID n’a pas besoin d’être donné ; il est choisi
pendant la création initiale du périphérique RAID et est ensuite déterminé
automatiquement.
Les volumes logiques LVM « alpha » et « beta » du groupe de volumes « vg0 » se déclarent de cette façon :
(mapped-device
(source "vg0")
(targets (list "vg0-alpha" "vg0-beta"))
(type lvm-device-mapping))
Les périphériques /dev/mapper/vg0-alpha et
/dev/mapper/vg0-beta sont maintenant utilisables comme device
d’une déclaration file-system
(voir Systèmes de fichiers).
Suivant: Comptes utilisateurs, Précédent: Périphériques mappés, Monter: Configuration du système [Table des matières][Index]
Un espace d’échange est un espace disque spécifiquement dédié à la pagination mémoire : le processus en charge de la gestion de la mémoire (le noyau Linux ou le gestionnaire par défaut du Hurd) peut décider que certaines pages mémoire stockées en RAM qui appartiennent à un processus en cours d’exécution mais qui sont inutilisées devraient plutôt être stockées sur disque. Il les décharge de la RAM pour libérer la précieuse mémoire rapide, et les écrit sur l’espace d’échange. Si le programme essaye d’accéder à la page, le processus de gestion de la mémoire la charge à nouveau dans la mémoire pour que le programme puisse l’utiliser.
Une idée fausse répandue sur l’espace d’échange est qu’il n’est utile que lorsque seule une petite quantité de RAM est disponible sur le système. En réalité, vous devriez savoir que les noyaux utilisent souvent toute la RAM disponible pour le cache des accès disques pour rendre les opérations d’entrée-sortie plus rapides. En conséquence, déplacer des pages mémoire inutilisées augmentera la quantité de RAM disponible pour ce cache.
Pour une description plus complète de la gestion de la mémoire du point de vue d’un noyau monolithique, voir Memory Concepts dans le manuel de référence de la bibliothèque C de GNU.
Le noyau Linux prend en charge les partitions d’échanges et les fichiers d’échange : le premier utilise une partition disque complète pour la pagination, alors que le second utilise un fichier sur un système de fichiers pour cela (le pilote du système de fichiers doit le prendre en charge). Pour une configuration comparable, les deux ont les mêmes performances, donc vous devriez considérer la facilité d’utilisation pour vous décider entre les deux. Les partitions sont « plus simples » et n’ont pas besoin de la prise en charge dans le système de fichiers, mais ont besoin d’être allouées au formatage du disque (en oubliant les volumes logiques), alors que les fichiers peuvent être alloués et désalloués à n’importe quel moment.
Un espace d’échange est également requis pour mettre le système en hibernation (également appelé suspens sur disque), état dans lequel la mémoire est copiée dans l’espace d’échange avant l’extinction pour qu’elle puisse être récupérée après le redémarrage de la machine. L’hibernation utilise au plus la moitié de la taille de la RAM dans l’espace d’échange configuré. Le noyau Linux a besoin de connaître l’espace d’échange à utiliser lorsqu’il sort d’hibernation au démarrage (via un argument du noyau). Lorsque vous utilisez un fichier d’échange, sa position sur le périphérique qui le contient doit être donnée au noyau. Cette valeur doit être mise à jour si le fichier est de nouveau initialisé en tant qu’espace d’échange — p. ex. si sa taille a changé.
Remarquez que l’espace d’échange n’est pas remis à zéro à l’extinction donc les données sensibles (comme les mots de passe) peuvent y rester si elles y ont été déplacées. De fait, vous devriez faire résider votre espace d’échange sur un périphérique chiffré (voir Périphériques mappés).
Les objets de ce type représentent des espaces d’échange. Ils contiennent les membres suivants :
target
Le périphérique ou le fichier à utiliser, soit un UUID, soit un
file-system-label
, soit une chaine, comme dans la définition d’un
file-system
(voir Systèmes de fichiers).
dependencies
(par défaut : '()
)Une liste de d’objets file-system
ou mapped-device
, dont
dépend la disponibilité de l’espace. Remarquez que, tout comme pour les
objets file-system
, les dépendances qui sont requises au démarrage et
montées au plus tôt en espace utilisateur ne sont pas gérées par le
Shepherd, et sont donc automatiquement retirées pour vous.
priority
(par défaut : #f
)Seulement pris en charge par le noyau Linux. Soit #f
pour désactive
la priorité de l’espace d’échange, soit un entier entre 0 et 32767. Le noyau
utilisera d’abord les espaces d’échange avec la plus grande priorité, et
utilisera les espaces d’échange de même priorité à tour de rôle. Le noyau
utilisera les espaces d’échange sans priorité après les espaces
prioritaires, et dans l’ordre dans lequel ils sont apparus (donc pas à tour
de rôle).
discard?
(par défaut : #f
)Uniquement pris en charge par le noyau Linux. Lorsque la valeur est vraie, le noyau notifiera le contrôleur de disque des pages supprimées, par exemple avec l’opération TRIM sur les disques SSD.
Voici quelques exemples :
(swap-space (target (uuid "4dab5feb-d176-45de-b287-9b0a6e4c01cb")))
Utilise la partition de swap avec l’UUID donné. Vous pouvez voir l’UUID
d’une partition de swap Linux en lançant swaplabel device
,
où device est le nom de fichier /dev de cette partition.
(swap-space
(target (file-system-label "swap"))
(dependencies mapped-device))
Utilise la partition avec l’étiquette swap
, qui peut être trouvée
après que tous les périphériques mappés mapped-devices ont été
ouverts. De nouveau, la commande swaplabel
vous permet de voir et
de changer l’étiquette d’une partition swap de Linux.
Voici un exemple plus complet de la partie file-systems
d’une
déclaration operating-system
.
(file-systems (list (file-system (device (file-system-label "root")) (mount-point "/") (type "ext4")) (file-system (device (file-system-label "btrfs")) (mount-point "/btrfs") (type "btrfs")))) (swap-devices (list (swap-space (target "/btrfs/swapfile") (dependencies (filter (file-system-mount-point-predicate "/btrfs") file-systems)))))
utilise le fichier /btrfs/swapfile comme espace d’échange, ce qui dépend du système de fichiers monté sur /btrfs. Remarquez comment nous utilisons la fonction filter de Guile pour élégamment sélectionner le système de fichiers !
(swap-devices (list (swap-space (target "/dev/mapper/my-swap") (dependencies mapped-devices)))) (kernel-arguments (cons* "resume=/dev/mapper/my-swap" %default-kernel-arguments))
Le bout de code précédent provient d’une déclaration operating-system
et permet d’utiliser le périphérique mappé /dev/mapper/my-swap (qui
peut faire partie d’un périphérique chiffré) en tant qu’espace d’échange, et
dit au noyau de l’utiliser pour l’hibernation via l’argument du noyau
resume
(voir Référence de operating-system
, kernel-arguments
).
(swap-devices (list (swap-space (target "/swapfile") (dependencies (filter (file-system-mount-point-predicate "/") file-systems))))) (kernel-arguments (cons* "resume=/dev/sda3" ;device that holds /swapfile "resume_offset=92514304" ;offset of /swapfile on device %default-kernel-arguments))
This other snippet of operating-system
enables the swap file
/swapfile for hibernation by telling the kernel about the partition
containing it (resume
argument) and its offset on that partition
(resume_offset
argument). The latter value can be found in the
output of the command filefrag -e
as the first number right under
the physical_offset
column header (the second command extracts its
value directly):
$ sudo filefrag -e /swapfile Filesystem type is: ef53 File size of /swapfile is 2463842304 (601524 blocks of 4096 bytes) ext: logical_offset: physical_offset: length: expected: flags: 0: 0.. 2047: 92514304.. 92516351: 2048: … $ sudo filefrag -e /swapfile | grep '^ *0:' | cut -d: -f3 | cut -d. -f1 92514304
Suivant: Disposition du clavier, Précédent: Espace d’échange, Monter: Configuration du système [Table des matières][Index]
Les comptes utilisateurs et les groupes sont gérés entièrement par la
déclaration operating-system
. Ils sont spécifiés avec les formes
user-account
et user-group
:
(user-account
(name "alice")
(group "users")
(supplementary-groups '("wheel" ;permet d'utiliser sudo, etc.
"audio" ;carte son
"video" ;périphériques réseaux comme les webcams
"cdrom")) ;le bon vieux CD-ROM
(comment "Bob's sister"))
Voici un compte d’utilisateur·rice qui utilise un shell différent et un répertoire d’accueil personnalisé (le répertoire par défaut serait "/home/bob") :
(user-account
(name "bob")
(group "users")
(comment "Alice's bro")
(shell (file-append zsh "/bin/zsh"))
(home-directory "/home/robert"))
Lors du démarrage ou à la fin de guix system reconfigure
, le
système s’assure que seuls les comptes utilisateurs et les groupes spécifiés
dans la déclaration operating-system
existent, et avec les propriétés
spécifiées. Ainsi, les modifications ou les créations de comptes ou de
groupes effectuées directement en invoquant des commandes comme
useradd
sont perdue à la reconfiguration ou au redémarrage. Cela
permet de s’assurer que le système reste exactement tel que déclaré.
Les objets de se type représentent les comptes utilisateurs. Les membres suivants peuvent être spécifiés :
name
Le nom du compte utilisateur.
group
¶C’est le nom (une chaîne) ou un identifiant (un nombre) du groupe utilisateur auquel ce compte appartient.
supplementary-groups
(par défaut : '()
)Éventuellement, cela peut être définie comme une liste de noms de groupes auxquels ce compte appartient.
uid
(par défaut : #f
)C’est l’ID utilisateur de ce compte (un nombre) ou #f
. Dans ce
dernier cas, le nombre est choisi automatiquement par le système à la
création du compte.
comment
(par défaut : ""
)Un commentaire à propos du compte, comme le nom complet de l’utilisateur.
Remarquez que, pour les compte non-systèmes, vous êtes libres de changer
votre nom réel tel qu’il apparait dans /etc/passwd avec la commande
chfn
. Lorsque vous faites cela, votre choix prévaut sur le choix
de l’administrateur ou l’administratrice système ; la reconfiguration ne
change pas votre nom.
home-directory
C’est le nom du répertoire personnel du compte.
create-home-directory?
(par défaut : #t
)Indique si le répertoire personnel du compte devrait être créé s’il n’existe pas déjà.
shell
(par défaut : Bash)C’est une G-expression qui désigne le nom de fichier d’un programme utilisé comme shell (voir G-Expressions). Par exemple, vous pourriez vous référer à l’exécutable Bash comme ceci :
(file-append bash "/bin/bash")
... et à l’ exécutable Zsh comme ceci :
(file-append zsh "/bin/zsh")
system?
(par défaut : #f
)C’est une valeur booléenne qui indique si le compte est un compte « système ». Les comptes systèmes sont parfois traités à part ; par exemple, les gestionnaires de connexion graphiques ne les liste pas.
password
(par défaut : #f
)Vous laisseriez normalement ce champ à #f
et initialiseriez les mots
de passe utilisateurs en tant que root
avec la commande
passwd
, puis laisseriez l’utilisateur le changer avec
passwd
. Les mots de passes définis avec passwd
sont
bien sûr préservés après redémarrage et reconfiguration.
Si vous voulez vraiment définir un mot de passe pour un compte, alors
ce champ doit contenir le mot de passe chiffré, comme une chaîne de
caractère. Vous pouvez utiliser la procédure crypt
pour cela :
(user-account
(name "charlie")
(group "users")
;; Spécifie un mot de passe initial hashé avec sha512.
(password (crypt "InitialPassword!" "$6$abc")))
Remarque : Le hash de ce mot de passe initial sera disponible dans un fichier dans /gnu/store, lisible par tous les utilisateurs, donc cette méthode est à utiliser avec soin.
Voir Passphrase Storage dans The GNU C Library Reference Manual, pour
plus d’information sur le chiffrement des mots de passe et
Encryption dans GNU Guile Reference Manual, pour des informations
sur la procédure crypt
de Guile.
Les déclarations de groupes sont encore plus simple :
(user-group (name "students"))
C’est le type pour, hé bien, les comptes utilisateurs. Il n’y a que quelques champs :
name
Le nom du groupe.
id
(par défaut : #f
)L’identifiant du groupe (un nombre). S’il est #f
, un nouveau nombre
est alloué automatiquement lorsque le groupe est créé.
system?
(par défaut : #f
)Cette valeur booléenne indique si le groupe est un groupe « système ». les groupes systèmes ont un numéro d’ID bas.
password
(par défaut : #f
)Quoi, les groupes utilisateurs peuvent avoir des mots de passe ? On dirait
bien. À moins que la valeur ne soit #f
, ce champ spécifie le mot de
passe du groupe.
Par simplicité, une variable liste les groupes utilisateurs de base auxquels on pourrait s’attendre :
C’est la liste des groupes utilisateur de base que les utilisateurs et les paquets s’attendent à trouver sur le système. Cela comprend des groupes comme « root », « wheel » et « users », ainsi que des groupes utilisés pour contrôler l’accès à certains périphériques, comme « audio », « disk » et « cdrom ».
C’est la liste des compte du système de base que les programmes peuvent s’attendre à trouver sur un système GNU/Linux, comme le compte « nobody ».
Remarquez que le compte « root » n’est pas défini ici. C’est un cas particulier et il est automatiquement ajouté qu’il soit spécifié ou non.
Suivant: Régionalisation, Précédent: Comptes utilisateurs, Monter: Configuration du système [Table des matières][Index]
Pour spécifier ce que fait chaque touche de votre clavier, vous devez dire au système d’exploitation quel disposition du clavier vous voulez utiliser. Par défaut, lorsque rien n’est spécifié, la disposition QWERTY pour l’anglais américain pour les claviers 105 touches est utilisée. Cependant, les germanophones préfèrent généralement la disposition QWERTZ, les francophones la disposition AZERTY etc. ; les hackers peuvent préférer Dvorak ou bépo, et peuvent même vouloir personnaliser plus en détails l’effet de certaines touches. Cette section explique comment faire cela.
Il y a trois composants qui devront connaître votre disposition du clavier :
keyboard-layout
). C’est utile si vous voulez par exemple vous
assurer que vous pouvez saisir la phrase de passe de votre partition racine
chiffrée avec la bonne disposition.
keyboard-layout
).
keyboard-layout
).
Guix vous permet de configurer les trois séparément mais, heureusement, il vous permet de partager la même disposition du clavier pour chacun des trois composants.
Les dispositions de clavier sont représentées par des enregistrements créés
par la procédure keyboard-layout
de (gnu system keyboard)
. En
suivant l’extension clavier de X (XKB), chaque disposition a quatre
attributs : un nom (souvent un code de langue comme « fi » pour le finnois
ou « jp » pour le japonais), un nom de variante facultatif, un nom de modèle
de clavier facultatif et une liste éventuellement vide d’options
supplémentaires. Dans la plupart des cas, vous n’aurez besoin que du nom de
la disposition.
Renvoie une nouvelle disposition de clavier avec les nom et variante donnés.
nom doit être une chaine comme "fr"
; variante doit être
une chaine comme "bepo"
ou "nodeadkeys"
. Vois le paquet
xkeyboard-config
pour les options valides.
Voici quelques exemples :
;; La disposition QWERTZ allemande. Ici on suppose que vous utilisez un clavier ;; type « pc105 » standard. (keyboard-layout "de") ;; La variante bépo de la disposition française. (keyboard-layout "fr" "bepo") ;; La disposition catalane. (keyboard-layout "es" "cat") ;; Disposition du clavier en langue arabe avec « Alt-Shift » pour passer à la mise en page US. (keyboard-layout "ar,us" #:options '("grp:alt_shift_toggle")) ;; La disposition espagnole américaine. En plus, la touche ;; « Verr. Maj. » est utilisée comme touche « Ctrl » supplémentaire, ;; et la touche « Menu » est utilisée comme touche « Compose » pour ;; saisir des lettres accentuées. (keyboard-layout "latam" #:options '("ctrl:nocaps" "compose:menu")) ;; La disposition russe pour un clavier de ThinkPad. (keyboard-layout "ru" #:model "thinkpad") ;; La disposition « US internationale », qui est comme la disposition US plus ;; des touches mortes pour saisir des caractères accentués. Cet exemple est pour ;; un clavier de MacBook Apple. (keyboard-layout "us" "intl" #:model "macbook78")
Voir le répertoire share/X11/xkb du paquet xkeyboard-config
pour une liste complète des disposition, des variantes et des modèles pris
en charge.
Disons que vous voulez que votre système utilise la disposition turque sur tout le système — du chargeur d’amorçage à Xorg en passant par la console. Voici ce que votre configuration du système contiendrait :
;; Utiliser la disposition turque pour le chargeur d'amorçage, ;; la console et Xorg. (operating-system ;; ... (keyboard-layout (keyboard-layout "tr")) ;pour la console (bootloader (bootloader-configuration (bootloader grub-efi-bootloader) (targets '("/boot/efi")) (keyboard-layout keyboard-layout))) ;pour GRUB (services (cons (set-xorg-configuration (xorg-configuration ;pour Xorg (keyboard-layout keyboard-layout))) %desktop-services)))
Dans l’exemple ci-dessus, pour GRUB et pour Xorg, nous nous référons
simplement au champ keyboard-layout
au dessus, mais on pourrait aussi
bien se référer à une autre disposition. La procédure
set-xorg-configuration
communique la configuration Xorg désirée au
gestionnaire de connexion, par défaut GDM.
Nous avons discuté de la manière de spécifier la disposition du clavier par défaut lorsque votre système démarre, mais vous pouvez aussi l’ajuster à l’exécution :
sexkbmap
(du paquet du même nom) vous
permet de changer la disposition actuelle. Par exemple, voilà comment
changer la disposition pour un Dvorak américain :
setxkbmap us dvorak
loadkey
change la disposition du clavier dans la console
Linux. Cependant, remarque que loadkeys
n’utilise pas la
catégorisation des dispositions XKB décrite plus haut. La commande suivante
charge la disposition bépo française :
loadkeys fr-bepo
Suivant: Services, Précédent: Disposition du clavier, Monter: Configuration du système [Table des matières][Index]
Un paramètre linguistique définie les conventions culturelles d’une
langue et d’une région particulières (voir Locales dans The GNU C
Library Reference Manual). Chaque paramètre linguistique a un nom de la
forme langue_territoire.jeudecaractères
— p.
ex. fr_LU.utf8
désigne le paramètre linguistique pour le français,
avec les conventions culturelles du Luxembourg, en utilisant l’encodage
UTF-8.
Normalement, vous voudrez spécifier les paramètres linguistiques par défaut
pour la machine en utilisant le champ locale
de la déclaration
operating-system
(voir locale
).
Les paramètres régionaux choisis sont automatiquement ajoutés aux
définitions des paramètres régionaux connues par le système au besoin,
avec le jeu de caractères inféré à partir de son nom, p. ex.
bo_CN.utf8
supposera qu’il faut utiliser le jeu de caractères
UTF-8
. Des définitions supplémentaires peuvent être spécifiées dans
le champ locale-definitions
de operating-system
— c’est utile
par exemple si le jeu de caractères n’a pas été inféré à partir du nom.
L’ensemble par défaut de définitions comprend certains paramètres
linguistiques parmi les plus utilisés, mais pas toutes les variantes
disponibles, pour gagner de la place.
Par exemple, pour ajouter les paramètres pour le frison septentrional en Allemagne, la valeur de ce champ serait :
(cons (locale-definition
(name "fy_DE.utf8") (source "fy_DE"))
%default-locale-definitions)
De me, pour gagner de la place, on peut vouloir lister dans
locale-definitions
seulement les paramètres qui sont vraiment
utilisés, comme dans :
(list (locale-definition
(name "ja_JP.eucjp") (source "ja_JP")
(charset "EUC-JP")))
Les définitions compilées de locale sont disponibles à
/run/current-system/locale/X.Y, où X.Y
est la version de la
libc, qui est l’emplacement par défaut où la GNU libc fournie par Guix
recherche les données locales. Il est possible d’y remédier en utilisant la
variable d’environnement LOCPATH
(voir LOCPATH
et les paquets locaux).
La forme locale-definition
est fournie par le module (gnu
system locale)
. Des détails sont disponibles plus bas.
C’est le type de données d’une définition de paramètres linguistiques.
name
Le nom du paramètre linguistique. Voir Locale Names dans The GNU C Library Reference Manual, pour en savoir plus sur les noms de paramètres linguistiques.
source
Le nom de la source pour ce paramètre linguistique. C’est typiquement la
partie langue_territoire
du nom du paramètre.
charset
(par défaut : "UTF-8"
)Le « jeu de caractères » d’un paramètre linguistique, défini par l’IANA.
Une liste des paramètres linguistiques UTF-8 couramment utilisés, utilisée
comme valeur par défaut pour le champ locale-definitions
des
déclarations operating-system
.
Ces définitions de paramètres linguistiques utilisent le jeu de
caractère normalisé pour la partie qui suit le point dans le nom
(voir normalized codeset dans The GNU C
Library Reference Manual). Donc par exemple il y a uk_UA.utf8
mais
pas, disons, uk_UA.UTF-8
.
Les déclaration operating-system
fournissent un champ
locale-libcs
pour spécifier les paquets GNU libc à utiliser pour
compiler les déclarations de paramètres linguistiques
(voir Référence de operating-system
). « Pourquoi je devrais m’en soucier ?
», vous demandez-vous sûrement. Hé bien il se trouve que le format binaire
des données linguistique est parfois incompatible d’une version de la libc à
une autre.
Par exemple, un programme lié à la version 2.21 de la libc est incapable de
lire les données locales produites avec la libc 2.22 ; pire encore, ce
programme aborts au lieu d’ignorer simplement les données locales
incompatibles33. De même, un programme lié à la libc 2.22 peut lire la
plupart des données locales de la libc 2.21, mais pas toutes (en
particulier, les données LC_COLLATE
sont incompatibles) ; ainsi, les
appels à setlocale
peuvent échouer, mais les programmes ne
s’arrêteront pas.
Le « problème » avec Guix c’est que les utilisateurs ont beaucoup de liberté : ils peuvent choisir s’ils veulent et quand ils veulent mettre à jour les logiciels de leur profil, et peuvent utiliser une version différente de la libc de celle que l’administrateur système utilise pour construire les données linguistiques du système global.
Heureusement, les utilisateur·rice·s non privilégié·e·s peuvent aussi
installer leurs propres données linguistiques et définir GUIX_LOCPATH
comme il le faut (voir GUIX_LOCPATH
and locale
packages).
Cependant, c’est encore mieux si les données linguistiques du système dans
/run/current-system/locale étaient construites avec les versions de
la libc utilisées sur le système, pour que tous les programmes puissent y
accéder — c’est surtout crucial sur un système multi-utilisateurs. Pour
cela, l’administrateur peut spécifier plusieurs paquets de la libc dans le
champ locale-libcs
de operating-system
:
(use-package-modules base) (operating-system ;; … (locale-libcs (list glibc-2.21 (canonical-package glibc))))
Cet exemple créera un système contenant les définitions des paramètres linguistiques pour la libc 2.21 et pour la version actuelle de la libc dans /run/current-system/locale.
Suivant: Privileged Programs, Précédent: Régionalisation, Monter: Configuration du système [Table des matières][Index]
Une part importante de la préparation d’une déclaration
operating-system
est la liste des services systèmes et de leur
configuration (voir Utiliser le système de configuration). Les services
systèmes sont typiquement des démons lancés au démarrage ou d’autres actions
requises à ce moment-là — p. ex. configurer les accès réseaux.
Guix a une définition large de « service » (voir Composition de services),
mais beaucoup de services sont gérés par le GNU Shepherd
(voir Services Shepherd). Sur un système lancé, la commande
herd
vous permet de lister les services disponibles, montrer leur
statut, les démarrer et les arrêter, ou faire d’autres opérations
spécifiques (voir Jump Start dans The GNU Shepherd Manual). Par
exemple :
# herd status
La commande ci-dessus, lancée en root
, liste les services
actuellement définis. La commande herd doc
montre un synopsis du
service donné et ses actions associées :
# herd doc nscd Run libc's name service cache daemon (nscd). # herd doc nscd action invalidate invalidate: Invalidate the given cache--e.g., 'hosts' for host name lookups.
Les sous-commandes start
, stop
et restart
ont
l’effet auquel on s’attend. Par exemple, les commande suivantes stoppent le
service nscd et redémarrent le serveur d’affichage Xorg :
# herd stop nscd Service nscd has been stopped. # herd restart xorg-server Service xorg-server has been stopped. Service xorg-server has been started.
Pour certains services, herd configuraiton
renvoie le nom du
fichier de configuration du service, ce qui peut être pratique pour
inspecter sa configuration :
# herd configuration sshd /gnu/store/…-sshd_config
Les sections suivantes documentent les services disponibles, en commençant
par les services de base qui peuvent être utilisés avec une déclaration
operating-system
.
Suivant: Exécution de tâches planifiées, Monter: Services [Table des matières][Index]
Le module (gnu services base)
fournit des définitions de services
pour les services de base qu’on peut attendre du système. Les services
exportés par ce module sort listés ci-dessous.
Cette variable contient une liste de services de base (voir Types service et services, pour plus d’informations sur les objets service) qu’on peut attendre du système : un service de connexion (mingetty) sur chaque tty, syslogd, le démon de cache de noms de la libc (nscd), le gestionnaire de périphériques udev, et plus.
C’est la valeur par défaut du champ services
des déclarations
operating-system
. Habituellement, lors de la personnalisation d’un
système, vous voudrez ajouter des services à ceux de %base-services
,
comme ceci :
C’est le service qui met en place des « fichiers spéciaux » comme
/bin/sh ; une instance de ce service fait partie de
%base-services
.
The value associated with special-files-service-type
services must be
a list of two-element lists where the first element is the “special file”
and the second element is its target. By default it is:
`(("/bin/sh" ,(file-append bash "/bin/sh")) ("/usr/bin/env" ,(file-append coreutils "/bin/env")))
Si vous voulez ajouter, disons, /bin/bash
à votre système, vous
pouvez changer cela en :
`(("/bin/sh" ,(file-append bash "/bin/sh")) ("/usr/bin/env" ,(file-append coreutils "/bin/env")) ("/bin/bash" ,(file-append bash "/bin/bash")))
Comme cela fait partie de %base-services
, vous pouvez utiliser
modify-services
pour personnaliser l’ensemble des fichiers spéciaux
(voir modify-services
). Mais la manière la
plus simple d’ajouter un fichier spécial est via la procédure
extra-special-file
(voir ci-dessous).
Utilise target comme « fichier spécial » file.
Par exemple, ajouter l’une des lignes suivantes au champ services
de
votre déclaration de système d’exploitation crée un lien symbolique
/usr/bin/env :
(extra-special-file "/usr/bin/env"
(file-append coreutils "/bin/env"))
This procedure is meant for /bin/sh
, /usr/bin/env
and similar
targets. In particular, use for targets under /etc
might not work as
expected if the target is managed by Guix in other ways.
Type of the service that sets the system host name, whose value is a
string. This service is included in operating-system
by default
(voir essential-services
).
Installez les polices données sur les ttys spécifiés (les polices sont par
console virtuelle sur le noyau Linux). La valeur de ce service est une
liste de paires tty/polices. La police peut être le nom d’une police
fournie par le paquet kbd
ou tout argument valide de
setfont
, comme dans cet exemple :
`(("tty1" . "LatGrkCyr-8x16") ("tty2" . ,(file-append font-tamzen "/share/kbd/consolefonts/TamzenForPowerline10x20.psf")) ("tty3" . ,(file-append font-terminus "/share/consolefonts/ter-132n"))) ; pour HDPI
Type of the service that populates the entries for (/etc/hosts).
This service type can be extended by passing it a list of host
records.
The example below shows how to add two entries to /etc/hosts:
(simple-service 'add-extra-hosts
hosts-service-type
(list (host "192.0.2.1" "example.com"
'("example.net" "example.org"))
(host "2001:db8::1" "example.com"
'("example.net" "example.org"))))
Remarque : By default /etc/hosts comes with the following entries:
127.0.0.1 localhost host-name ::1 localhost host-nameFor most setups this is what you want though if you find yourself in the situation where you want to change the default entries, you can do so in
operating-system
viamodify-services
(voirmodify-services
).The following example shows how to unset host-name from being an alias of
localhost
.(operating-system ;; … (essential-services (modify-services (operating-system-default-essential-services this-operating-system) (hosts-service-type config => (list (host "127.0.0.1" "localhost") (host "::1" "localhost"))))))
Return a new record for the host at address with the given canonical-name and possibly aliases.
address must be a string denoting a valid IPv4 or IPv6 address, and canonical-name and the strings listed in aliases must be valid host names.
Type of the service that provides a console login service, whose value is a
<login-configuration>
object.
Data type representing the configuration of login, which specifies the MOTD (message of the day), among other things.
motd
¶Un objet simili-fichier contenant le « message du jour ».
allow-empty-passwords?
(par défaut : #t
)Permet les mots de passes vides par défaut pour que les utilisateurs puissent se connecter au compte « root » la première fois après sa création.
Type of the service that runs Mingetty, an implementation of the virtual
console log-in. The value for this service is a
<mingetty-configuration>
object.
Data type representing the configuration of Mingetty, which specifies the tty to run, among other things.
tty
Le nom de la console sur laquelle tourne ce Mingetty, p. ex.
"tty1"
.
auto-login
(par défaut : #f
)Lorsque la valeur est vraie, ce champ doit être une chaîne de caractère
dénotant le nom d’utilisateur pour lequel le système se connecte
automatiquement. Lorsque la valeur est #f
, il faut entrer un nom
d’utilisateur et un mot de passe pour se connecter.
login-program
(par défaut : #f
)Ce doit être soit #f
, auquel cas le programme de connexion par défaut
est utilisé (login
de la suite d’outils Shadow), soit une gexp
dénotant le nom d’un programme de connexion.
login-pause?
(par défaut : #f
)Lorsque la valeur est #t
en plus de auto-login, l’utilisateur
devrai appuyer sur une touche avant que le shell de connexion ne soit lancé.
clear-on-logout?
(par défaut : #t
)Lorsque la valeur est #t
, l’écran sera nettoyé après la déconnexion.
mingetty
(par défaut : mingetty)Le paquet Mingetty à utiliser.
Type of the service that runs agetty, which implements virtual and serial
console log-in. The value for this service is a
<agetty-configuration>
object.
Data type representing the configuration of agetty, which specifies the tty to run, among other things34.
tty
Le nom de la console sur laquelle cet agetty fonctionne, sous forme de
chaîne de caractères, par exemple "ttyS0"
. Cet argument est
optionnel, il sera par défaut un port série raisonnable par défaut utilisé
par le noyau Linux.
Pour cela, s’il y a une valeur pour une option agetty.tty
sur la
ligne de commande du noyau, agetty extraira le nom du périphérique du port
série à partir de cette option.
Sinon et s’il y a une valeur pour une option console
avec un tty sur
la ligne de commande du noyau Linux, agetty extraira le nom du périphérique
du port série et l’utilisera.
Dans les deux cas, agetty laissera les autres paramètres du périphérique série (baud, etc.) sans y toucher — dans l’espoir que Linux leur a assigné les bonnes valeurs.
baud-rate
(par défaut : #f
)Une chaîne qui contient une liste d’un ou plusieurs taux de baud séparés par des virgules, en ordre décroissant.
term
(par défaut : #f
)Une chaîne de caractères contenant la valeur utilisée pour la variable
d’environnement TERM
.
eight-bits?
(par défaut : #f
)Lorsque la valeur est #t
, le tty est supposé être propre pour les
caractères 8-bit et la détection de parité est désactivée.
auto-login
(par défaut : #f
)Lorsqu’un nom de connexion est passé comme une chaîne de caractères, l’utilisateur spécifié sera automatiquement connecté sans demande du nom d’utilisateur ni du mot de passe.
no-reset?
(par défaut : #f
)Lorsque la valeur est #t
, ne vide pas les cflags du terminal (modes
de contrôle).
host
(par défaut : #f
)Ceci accepte une chaîne de caractères contenant le "login_host", qui sera écrite dans le fichier /var/run/utmpx.
remote?
(par défaut : #f
)Lorsque la valeur est #t
en plus de host, cette option ajoutera
une option fakehost -r
à la ligne de commande du programme de
connexion spécifié dans login-program.
flow-control?
(par défaut : #f
)Lorsque la valeur est #t
, active le contrôle de flux matériel
(RTS/CTS).
no-issue?
(par défaut : #f
)Lorsque la valeur est #t
, le contenu du fichier /etc/issue ne
sera pas affiché avant de présenter l’écran de connexion.
init-string
(par défaut : #f
)Cette option accepte une chaîne de caractères qui sera envoyée au tty ou au modem avant toute autre chose. Elle peut être utilisée pour initialiser un modem.
no-clear?
(par défaut : #f
)Lorsque la valeur est #t
, agetty ne nettoiera pas l’écran avant de
montrer l’écran de connexion.
login-program
(par défaut : (file-append shadow "/bin/login"))Cette option doit être soit une gexp dénotant le nom d’un programme de
connexion, soit non définie, auquel cas la valeur par défaut est la commande
login
de la suite d’outils Shadow.
local-line
(par défaut : #f
)Contrôle le drapeau CLOCAL. Cette option accepte l’un des trois symboles
comme argument, 'auto
, 'always
ou 'never
. Si la valeur
est #f
, la valeur par défaut choisie par agetty est 'auto
.
extract-baud?
(par défaut : #f
)Lorsque la valeur est #t
, dit à agetty d’essayer d’extraire la taux
de baud depuis les messages de statut produits par certains modems.
skip-login?
(par défaut : #f
)Lorsque la valeur est #t
, ne demande par de nom d’utilisateur. Elle
peut être utilisée avec le champ login-program pour utiliser des
systèmes de connexion non standards.
no-newline?
(par défaut : #f
)Lorsque la valeur est #t
, n’affiche pas de retour à la ligne avant
d’afficher le fichier /etc/issue.
login-options
(par défaut : #f
)Cette option accepte une chaîne de caractères contenant des options passées au programme login. Lorsqu’utilisé avec login-program, soyez conscient qu’un utilisateur malicieux pourrait essayer de rentrer un nom d’utilisateur contenant des options incluses qui pourraient être analysées par le programme de connexion.
login-pause
(par défaut : #f
)Lorsque la valeur est #t
, attend qu’une touche soit appuyée avant de
montrer l’écran de connexion. Cela peut être utilisé avec auto-login
pour sauvegarder de la mémoire en lançant les shells de manière fainéante.
chroot
(par défaut : #f
)Change de racine dans le répertoire donné. Cette option accepte un chemin en tant que chaîne de caractères.
hangup?
(par défaut : #f
)Utilise l’appel système Linux vhangup
pour raccrocher virtuellement
le terminal spécifié.
keep-baud?
(par défaut : #f
)Lorsque la valeur est #t
, essaye de garder le taux de baud existant.
Les taux de baud de baud-rate sont utilisés lorsque agetty reçoit un
caractères BREAK.
timeout
(par défaut : #f
)Lorsque la valeur est un nombre entier, termine la session si aucun nom d’utilisateur n’a pu être lu après timeout secondes.
detect-case?
(par défaut : #f
)Lorsque la valeur est #t
, active le support pour la détection des
terminaux en majuscule uniquement. Ce paramètre détectera qu’un nom
d’utilisateur qui ne contient que des majuscules indique un terminal en
majuscule et effectuera des conversion de majuscule en minuscule. Remarquez
que cela ne fonctionne pas avec les caractères unicode.
wait-cr?
(par défaut : #f
)Lorsque la valeur est #t
, attend que l’utilisateur ou le modem envoie
un retour chariot ou un saut de ligne avant d’afficher /etc/issue ou
l’écran de connexion. Cela est typiquement utilisé avec l’option
init-string.
no-hints?
(par défaut : #f
)Lorsque la valeur est #t
, n’affiche par les astuces à propos des
verrouillages numériques, majuscule et défilement.
no-hostname?
(par défaut : #f
)Par défaut, le nom d’hôte est affiché. Lorsque la valeur est #t
,
aucun nom d’hôte ne sera affiché.
long-hostname?
(par défaut : #f
)Par défaut, le nom d’hôte n’est affiché qu’après le premier point. Lorsque
la valeur est #t
, le nom d’hôte pleinement qualifié renvoyé par
gethostname
ou getaddrinfo
sera affiché.
erase-characters
(par défaut : #f
)Cette option accepte une chaîne de caractères de caractères supplémentaires qui devraient être interprétés comme des effacements lorsque l’utilisateur les tape dans leur nom d’utilisateur.
kill-characters
(par défaut : #f
)Cette option accepte une chaîne de caractères qui devrait être interprétée comme signifiant « ignore tous les caractères précédents » (aussi appelé un caractère « kill ») lorsque l’utilisateur·rice tape son nom d’utilisateur·rice.
chdir
(par défaut : #f
)Cette option accepte, en tant que chaîne de caractères, un chemin vers un répertoire dans lequel se trouvera la commande avant la connexion.
delay
(par défaut : #f
)Cette option accepte, en tant qu’entier, le nombre de secondes à attendre avant d’ouvrir le tty et afficher l’écran de connexion.
nice
(par défaut : #f
)Cette option accepte, en tant qu’entier, la valeur « nice » avec laquelle le
programme login
tourne.
extra-options
(par défaut : '()
)Cette option fournit un « mécanisme de secours » pour que l’utilisateur·rice
puisse ajouter des arguments arbitraires en ligne de commande à
agetty
comme une liste de chaînes de caractères.
rshepherd-equirement
(par défaut : '()
)L’option peut être utilisée pour fournir des prérequis shepherd
supplémentaires (par exemple 'syslogd
) aux services shepherd
'term-
* correspondants.
Type of the service that runs
kmscon, which
implements virtual console log-in. The value for this service is a
<kmscon-configuration>
object.
Data type representing the configuration of Kmscon, which specifies the tty to run, among other things.
virtual-terminal
Le nom de la console sur laquelle Kmscon tourne, p. ex. "tty1"
.
login-program
(par défaut : #~(string-append #$shadow "/bin/login")
)Une gexp qui dénote le nom d’un programme de connexion. le programme de
connexion par défaut est login
de la suite d’outils Shadow.
login-arguments
(par défaut : '("-p")
)Une liste d’arguments à passer à login
.
auto-login
(par défaut : #f
)Lorsqu’un nom de connexion est passé comme une chaîne de caractères, l’utilisateur spécifié sera automatiquement connecté sans demande du nom d’utilisateur ni du mot de passe.
hardware-acceleration?
(par défaut : #f)S’il faut utiliser l’accélération matérielle.
font-engine
(par défaut : "pango"
)Moteur de polices utilisé dans Kmscon.
font-size
(par défaut : 12
)Taille de police utilisée par Kmscon.
keyboard-layout
(par défaut : #f
)Si la valeur est #f
, Kmscon utilise la disposition du clavier par
défaut — habituellement la disposition anglaise américaine (« qwerty ») pour
un clavier de PC à 105 touches.
Sinon cela doit être un objet keyboard-layout
spécifiant la
disposition du clavier. Voir Disposition du clavier pour plus d’informations sur
la manière de spécifier la disposition du clavier.
kmscon
(par défaut : kmscon)Le paquet Kmscon à utiliser.
Type of the service that runs the libc nscd (name service cache
daemon), whose value is an <nscd-configuration>
object.
Parce que c’est pratique, le service du Shepherd pour nscd fournit les actions suivantes :
invalidate
¶Cela invalide le cache donné. Par exemple, en laçant :
herd invalidate nscd hosts
on invalide le cache de noms d’hôtes de nscd.
statistiques
Lancer herd statistics nscd
affiche des informations sur
l’utilisation de nscd et des caches.
Data type representing the nscd (name service cache daemon) configuration.
name-services
(par défaut : '()
)Liste des paquets dénotant des services de noms qui doivent être
visible pour nscd, p. ex. (list nss-mdns)
.
glibc
(par défaut : glibc)Objet de paquet qui dénote la Bibliothèque C de GNU qui fournit la commande
nscd
.
log-file
(par défaut : #f
)Name of the nscd log file. Debugging output goes to that file when
debug-level
is strictly positive, or to standard error if it is
#f
. Regular messages are written to syslog when debug-level
is zero, regardless of the value of log-file
.
debug-level
(par défaut : 0
)Entier qui dénote le niveau de débogage. Les entiers les plus grands signifient plus de sortie de débogage.
caches
(par défaut : %nscd-default-caches
)Liste d’objets <nscd-cache>
qui dénotent des choses à mettre en cache
; voir plus bas.
Type de données représentant une base de données de cache de nscd et ses paramètres.
database
C’est un symbole qui représente le nom de la base de donnée à mettre en
cache. Les valeurs valide sont passwd
, group
, hosts
et
services
qui désignent les bases de données NSS correspondantes
(voir NSS Basics dans The GNU C Library Reference Manual).
positive-time-to-live
negative-time-to-live
(par défaut : 20
)Un entier qui représente le nombre de secondes pendant lesquelles un résultat positif ou négatif reste en cache.
check-files?
(par défaut : #t
)Indique s’il faut vérifier des mises à jours dans les fichiers correspondant à database.
Par exemple, lorsque database est hosts
, ce drapeau indique à
nscd de vérifier s’il y a des mises à jour de /etc/hosts et de les
prendre en compte.
persistent?
(par défaut : #t
)Indique si le cache devrait être stocké de manière persistante sur le disque.
shared?
(par défaut : #t
)Indique si le cache devrait être partagé entre les utilisateurs.
max-database-size
(par défaut : 32 MiB)Taille maximale en octets de la base de données en cache.
Liste d’objets <nscd-cache>
utilisés par défaut par
nscd-configuration
(voir plus haut).
Elle active la mise en cache persistante et agressive des recherches de services et de noms d’hôtes. Ces derniers fournissent une recherche de noms d’hôtes plus performante, résiliente face à des serveurs de noms peu fiables et une protection de votre vie privée plus efficace — souvent le résultat des recherches de noms d’hôtes sont dans le cache local, donc les serveurs de nom externes n’ont même pas besoin d’être questionnés.
Type of the service that runs the syslog daemon, whose value is a
<syslog-configuration>
object.
To have a modified syslog-configuration
come into effect after
reconfiguring your system, the ‘reload’ action should be preferred to
restarting the service, as many services such as the login manager depend on
it and would be restarted as well:
# herd reload syslog
which will cause the running syslogd
process to reload its
configuration.
Data type representing the configuration of the syslog daemon.
syslogd
(par défaut : #~(string-append #$inetutils "/libexec/syslogd")
)Le démon syslog à utiliser.
config-file
(par défaut : %default-syslog.conf
)The syslog configuration file to use. Voir syslogd invocation dans GNU Inetutils, for more information on the configuration file syntax.
C’est le type de service qui lance le démon de construction,
guix-daemon
(voir Invoquer guix-daemon
). Sa valeur doit être
un enregistrement guix-configuration
décrit plus bas.
Ce type de données représente la configuration du démon de construction de
Guix. Voir Invoquer guix-daemon
pour plus d’informations.
guix
(par défaut : guix)The Guix package to use. Voir Customizing the System-Wide Guix to learn how to provide a package with a pre-configured set of channels.
build-group
(par défaut : "guixbuild"
)Nom du groupe des comptes utilisateurs de construction.
build-accounts
(par défaut : 10
)Nombre de comptes utilisateurs de construction à créer.
authorize-key?
(par défaut : #t
) ¶Indique s’il faut autoriser ou non les clefs de substituts listées dans
authorize-keys
— par défaut celle de
bordeaux.guix.gnu.org
et ci.guix.gnu.org
(voir Substituts).
Lorsque authorize-key?
est vrai, /etc/guix/acl ne peut pas
être changé en invoquant guix archive --authorize
. vous devez
plutôt ajuster guix-configuration
comme vous le souhaitez et
reconfigurer le système. Cela s’assure que le fichier de configuration de
votre système est auto-contenu.
Remarque : Au démarrage ou la reconfiguration d’un système où
authorize-key?
est vrai, le fichier /etc/guix/acl existant est sauvegardé dans /etc/guix/acl.bak s’il est déterminé qu’il a été modifié manuellement. Cela facilite la migration à partir de versions précédentes, qui permettaient des modifications en-place de /etc/guix/acl.
authorized-keys
(par défaut : %default-authorized-guix-keys
)La liste des fichiers des fichiers de clés autorisées pour les imports
d’archives, en tant que liste de gexps sous forme de chaines
(voir Invoquer guix archive
). Par défaut, elle contient celle de
bordeaux.guix.gnu.org
et ci.guix.gnu.org
(voir Substituts). Voir substitute-urls
ci-dessous pour apprendre
comment la changer.
use-substitutes?
(par défaut : #t
)S’il faut utiliser les substituts.
substitute-urls
(par défaut : %default-substitute-urls
)La liste des URL où trouver des substituts par défaut.
Supposons que vous vouliez récupérer des substituts à partir de
guix.example.org
en plus de bordeaux.guix.gnu.org
. Vous
devrez faire deux choses : (1) ajouter guix.example.org
à
substitute-urls
, et (2) autoriser sa clé de signature, après avoir
effectué les vérifications adéquates (voir Autoriser un serveur de substituts). La configuration ci-dessous fait exactement cela :
(guix-configuration
(substitute-urls
(append (list "https://guix.example.org")
%default-substitute-urls))
(authorized-keys
(append (list (local-file "./guix.example.org-key.pub"))
%default-authorized-guix-keys)))
Cet exemple suppose que le fichier ./guix.example.org-key.pub
contient la clé publique que guix.example.org
utilise pour signer les
substituts.
generate-substitute-keys?
(par défaut : #t
)Indique s’il faut générer une paire de clés de substituts dans /etc/guix/signing-key.pub et /etc/guix/signing-key.sec si elle n’existe pas déjà.
Cette paire de clés est utilisée pour exporter les éléments du dépôt, par
exemple avec guix publish
(voir Invoquer guix publish
) ou
guix archive
(voir Invoquer guix archive
). Générer une paire de
clés prend quelques secondes quand il y a assez d’entropie disponible et
n’est fait qu’une seule fois ; vous pouvez la désactiver par exemple dans
une machine virtuelle qui n’en pas besoin et où le temps de démarrage
supplémentaire peut être problématique.
channels
(default: #f
)List of channels to be specified in /etc/guix/channels.scm, which is
what guix pull
uses by default (voir Invoquer guix pull
).
Remarque : When reconfiguring a system, the existing /etc/guix/channels.scm file is backed up as /etc/guix/channels.scm.bak if it was determined to be a manually modified file. This is to facilitate migration from earlier versions, which allowed for in-place modifications to /etc/guix/channels.scm.
max-silent-time
(default: 3600
)timeout
(default: (* 3600 24)
)Le nombre de secondes de silence et le nombre de secondes d’inactivité, respectivement, après lesquelles un processus de construction son délai d’attente. Une valeur de zéro désactive le délai d’attente.
log-compression
(par défaut : 'gzip
)Le type de compression utilisé par les journaux de construction — parmi
gzip
, bzip2
et none
.
discover?
(par défaut : #f
)Indique s’il faut découvrir les serveurs de substitut sur le réseau local avec mDNS et DNS-SD.
build-machines
(default: #f
)This field must be either #f
or a list of gexps evaluating to a
build-machine
record or to a list of build-machine
records
(voir Utiliser le dispositif de déchargement).
When it is #f
, the /etc/guix/machines.scm file is left
untouched. Otherwise, the list of of gexps is written to
/etc/guix/machines.scm; if a previously-existing file is found, it is
backed up as /etc/guix/machines.scm.bak. This allows you to declare
build machines for offloading directly in the operating system declaration,
like so:
(guix-configuration
(build-machines
(list #~(build-machine (name "foo.example.org") …)
#~(build-machine (name "bar.example.org") …))))
Additional build machines may be added via the guix-extension
mechanism (see below).
extra-options
(par défaut : '()
)Liste d’options supplémentaires de la ligne de commande pour
guix-daemon
.
log-file
(par défaut : "/var/log/guix-daemon.log"
)Le fichier où les sorties standard et d’erreur de guix-daemon
sont
écrites.
http-proxy
(par défaut : #f
)L’URL du proxy HTTP et HTTPS utilisé pour le téléchargement des dérivés et substituts à sortie fixe.
Il est également possible de changer le proxy du démon au moment de
l’exécution grâce à l’action set-http-proxy
, qui le redémarre :
herd set-http-proxy guix-daemon http://localhost:8118
Pour effacer les paramètres du proxy, exécutez :
herd set-http-proxy guix-daemon
tmpdir
(par défaut : #f
)Un répertoire où guix-daemon
effectuera ses constructions.
environment
(par défaut : '()
)Les variables d’environnement à configurer avant de démarrer le démon, en
tant que liste de chaines clé=valeur
.
socket-directory-permissions
(default: #o755
)Permissions to set for the directory /var/guix/daemon-socket. This,
together with socket-directory-group
and
socket-directory-user
, determines who can connect to the build daemon
via its Unix socket. TCP socket operation is unaffected by these.
socket-directory-user
(default: #f
)socket-directory-group
(default: #f
)User and group owning the /var/guix/daemon-socket directory or
#f
to keep the user or group as root.
Ce type de données représente les paramètres du démon de construction de Guix qui peuvent être étendus. C’est le type d’objet qui doit être utilisé dans une extension du service guix. Voir Composition de services, pour plus d’informations.
authorized-keys
(par défaut : '()
)Une liste d’objets simili-fichiers où chaque élément contient une clé publique.
substitute-urls
(par défaut : '()
)Une liste de chaines où chaque élément est l’URL d’un serveur de substituts.
build-machines
(default: '()
)A list of gexps that evaluate to build-machine
records or to a list
of build-machine
records. (voir Utiliser le dispositif de déchargement).
Using this field, a service may add new build machines to receive builds
offloaded by the daemon. This is useful for a service such as
hurd-vm-service-type
, which can make a GNU/Hurd virtual machine
directly usable for offloading (voir hurd-vm-service-type
).
chroot-directories
(par défaut : '()
)Une liste d’objets simili-fichiers ou de chaines pointant vers des répertoires supplémentaires que le démon de construction peut utiliser.
Type of the service that runs udev, a service which populates the
/dev directory dynamically, whose value is a
<udev-configuration>
object.
Since the file names for udev rules and hardware description files matter, the configuration items for rules and hardware cannot simply be plain file-like objects with the rules content, because the name would be ignored. Instead, they are directory file-like objects that contain optional rules in lib/udev/rules.d and optional hardware files in lib/udev/hwdb.d. This way, the service can be configured with whole packages from which to take rules and hwdb files.
The udev-service-type
can be extended with file-like
directories that respect this hierarchy. For convenience, the
udev-rule
and file->udev-rule
can be used to construct udev
rules, while udev-hardware
and file->udev-hardware
can be used
to construct hardware description files.
In an operating-system
declaration, this service type can be
extended using procedures udev-rules-service
and
udev-hardware-service
.
Data type representing the configuration of udev.
udev
(default: eudev
) (type: file-like)Package object of the udev service. This package is used at run-time, when compiled for the target system. In order to generate the hwdb.bin hardware index, it is also used when generating the system definition, compiled for the current system.
rules
(default: ’()) (type: list-of-file-like)List of file-like objects denoting udev rule files under a sub-directory.
hardware
(default: ’()) (type: list-of-file-like)List of file-like objects denoting udev hardware description files under a sub-directory.
Renvoie un fichier de règle udev nommé file-name contenant les règles définie par le littéral contents.
Dans l’exemple suivant, on définie une règle pour un périphérique USB qui sera stockée dans le fichier 90-usb-thing.rules. La règle lance un script à la détection du périphérique USB avec l’identifiant de produit donné.
(define %example-udev-rule
(udev-rule
"90-usb-thing.rules"
(string-append "ACTION==\"add\", SUBSYSTEM==\"usb\", "
"ATTR{product}==\"Example\", "
"RUN+=\"/path/to/script\"")))
Return a udev hardware description file named file-name containing the hardware information contents.
Renvoie un service qui étend udev-service-type
avec rules et
account-service-type
avec groups comme groupes système. Cela
fonctionne en créant un service de type name-udev-rules
, dont
le service renvoyé est une instance.
Nous montrons ici comment cela peut être utilisé pour étendre
udev-service-type
avec la règle précédemment définie
%exemple-udev-rule
.
(operating-system
;; …
(services
(cons (udev-rules-service 'usb-thing %example-udev-rule)
%desktop-services)))
Return a service that extends udev-service-type
with hardware.
The service name is name-udev-hardware
.
Return a udev-rule file named file-name containing the rules defined within file, a file-like object.
L’exemple suivant montre comment utiliser un fichier de règles existant.
(use-modules (guix download) ;pour url-fetch (guix packages) ;pour origin …) (define %android-udev-rules (file->udev-rule "51-android-udev.rules" (let ((version "20170910")) (origin (method url-fetch) (uri (string-append "https://raw.githubusercontent.com/M0Rf30/" "android-udev-rules/" version "/51-android.rules")) (sha256 (base32 "0lmmagpyb6xsq6zcr2w1cyx9qmjqmajkvrdbhjx32gqf1d9is003"))))))
Since guix package definitions can be included in rules in order to
use all their rules under the lib/udev/rules.d sub-directory, then in
lieu of the previous file->udev-rule example, we could have used the
android-udev-rules package which exists in Guix in the (gnu
packages android)
module.
Return a udev hardware description file named file-name containing the rules defined within file, a file-like object.
L’exemple suivant montre comment utiliser le paquet android-udev-rules
pour que l’outil Android adb
puisse détecter les appareils sans
privilège root. Il détaille aussi comment créer le groupe adbusers
,
requis pour le bon fonctionnement des règles définies dans le paquet
android-udev-rules
. Pour créer ce groupe, on doit le définir dans
les supplementary-groups
de la déclaration user-account
ainsi
que dans le champ groups de l’enregistrement operating-system.
(use-modules (gnu packages android) ;pour android-udev-rules (gnu system shadow) ;pour user-group …) (operating-system ;; … (users (cons (user-account ;; … (supplementary-groups '("adbusers" ;for adb "wheel" "netdev" "audio" "video"))))) ;; … (services (cons (udev-rules-service 'android android-udev-rules #:groups '("adbusers")) %desktop-services)))
Conserve de l’ entropie dans %random-seed-file
pour amorcer
/dev/urandom lors du redémarrage. Il essaie également d’amorcer
/dev/urandom à partir de /dev/hwrng lors du démarrage, si
/dev/hwrng existe et est lisible.
C’est le nom du fichier où des octets aléatoires sont sauvegardés par urandom-seed-service pour démarrer /dev/urandom au redémarrage. Sa valeur par défaut est /var/lib/random-seed.
C’est le type du service qui lance GPM, le démon de souris à but général, qui fournit le support de la souris sur la console Linux. GPM permet aux utilisateurs d’utiliser la souris dans la console, entre autres pour sélectionner, copier et coller du texte.
La valeur pour les services de ce type doit être un gpm-configuration
(voir plus bas). Ce service ne fait pas partie de %base-services
.
Type de données représentant la configuration de GPM.
options
(par défaut : %default-gpm-options
)Les options de la ligne de commande à passer à gpm
. L’ensemble
des options par défaut dit à gpm
d’écouter les événements de la
souris dans /dev/input/mice. Voir Command Line dans gpm manual,
pour plus d’informations.
gpm
(par défaut : gpm
)Le paquet GPM à utiliser.
C’est le type de service pour guix publish
(voir Invoquer guix publish
). Sa valeur doit être un objet guix-publish-configuration
décrit plus bas.
Ce service suppose que /etc/guix contient déjà une paire de clefs
créée par guix archive --generate-key
(voir Invoquer guix archive
). Si ce n’est pas le cas, le service ne démarrera pas.
Le type de données représentant la configuration du service guix
publish
.
guix
(par défaut : guix
)Le paquet Guix à utiliser.
port
(par défaut : 80
)Le port TCP sur lequel écouter les connexions.
host
(par défaut : "localhost"
)L’hôte (et donc, l’interface réseau) sur lequel écouter. Utilisez
"0.0.0.0"
pour écouter sur toutes les interfaces réseaux.
advertise?
(par défaut : #f
)Lorsque la valeur est vraie, annonce le service sur le réseau local via le protocole DNS-SD, avec Avahi.
Cela permet aux machines Guix voisines qui ont activé la découverte (voir
guix-configuration
ci-dessus) de découvrir cette instance de
guix publish
et de télécharger des substituts directement à partir
d’elle.
compression
(par défaut : '(("gzip" 3) ("zstd" 3))
)Il s’agit d’une liste de méthodes de compression/numéros de niveau utilisés lors de la compression des substituts. Par exemple, pour compresser tous les substituts avec both lzip au niveau 7 et gzip au niveau 9, écrivez :
'(("lzip" 7) ("gzip" 9))
Le niveau 9 atteint le meilleur taux de compression au détriment d’une
utilisation accrue du CPU, tandis que le niveau 1 atteint une compression
rapide. Voir Invoquer guix publish
, pour plus d’information sur les
méthodes de compression disponibles et les compromis à faire entre elles.
Une liste vide désactive complètement la compression.
nar-path
(par défaut : "nar"
)Le chemin d’URL où les « nars » se trouvent. Voir --nar-path, pour des détails.
cache
(par défaut : #f
)Lorsque la valeur est #f
, désactive le cache et génère les archives à
la demande. Sinon, cela devrait être le nom d’un répertoire — p. ex.
"/var/cache/guix/publish"
— où guix publish
gère le cache
des archives et des métadonnées prêtes à être envoyées. Voir --cache, pour plus d’informations sur les compromis
impliqués.
workers
(par défaut : #f
)Lorsque la valeur est un entier, c’est le nombre de threads de travail
utilisés pour le cache ; lorsque la valeur est #f
, le nombre de
processeurs est utilisé. Voir --workers,
pour plus d’informations.
cache-bypass-threshold
(par défaut : 10 Mio)Lorsque cache
est vrai, c’est la taille maximale en octets d’un
élément du dépôt pour lequel guix publish
peut contourner le cache
s’il n’y est pas. Voir --cache-bypass-threshold, pour plus d’informations.
ttl
(par défaut : #f
)Lorsque la valeur est un entier, il dénote la durée de vie en secondes des archives publiées. Voir --ttl, pour plus d’informations.
negative-ttl
(par défaut : #f
)Lorsque la valeur est un entier, il dénote la durée de vie en secondes pour les réponses négatives. Voir --negative-ttl, pour plus d’informations.
Type of the service that runs rng-tools rngd, whose value is an
<rngd-configuration>
object.
Data type representing the configuration of rngd.
rng-tools
(default: rng-tools
) (type: file-like)Package object of the rng-tools rngd.
device
(default: "/dev/hwrng") (type: string)Path of the device to add to the kernel’s entropy pool. The service will fail if device does not exist.
Type of the service that installs a configuration file for the
pam_limits
module. The value for this service type is a list of
pam-limits-entry
values, which can be used to specify ulimit
limits and nice
priority limits to user sessions. By default, the
value is the empty list.
La définition de limites suivante défini deux limites matérielles et
logicielles pour toutes les sessions connectées des utilisateurs du groupe
realtime
:
(service pam-limits-service-type
(list
(pam-limits-entry "@realtime" 'both 'rtprio 99)
(pam-limits-entry "@realtime" 'both 'memlock 'unlimited)))
La première entrée augment la priorité en temps réel maximale des processus non privilégiés ; la deuxième entrée abandonne les restrictions sur l’espace d’adressage maximal qui peut être verrouillé en mémoire. Ces paramètres sont souvent utilisés sur les systèmes audio temps-réel.
Un autre exemple utile est d’augmenter le nombre maximum de descripteurs de fichiers ouverts qui peuvent être utilisés :
(service pam-limits-service-type
(list
(pam-limits-entry "*" 'both 'nofile 100000)))
Dans l’exemple au-dessus, l’astérisque signifie que la limite s’applique à
tous les utilisateurs. Il est important de s’assurer que la valeur choisie
n’excède pas la valeur maximale du système visible dans le fichier
/proc/sys/fs/file-max, sinon les utilisateurs ne pourront pas se
connecter. Pour plus d’information sur les limites du module
d’authentification grefable (PAM), regardez la page de manuel
‘pam_limits’ du paquet linux-pam
.
greetd
est un démon
de gestion des connexions minimaliste et flexible, qui ne fait aucune
hypothèse sur ce que vous voulez lancer.
Si vous pouvez le lancer depuis votre shell dans un TTY, greetd peut le lancer. S’il peut apprendre à parler un protocole IPC simple basé sur JSON, alors ce peut être un écran d’accueil.
greetd-service-type
fournit l’infrastructure nécessaire pour la
connexion des utilisateurs, ce qui comprend :
greetd
pam-mount
pour monter XDG_RUNTIME_DIR
Voici un exemple pour passer de mingetty-service-type
à
greetd-service-type
et comment vous pouvez le spécifier pour
plusieurs terminaux :
(append
(modify-services %base-services
;; greetd-service-type fournit le srevice PAM « greetd »
(delete login-service-type)
;; et peut être utilisé à la place de mingetty-service-type
(delete mingetty-service-type))
(list
(service greetd-service-type
(greetd-configuration
(terminals
(list
;; on peut rendre n'importe quel terminal actif par défaut
(greetd-terminal-configuration (terminal-vt "1") (terminal-switch #t))
;; on peut créer des environnement sans initialiser XDG_RUNTIME_DIR
;; et même fournir nos propres variables d'environnement
(greetd-terminal-configuration
(terminal-vt "2")
(default-session-command
(greetd-agreety-session
(extra-env '(("MY_VAR" . "1")))
(xdg-env? #f))))
;; on peut utiliser un shell différent au lieu de bash par défaut
(greetd-terminal-configuration
(terminal-vt "3")
(default-session-command
(greetd-agreety-session (command (file-append zsh "/bin/zsh")))))
;; on peut utiliser n'importe quelle autre commande exécutable comme gestionnaire de connexion
(greetd-terminal-configuration
(terminal-vt "4")
(default-session-command (program-file "my-noop-greeter" #~(exit))))
(greetd-terminal-configuration (terminal-vt "5"))
(greetd-terminal-configuration (terminal-vt "6"))))))
;; mingetty-service-type peut être utilisé en parallèle
;; si vous voulez faire cela, n'utilisez pas (delete login-service-type)
;; comme indiqué plus haut
#| (service mingetty-service-type (mingetty-configuration (tty "tty8"))) |#))
La configuration pour greetd-service-type
.
motd
Un objet simili-fichier contenant le « message du jour ».
allow-empty-passwords?
(par défaut : #t
)Permet les mots de passes vides par défaut pour que les utilisateurs puissent se connecter au compte « root » la première fois après sa création.
terminal
(par défaut : '()
)Liste de greetd-terminal-configuration
par terminal pour lequel
greetd
doit démarrer.
greeter-supplementary-groups
(par défaut : '()
)Liste des groupes qui devraient être ajoutés à l’utilisateur
greeter
. Par exemple :
(greeter-supplementary-groups '("seat" "video"))
Remarquez que cet exemple échouera si le groupe seat
n’existe pas.
Enregistrement de la configuration par terminal du service greetd.
greetd
(par défaut : greetd
)Le paquet greetd à utiliser.
config-file-name
Nom du fichier de configuration utilisé pour le démon greetd. En général,
c’est une dérivation générée à partir de la valeur de terminal-vt
.
log-file-name
Nom du fichier de journalisation utilisé par le démon greetd. En général,
c’est un nom généré à partir de la valeur de terminal-vt
.
terminal-vt
(par défaut : ‘"7"’)Le terminal virtuel sur lequel tourner. L’utilisation d’un VT spécifique en évitant les conflits est recommandé.
terminal-switch
(par défaut : #f
)Rend ce terminal actif au démarrage de greetd
.
source-profile?
(par défaut : #t
)Indique s’il faut sourcer /etc/profile et ~/.profile, s’ils existent.
default-session-user
(par défaut : ‘"greeter"’)L’utilisateur à utiliser pour lancer l’écran d’accueil.
default-session-command
(par défaut : (greetd-agreety-session)
)Peut être soit une instance d’une configuration
greetd-agreety-session
ou un objet comme gexp->script
à
utiliser comme écran d’accueil.
Enregistrement de la configuration de l’écran d’accueil agreety de greetd.
agreety
(par défaut : greetd
)Le paquet dans lequel se trouve la commande /bin/agreety
.
command
(par défaut : (file-append bash "/bin/bash"
)La commande à démarrer par /bin/agreety
si la connexion réussi.
command-args
(par défaut : '("-l")
)Les arguments à passer à la commande.
extra-env
(par défaut : '()
)Variables d’environnement supplémentaires à définir à la connexion.
xdg-env?
(par défaut : #t
)If true XDG_RUNTIME_DIR
and XDG_SESSION_TYPE
will be set
before starting command. One should note that, extra-env
variables
are set right after mentioned variables, so that they can be overridden.
Enregistrement de configuration générique de l’écran d’accueil wlgreet de greetd.
wlgreet
(par défaut : wlgreet
)Le paquet dans lequel se trouve la commande /bin/wlgreet
.
command
(par défaut : (file-append sway "/bin/sway"
)La commande à démarrer par /bin/wlgreet
si la connexion réussi.
command-args
(par défaut : '()
)Les arguments à passer à la commande.
output-mode
(par défaut : "all"
)Option à utiliser pour outputMode
dans le fichier de configuration
TOML.
sclae
(par défaut : 1
)Option à utiliser pour scale
dans le fichier de configuration TOML.
background
(par défaut : '(0 0 0 0.9)
)Liste RGBA à utiliser comme couleur de fond pour l’invite de connexion.
headline
(par défaut : '(1 1 1 1)
)Liste RGBA à utiliser comme couleur de titre dans la popup.
prompt
(par défaut : '(1 1 1 1)
)Liste RGBA à utiliser comme couleur d’invite dans la popup.
prompt-error
(par défaut : '(1 1 1 1)
)Liste RGBA à utiliser comme couleur d’erreur dans la popup.
border
(par défaut : '(1 1 1 1)
)Liste RGBA à utiliser comme couleur de bordure de la popup.
extra-env
(par défaut : '()
)Variables d’environnement supplémentaires à définir à la connexion.
Enregistrement de la configuration spécifique à sway, de l’écran d’accueil wlgreet de greetd.
wlgreet-session
(par défaut : (greetd-wlgreet-session)
)Un enregistrement greetd-wlgreet-session
pour la configuration
générale de wlgreet, en plus du greetd-wlgreet-sway-session
spécifique à Sway.
sway
(par défaut : sway
)Le paquet qui fournit la commande /bin/sway
.
sway-configuration
(par défaut : #f
)Objet simili-fichier qui fournit un fichier de configuration Sway supplémentaire à ajouter au début de la partie obligatoire de la configuration.
Voici un exemple de configuration de greetd qui utilise wlgreet et Sway :
(greetd-configuration
;; Nous devons donner ces permissions à l'utilisateur de l'écran d'accueil, sinon
;; Sway plantera au démarrage.
(greeter-supplementary-groups (list "video" "input" "seat"))
(terminals
(list (greetd-terminal-configuration
(terminal-vt "1")
(terminal-switch #t)
(default-session-command
(greetd-wlgreet-sway-session
(sway-configuration
(local-file "sway-greetd.conf"))))))))
Suivant: Rotation des journaux, Précédent: Services de base, Monter: Services [Table des matières][Index]
Le module (gnu services mcron)
fournit une interface pour
GNU mcron, un démon qui lance des tâches planifiées (voir GNU mcron). GNU mcron est similaire au démon Unix
traditionnel cron
; la principale différence est qu’il est
implémenté en Guile Scheme, qui fournit beaucoup de flexibilité lors de la
spécification de la planification des tâches et de leurs actions.
L’exemple en dessous définit un système d’exploitation qui lance les
commandes updatebd
(voir Invoking updatedb dans Finding
Files) et guix gc
(voir Invoquer guix gc
) tous les jours,
ainsi que la commande mkid
en tant qu’utilisateur non privilégié
(voir mkid invocation dans ID Database Utilities). Il utilise des
gexps pour introduire des définitions de tâches qui sont passées à mcron
(voir G-Expressions).
(use-modules (guix) (gnu) (gnu services mcron)) (use-package-modules base idutils) (define updatedb-job ;; Lance « updatedb » à 3h du matin chaque jour. Ici nous spécifions ;; l'action de la tâche comme une procédure Scheme. #~(job '(next-hour '(3)) (lambda () (system* (string-append #$findutils "/bin/updatedb") "--prunepaths=/tmp /var/tmp /gnu/store")) "updatedb")) (define garbage-collector-job ;; Lance le ramasse-miettes tous les jours à minuit cinq. ;; L'action de la tâche est une commande shell. #~(job "5 0 * * *" ;Vixie cron syntax "guix gc -F 1G")) (define idutils-job ;; Met à jour la base de données d'index en tant que « charlie » à 12h15 ;; et 19h15. La commande est lancée depuis le répertoire personnel de l'utilisateur. #~(job '(next-minute-from (next-hour '(12 19)) '(15)) (string-append #$idutils "/bin/mkid src") #:user "charlie")) (operating-system ;; … ;; %BASE-SERVICES inclus déjà une instance de ;; « mcron-service-type », que nous étendons avec un ;; travail supplémentaire avec « simple-service ». (services (cons (simple-service 'my-cron-jobs mcron-service-type (list garbage-collector-job updatedb-job idutils-job)) %base-services)))
Astuce : Lorsque vous fournissez l’action d’une spécification de tâche avec une procédure, vous devriez donner un nom explicite à la tâche via le troisième argument facultatif comme dans l’exemple
updatedb-job
ci-dessus. Sinon, la tâche apparaitra comme « Lambda function » dans la sortie deherd schedule mcron
, ce qui n’est pas très descriptif !
Astuce : Évitez d’appeler les procédures Guile
execl
,execle
etexeclp
dans la spécification des tâches sinon mcron ne pourra pas afficher le statut complet de la tâche.
Pour les tâches plus complexes définies dans Scheme où vous devez contrôler
le haut niveau, par exemple pour introduire un formulaire
use-modules
, vous pouvez déplacer votre code vers un programme séparé
en utilisant la procédure program-file
du module (guix gexp)
(voir G-Expressions). L’exemple ci-dessous illustre cette possibilité.
(define %battery-alert-job
;; Beep when the battery percentage falls below %MIN-LEVEL.
#~(job
'(next-minute (range 0 60 1))
#$(program-file
"battery-alert.scm"
(with-imported-modules (source-module-closure
'((guix build utils)))
#~(begin
(use-modules (guix build utils)
(ice-9 popen)
(ice-9 regex)
(ice-9 textual-ports)
(srfi srfi-2))
(define %min-level 20)
(setenv "LC_ALL" "C") ; assure que la sortie est en anglais
(and-let* ((input-pipe (open-pipe*
OPEN_READ
#$(file-append acpi "/bin/acpi")))
(output (get-string-all input-pipe))
(m (string-match "Discharging, ([0-9]+)%" output))
(level (string->number (match:substring m 1)))
((< level %min-level)))
(format #t "warning: Battery level is low (~a%)~%" level)
(invoke #$(file-append beep "/bin/beep") "-r5")))))))
Voir mcron job specifications dans GNU mcron, pour plus d’informations sur les spécifications des tâche de mcron. Ci-dessous est la référence du service mcron.
Sur un système lancé, vous pouvez utiliser l’action schedule
du
service pour visualiser les travaux mcron qui seront exécutés ensuite :
# herd schedule mcron
Cet exemple ci-dessus montre les cinq tâches qui seront exécutés, mais vous pouvez spécifier le nombre de tâches à afficher :
# herd schedule mcron 10
C’est le type du service mcron
, dont la valeur est un objet
mcron-configuration
.
Ce type de service peut être la cible d’une extension de service qui fournit des spécifications de tâches supplémentaires (voir Composition de services). En d’autres termes, il est possible de définir des services qui fournissent des tâches mcron à lancer.
Les champs de mcron-configuration
disponibles sont :
mcron
(par défaut : mcron
) (type : simili-fichier)Le paquet mcron à utiliser.
jobs
(par défaut : '()
) (type : liste-de-gexps)C’est la liste des gexps (voir G-Expressions), où chaque gexp correspond à une spécification de tâche de mcron (voir mcron job specifications dans GNU mcron).
log?
(par défaut : #t
) (type : booléen)Journalise les messages sur la sortie standard.
log-file
(par défaut : "/var/log/mcron.log"
) (type : chaine)Log file location.
log-format
(par défaut : "~1@*~a ~a: ~a~%"
) (type : chaine)Chaine de format (ice-9 format)
pour les message de journaux. La
valeur par défaut produit des messages de type ‘pid name:
message’ (voir Invoking dans GNU mcron). Chaque message est aussi préfixé par un horodatage
par le GNU Shepherd.
date-format
(type : peut-être-chaine)(srfi srfi-19)
format string for date.
Suivant: Configuration du réseau, Précédent: Exécution de tâches planifiées, Monter: Services [Table des matières][Index]
Les fichiers journaux comme ceux qui se trouvent dans /var/log ont
tendance à grandir sans fin, donc c’est une bonne idée de le faire
tourner de temps à autres — c.-à-d. archiver leur contenu dans des
fichiers séparés, potentiellement compressés. Le module (gnu services
admin)
fournit une interface pour GNU Rot[t]log, un outil de rotation
de journaux (voir GNU Rot[t]log Manual).
Ce service fait partie de %base-services
, et se trouve donc activé
par défaut, avec les paramètres par défaut, pour les fichiers journaux les
plus fréquemment rencontrés. L’exemple ci-dessous montre comment l’étendre
avec une rotation supplémentaire, si vous devez le faire
(généralement, les services qui produisent des fichiers journaux s’en
chargent déjà) :
(use-modules (guix) (gnu)) (use-service-modules admin) (define my-log-files ;; Journaux que je veux faire tourner. '("/var/log/something.log" "/var/log/another.log")) (operating-system ;; … (services (cons (simple-service 'rotate-my-stuff rottlog-service-type (list (log-rotation (frequency 'daily) (files my-log-files)))) %base-services)))
C’est le type du service Rotlog, dont la valeur est un objet
rottlog-configuration
.
D’autres services peuvent étendre celui-ci avec de nouveaux objets
log-rotation
(voir plus bas), en augmentant ainsi l’ensemble des
fichiers à faire tourner.
Ce type de service peut définir des tâches (voir Exécution de tâches planifiées) pour lancer le service rottlog.
Type de données représentant la configuration de rottlog.
rottlog
(par défaut : rottlog
)Le paquet Rottlog à utiliser.
rc-file
(par défaut : (file-append rottlog "/etc/rc")
)Le fichier de configuration Rottlog à utiliser (voir Mandatory RC Variables dans GNU Rot[t]log Manual).
rotations
(par défaut : %default-rotations
)Une liste d’objets log-rotation
définis plus bas.
jobs
C’est une liste de gexps où chaque gexp correspond à une spécification de tâche de mcron (voir Exécution de tâches planifiées).
Type de données représentant la rotation d’un groupe de fichiers journaux.
En reprenant un exemple du manuel de Rottlog (voir Period Related File Examples dans GNU Rot[t]log Manual), on peut définir la rotation d’un journal de cette manière :
(log-rotation
(frequency 'daily)
(files '("/var/log/apache/*"))
(options '("storedir apache-archives"
"rotate 6"
"notifempty"
"nocompress")))
La liste des champs est la suivante :
frequency
(par défaut : 'weekly
)La fréquence de rotation, un symbole.
files
La liste des fichiers ou des motifs de noms de fichiers à faire tourner.
options
(par défaut : %default-log-rotation-options
)La liste des options de rottlog pour cette rotation (voir Configuration parameters dans GNU Rot[t]log Manual).
post-rotate
(par défaut : #f
)Soit #f
, soit une gexp à exécuter une fois la rotation terminée.
Spécifie la rotation hebdomadaire de %rotated-files
et de
/var/log/guix-daemon.log.
La liste des fichiers contrôlés par syslog à faire tourner. Par défaut il
s’agit de : '("/var/log/messages" "/var/log/secure" "/var/log/debug" \
"/var/log/maillog")
.
Certains fichiers journaux doivent simplement être supprimés périodiquement
quand ils deviennent trop vieux, sans autre critère et sans étape
d’archivage. C’est le cas des journaux de construction stockés par
guix-daemon
dans /var/log/guix/drvs (voir Invoquer guix-daemon
). Le service log-cleanup
gère ce cas. Par exemple,
%base-services
(voir Services de base) inclus ce qui suit :
;; Supprime régulièrement les anciens journaux de construction. (service log-cleanup-service-type (log-cleanup-configuration (directory "/var/log/guix/drvs")))
Cela s’assure que les journaux de construction ne s’accumulent pas sans fin.
C’est le type du service pour supprimer les anciens journaux. Sa valeur
doit être un enregistrement log-cleanup-configuration
, décrit
ci-dessous.
Type de données représentant la configuration de nettoyage des journaux
directory
Nom du répertoire contenant les fichiers journaux.
expiry
(par défaut : (* 6 30 24 3600)
)Âge en secondes après lequel un fichier peut être supprimé (six moins par défaut).
schedule
(par défaut : "30 12 01,08,15,22 * *"
)Chaine ou gexp dénotant la date de la tâche mcron correspondant (voir Exécution de tâches planifiées).
Anonip est un filtre pour la vie privée qui supprime les adresses IP des journaux des serveurs web. Ce service crée une FIFO et filtre toutes les lignes écrite avec anonip avant d’écrire les journaux filtrés dans un fichier cible.
L’exemple suivant configure la FIFO /var/run/anonip/https.access.log et écrit le fichier journal filtré dans /var/log/anonip/https.access.log.
(service anonip-service-type
(anonip-configuration
(input "/var/run/anonip/https.access.log")
(output "/var/log/anonip/https.access.log")))
Configurez votre serveur web pour écrire ses journaux dans la FIFO /var/run/anonip/https.access.log et récupérez les fichiers journaux anonymisés dans /var/web-logs/https.access.log.
Ce type de données représente la configuration d’anonip. Il a les paramètres suivants :
anonip
(par défaut : anonip
)Le paquet anonip à utiliser.
input
Le nom de fichier du fichier journal d’entrée à traiter. Le service crée une FIFO de ce nom. Le serveur web doit écrire ses journaux dans cette FIFO.
output
Le nom du fichier journal traité.
Les réglages facultatifs suivants peuvent être fournis :
debug?
Print debug messages when #true
.
skip-private?
Lorsque la valeur est #true
, ne masque pas les adresses dans les
plages privées.
column
Un numéro de colonne commençant par 1 pour la première colonne. Suppose que l’adresse IP est dans la colonne donnée (1 par défaut).
replacement
Chaine de remplacement au cas où l’analyse de l’adresse échoue, p. ex.
"0.0.0.0"
.
ipv4mask
Nombre de bits à masquer dans les adresses IPv4.
ipv6mask
Nombre de bits à masquer dans les adresses IPv6.
increment
Incrémente l’adresse IP par le nombre donné. La valeur par défaut est zéro.
delimiter
Chaine de délimitation des journaux.
regex
Expression régulière pour détecter l’adresse IP. À utiliser à la place de
column
.
Suivant: Services réseau, Précédent: Rotation des journaux, Monter: Services [Table des matières][Index]
Le module (gnu services networking)
fournit des services pour
configurer les interfaces réseau et paramétrer le réseau sur votre
machine. Ces services fournissent différentes manière pour paramétrer votre
machine : en déclarant une configuration réseau statique, en lançant un
client DHCP (Dynamic Host Configuration Protocol) ou en lançant des démon
comme NetworkManager et Connman qui automatisent le processus complet, en
s’adaptant automatiquement aux changements de connectivité et en fournissant
une interface utilisateur de haut niveau.
Sur un portable, NetworkManager et Connman sont de loin les options les plus
pratiques, ce qui explique que les services de bureau par défaut incluent
NetworkManager voir %desktop-services
). Pour un
serveur, une machine virtuelle ou un conteneur, la configuration réseau
statique ou un simple client DHCP sont plus souvent mieux appropriés.
Cette section décrit les divers services de paramétrage réseau existants, en commençant par le configuration réseau statique.
C’est le type pour les interfaces réseaux configurées statiquement. Sa
valeur doit être une liste d’enregistrements
static-networking
. Chacun déclare un ensemble d’adresses, de
routes et de liens, comme indiqué plus bas.
Voici la plus simple des configurations, avec un seul contrôleur d’interface réseau (NIC) et une seule connectivité IPv4 :
;; Réseau statique pour un NIC, IPv4 uniquement. (service static-networking-service-type (list (static-networking (addresses (list (network-address (device "eno1") (value "10.0.2.15/24")))) (routes (list (network-route (destination "default") (gateway "10.0.2.2")))) (name-servers '("10.0.2.3")))))
Le bout de code ci-dessus peut être ajouté au champ services
de votre
configuration du système d’exploitation (voir Utiliser le système de configuration). Il configurera votre machine pour avoir l’adresse IP 10.0.2.15,
avec un masque de sous-réseau de 24 bits pour le réseau local — cela
signifie que toutes les adresse 10.0.2.x sont sur le réseau local
(LAN). Le trafic à destination d’adresses extérieures au réseau local est
routé via 10.0.2.2. Les noms d’hôte sont résolus en envoyant des
requêtes au système de nom de domaine (DNS) à 10.0.2.3.
C’est le type de données représentant la configuration d’un réseau statique.
Voici un exemple de la manière dont vous pouvez déclarer la configuration
sur une machine avec un seul contrôleur d’interface réseau (NIC) disponible
sous le nom eno1
et avec une adresse IPv4 et une adresse IPv6 :
;; Configuration réseau pour un NIC, IPv4 + IPv6. (static-networking (addresses (list (network-address (device "eno1") (value "10.0.2.15/24")) (network-address (device "eno1") (value "2001:123:4567:101::1/64")))) (routes (list (network-route (destination "default") (gateway "10.0.2.2")) (network-route (destination "default") (gateway "2020:321:4567:42::1")))) (name-servers '("10.0.2.3")))
Si vous connaissez la commande ip
du
paquet
iproute2
qui se trouve sur les systèmes Linux, la déclaration
ci-dessus est équivalente à exécuter :
ip address add 10.0.2.15/24 dev eno1 ip address add 2001:123:4567:101::1/64 dev eno1 ip route add default via inet 10.0.2.2 ip route add default via inet6 2020:321:4567:42::1
Exécutez man 8 ip
pour plus d’informations. Les utilisateurs et
utilisatrices vétérans de GNU/Linux sauront sans doute comment le faire avec
ifconfig
et route
, mais nous vous épargnons cela.
Les champs disponibles pour ce type de données sont les suivants :
adresses
links
(par défaut : '()
)routes
(par défaut : '()
)La liste de enregistrements network-address
, network-link
et
network-route
pour ce réseau (voir plus bas).
name-servers
(par défaut : '()
)La liste des adresses IP (chaines) des serveurs de nom de domaine. Ces adresses IP vont dans /etc/resolv.conf.
provision
(par défaut : '(networking)
)Si la valeur est vraie, cela devrait être une liste de symboles pour le service Shepherd correspondant à cette configuration réseau.
requirement
(par défaut : '()
)La liste des services Shepherd dont celui-ci dépend.
C’est le type de données représentant l’adresse IP d’une interface réseau.
device
Le nom de l’interface réseau pour cette adresse — p. ex.
"eno1"
.
valeur
L’adresse IP effective et le masque de sous-réseau en notation CIDR (Classless Inter-Domain Routing), en tant que chaine de caractères.
Par exemple, "10.0.2.15/24"
dénote l’adresse IPv4 10 0 2 15 sur un
sous-réseau de 24 bits — toutes les adresses 10.0.2.x sont sur le
même réseau local.
ipv6?
Indique si value
dénote une adresse IPv6. Par défaut cela est
déterminé automatiquement.
C’est le type de donnée représentant une route réseau.
destination
La destination de la route (une chaine), soit une adresse IP et un masque de
sous-réseau, soit "default"
qui dénote la route par défaut.
source
(par défaut : #f
)Le source de la route.
device
(par défaut : #f
)Le périphérique utilisé pour la route — p. ex. "eno2"
.
ipv6?
(par défaut : auto)Indique si c’est une route IPv6. Par défaut cela est déterminé
automatiquement en fonction de destination
ou de gateway
.
gateway
(par défaut : #f
)Adresse IP (une chaine) à travers laquelle le trafic est routé.
Data type for a network link (voir Link dans Guile-Netlink Manual). During startup, network links are employed to construct or modify existing or virtual ethernet links. These ethernet links can be identified by their name or mac-address. If there is a need to create virtual interface, name and type fields are required.
name
The name of the link—e.g., "v0p0"
(default: #f
).
type
A symbol denoting the type of the link—e.g., 'veth
(default:
#f
).
mac-address
The mac-address of the link—e.g., "98:11:22:33:44:55"
(default:
#f
).
arguments
La liste des arguments pour ce type de lien.
Consider a scenario where a server equipped with a network interface which has multiple ports. These ports are connected to a switch, which supports link aggregation (also known as bonding or NIC teaming). The switch uses port channels to consolidate multiple physical interfaces into one logical interface to provide higher bandwidth, load balancing, and link redundancy. When a port is added to a LAG (or link aggregation group), it inherits the properties of the port-channel. Some of these properties are VLAN membership, trunk status, and so on.
VLAN (or virtual local area network) is a logical network that is isolated from other VLANs on the same physical network. This can be used to segregate traffic, improve security, and simplify network management.
With all that in mind let’s configure our static network for the server. We will bond two existing interfaces together using 802.3ad schema and on top of it, build a VLAN interface with id 1055. We assign a static ip to our new VLAN interface.
(static-networking
(links (list (network-link
(name "bond0")
(type 'bond)
(arguments '((mode . "802.3ad")
(miimon . 100)
(lacp-active . "on")
(lacp-rate . "fast"))))
(network-link
(mac-address "98:11:22:33:44:55")
(arguments '((master . "bond0"))))
(network-link
(mac-address "98:11:22:33:44:56")
(arguments '((master . "bond0"))))
(network-link
(name "bond0.1055")
(type 'vlan)
(arguments '((id . 1055)
(link . "bond0"))))))
(addresses (list (network-address
(value "192.168.1.4/24")
(device "bond0.1055")))))
C’est l’enregistrement static-networking
qui représente le «
périphérique de rebouclage », lo
, pour les adresses IP 127.0.0.1 et
::1, et qui fournit le service Shepherd loopback
.
This is the static-networking
record representing network setup when
using QEMU’s user-mode network stack on eth0
(voir Using the user
mode network stack dans QEMU Documentation).
This is the type of services that run dhclient, the ISC Dynamic Host Configuration Protocol (DHCP) client.
Data type representing the configuration of the ISC DHCP client service.
package
(par défaut : isc-dhcp
)The ISC DHCP client package to use.
interfaces
(par défaut : 'all
)Either 'all
or the list of interface names that the ISC DHCP client
should listen on—e.g., '("eno1")
.
When set to 'all
, the ISC DHCP client listens on all the available
non-loopback interfaces that can be activated. Otherwise the ISC DHCP
client listens only on the specified interfaces.
config-file
(par défaut : #f
)The configuration file for the ISC DHCP client.
version
(par défaut : "4"
)The DHCP protocol version to use, as a string. Accepted values are
"4"
or "6"
for DHCPv4 or DHCPv6, respectively, as well as
"4o6"
, for DHCPv4 over DHCPv6 (as specified by RFC 7341).
rshepherd-equirement
(par défaut : '()
)shepherd-provision
(default: '(networking)
)This option can be used to provide a list of symbols naming Shepherd
services that this service will depend on, such as 'wpa-supplicant
or
'iwd
if you require authenticated access for encrypted WiFi or
Ethernet networks.
Likewise, shepherd-provision
is a list of Shepherd service names
(symbols) provided by this service. You might want to change the default
value if you intend to run several ISC DHCP clients, only one of which
provides the networking
Shepherd service.
C’est le type de service pour le service
NetworkManager. La
valeur pour ce type de service est un enregistrement
network-manager-configuration
.
Ce service fait partie de %desktop-services
(voir Services de bureaux).
Type de données représentant la configuration de NetworkManager.
network-manager
(par défaut : network-manager
)Le paquet NetworkManager à utiliser.
shepherd-requirement
(default: '(wpa-supplicant)
)This option can be used to provide a list of symbols naming Shepherd
services that this service will depend on, such as 'wpa-supplicant
or
'iwd
if you require authenticated access for encrypted WiFi or
Ethernet networks.
dns
(par défaut : "default"
)Mode de gestion pour le DNS, qui affecte la manière dont NetworkManager
utilise le fichier de configuration resolv.conf
.
NetworkManager mettra à jour resolv.conf
pour refléter les serveurs
de noms fournis par les connexions actives.
NetworkManager exécutera dnsmasq
comme un serveur de noms local en
cache, en utilisant une configuration transfert conditionnel si vous
êtes connecté à un VPN, puis mettra à jour resolv.conf
pour pointer
vers le serveur de noms local.
Avec ce paramètre, vous pouvez partager votre connexion réseau. Par
exemple, lorsque vous souhaitez partager votre connexion réseau avec un
autre ordinateur portable via un câble Ethernet, vous pouvez ouvrir
nm-connection-editor
et configurer la méthode de connexion câblée
pour IPv4 et IPv6 de manière à ce qu’elle soit "partagée avec d’autres
ordinateurs" et à ce que la connexion soit rétablie (ou redémarrée).
Vous pouvez également établir une connexion hôte-invité aux VM QEMU
(voir Installer Guix sur une machine virtuelle). Avec une connexion d’hôte à invité, vous
pouvez par exemple : accéder à un serveur Web fonctionnant sur la VM
(voir Services web) à partir d’un navigateur Web sur votre système hôte,
ou vous connecter à la VM via SSH (voir openssh-service-type
). Pour établir une connexion entre hôtes,
exécutez cette commande une fois :
nmcli connection add type tun \ connection.interface-name tap0 \ tun.mode tap tun.owner $(id -u) \ ipv4.method shared \ ipv4.addresses 172.28.112.1/24
Ensuite, chaque fois que vous lancez votre VM QEMU (voir Exécuter Guix sur une machine virtuelle), passez -nic tap,ifname=tap0,script=no,downscript=no à
qemu-system-...
.
NetworkManager ne modifiera pas resolv.conf
.
vpn-plugins
(par défaut : '()
)C’est la liste des greffons disponibles pour les VPN (réseaux privés
virtuels). Un exemple est le paquet network-manager-openvpn
, qui
permet à NetworkManager de gérer des VPN via OpenVPN.
C’est le type de service pour lancer Connman, un gestionnaire de connexions réseaux.
Sa valeur doit être un enregistrement connman-configuration
comme
dans cet exemple :
(service connman-service-type
(connman-configuration
(disable-vpn? #t)))
Voir plus bas pour des détails sur connman-configuration
.
Type de données représentant la configuration de connman.
connman
(par défaut : connman)Le paquet connman à utiliser.
rshepherd-equirement
(par défaut : '()
)This option can be used to provide a list of symbols naming Shepherd
services that this service will depend on, such as 'wpa-supplicant
or
'iwd
if you require authenticated access for encrypted WiFi or
Ethernet networks.
disable-vpn?
(par défaut : #f
)Lorsque la valeur est vraie, désactive le greffon vpn de connman.
general-configuration
(default: (connman-general-configuration)
)Configuration serialized to main.conf and passed as --config
to connmand
.
Available connman-general-configuration
fields are:
input-request-timeout
(type: maybe-number)Set input request timeout. Default is 120 seconds. The request for inputs like passphrase will timeout after certain amount of time. Use this setting to increase the value in case of different user interface designs.
browser-launch-timeout
(type: maybe-number)Set browser launch timeout. Default is 300 seconds. The request for launching a browser for portal pages will timeout after certain amount of time. Use this setting to increase the value in case of different user interface designs.
background-scanning?
(type: maybe-boolean)Enable background scanning. Default is true. If wifi is disconnected, the
background scanning will follow a simple back off mechanism from 3s up to 5
minutes. Then, it will stay in 5 minutes unless user specifically asks for
scanning through a D-Bus call. If so, the mechanism will start again from
3s. This feature activates also the background scanning while being
connected, which is required for roaming on wifi. When
background-scanning?
is false, ConnMan will not perform any scan
regardless of wifi is connected or not, unless it is requested by the user
through a D-Bus call.
use-gateways-as-timeservers?
(type: maybe-boolean)Assume that service gateways also function as timeservers. Default is false.
fallback-timeservers
(type: maybe-list)List of Fallback timeservers. These timeservers are used for NTP sync when
there are no timeservers set by the user or by the service, and when
use-gateways-as-timeservers?
is #f
. These can contain a mixed
combination of fully qualified domain names, IPv4 and IPv6 addresses.
fallback-nameservers
(type: maybe-list)List of fallback nameservers appended to the list of nameservers given by the service. The nameserver entries must be in numeric format, host names are ignored.
default-auto-connect-technologies
(type: maybe-list)List of technologies that are marked autoconnectable by default. The
default value for this entry when empty is "ethernet"
, "wifi"
,
"cellular"
. Services that are automatically connected must have been
set up and saved to storage beforehand.
default-favourite-technologies
(type: maybe-list)List of technologies that are marked favorite by default. The default value
for this entry when empty is "ethernet"
. Connects to services from
this technology even if not setup and saved to storage.
always-connected-technologies
(type: maybe-list)List of technologies which are always connected regardless of
preferred-technologies setting (auto-connect?
#t
). The
default value is empty and this feature is disabled unless explicitly
enabled.
preferred-technologies
(type: maybe-list)List of preferred technologies from the most preferred one to the least preferred one. Services of the listed technology type will be tried one by one in the order given, until one of them gets connected or they are all tried. A service of a preferred technology type in state ’ready’ will get the default route when compared to another preferred type further down the list with state ’ready’ or with a non-preferred type; a service of a preferred technology type in state ’online’ will get the default route when compared to either a non-preferred type or a preferred type further down in the list.
network-interface-blacklist
(type: maybe-list)List of blacklisted network interfaces. Found interfaces will be compared
to the list and will not be handled by ConnMan, if their first characters
match any of the list entries. Default value is "vmnet"
,
"vboxnet"
, "virbr"
, "ifb"
.
allow-hostname-updates?
(type: maybe-boolean)Allow ConnMan to change the system hostname. This can happen for example if
we receive DHCP hostname option. Default value is #t
.
allow-domainname-updates?
(type: maybe-boolean)Allow connman to change the system domainname. This can happen for example
if we receive DHCP domainname option. Default value is #t
.
single-connected-technology?
(type: maybe-boolean)Keep only a single connected technology at any time. When a new service is
connected by the user or a better one is found according to
preferred-technologies, the new service is kept connected and all the other
previously connected services are disconnected. With this setting it does
not matter whether the previously connected services are in ’online’ or
’ready’ states, the newly connected service is the only one that will be
kept connected. A service connected by the user will be used until going
out of network coverage. With this setting enabled applications will notice
more network breaks than normal. Note this options can’t be used with
VPNs. Default value is #f
.
tethering-technologies
(type: maybe-list)List of technologies that are allowed to enable tethering. The default
value is "wifi"
, "bluetooth"
, "gadget"
. Only those
technologies listed here are used for tethering. If one wants to tether
ethernet, then add "ethernet"
in the list. Note that if ethernet
tethering is enabled, then a DHCP server is started on all ethernet
interfaces. Tethered ethernet should never be connected to corporate or
home network as it will disrupt normal operation of these networks. Due to
this ethernet is not tethered by default. Do not activate ethernet
tethering unless you really know what you are doing.
persistent-tethering-mode?
(type: maybe-boolean)Restore earlier tethering status when returning from offline mode,
re-enabling a technology, and after restarts and reboots. Default value is
#f
.
enable-6to4?
(type: maybe-boolean)Automatically enable anycast 6to4 if possible. This is not recommended, as
the use of 6to4 will generally lead to a severe degradation of connection
quality. See RFC6343. Default value is #f
(as recommended by
RFC6343 section 4.1).
vendor-class-id
(type: maybe-string)Set DHCP option 60 (Vendor Class ID) to the given string. This option can be used by DHCP servers to identify specific clients without having to rely on MAC address ranges, etc.
enable-online-check?
(type: maybe-boolean)Enable or disable use of HTTP GET as an online status check. When a service
is in a READY state, and is selected as default, ConnMan will issue an HTTP
GET request to verify that end-to-end connectivity is successful. Only then
the service will be transitioned to ONLINE state. If this setting is false,
the default service will remain in READY state. Default value is #t
.
online-check-ipv4-url
(type: maybe-string)IPv4 URL used during the online status check. Please refer to the README for more detailed information. Default value is http://ipv4.connman.net/online/status.html.
online-check-ipv6-url
(type: maybe-string)IPv6 URL used during the online status check. Please refer to the README for more detailed information. Default value is http://ipv6.connman.net/online/status.html.
online-check-initial-interval
(type: maybe-number)Range of intervals between two online check requests. Please refer to the README for more detailed information. Default value is ‘1’.
online-check-max-interval
(type: maybe-number)Range of intervals between two online check requests. Please refer to the README for more detailed information. Default value is ‘1’.
enable-online-to-ready-transition?
(type: maybe-boolean)WARNING: This is an experimental feature. In addition to
enable-online-check
setting, enable or disable use of HTTP GET to
detect the loss of end-to-end connectivity. If this setting is #f
,
when the default service transitions to ONLINE state, the HTTP GET request
is no more called until next cycle, initiated by a transition of the default
service to DISCONNECT state. If this setting is #t
, the HTTP GET
request keeps being called to guarantee that end-to-end connectivity is
still successful. If not, the default service will transition to READY
state, enabling another service to become the default one, in replacement.
Default value is #f
.
auto-connect-roaming-services?
(type: maybe-boolean)Automatically connect roaming services. This is not recommended unless you
know you won’t have any billing problem. Default value is #f
.
address-conflict-detection?
(type: maybe-boolean)Enable or disable the implementation of IPv4 address conflict detection
according to RFC5227. ConnMan will send probe ARP packets to see if an IPv4
address is already in use before assigning the address to an interface. If
an address conflict occurs for a statically configured address, an IPv4LL
address will be chosen instead (according to RFC3927). If an address
conflict occurs for an address offered via DHCP, ConnMan sends a DHCP
DECLINE once and for the second conflict resorts to finding an IPv4LL
address. Default value is #f
.
localtime
(type: maybe-string)Path to localtime file. Defaults to /etc/localtime.
regulatory-domain-follows-timezone?
(type: maybe-boolean)Enable regulatory domain to be changed along timezone changes. With this
option set to true each time the timezone changes the first present ISO3166
country code is read from /usr/share/zoneinfo/zone1970.tab and set as
regulatory domain value. Default value is #f
.
resolv-conf
(type: maybe-string)Path to resolv.conf file. If the file does not exist, but intermediate directories exist, it will be created. If this option is not set, it tries to write into /var/run/connman/resolv.conf if it fails (/var/run/connman does not exist or is not writeable). If you do not want to update resolv.conf, you can set /dev/null.
C’est le type du service qui lanceWPA supplicant, un démon d’authentification requis pour s’authentifier sur des WiFi chiffrés ou des réseaux ethernet.
Type données qui représente la configuration de WPA Supplicant.
Il prend les paramètres suivants :
wpa-supplicant
(par défaut : wpa-supplicant
)Le paquet WPA Supplicant à utiliser.
requirement
(par défaut : '(user-processes loopback syslogd)
Liste des services qui doivent être démarrés avant le début de WPA Supplicant.
dbus?
(par défaut : #t
)Indique s’il faut écouter les requêtes sur D-Bus.
pid-file
(par défaut : "/var/run/wpa_supplicant.pid"
)Où stocker votre fichier de PID.
interface
(par défaut : #f
)Si une valeur est indiquée, elle doit spécifier le nom d’une interface réseau que WPA supplicant contrôlera.
config-file
(par défaut : #f
)Fichier de configuration facultatif à utiliser.
extra-options
(par défaut : '()
)Liste d’arguments de la ligne de commande supplémentaires à passer au démon.
Certains périphériques réseau comme les modems ont des besoins spécifiques et c’est ce dont s’occupe les services suivants.
C’est le type de service pour le service
ModemManager. La
valeur de ce type de service est un enregistrement
modem-manager-configuration
.
Ce service fait partie de %desktop-services
(voir Services de bureaux).
Type de donnée représentant la configuration de ModemManager.
modem-manager
(par défaut : modem-manager
)Le paquet ModemManager à utiliser.
C’est le type de service pour le service
USB_ModeSwitch. La
valeur pour ce type de service est un enregistrement
usb-modeswitch-configuration
.
Lorsqu’ils sont branchés, certains modems USB (et autres dispositifs USB) se présentent initialement comme un support de stockage en lecture seule et non comme un modem. Ils doivent être modeswitched avant d’être utilisables. Le service de type USB_ModeSwitch installe des règles udev pour commuter automatiquement les modes de ces dispositifs lorsqu’ils sont branchés.
Ce service fait partie de %desktop-services
(voir Services de bureaux).
Type de données représentant la configuration du USB_ModeSwitch.
usb-modeswitch
(par défaut : usb-modeswitch
)Le paquet USB_ModeSwitch fournit les binaires pour la commutation de modes.
usb-modeswitch-data
(par défaut : usb-modeswitch-data
)Le paquet fournissant les données du dispositif et le fichier de règles udev utilisé par USB_ModeSwitch.
config-file
(par défaut : #~(string-append #$usb-modeswitch:dispatcher "/etc/usb_modeswitch.conf")
)Le fichier de configuration à utiliser pour le répartiteur USB_ModeSwitch.
Par défaut, le fichier de configuration livré avec USB_ModeSwitch est
utilisé, ce qui désactive la connexion au /var/log parmi d’autres
paramètres par défaut. S’il est défini sur #f
, aucun fichier de
configuration n’est utilisé.
Suivant: Mises à jour non surveillées (Unattended Upgrades), Précédent: Configuration du réseau, Monter: Services [Table des matières][Index]
Le module (gnu services networking)
dont on a parlé dans la section
précédente fournit des services pour des configuration plus avancées :
fournir un service DHCP que d’autres peuvent utiliser, filtrer des paquets
avec iptables ou nftables, faire tourner un point d’accès WiFi avec
hostadp
, lancer le « superdémon » inetd
et bien plus
encore. Cette section les décrit.
Ce type définie un service qui lance un démon DHCP. Pour créer un service
de ce type, vous devez appliquer un objet <dhcpd-configuration>
. Par
exemple :
(service dhcpd-service-type
(dhcpd-configuration
(config-file (local-file "my-dhcpd.conf"))
(interfaces '("enp0s25"))))
package
(par défaut : isc-dhcp
)Le paquet qui fournit le démon DHCP. ce paquet doit fournir le démon sbin/dhcpd relativement à son répertoire de sortie. Le paquet par défaut est le serveur DHCP d’ISC.
config-file
(par défaut : #f
)Le fichier de configuration à utiliser. Il est requis. Il sera passé à
dhcpd
via son option -cf
. La valeur peut être n’importe quel
objet « simili-fichier » (voir file-like objects). Voir
man dhcpd.conf
pour des détails sur la syntaxe du fichier de
configuration.
version
(par défaut : "4"
)La version de DHCP à utiliser. Le serveur DHCP d’ISC supporte les valeur «
4 », « 6 » et « 4o6 ». Elles correspondent aux options -4
, -6
et -4o6
du programme dhcpd
. Voir man dhcpd
pour plus
de détails.
run-directory
(par défaut : "/run/dhcpd"
)Le répertoire d’exécution à utiliser. Au moment de l’activation du service, ce répertoire sera créé s’il n’existe pas.
pid-file
(par défaut : "/run/dhcpd/dhcpd.pid"
)Le fichier de PID à utiliser. Cela correspond à l’option -pf
de
dhcpd
. Voir man dhcpd
pour plus de détails.
interfaces
(par défaut : '()
)Les noms des interfaces réseaux sur lesquelles dhcpd écoute. Si cette liste
n’est pas vide, alors ses éléments (qui doivent être des chaînes de
caractères) seront ajoutés à l’invocation de dhcpd
lors du démarrage
du démon. Il n’est pas forcément nécessaire de spécifier des interfaces ici
; voir man dhcpd
pour plus de détails.
Il s’agit du type de service permettant d’exécuter le démon
hostapd pour mettre en place des points
d’accès et des serveurs d’authentification WiFi (IEEE 802.11). Sa valeur
associée doit être un hostapd-configuration
comme indiqué ci-dessous
:
;; Utiliser wlan1 pour lancer le point d'accès pour « My Network ». (service hostapd-service-type (hostapd-configuration (interface "wlan1") (ssid "My Network") (channel 12)))
Ce type de données représente la configuration du service hostapd, avec les champs suivants :
package
(par défaut : hostapd
)Le paquet hostapd à utiliser.
interface
(par défaut : "wlan0"
)L’interface réseau pour faire fonctionner le point d’accès WiFi.
ssid
Le SSID (identifiant de l’ensemble de services), une chaîne de caractères qui identifie ce réseau.
broadcast-ssid?
(par défaut : #t
)La diffusion de ce SSID.
channel
(par défaut : #f
)Le canal WiFi à utiliser.
drivers
(par défaut : "nl80211"
)Le type d’interface du conducteur. "nl80211"
est utilisé avec tous
les pilotes mac80211 de Linux. Utilisez "none"
si vous construisez
hostapd comme un serveur RADIUS autonome qui ne contrôle aucun pilote
sans-fil/filaire.
extra-settings
(par défaut : ""
)Paramètres supplémentaires à ajouter tels quels au fichier de configuration de hostapd. Voir https://w1.fi/cgit/hostap/plain/hostapd/hostapd.conf pour la référence du fichier de configuration.
C’est le type de service permettant de simuler la mise en réseau WiFi, qui
peut être utile dans les machines virtuelles à des fins de test. Le service
charge le noyau Linux
module mac80211_hwsim
et lance hostapd pour créer un pseudo réseau
WiFi qui peut être vu sur wlan0
, par défaut.
La valeur du service est un enregistrement hostapd-configuration
.
C’est le type de service pour mettre en place une configuration iptables. iptables est un outil de filtrage de paquets pris en charge par le noyau Linux. Ce service prend en charge la configuration d’iptable pour IPv4 et IPv6. Un exemple de configuration simple, qui rejette les connexions entrantes sauf celles sur le port 22 est présenté ci-dessous.
(service iptables-service-type
(iptables-configuration
(ipv4-rules (plain-file "iptables.rules" "*filter
:INPUT ACCEPT
:FORWARD ACCEPT
:OUTPUT ACCEPT
-A INPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT
-A INPUT -p tcp --dport 22 -j ACCEPT
-A INPUT -j REJECT --reject-with icmp-port-unreachable
COMMIT
"))
(ipv6-rules (plain-file "ip6tables.rules" "*filter
:INPUT ACCEPT
:FORWARD ACCEPT
:OUTPUT ACCEPT
-A INPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT
-A INPUT -p tcp --dport 22 -j ACCEPT
-A INPUT -j REJECT --reject-with icmp6-port-unreachable
COMMIT
"))))
Type de données représentant la configuration d’iptables.
iptables
(par défaut : iptables
)Le paquet iptables qui fournit iptables-restore
et
ip6tables-restore
.
ipv4-rules
(par défaut : %iptables-accept-all-rules
)Les règles iptables à utiliser. Elles seront passées à
iptables-restore
. Cela peut être un objet « simili-fichier »
(voir file-like objects).
ipv6-rules
(par défaut : %iptables-accept-all-rules
)Les règles iptables à utiliser. Elles seront passées à
ip6tables-restore
. Cela peut être un objet « simili-fichier »
(voir file-like objects).
C’est le type de service permettant de mettre en place une configuration
nftables. nftables est un projet de netfilter qui vise à remplacer le cadre
existant iptables, ip6tables, arptables et ebtables. Il fournit un nouveau
cadre de filtrage de paquets, un nouvel utilitaire d’espace utilisateur·rice
nft
, et une couche de compatibilité pour iptables. Ce service est
fourni avec un jeu de règles par défaut %default-nftables-ruleset
qui
rejette toutes les connexions entrantes sauf celles vers le port ssh 22.
Pour l’utiliser, il suffit d’écrire :
Type de données représentant la configuration de nftables.
package
(par défaut : nftables
)Le paquet nftables qui fournit nft
.
ruleset
(par défaut : %default-nftables-ruleset
)Les règles d’utilisation de nftables. Il peut s’agir de n’importe quel objet « de type fichier » (voir objets de type fichier).
C’est le type de service qui lance le démon Network Time Protocol (NTP), ntpd
. Le démon gardera l’horloge
système synchronisée avec celle des serveurs NTP spécifiés.
La valeur de ce service est un objet ntpd-configuration
, décrit
ci-dessous.
C’est le type de données représentant la configuration du service NTP.
servers
(par défaut : %ntp-servers
)C’est la liste des serveurs (enregistrements <ntp-server>
) avec
lesquels ntpd
sera synchronisé. Voir la définition du type de
données ntp-server
ci-dessous.
allow-large-adjustment?
(par défaut : #t
)Détermine si ntpd
peut faire un ajustement initial de plus de
1 000 secondes.
ntp
(par défaut : ntp
)Le paquet NTP à utiliser.
Liste de noms d’hôtes à utiliser comme serveurs NTP par défaut. Ce sont les serveurs du projet NTP Pool.
Le type de données représentant la configuration d’un serveur NTP.
type
(par défaut : 'server
)Le type de serveur NTP, indiqué par un symbole. L’un des types suivants :
'pool
, 'server
, 'peer
, 'broadcast
ou
'manycastclient
.
adresse
L’adresse du serveur, comme une chaîne de caractères.
options
Les options NTPD à utiliser avec ce serveur spécifique, données sous la forme d’une liste de noms d’options et/ou de tuples de noms et de valeurs d’options. L’exemple suivant définit un serveur à utiliser avec les options iburst et prefer, ainsi que version 3 et un temps maxpoll de 16 secondes.
(ntp-server (type 'server) (address "some.ntp.server.org") (options `(iburst (version 3) (maxpoll 16) prefer))))
Lance le démon NTP ntpd
, implémenté par
OpenNTPD. Le démon gardera l’horloge
système synchronisée avec celle des serveurs donnés.
(service
openntpd-service-type
(openntpd-configuration
(listen-on '("127.0.0.1" "::1"))
(sensor '("udcf0 correction 70000"))
(constraint-from '("www.gnu.org"))
(constraints-from '("https://www.google.com/"))))
Cette variable est une liste des adresses de serveurs définies dans
%ntp-servers
.
openntpd
(par défaut : openntpd
)Le paquet openntpd à utiliser.
listen-on
(par défaut : '("127.0.0.1" "::1")
)Une liste d’adresses IP locales ou de noms d’hôtes que devrait écouter le démon ntpd.
query-from
(par défaut : '()
)Une liste d’adresses IP que le démon devrait utiliser pour les requêtes sortantes.
sensor
(par défaut : '()
)Spécifie une liste de senseurs de différences de temps que ntpd devrait
utiliser. ntpd
écoutera chaque senseur qui existe et ignorera ceux
qui n’existent pas. Voir la
documentation en amont pour plus d’informations.
server
(par défaut : '()
)Spécifie une liste d’adresses IP ou de noms d’hôtes de serveurs NTP avec lesquels se synchroniser.
servers
(par défaut : %openntp-servers
)Spécifie une liste d’adresses IP ou de noms d’hôtes de banques de serveurs NTP avec lesquelles se synchroniser.
constraint-from
(par défaut : '()
)ntpd
peut être configuré pour demander la « Date » à des serveurs
HTTPS de confiance via TLS. Cette information de temps n’est pas utilisée
pour sa précision mais agit comme une contrainte authentifiée, ce qui réduit
l’impact d’une attaque par l’homme du milieu sur le protocole NTP non
authentifié. Spécifie une liste d’URL, d’adresses IP ou de noms d’hôtes de
serveurs HTTPS qui fournissent cette contrainte.
constraints-from
(par défaut : '()
)Comme pour constraint-from
, spécifie une liste d’URL, d’adresses IP
ou de noms d’hôtes de serveurs HTTPS qui fournissent une contrainte. Si les
noms d’hôtes sont résolus en plusieurs adresses IP, ntpd
calculera la
contrainte médiane.
Ce service lance le démon inetd
(voir inetd invocation dans GNU Inetutils). inetd
écoute des connexions sur des
sockets internet et démarre le programme spécifié uniquement lorsqu’une
connexion arrive sur l’un de ces sockets.
La valeur de ce service est un objet inetd-configuration
. L’exemple
suivant configure le démon inetd
pour qu’il fournisse le service
echo
, ainsi qu’un service smtp qui transfère le trafic smtp par
ssh à un serveur smtp-server
derrière une passerelle hostname
:
(service
inetd-service-type
(inetd-configuration
(entries (list
(inetd-entry
(name "echo")
(socket-type 'stream)
(protocol "tcp")
(wait? #f)
(user "root"))
(inetd-entry
(node "127.0.0.1")
(name "smtp")
(socket-type 'stream)
(protocol "tcp")
(wait? #f)
(user "root")
(program (file-append openssh "/bin/ssh"))
(arguments
'("ssh" "-qT" "-i" "/chemin/vers/ssh_key"
"-W" "smtp-server:25" "user@hostname")))))))
Voir plus bas pour plus de détails sur inetd-configuration
.
Type de données représentant la configuration de inetd
.
program
(par défaut : (file-append inetutils "/libexec/inetd")
)L’exécutable inetd
à utiliser.
entries
(par défaut : '()
)Une liste d’entrées de services inetd
. Chaque entrée devrait être
crée avec le constructeur inetd-entry
.
Type de données représentant une entrée dans la configuration
d’inetd
. Chaque entrée correspond à un socket sur lequel
inetd
écoutera les requêtes.
node
(par défaut : #f
)Chaîne de caractères facultative, un liste d’adresses locales séparées par
des virgules que inetd
devrait utiliser pour écouter ce service.
Voir Configuration file dans GNU Inetutils pour une description
complète de toutes les options.
name
Une chaîne de caractères dont le nom doit correspondre à une entrée de
/etc/services
.
socket-type
Un symbole parmi 'stream
, 'dgram
, 'raw
, 'rdm
ou
'seqpacket
.
protocol
Une chaîne de caractères qui doit correspondre à une entrée dans
/etc/protocols
.
wait?
(par défaut : #t
)Indique si inetd
devrait attendre que le serveur ait quitté avant
d’écouter de nouvelles demandes de service.
user
Une chaîne de caractères contenant le nom d’utilisateur (et éventuellement
de groupe) de l’utilisateur en tant que lequel le serveur devrait tourner.
Le nom du groupe peut être spécifié comme un suffixe, séparé par un
deux-points ou un point, c.-à-d. "utilisateur"
,
"utilisateur:groupe"
ou "utilisateur.groupe"
.
program
(par défaut : "internal"
)Le programme du serveur qui servira les requêtes, ou "internal"
si
inetd
devrait utiliser un service inclus.
arguments
(par défaut : '()
)Une liste de chaînes de caractères ou d’objets simili-fichiers qui sont les
arguments du programme du serveur, en commençant par le zéroième argument,
c.-à-d. le nom du programme lui-même. Pour les services internes à
inetd
, cette entrée doit être '()
ou '("internal")
.
Voir Configuration file dans GNU Inetutils pour trouver une discussion plus détaillée de chaque champ de configuration.
C’est le type du service qui lance un nœud OpenDHT, dhtnode
. Le démon peut être utilisé pour héberger votre
propre service mandataire à la table de hash distribue (DHT), par exemple
pour y connecter Jami, entre autres applications.
Important : Lorsque vous utiliser le serveur mandataire OpenDHT, les adresses IP qu’il « voit » venant des clients devraient être les adresses atteignables depuis les autres pairs. En pratique cela signifie qu’une adresse accessible publiquement est préférable pour un serveur mandataire, en dehors de votre réseau privé. Par exemple, héberger le serveur mandataire sur un réseau local privé en IPv4 et l’exposer via une redirection de port pourrait fonctionner pour les pairs externes, mais les pairs locaux au mandataire verront leur adresse privée partagées avec les pairs externes, ce qui posera des problèmes de connectivité.
La valeur de ce service est un objet opendht-configuration
, décrit
ci-dessous.
Les champs de opendht-configuration
disponibles sont :
opendht
(par défaut : opendht
) (type : simili-fichier)Le paquet opendht
à utiliser.
peer-discovery?
(par défaut : #f
) (type : booléen)Indique s’il faut activer le mécanisme de découverte de pairs locaux en multidiffusion.
enable-logging?
(par défaut : #f
) (type : booléen)Indique s’il faut activer la journalisation des messages vers syslog. C’est désactivé par défaut car cette option est plutôt verbeuse.
debug?
(par défaut : #f
) (type : booléen)Indique s’il faut activer la journalisation de débogage. Cela n’a aucun effet si la journalisation n’est pas activée.
bootstrap-host
(par défaut : "bootstrap.jami.net:4222"
) (type : peut-être-chaine)Le nom d’hôte du nœud utilisé pour effectuer la première connexion au
réseau. Vous pouvez fournir une valeur de port spécifique en ajoutant le
suffixe :PORT
. Par défaut, cela utilise les nœuds d’amorçage de Jami,
mais n’importe quel hôte peut être spécifié ici. Il est aussi possible de
désactiver l’amorçage en paramétrant explicitement ce champ à la valeur
%unset-value
.
port
(par défaut : 4222
) (type : peut-être-entier)Le port UDP sur lequel se lier. Lorsque la valeur est laissée non spécifiée, un port disponible est automatiquement choisi.
proxy-server-port
(type : peut-être-entier)Crée un serveur mandataire écoutant sur le port spécifié.
proxy-server-port-tls
(type : peut-être-entier)Crée un serveur mandataire écoutant les connexions TLS sur le port spécifié.
Type for a service that runs the Tor
anonymous networking daemon. The service is configured using a
<tor-configuration>
record. By default, the Tor daemon runs as the
tor
unprivileged user, which is a member of the tor
group.
Services of this type can be extended by other services to specify
onion services (in addition to those already specified in
tor-configuration
) as in this example:
(simple-service 'my-extra-onion-service tor-service-type
(list (tor-onion-service-configuration
(name "extra-onion-service")
(mapping '((80 . "127.0.0.1:8080"))))))
tor
(par défaut : tor
)Le paquet qui fournit le démon Tor. Ce paquet doit fournir le démon bin/tor relativement à son répertoire de sortie. Le paquet par défaut est le l’implémentation du projet Tor.
config-file
(par défaut : (plain-file "empty" "")
)Le fichier de configuration à utiliser. Il sera ajouté au fichier de
configuration par défaut, et le fichier de configuration final sera passé à
tor
via son option -f
. Cela peut être n’importe quel objet «
simili-fichier » (voir file-like objects). Voir man
tor
pour plus de détails sur la syntaxe du fichier de configuration.
hidden-services
(par défaut : '()
)The list of <tor-onion-service-configuration>
records to use. For
any onion service you include in this list, appropriate configuration to
enable the onion service will be automatically added to the default
configuration file.
socks-socket-type
(par défaut : 'tcp
)Le type de socket par défaut que Tor devrait utiliser pour les socket
SOCKS. Cela doit être soit 'tcp
soit 'unix
. S’il s’agit de
'tcp
, alors Tor écoutera pas défaut sur le port TCP 9050 sur
l’interface de boucle locale (c.-à-d. localhost). S’il s’agit de
'unix
, Tor écoutera sur le socket UNIX domain
/var/run/tor/socks-sock, qui sera inscriptible pour les membres du
groupe tor
.
Si vous voulez personnaliser le socket SOCKS plus avant, laissez
socks-socket-type
à sa valeur par défaut de 'tcp
et utilisez
config-file
pour remplacer les valeurs par défaut avec votre propre
option SocksPort
.
control-socket?
(par défaut : #f
)Indique s’il faut utiliser un « socket de contrôle » par lequel on peut
contrôler Tor pour, par exemple, instancier des services onion
dynamiquement. Si la valeur est #t
, Tor écoutera les commandes de
contrôle sur le socket UNIX domain /var/run/tor/control-sock, qui
sera inscriptible pour les membres du groupe tor
.
transport-plugins
(default: '()
)The list of <tor-transport-plugin>
records to use. For any transport
plugin you include in this list, appropriate configuration line to enable
transport plugin will be automatically added to the default configuration
file.
Data Type representing a Tor Onion Service configuration. See
the Tor project’s
documentation for more information. Available
tor-onion-service-configuration
fields are:
name
(type : string)Name for this Onion Service. This creates a
/var/lib/tor/hidden-services/name directory, where the
hostname file contains the ‘.onion
’ host name for this
Onion Service.
mapping
(type: alist)Association list of port to address mappings. The following example:
'((22 . "127.0.0.1:22") (80 . "127.0.0.1:8080"))
maps ports 22 and 80 of the Onion Service to the local ports 22 and 8080.
Data type representing a Tor pluggable transport plugin in
tor-configuration
. Plugguble transports are programs that disguise
Tor traffic, which can be useful in case Tor is censored. See the the Tor
project’s documentation and specification for more information.
Each transport plugin corresponds either to ClientTransportPlugin ...
or to ServerTransportPlugin ...
line in the default configuration
file, see man tor
. Available tor-transport-plugin
fields
are:
role
(default: 'client
)This must be either 'client
or 'server
. Otherwise, an error
is raised. Set the 'server
value if you want to run a bridge to help
censored users connect to the Tor network, see
the Tor project’s
brige guide. Set the 'client
value if you want to connect to
somebody else’s bridge, see the Tor
project’s “Get Bridges” page. In both cases the required additional
configuration should be provided via #:config-file
option of
tor-configuration
.
protocol
(default: "obfs4"
)A string that specifies a pluggable transport protocol.
program
This must be a “file-like” object or a string pointing to the pluggable transport plugin executable. This option allows the Tor daemon run inside the container to access the executable and all the references (e.g. package dependencies) attached to it.
Suppose you would like Tor daemon to use obfs4 type obfuscation and to
connect to Tor network via obfs4 bridge (a nonpublic Tor relay with support
for obfs4 type obfuscation). Then you may go to
https://bridges.torproject.org/ and
get there a couple of bridge lines (each starts with obfs4 ...
) and
use these lines in tor-service-type configuration as follows:
(service tor-service-type
(tor-configuration
(config-file (plain-file "torrc"
"\
UseBridges 1
Bridge obfs4 ...
Bridge obfs4 ..."))
(transport-plugins
(list (tor-transport-plugin
(program
(file-append
go-gitlab-torproject-org-tpo-anti-censorship-pluggable-transports-lyrebird
"/bin/lyrebird")))))))
Le module (gnu services rsync)
fournit les services suivant :
Vous pourriez vouloir un démon rsync si vous voulez que des fichiers soient disponibles pour que n’importe qui (ou juste vous) puisse télécharger des fichiers existants ou en téléverser des nouveaux.
C’est le type pour le démon rsync. La valeur
de ce service est un enregistrement rsync-configuration
comme dans
cet exemple :
;; Exporte deux répertoires par rsync. Par défaut rsync écoute sur toutes ;; les interfaces réseau. (service rsync-service-type (rsync-configuration (modules (list (rsync-module (name "music") (file-name "/srv/zik") (read-only? #f)) (rsync-module (name "movies") (file-name "/home/charlie/movies"))))))
Voir plus pas pour trouver des détails à propos de
rsync-configuration
.
Type de données représentant la configuration de rsync-service
.
package
(par défaut : rsync)Le paquet rsync
à utiliser.
address
(par défaut : #f
)L’adresse sur laquelle rsync
écoute les connexions entrantes. Si
la valeur n’est pas spécifiée, écoute sur toutes les adresses par défaut.
port-number
(par défaut : 873
)Le port TCP sur lequel rsync
écoute les connexions entrantes. Si
le port est inférieur à 1024
, rsync
doit être démarré en
tant qu’utilisateur et groupe root
.
pid-file
(par défaut : "/var/run/rsyncd/rsyncd.pid"
)Nom du fichier où rsync
écrit son PID.
lock-file
(par défaut : "/var/run/rsyncd/rsyncd.lock"
)Nom du fichier où rsync
écrit son fichier de verrouillage.
log-file
(par défaut : "/var/log/rsyncd.log"
)Nom du fichier où rsync
écrit son fichier de journal.
user
(par défaut : "root"
)Propriétaire du processus rsync
.
group
(par défaut : "root"
)Groupe du processus rsync
.
uid
(par défaut : "rsyncd"
)Nom d’utilisateur ou ID utilisateur en tant que lequel les transferts de
fichiers ont lieu si le démon a été lancé en root
.
gid
(par défaut : "rsyncd"
)Nom du groupe ou ID du groupe qui sera utilisé lors de l’accès au module.
modules
(par défaut : %default-modules
)Liste des « modules » — c.-à-d. des répertoires exportés par
rsync. Chaque élément doit être un enregistrement rsync-module
, comme
décrit plus bas.
C’est le type de données pour les « modules » rsync. Un module est un répertoire exporté par le protocole rsync. Les champs disponibles sont les suivants :
name
Le nom du module. C’est le nom qui apparait dans les URL. Par exemple, si le
module se nomme music
, l’URL correspondante sera
rsync://host.example.org/music
.
file-name
Nom du répertoire exporté.
comment
(par défaut : ""
)Commentaire associé au module. Les interfaces utilisateurs clientes peuvent l’afficher quand ils récupèrent la liste des modules disponibles.
read-only?
(par défaut : #t
)Indique si le client pourra envoyer des fichiers. Si la valeur est fausse, les envoies seront autorisés si les permissions du côté du démon le permettent.
chroot?
(par défaut : #t
)Lorsque la valeur est vraie, le démon rsync change de racine pour le répertoire du module avant de commencer le transfert de fichiers avec le client. Cela améliore la sécurité, mais nécessite que rsync tourne en root.
timeout
(par défaut : 300
)La durée en secondes de silence après laquelle le démon ferme une connexion avec le client.
Le module (gnu services syncthing)
fournit les services suivant :
Vous pourriez vouloir un démon syncthing si vous avez des fichiers sur plusieurs ordinateurs et souhaitez les synchroniser en temps réel, de manière sécurisée sans espionnage possible.
C’est le type pour le démon syncthing. La
valeur de ce service est un enregistrement syncthing-configuration
comme dans cet exemple :
(service syncthing-service-type
(syncthing-configuration (user "alice")))
Remarque : This service is also available for Guix Home, where it runs directly with your user privileges (voir
home-syncthing-service-type
).
Voir plus pas pour trouver des détails à propos de
syncthing-configuration
.
Type de données représentant la configuration de syncthing-service
.
syncthing
(par défaut : syncthing)Le paquet syncthing
à utiliser.
arguments
(par défaut : ’())Liste d’arguments de la ligne de commande à passer au binaire
syncthing
.
logflags
(par défaut : 0)L’ensemble des drapeaux de journalisation, voir logfiles sur la documentation de Syncthing.
user
(par défaut : #f)L’utilisateur qui lance le service Syncthing. Cela suppose que l’utilisateur spécifié existe.
group
(par défaut : "users")Le groupe qui lance le service Syncthing. Cela suppose que le group spécifié existe.
home
(par défaut : #f)Configuration et répertoires de données communs. Le répertoire de
configuration par défaut est $HOME de l’utilisateur user
de
Syncthing.
En plus, (gnu services ssh)
fournit les services suivant.
Type of the service that runs the GNU lsh secure shell (SSH) daemon,
lshd
. The value for this service is a <lsh-configuration>
object.
Data type representing the configuration of lshd
.
lsh
(default: lsh
) (type: file-like)The package object of the GNU lsh secure shell (SSH) daemon.
daemonic?
(default: #t
) (type: boolean)Whether to detach from the controlling terminal.
host-key
(default: "/etc/lsh/host-key"
) (type: string)File containing the host key. This file must be readable by root only.
interfaces
(default: '()
) (type: list)List of host names or addresses that lshd
will listen on. If
empty, lshd
listens for connections on all the network interfaces.
port-number
(default: 22
) (type: integer)Port to listen on.
allow-empty-passwords?
(par défaut : #f
) (type : booléen)Whether to accept log-ins with empty passwords.
root-login?
(default: #f
) (type: boolean)Whether to accept log-ins as root.
syslog-output?
(default: #t
) (type: boolean)Whether to log lshd
standard output to syslogd. This will make
the service depend on the existence of a syslogd service.
pid-file?
(default: #f
) (type: boolean)When #t
, lshd
writes its PID to the file specified in
pid-file.
pid-file
(default: "/var/run/lshd.pid"
) (type: string)File that lshd
will write its PID to.
x11-forwarding?
(default: #t
) (type: boolean)Whether to enable X11 forwarding.
tcp/ip-forwarding?
(default: #t
) (type: boolean)Whether to enable TCP/IP forwarding.
password-authentication?
(default: #t
) (type: boolean)Whether to accept log-ins using password authentication.
public-key-authentication?
(default: #t
) (type: boolean)Whether to accept log-ins using public key authentication.
initialize?
(default: #t
) (type: boolean)When #f
, it is up to the user to initialize the randomness generator
(voir lsh-make-seed dans LSH Manual), and to create a key pair with
the private key stored in file host-key (voir lshd basics dans LSH Manual).
C’est le type pour le démon ssh OpenSSH,
sshd
. Sa valeur doit être un enregistrement
openssh-configuration
comme dans cet exemple :
(service openssh-service-type
(openssh-configuration
(x11-forwarding? #t)
(permit-root-login 'prohibit-password)
(authorized-keys
`(("alice" ,(local-file "alice.pub"))
("bob" ,(local-file "bob.pub"))))))
Voir plus bas pour trouver des détails sur openssh-configuration
.
Ce service peut être étendu avec des clefs autorisées supplémentaires, comme dans cet exemple :
(service-extension openssh-service-type
(const `(("charlie"
,(local-file "charlie.pub")))))
C’est l’enregistrement de la configuration de la commande sshd
d’OpenSSH.
openssh
(par défaut : openssh)Le paquet OpenSSH à utiliser.
pid-file
(par défaut : "/var/run/sshd.pid"
)Nom du fichier où sshd
écrit son PID.
port-number
(par défaut : 22
)Port TCP sur lequel sshd
écoute les connexions entrantes.
max-connections
(par défaut : 200
)Limite du nombre maximum de connexions clientes simultanées, appliquée par
le service Shepherd dans le style d’inetd (voir make-inetd-constructor
dans le manuel de GNU
Shepherd).
permit-root-login
(par défaut : #f
)Ce champ détermine si et quand autoriser les connexions en root. Si la
valeur est #f
, les connexions en root sont désactivées ; si la valeur
est #t
, elles sont autorisées. S’il s’agit du symbole
'prohibit-password
, alors les connexions root sont autorisées mais
pas par une authentification par mot de passe.
allow-empty-passwords?
(par défaut : #f
)Lorsque la valeur est vraie, les utilisateurs avec un mot de passe vide peuvent se connecter. Sinon, ils ne peuvent pas.
password-authentication?
(par défaut : #t
)Lorsque la valeur est vraie, les utilisateurs peuvent se connecter avec leur mot de passe. Sinon, ils doivent utiliser une autre méthode d’authentification.
public-key-authentication?
(par défaut : #t
)Lorsque la valeur est vraie, les utilisateurs peuvent se connecter avec leur clef publique. Sinon, les utilisateurs doivent utiliser une autre méthode d’authentification.
Les clefs publiques autorisées sont stockées dans ~/.ssh/authorized_keys. Ce n’est utilisé que par le protocole version 2.
x11-forwarding?
(par défaut : #f
)Lorsque la valeur est vraie, le transfert de connexion du client graphique
X11 est activé — en d’autre termes, les options -X et -Y
de ssh
fonctionneront.
allow-agent-forwarding?
(par défaut : #t
)Indique s’il faut autoriser la redirection d’agent.
allow-tcp-forwarding?
(par défaut : #t
)Indique s’il faut autoriser la redirection TCP.
gateway-ports?
(par défaut : #f
)Indique s’il faut autoriser les ports de passerelle.
challenge-response-authentication?
(par défaut : #f
)Spécifie si l’authentification par défi est autorisée (p. ex. via PAM).
use-pam?
(par défaut : #t
)Active l’interface avec le module d’authentification greffable, PAM. Si la
valeur est #t
, cela activera l’authentification PAM avec
challenge-response-authentication?
et
password-authentication?
, en plus des modules de compte et de session
de PAM pour tous les types d’authentification.
Comme l’authentification par défi de PAM sert généralement un rôle
équivalent à l’authentification par mot de passe, vous devriez désactiver
soit challenge-response-authentication?
, soit
password-authentication?
.
print-last-log?
(par défaut : #t
)Spécifie si sshd
devrait afficher la date et l’heure de dernière
connexion des utilisateurs lorsqu’un utilisateur se connecte de manière
interactive.
subsystems
(par défaut : '(("sftp" "internal-sftp"))
)Configure les sous-systèmes externes (p. ex. le démon de transfert de fichiers).
C’est une liste de paires, composées chacune du nom du sous-système et d’une commande (avec éventuellement des arguments) à exécuter à la demande du sous-système.
La commande internal-sftp
met en œuvre un serveur SFTP en cours de
traitement. On peut aussi spécifier la commande sftp-server
:
(service openssh-service-type
(openssh-configuration
(subsystems
`(("sftp" ,(file-append openssh "/libexec/sftp-server"))))))
accepted-environment
(par défaut : '()
)Liste de chaînes de caractères qui décrivent les variables d’environnement qui peuvent être exportées.
Chaque chaîne a sa propre ligne. Voir l’option AcceptEnv
dans
man sshd_config
.
Cet exemple permet aux clients ssh d’exporter la variable COLORTERM
.
Elle est initialisée par les émulateurs de terminaux qui supportent les
couleurs. Vous pouvez l’utiliser dans votre fichier de ressource de votre
shell pour activer les couleurs sur la ligne de commande si cette variable
est initialisée.
(service openssh-service-type
(openssh-configuration
(accepted-environment '("COLORTERM"))))
authorized-keys
(par défaut : '()
) ¶C’est la liste des clefs autorisées. Chaque élément de la liste est un nom d’utilisateur suivit d’un ou plusieurs objets simili-fichiers qui représentent les clefs publiques SSH. Par exemple :
(openssh-configuration
(authorized-keys
`(("rekado" ,(local-file "rekado.pub"))
("chris" ,(local-file "chris.pub"))
("root" ,(local-file "rekado.pub") ,(local-file "chris.pub")))))
enregistre les clefs publiques spécifiées pour les comptes rekado
,
chris
et root
.
Des clefs autorisées supplémentaires peuvent être spécifiées via
service-extension
.
Remarquez que cela n’interfère pas avec l’utilisation de ~/.ssh/authorized_keys.
generate-host-keys?
(par défaut : #t
)Indique s’il faut générer des pairs de clés hôtes avec ssh-keygen
-A
dans /etc/ssh s’il n’y en a pas.
Générer des pairs de clés prend quelques secondes quand assez d’entropie est disponible et n’arrive qu’une fois. Vous pouvez vouloir désactiver cette génération dans une machine virtuelle qui n’en a pas besoin car les clés hôtes sont fournies d’une autre manière, et où le temps de démarrage supplémentaire peut être un problème.
log-level
(par défaut : 'info
)C’est le symbole qui spécifie le niveau de journalisation : quiet
,
fatal
, error
, info
, verbose
, debug
, etc.
Voir la page de manuel de sshd_config pour trouver la liste complète
des noms de niveaux.
extra-content
(par défaut : ""
)Ce champ peut être utilisé pour ajouter un texte arbitraire au fichier de configuration. C’est particulièrement utile pour des configurations élaborées qui ne pourraient pas être exprimées autrement. Cette configuration, par exemple, désactiverait les connexions en root, mais les permettrait depuis une adresse IP spécifique :
(openssh-configuration
(extra-content "\
Match Address 192.168.0.1
PermitRootLogin yes"))
Type of the service that runs the
Dropbear SSH daemon,
whose value is a <dropbear-configuration>
object.
For example, to specify a Dropbear service listening on port 1234:
(service dropbear-service-type (dropbear-configuration
(port-number 1234)))
Ce type de données représente la configuration d’un démon SSH Dropbear.
dropbear
(par défaut : dropbear)Le paquet Dropbear à utiliser.
port-number
(par défaut : 22)Le port TCP sur lequel le démon attend des connexions entrantes.
syslog-output?
(par défaut : #t
)Indique s’il faut activer la sortie vers syslog.
pid-file
(par défaut : "/var/run/dropbear.pid"
)Nom du fichier de PID du démon.
root-login?
(par défaut : #f
)Indique s’il faut autoriser les connexions en root
.
allow-empty-passwords?
(par défaut : #f
)Indique s’il faut autoriser les mots de passes vides.
password-authentication?
(par défaut : #t
)Indique s’il faut autoriser l’authentification par mot de passe.
C’est le type du programme AutoSSH qui exécute une copie de ssh
et la surveille, en la
redémarrant si nécessaire si elle meurt ou arrête le trafic passant.
AutoSSH peut être exécuté manuellement à partir de la ligne de commande en
passant des arguments au binaire autossh
du paquet autossh
,
mais peut aussi être exécuté comme un service Guix. Ce dernier cas
d’utilisation est documenté ici.
AutoSSH peut être utilisé pour transférer le trafic local vers une machine distante en utilisant un tunnel SSH, et il respecte le ~/.ssh/config de l’utilisateur sous lequel il est exécuté.
Par exemple, pour spécifier un service exécutant autossh comme
utilisateur·rice pino
et transférant toutes les connexions locales au
port 8081
vers remote:8081
en utilisant un tunnel SSH, ajoutez
cet appel au champ services
du système d’exploitation :
(service autossh-service-type
(autossh-configuration
(user "pino")
(ssh-options (list "-T" "-N" "-L" "8081:localhost:8081" "remote.net"))))
Ce type de données représente la configuration du service AutoSSH.
user
(par défaut : "autossh"
)L’utilisateur·rice en tant que responsable du service AutoSSH. Cela suppose que l’utilisateur spécifié existe.
poll
(par défaut : 600
)Spécifie le temps de sondage de la connexion en secondes.
first-poll
(par défaut : #f
)Indique le nombre de secondes que l’AutoSSH attend avant le premier test de
connexion. Après ce premier test, le vote reprend au rythme défini dans
poll
. Lorsqu’il est défini à #f
, le premier sondage n’est pas
traité spécialement et utilisera également le sondage de connexion spécifié
dans poll
.
gate-time
(par défaut : 30
)Spécifie combien de secondes une connexion SSH doit être active avant qu’elle soit considérée comme réussie.
log-level
(par défaut : 1
)Le niveau du log, correspondant aux niveaux utilisés par syslog—donc
0
est le plus silencieux tandis que 7
est le plus bavard.
max-start
(par défaut : #f
)Le nombre maximum de fois que SSH peut être (re)démarré avant la sortie
d’AutoSSH. Lorsqu’il est défini sur #f
, aucun maximum n’est
configuré et AutoSSH peut redémarrer indéfiniment.
message
(par défaut : ""
)Le message à ajouter à celui de echo envoyé lors du test des connexions.
port
(par défaut : "0"
)Les ports utilisés pour la surveillance de la connexion. Lorsqu’il est
défini sur "0"
, la surveillance est désactivée. Lorsqu’il est défini
sur "n"
où n est un entier positif, les ports n et
n+1 sont utilisés pour surveiller la connexion, de sorte que le port
n est le port de surveillance de base et n+1
est le port
d’echo. Lorsqu’ils sont définis sur "n:m"
où n et
m sont des entiers positifs, les ports n et m sont
utilisés pour surveiller la connexion, de sorte que le port n est le
port de surveillance de base et m est le port d’echo.
ssh-options
(par défaut : '()
)La liste des arguments de la ligne de commande à passer à ssh
lorsqu’elle est exécutée. Les options -f et -M sont
réservées à AutoSSH et peuvent provoquer un comportement indéfini.
C’est le type du programme WebSSH
qui exécute un client web SSH. WebSSH peut être exécuté manuellement à
partir de la ligne de commande en passant des arguments au binaire
wssh
du paquet webssh
, mais il peut aussi être exécuté
comme un service Guix. Ce dernier cas d’utilisation est documenté ici.
Par exemple, pour spécifier un service exécutant WebSSH sur l’interface de
bouclage sur le port 8888
avec une politique de rejet avec une liste
des hôtes autorisés à se connecter, et NGINX comme reverse-proxy de ce
service écoutant la connexion HTTPS, ajouter cet appel au champ
services
du système d’exploitation :
(service webssh-service-type (webssh-configuration (address "127.0.0.1") (port 8888) (policy 'reject) (known-hosts '("localhost ecdsa-sha2-nistp256 AAAA…" "127.0.0.1 ecdsa-sha2-nistp256 AAAA…")))) (service nginx-service-type (nginx-configuration (server-blocks (list (nginx-server-configuration (inherit %webssh-configuration-nginx) (server-name '("webssh.example.com")) (listen '("443 ssl")) (ssl-certificate (letsencrypt-certificate "webssh.example.com")) (ssl-certificate-key (letsencrypt-key "webssh.example.com")) (locations (cons (nginx-location-configuration (uri "/.well-known") (body '("root /var/www;"))) (nginx-server-configuration-locations %webssh-configuration-nginx))))))))
Type de données représentant la configuration pour webssh-service
.
package
(par défaut : webssh)Le paquet webssh
à utiliser.
user-name
(par défaut : "webssh")Le nom ou l’identifiant de l’utilisateur·rice qui transfère le fichier vers et depuis ce module doit avoir lieu.
group-name
(par défaut : "webssh")Nom du groupe ou ID du groupe qui sera utilisé lors de l’accès au module.
address
(par défaut : #f)Adresse IP sur laquelle webssh
écoute les connexions entrantes.
port
(par défaut : 8888)Port TCP sur lequel webssh
écoute les connexions entrantes.
policy
(par défaut : #f)Politique de connexion. La politique de reject nécessite de spécifier known-hosts.
known-hosts
(par défaut : ’())Liste des hôtes qui ont permis une connexion SSH à partir de
webssh
.
log-file
(par défaut : "/var/log/webssh.log"
)Nom du fichier où webssh
écrit son fichier de journal.
log-level
(par défaut : #f)Niveau d’enregistrement.
This service type adds a list of known Facebook hosts to the
/etc/hosts file. (voir Host Names dans The GNU C Library
Reference Manual) Each line contains an entry that maps a known server
name of the Facebook on-line service—e.g., www.facebook.com
—to
unroutable IPv4 and IPv6 addresses.
Ce mécanisme peut éviter que des programmes qui tournent localement, comme des navigateurs Web, ne se connectent à Facebook.
Le module (gnu services avahi)
fourni la définition suivante.
C’est le service qui lance avahi-daemon
, un service système qui
répond aux requêtes mDNS/DNS-SD qui permet la découverte de services et la
recherche de nom en « zéro configuration » (voir
https://avahi.org/). Sa valeur doit être un enregistrement
avahi-configuration
— voir plus bas.
Ce service étend le démon de cache de services de noms (nscd) pour qu’il
puisse résoudre les noms d’hôtes en .local
avec
nss-mdns. Voir Name Service Switch, pour plus d’informations sur la résolution des noms d’hôte.
En plus, cela ajoute le paquet avahi au profil du système pour que les
commandes comme avahi-browse
soient directement utilisables.
Type de données représentant la configuration d’Avahi.
host-name
(par défaut : #f
)Si la valeur n’est pas #f
, utilise cette valeur comme nom d’hôte à
publier pour la machine ; sinon, utilise le vrai nom d’hôte de la machine.
publish?
(par défaut : #t
)Lorsque la valeur est vraie, permet la publication sur le réseau (en diffusion) des noms d’hôtes et des services.
publish-workstation?
(par défaut : #t
)Lorsque la valeur est vraie, avahi-daemon
publie le nom d’hôte et
l’adresse IP de la machine via mDNS sur le réseau local. Pour voir les noms
d’hôtes publiés sur votre réseau local, vous pouvez lancer :
avahi-browse _workstation._tcp
wide-area?
(par défaut : #f
)Lorsque la valeur est vraie, DNS-SD sur DNS unicast est activé.
ipv4?
(par défaut : #t
)ipv6?
(par défaut : #t
)Ces champs déterminent s’il faut utiliser des socket IPv4/IPv6.
domains-to-browse
(par défaut : '()
)C’est la liste des domaines sur lesquels naviguer.
C’est le type du service Open vSwitch,
dont la valeur devrait être un objet openvswitch-configuration
.
Type de données représentant la configuration de Open vSwitch, un commutateur virtuel multiniveaux conçu pour rendre possible l’automatisation massive des réseaux avec des extensions programmables.
package
(par défaut : openvswitch)Objet de paquet de Open vSwitch.
Il s’agit du type de service du service PageKite, une solution de tunneling permettant de rendre les serveurs
locaux visibles au public, même derrière des pare-feu restrictifs ou du NAT
sans transfert de ports. La valeur pour ce type de service est un
enregistrement pagekite-configuration
.
Voici un exemple exposant les démons locaux HTTP et SSH :
(service pagekite-service-type
(pagekite-configuration
(kites '("http:@kitename:localhost:80:@kitesecret"
"raw/22:@kitename:localhost:22:@kitesecret"))
(extra-file "/etc/pagekite.rc")))
Type de données représentant la configuration de PageKite.
package
(par défaut : pagekite)Objet du paquet de PageKite.
kitename
(par défaut : #f
)Nom de PageKite pour l’authentification au serveur frontal.
kitesecret
(par défaut : #f
)Secret partagé pour s’authentifier auprès du serveur frontal. Vous devriez
probablement mettre cela dans extra-file
à la place.
frontend
(par défaut : #f
)Connectez-vous au serveur frontal nommé PageKite au lieu du service pagekite.net.
kites
(par défaut : '("http:@kitename:localhost:80:@kitesecret")
)Liste de services kites à utiliser. Expose HTTP sur le port 80 par
défaut. Le format est proto:nomdukite:hôte:port:secret
.
extra-file
(par défaut : #f
)Fichier de configuration supplémentaire à lire, que vous devez créer manuellement. Utilisez-le pour ajouter des options supplémentaires et gérer les secrets partagés hors bande.
Le type de service pour se connecter au réseau Yggdrasil, une jeune implémentation d’un réseau IPv6 entièrement chiffré de bout en bout.
Yggdrasil fournit le routage indépendant du nom avec des adresses générées de manière cryptographiques. L’adressage statique signifie que vous pouvez garder la même adresse aussi longtemps que vous le souhaitez, même si vous changez d’emplacement, et que vous pouvez générer une nouvelle adresse (en générant de nouvelles clés) quand vous le souhaitez. https://yggdrasil-network.github.io/2018/07/28/addressing.html
Passez-lui une valeur de type yggdrasil-configuration
pour le
connecter aux pairs publics ou aux pairs locaux.
voici un exemple qui utilise des pairs publics et une adresse statique. Les
clés de signature et de chiffrement statiques sont définies dans
/etc/yggdrasil-private.conf (la valeur par défaut de
config-file
).
;; extrait d'une déclaration de système d'exploitation (service yggdrasil-service-type (yggdrasil-configuration (autoconf? #f) ;; utiliser uniquement les pairs publics (json-config ;; choisir parmi ;; https://github.com/yggdrasil-network/public-peers '((peers . #("tcp://1.2.3.4:1337")))) ;; /etc/yggdrasil-private.conf est la valeur par défaut pour config-file ))
# sample content for /etc/yggdrasil-private.conf { # Your private key. DO NOT share this with anyone! PrivateKey: 5c750... }
Type de données qui représente la configuration de Yggdrasil.
package
(par défaut : yggdrasil
)Objet du paquet de Yggdrasil.
json-config
(par défaut : '()
)Contenu de /etc/yggdrasil.conf. Sera fusionné avec
/etc/yggdrasil-private.conf. Remarquez que ces paramètres sont
stockés dans le dépôt de Guix, qui est disponible en lecture pour tout le
monde. Ne stockez pas vos clés privées dedans. Voir la sortie de
yggdrasil -genconf
pour un aperçu rapide de ce que sont des clés
valides et leurs valeurs par défaut.
autoconf?
(par défaut : #f
)Indique s’il faut utiliser le mode automatique. L’activer fera utiliser une IP dynamique à Yggdrasil et l’appairer à ses voisins IPv6.
log-level
(par défaut : 'info
)La quantité de détails à inclure dans les journaux. Utilisez 'debug
pour plus de détails.
log-to
(par défaut : 'stdout
)L’emplacement où envoyer les journaux. Par défaut, le service enregistre la
sortie standard dans /var/log/yggdrasil.log. L’alternative est
'syslog
, qui envoie la sortie au service syslog.
config-file
(par défaut : "/etc/yggdrasil-private.conf"
)What HJSON file to load sensitive data from. This is where private keys
should be stored, which are necessary to specify if you don’t want a
randomized address after each restart. Use #f
to disable. Options
defined in this file take precedence over json-config
. Use the
output of yggdrasil -genconf
as a starting point. To configure a
static address, delete everything except PrivateKey option.
Le type de service pour se connecter au réseau IPFS,
un système de fichiers mondial, versionné et en pair-à-pair. Passez lui un
objet ipfs-configuration
pour changer les ports utilisés pour la
passerelle et l’API.
Voici un exemple de configuration, avec des ports non standards :
(service ipfs-service-type
(ipfs-configuration
(gateway "/ip4/127.0.0.1/tcp/8880")
(api "/ip4/127.0.0.1/tcp/8881")))
Type de données représentant la configuration d’IPFS.
package
(par défaut : go-ipfs
)Objet du paquet d’IPFS.
gateway
(par défaut : "/ip4/127.0.0.1/tcp/8082"
)Adresse de la passerelle, au format « multiaddress ».
api
(par défaut : "/ip4/127.0.0.1/tcp/5001"
)Adresse du point d’accès de l’API, au format « multiaddress ».
C’est le type pour le logiciel de routage Keepalived, keepalived
. Sa valeur doit être un enregistrement
keepalived-configuration
comme dans cet exemple pour la machine
maître :
(service keepalived-service-type
(keepalived-configuration
(config-file (local-file "keepalived-master.conf"))))
où keepalived-master.conf :
vrrp_instance my-group { state MASTER interface enp9s0 virtual_router_id 100 priority 100 unicast_peer { 10.0.0.2 } virtual_ipaddress { 10.0.0.4/24 } }
et pour la machine de secours :
(service keepalived-service-type
(keepalived-configuration
(config-file (local-file "keepalived-backup.conf"))))
où keepalived-backup.conf :
vrrp_instance my-group { state BACKUP interface enp9s0 virtual_router_id 100 priority 99 unicast_peer { 10.0.0.3 } virtual_ipaddress { 10.0.0.4/24 } }
Suivant: Système de fenêtrage X, Précédent: Services réseau, Monter: Services [Table des matières][Index]
Guix fournit un service pour effectuer des unattended upgrades : périodiquement, le système se reconfigure automatiquement à partir du dernier Guix. Guix System possède plusieurs propriétés qui rendent les mises à jour non surveillées sûres :
guix system list-generations
–et vous pouvez revenir à n’importe
quelle génération précédente, si le système mis à jour ne se comporte pas
comme prévu ;
guix system reconfigure
empêche les déclassements, ce qui le rend
immunisé contre les attaques downgrade attacks.
Pour mettre en place des mises à jour sans surveillance, ajoutez une
instance de unattended-upgrade-service-type
comme celle ci-dessous, à
la liste des services de votre système d’exploitation :
Les valeurs par défaut ci-dessus mettent en place des mises à jour hebdomadaires : tous les dimanches à minuit. Il n’est pas nécessaire de fournir le fichier de configuration du système d’exploitation : il utilise /run/current-system/configuration.scm, ce qui garantit qu’il utilise toujours votre dernière configuration—voir provenance-service-type, pour plus d’informations sur ce fichier.
Plusieurs choses peuvent être configurés, notamment la périodicité et les
services (démons) à redémarrer à la fin. Lorsque la mise à jour est
réussie, le service se charge de supprimer les générations de systèmes plus
anciennes qu’un certain seuil, conformément à guix system
delete-generations
. Voir la référence ci-dessous pour plus de détails.
Pour vous assurer que les mises à jour sont bien effectuées, vous pouvez
exécuter guix system describe
. Pour enquêter sur les échecs de
mise à jour, consultez le fichier journal des mises à jour non surveillées
(voir ci-dessous).
C’est le type de service pour les mises à jour sans surveillance. Il met en
place un job mcron (voir Exécution de tâches planifiées) qui exécute
guix system reconfigure
à partir de la dernière version des canaux
spécifiés.
Sa valeur doit être un enregistrement
unattended-upgrade-configuration
(voir ci-dessous).
Ce type de données représente la configuration du service de mise à jour non surveillée. Les champs suivants sont disponibles :
schedule
(par défaut : "30 01 * * 0"
)Il s’agit du calendrier des mises à jour, exprimé sous la forme d’une gexp contenant un calendrier des travaux mcron (voir mcron job specifications dans GNU mcron).
channels
(par défaut : #~%default-channels
)Ce gexp spécifie les canaux à utiliser pour la mise à jour
(voir Canaux). Par défaut, l’extrémité du canal officiel guix
est
utilisée.
operating-system-file
(par défaut : "/run/current-system/configuration.scm"
)Ce champ indique le fichier de configuration du système d’exploitation à utiliser. La valeur par défaut est de réutiliser le fichier de configuration de la configuration actuelle.
Il y a cependant des cas où la référence à
/run/current-system/configuration.scm n’est pas suffisante, par
exemple parce que ce fichier fait référence à des fichiers supplémentaires
(clés publiques SSH, fichiers de configuration supplémentaires, etc.)
via local-file
et constructions similaires. Pour ces cas, nous
recommandons quelque chose qui va dans ce sens :
(unattended-upgrade-configuration
(operating-system-file
(file-append (local-file "." "config-dir" #:recursive? #t)
"/config.scm")))
L’effet ici est d’importer tout le répertoire courant dans le dépôt, et de
se référer à config.scm dans ce répertoire. Par conséquent,
l’utilisation de local-file
dans config.scm fonctionnera comme
prévu. Voir G-Expressions, pour plus d’ informations sur
local-file
et file-append
.
operating-system-expression
(par défaut : #f
)Ce champ spécifie une expression qui s’évalue en un système d’exploitation à
utiliser pour la mise à jour. Si aucune valeur n’est fournie, le champ
operating-system-file
est utilisé.
(unattended-upgrade-configuration
(operating-system-expression
#~(@ (guix system install) installation-os)))
reboot?
(default: #f
)This field specifies whether the system should reboot after completing an unattended upgrade.
services-to-restart
(par défaut : '(mcron)
)Ce champ indique les services Shepherd à redémarrer lorsque la mise à jour est terminée.
Ces services sont redémarrés dès qu’ils sont terminés, comme avec
herd restart
, ce qui garantit que la dernière version
fonctionne—souvenez-vous que par défaut guix system reconfigure
ne redémarre que les services qui ne fonctionnent pas actuellement, ce qui
est conservateur : cela minimise les perturbations mais laisse fonctionner
les services obsolètes.
Utilisez herd status
pour trouver les candidats au
redémarrage. Voir Services, pour des informations générales sur les
services. Les services courants à redémarrer sont ntpd
et
ssh-daemon
.
Par défaut, le service mcron
est redémarré. Cela garantit que la
dernière version du travail de mise à niveau non surveillée sera utilisée la
prochaine fois.
system-expiration
(par défaut : (* 3 30 24 3600)
)C’est le temps d’expiration en secondes pour les générations du système.
Les générations du système plus anciennes que ce délai sont supprimées avec
guix system delete-generations
lorsqu’une mise à jour se termine .
Remarque : Le service de mise à jour sans surveillance ne fait pas fonctionner le ramasse miettes. Vous voudrez probablement configurer votre propre job mcron pour exécuter
guix gc
périodiquement.
minimum-duration
(par défaut : 3600
)Durée maximale en secondes de la mise à jour ; passé ce délai, la mise à jour est interrompue.
Cela est surtout utile pour s’assurer que la mise à jour ne finira pas par reconstruire ou retélécharger « le monde ».
log-file
(par défaut : "/var/log/unattended-upgrade.log"
)Fichier où sont consignées les mises à jour non surveillées.
Suivant: Services d’impression, Précédent: Mises à jour non surveillées (Unattended Upgrades), Monter: Services [Table des matières][Index]
La prise en chargue du système d’affichage graphique X Window — en
particulier Xorg — est fournit par le module (gnu services xorg)
.
Remarquez qu’il n’y a pas de procédure xorg-service
. À la place, le
serveur X est démarré par le gestionnaire de connexion, par défaut le
gestionnaire d’affichage de GNOME (GDM).
GDM permet évidemment aux utilisateurs de se connecter et d’ouvrir un gestionnaire de fenêtre ou un gestionnaire d’environnement autre que GNOME ; pour ceux qui utilisent GNOME, GDM est requis pour certaines fonctionnalités comme l’écran de verrouillage automatique.
Pour utiliser X11, vous devez installer au moins un gestionnaire de
fenêtre — par exemple les paquets windowmaker
ou openbox
— de
préférence en l’ajoutant au champ packages
de votre définition de
système d’exploitation (voir system-wide
packages).
GDM also supports Wayland: it can itself use Wayland instead of X11 for its
user interface, and it can also start Wayland sessions. Wayland support is
enabled by default. To disable it, set wayland?
to #f
in
gdm-configuration
.
C’est le type pour le GNOME
Desktop Manager (GDM), un programme qui gère les serveurs d’affichage
graphique et qui gère les connexions graphiques des utilisateur·rice·s. Sa
valeur doit être un gdm-configuration
(voir ci-dessous).
GDM cherche des types de sessions définies par les fichiers
.desktop dans /run/current-system/profile/share/xsessions
(pour les session X11) et
/run/current-system/profile/share/wayland-sessions (pour les sessions
Wayland) et permet aux utilisateurs de choisir une session depuis l’écran de
connexion. Les paquets comme gnmoe
, xfce
, i3
et
sway
fournissent des fichiers .desktop ; les ajouter à
l’ensemble des paquets du système les rendra automatiquement disponibles sur
l’écran de connexion.
En plus, les fichiers ~/.xsession sont pris en compte. Lorsqu’il est disponible, ~/.xsession doit être un fichier exécutable qui démarre un gestionnaire de fenêtre au un autre client X.
auto-login?
(par défaut : #f
)default-user
(par défaut : #f
)Lorsque auto-login?
est faux, GDM présente un écran de connexion.
Lorsque auto-login?
est vrai, GDM se connecte directement en tant que
default-user
.
auto-suspend?
(par défaut : #t
)Lorsque la valeur est vraie, GDM passera en veille lorsque personne n’est connecté physiquement. Si votre machine peut être utilisée avec un bureau à distance ou SSH, cette option devrait être mise à faux pour éviter que GDM n’interrompe les sessions distantes ou rende la machine indisponible.
debug?
(par défaut : #f
)Lorsqu’il est « vrai », GDM écrit des messages de débogage dans son journal.
gnome-shell-assets
(par défaut : …)Liste de données requises par GDM : un thème d’icônes, des polices, etc.
xorg-configuration
(par défaut : (xorg-configuration)
)Configuration du serveur graphique Xorg.
x-session
(par défaut : xinitrc
)Le script à lancer avant de démarrer une session X.
xdmcp?
(par défaut : #f
)Lorsque la valeur est vraie, active le protocole de contrôle du gestionnaire d’affichage X (XDMCP). Cela ne devrait être activé que dans des environnements de confiance, car le protocole n’est pas sécurisé. Lorsque l’option est activée, GDM attend des requêtes XDMCP sur le port UDP 177.
dbus-daemon
(par défaut : dbus-daemon-wrapper
)Nom du fichier de l’exécutable dbus-daemon
.
gdm
(par défaut : gdm
)Le paquet GDM à utiliser.
wayland?
(default: #t
)Lorsque la valeur est vraie, active Wayland dans GDM, ce qui est requis pour utiliser les sessions Wayland.
wayland-session
(par défaut : gdm-wayland-session-wrapper
)L’enveloppe de session Wayland à utiliser, requise pour mettre en place l’environnement.
C’est de type pour le gestionnaire de connexion graphique SLiM pour X11.
Comme GDM, SLiM recherche des types de sessions décrites par des fichiers .desktop et permet aux utilisateurs de choisir une session à partir de l’écran de connexion avec F1. Il prend aussi en compte les fichiers ~/.xsession.
Contrairement à GDM, SLiM ne démarre pas la session utilisateur sur un terminal virtuel différent à la connexion, ce qui signifie que vous ne pouvez démarrer qu’une seule session graphique. Si vous voulez pouvoir exécuter plusieurs sessions graphiques en même temps, vous devez ajouter plusieurs services SLiM à la liste des services de votre système. L’exemple suivant montre comment remplacer le service GDM par défaut par deux services SLiM sur les tty 7 et 8.
(use-modules (gnu services) (gnu services desktop) (gnu services xorg)) (operating-system ;; ... (services (cons* (service slim-service-type (slim-configuration (display ":0") (vt "vt7"))) (service slim-service-type (slim-configuration (display ":1") (vt "vt8"))) (modify-services %desktop-services (delete gdm-service-type)))))
Type de données représentant la configuration de slim-service-type
.
allow-empty-passwords?
(par défaut : #t
)S’il faut autoriser les connexions avec un mot de passe vide.
gnupg?
(par défaut : #f
)Si l’option est activée, pam-gnupg
essaiera automatique de débloquer
les clés GPG de l’utilisateur·rice avec le mot de passe de connexion via
gpg-agent
. Les keygrips de toutes les clés à débloquer doivent se
trouver dans ~/.pam-gnupg et vous pouvez les récupérer avec gpg
-K --with-keygrip
. Vous pouvez activer le préchargement des phrases de
passes en ajoutant allow-preset-passphrase
dans
~/.gnupg/gpg-agent.conf.
auto-login?
(par défaut : #f
)default-user
(par défaut : ""
)Lorsque auto-login?
est faux, SLiM présent un écran de connexion.
Lorsque auto-login?
est vrai, SLiM se connecte directement en tant
que default-user
.
theme
(par défaut : %default-slim-theme
)theme-name
(par défaut : %default-slim-theme-name
)Le thème graphique à utiliser et son nom.
auto-login-session
(par défaut : #f
)Si la valeur est vraie, elle doit être le nom d’un exécutable à démarrer
comme session par défaut — p. ex. (file-append windowmaker
"/bin/windowmaker")
.
Si la valeur est fausse, une session décrite par l’un des fichiers
.desktop disponibles dans /run/current-system/profile
et
~/.guix-profile
sera utilisée.
Remarque : Vous devez installer au moins un gestionnaire de fenêtres dans le profil du système ou dans votre profil utilisateur. Sinon, si
auto-login-session
est faux, vous ne serez jamais capable de vous connecter.
xorg-configuration
(par défaut : (xorg-configuration)
)Configuration du serveur graphique Xorg.
display
(par défaut : ":0"
)La session d’affichage sur laquelle démarrer le serveur graphique Xorg.
vt
(par défaut : "vt7"
)Le terminal virtuel sur lequel démarrer le serveur d’affichage graphique Xorg.
xauth
(par défaut : xauth
)Le paquet XAuth à utiliser.
shepherd
(par défaut : shepherd
)Le paquet Shepherd à utiliser pour invoquer halt
et
reboot
.
sessreg
(par défaut : sessreg
)Le paquet sessreg à utiliser pour enregistrer la session.
slim
(par défaut : slim
)Le paquet SLiM à utiliser.
Le thème SLiM par défaut et son nom.
C’est le type de service qui permet d’exécuter le gestionnaire d’affichage
Gestionnaire d’affichage SDDM. Sa
valeur doit être un enregistrement sddm-configuration
(voir
ci-dessous).
Voici un exemple d’utilisation :
(service sddm-service-type
(sddm-configuration
(auto-login-user "alice")
(auto-login-session "xfce.desktop")))
Ce type de données représente la configuration du gestionnaire de connexion SDDM. Les champs disponibles sont :
sddm
(par défaut : sddm
)Le paquet SDDM à utiliser.
Remarque : sddm has Qt6 enabled by default. If you want to still use a Qt5 theme, you need to set it to
sddm-qt5
.
display-server
(par défaut : "x11")Choisit le serveur d’affichage à utiliser pour l’écran d’accueil. Les valeurs valides sont ‘"x11"’ ou ‘"wayland"’.
numlock
(par défaut : "on")Les valeurs valides sont ‘"on"’, ‘"off"’ or ‘"none"’.
halt-command
(par défaut : #~(string-append #$shepherd "/sbin/halt")
)La commande à lancer à l’arrêt du système.
reboot-command
(par défaut : #~(string-append #$shepherd "/sbin/reboot")
)La commande à lancer lors du redémarrage du système.
theme
(par défaut : "maldives")Thème à utiliser. Les thèmes par défaut fournis par SDDM sont ‘"elarun"’, ‘"maldives"’ ou ‘"maya"’.
themes-directory
(par défaut : "/run/current-system/profile/share/sddm/themes")Le répertoire où se trouvent les thèmes.
faces-directory
(par défaut : "/run/current-system/profile/share/sddm/faces")Répertoire où se trouvent les avatars.
default-path
(par défaut : "/run/current-system/profile/bin")Le PATH par défaut à utiliser.
minimum-uid
(par défaut : 1000)UID minimum affiché dans le SDDM et autorisé pour la connexion.
maximum-uid
(par défaut : 2000)UID maximum pour être affiché dans SDDM.
remember-last-user?
(par défaut : #t)S’il faut se rappeler le dernier utilisateur connecté.
remember-last-session?
(par défaut : #t)S’il faut se rappeler la dernière session.
hide-users
(par défaut : "")Les noms d’utilisateurs à cacher sur l’écran d’accueil de SDDM.
hide-shells
(par défaut : #~(string-append #$shadow "/sbin/nologin")
)Les utilisateurs avec les shells listés seront cachés sur l’écran d’accueil de SDDM.
session-command
(par défaut : #~(string-append #$sddm "/share/sddm/scripts/wayland-session")
)Le script à lancer avant de démarrer une session wayland.
sessions-directory
(par défaut : "/run/current-system/profile/share/wayland-sessions")Le répertoire où trouver les fichiers .desktop qui démarrent des sessions wayland.
xorg-configuration
(par défaut : (xorg-configuration)
)Configuration du serveur graphique Xorg.
xauth-path
(par défaut : #~(string-append #$xauth "/bin/xauth")
)Chemin vers xauth.
xephyr-path
(par défaut : #~(string-append #$xorg-server "/bin/Xephyr")
)Chemin vers Xephyr.
xdisplay-start
(par défaut : #~(string-append #$sddm "/share/sddm/scripts/Xsetup")
)Le script à lancer après avoir démarré xorg-server.
xdisplay-stop
(par défaut : #~(string-append #$sddm "/share/sddm/scripts/Xstop")
)Le script à lancer avant d’arrêter xorg-server.
xsession-command
(par défaut : xinitrc
)Le script à lancer avant de démarrer une session X.
xsessions-directory
(par défaut : "/run/current-system/profile/share/xsessions")Répertoire où trouver les fichiers .desktop pour les sessions X.
minimum-vt
(par défaut : 7)VT minimal à utiliser.
auto-login-user
(par défaut : "")Compte utilisateur qui sera automatiquement connecté. Paramétrer ceci à la chaine vide désactive la connexion automatique.
auto-login-session
(par défaut : "")Nom du fichier .desktop utilisé comme session pour la connexion automatique, ou la chaine vide.
relogin?
(par défaut : #f)S’il faut se reconnecter après la déconnexion.
C’est le type de service qui lance le
gestionnaire d’affichage
LightDM. Sa valeur doit être un enregistrement
lightdm-configuration
, qui est documenté ci-dessous. Entre autres
particularité, il possède une intégration avec TigerVNC pour accéder à votre
bureau à distance ainsi que la prise en charge du protocole XDMCP, qui peut
être utilisé par les clients distants pour démarrer une session à partir du
gestionnaire de connexion.
Dans sa forme la plus basique, il peut s’utiliser de cette manière :
Un exemple plus élaboré qui utilise la fonctionnalité VNC et active plus de fonctionnalités et les journaux verbeux ressemblerait à ceci :
(service lightdm-service-type
(lightdm-configuration
(allow-empty-passwords? #t)
(xdmcp? #t)
(vnc-server? #t)
(vnc-server-command
(file-append tigervnc-server "/bin/Xvnc"
" -SecurityTypes None"))
(seats
(list (lightdm-seat-configuration
(name "*")
(user-session "ratpoison"))))))
Les champs de lightdm-configuration
disponibles sont :
lightdm
(par défaut : lightdm
) (type : simili-fichier)Le paquet lightdm à utiliser.
allow-empty-passwords?
(par défaut : #f
) (type : booléen)Indique si les utilisateurs et utilisatrices sans mot de passe peuvent se connecter.
debug?
(par défaut : #f
) (type : booléen)Active la sortie verbeuse.
xorg-configuration
(type : xorg-configuration)La configuration par défaut du serveur Xorg à utiliser pour générer le
script de démarrage du serveur Xorg. Elle peut être raffinée pour chaque
siège via le champ xserver-command
de l’enregistrement
<lightdm-seat-configuration>
si vous le souhaitez.
greeters
(type : liste-de-greeter-configurations)Les configurations de l’écran d’accueil de LightDM spécifiant les écrans d’accueil à utiliser.
seats
(type : liste-de-seat-configurations)Les configurations de sièges à utiliser. Un siège LightDM correspond à un utilisateur ou une utilisatrice.
xdmcp?
(par défaut : #f
) (type : booléen)Indique si le serveur XDMCP doit écouter sur le port UDP 177.
xdmcp-listen-address
(type : peut-être-chaine)L’hôte ou l’adresse IP sur laquelle le serveur XDMCP écoute les connexions entrantes. Si la valeur n’est pas spécifiée, écoute sur tous les hôtes et toutes les adresses.
vnc-server?
(par défaut : #f
) (type : booléen)Si un serveur VNC est démarré.
vnc-server-command
(type : simili-fichier)La commande Xvnc à utiliser pour le serveur VNC, il est possible de fournir des options supplémentaires qui ne sont sinon pas exposées avec la commande, par exemple pour désactiver la sécurité :
(vnc-server-command (file-append tigervnc-server "/bin/Xvnc"
" -SecurityTypes None" ))
Ou pour indiquer un fichier de mot de passe pour le mécanisme VncAuth classique (non sécurisé) :
(vnc-server-command (file-append tigervnc-server "/bin/Xvnc"
" -PasswordFile /var/lib/lightdm/.vnc/passwd"))
Le fichier de mots de passe devrait être créé manuellement avec la commande
vncpasswd
. Remarquez que LightDM créera de nouvelles sessions pour
les utilisateurs et les utilisatrices VNC, ce qui signifie qu’ils et elles
devront s’authentifier de la même manière que les utilisateurs locaux et
utilisatrices locales.
vnc-server-listen-address
(type : peut-être-chaine)L’hôte ou l’adresse IP sur laquelle le serveur VNC écoute les connexions entrantes. Si la valeur n’est pas spécifiée, écoute sur tous les hôtes et toutes les adresses.
vnc-server-port
(par défaut : 5900
) (type : nombre)Port TCP sur lequel écoute le serveur VNC.
extra-config
(par défaut : '()
) (type : liste-de-chaines)Valeurs de configuration supplémentaires à ajouter à la fin du fichier de configuration de LightDM.
Les champs de lightdm-gtk-greter-configuration
disponibles sont :
lightdm-gtk-greeter
(par défaut : lightdm-gtk-greeter
) (type : simili-fichier)Le paquet lightdm-gtk-greeter à utiliser.
assets
(par défaut : (adwaita-icon-theme gnome-themes-extrahicolor-icon-theme)
) (type : liste-de-simili-fichiers)La liste des paquets qui accompagnent l’écran d’accueil, comme un paquet qui fournit un thème d’icônes.
theme-name
(par défaut : "Adwaita"
) (type : chaine)Le nom du thème à utiliser.
icon-theme-name
(par défaut : "Adwaita"
) (type : chaine)Le nom du thème d’icônes à utiliser.
cursor-theme-name
(par défaut : "Adwaita"
) (type : chaine)Le nom du thème de curseurs à utiliser.
cursor-theme-size
(par défaut : 16
) (type : nombre)La taille à utiliser pour le thème de curseurs.
allow-debugging?
(type : peut-être-booléen)Indiquez #t pour activer le niveau de journalisation de débogage.
background
(type : simili-fichier)L’image de fond à utiliser.
at-spi-enables?
(par défaut : #f
) (type : booléen)Active la prise en charge de l’accessibilité à travers l’interface de fourniture de service de technologie d’assistance (AT-SPI).
a11y-states
(par défaut : (contrast font keyboard reader)
) (type : liste-d’états-d’accessibilité)Les fonctionnalités d’accessibilité à activer, données en tant que liste de symboles.
reader
(type : peut-être-simili-fichier)La commande à utiliser pour lancer un lecteur d’écran.
extra-config
(par défaut : '()
) (type : liste-de-chaines)Valeurs de configuration supplémentaires à ajouter à la fin du fichier de configuration de l’écran d’accueil de LightDM.
Les champs de lightdm-seat-configuration
disponibles sont :
name
(type : nom-de-siège)Le nom du siège. Vous pouvez utiliser un astérisque (*) dans le nom pour appliquer la configuration de siège à tous les noms de sièges qui correspondent.
user-session
(type : peut-être-chaine)La session à utiliser par défaut. Le nom de session doit être fournit en une
chaine en minuscules, comme "gnome"
, "ratpoison"
, etc.
type
(par défaut : local
) (type : type-de-siège)Le type du siège, soit le symbole local
, soit le symbole
xremote
.
autologin-user
(type : peut-être-chaine)Le nom d’utilisateur à connecter par défaut.
greeter-session
(par défaut : lightdm-gtk-greeter
) (type : greeter-session)La session d’écran d’accueil à utilisé, spécifié en tant que
symbole. Actuellement, seul lightdm-gtk-greeter
est pris en charge.
xserver-command
(type : peut-être-simili-fichier)La commande du serveur Xorg à lancer.
session-wrapper
(type : simili-fichier)L’enveloppe de session xinitrc à utiliser.
extra-config
(par défaut : '()
) (type : liste-de-chaines)Valeurs de configuration supplémentaires à ajouter à la fin de la section de configuration des sièges.
Ce type de données représente la configuration du serveur d’affichage
graphique Xorg. Remarquez qu’il n’y a pas de service Xorg ; à la place, le
serveur X est démarré par un « gestionnaire d’affichage graphique » comme
GDM, SDDM, LightDM et SLiM. Ainsi, la configuration de ces gestionnaires
d’affichage agrègent un enregistrement xorg-configuration
.
modules
(par défaut : %default-xorg-modules
)C’est une liste de paquets de module chargés par le serveur Xorg —
p. ex. xf86-video-vesa
, xf86-input-keyboard
etc.
fonts
(par défaut : %default-xorg-fonts
)C’est une liste de répertoires de polices à ajouter au chemin de polices du serveur.
drivers
(par défaut : '()
)Cela doit être soit la liste vide, auquel cas Xorg choisit un pilote
graphique automatiquement, soit une liste de noms de pilotes qui seront
essayés dans cet ordre — p. ex. '("modesetting" "vesa")
.
resolutions
(par défaut : '()
)Lorsque resolutions
est la liste vide, Xorg choisit une résolution
d’écran appropriée. Sinon, il doit s’agir d’une liste de résolutions — p.
ex. '((1024 768) (640 480))
.
keyboard-layout
(par défaut : #f
)Si la valeur est #f
, Xorg utilise la disposition du clavier par
défaut — habituellement la disposition anglaise américaine (« qwerty ») pour
un clavier de PC à 105 touches.
Sinon cela doit être un objet keyboard-layout
spécifiant la
disposition du clavier à utiliser lorsque Xorg tourne. Voir Disposition du clavier pour plus d’informations sur la manière de spécifier la disposition
du clavier.
extra-config
(par défaut : '()
)C’est une liste de chaînes de caractères ou d’objets ajoutés au fichier de configuration. Elle est utile pour ajouter du texte supplémentaire directement dans le fichier de configuration.
server
(par défaut : xorg-server
)C’est le paquet fournissant le serveur Xorg.
server-arguments
(par défaut : %default-xorg-server-arguments
)Liste d’arguments de la ligne de commande supplémentaires à passer au
serveur X. La valeur par défaut est -nolisten tcp
.
Dit au gestionnaire de connexion (de type login-manager-service-type)
d’utiliser config, un enregistrement <xorg-configuration>
.
Comme la configuration Xog est incluse dans la configuration du gestionnaire
de connexion — p. ex. gdm-configuration
— cette procédure fournit
un raccourci pour configurer Xorg.
Renvoie un script startx
dans lequel les modules, les polices, etc.,
spécifiés dans config sont disponibles. Le résultat devrait être
utilisé à la place de startx
.
Habituellement le serveur X est démarré par un gestionnaire de connexion.
Return a startx
script in which the modules, fonts, etc. specified in
config are available. The result should be used in place of
startx
and should be invoked by the user from a tty after login.
Unlike xorg-start-command
, this script calls xinit. Therefore it
works well when executed from a tty. This script can be set up as
startx
using startx-command-service-type
or
home-startx-command-service-type
. If you are using a desktop
environment, you are unlikely to need this procedure.
Type for a service that adds a package for a screen locker or screen saver
to the set of privileged programs and/or add a PAM entry for it. The value
for this service is a <screen-locker-configuration>
object.
While the default behavior is to setup both a privileged program and PAM
entry, these two methods are redundant. Screen locker programs may not
execute when PAM is configured and setuid
is set on their
executable. In this case, using-setuid?
can be set to #f
.
For example, to make XlockMore usable:
(service screen-locker-service-type
(screen-locker-configuration
(name "xlock")
(program (file-append xlockmore "/bin/xlock"))))
rend utilisable le bon vieux XlockMore.
For example, swaylock fails to execute when compiled with PAM support and setuid enabled. One can thus disable setuid:
(service screen-locker-service-type
(screen-locker-configuration
(name "swaylock")
(program (file-append swaylock "/bin/swaylock"))
(using-pam? #t)
(using-setuid? #f)))
Available screen-locker-configuration
fields are:
name
(type : string)Name of the screen locker.
program
(type: file-like)Path to the executable for the screen locker as a G-Expression.
allow-empty-password?
(default: #f
) (type: boolean)Indique s’il faut autoriser les mots de passes vides.
using-pam?
(default: #t
) (type: boolean)Whether to setup PAM entry.
using-setuid?
(default: #t
) (type: boolean)Whether to setup program as setuid binary.
Add startx
to the system profile putting it onto PATH
.
The value for this service is a <xorg-configuration>
object which is
passed to the xorg-start-command-xinit
procedure producing the
startx
used. Default value is (xorg-configuration)
.
Suivant: Services de bureaux, Précédent: Système de fenêtrage X, Monter: Services [Table des matières][Index]
Le module (gnu services cups)
fournit une définition de service Guix
pour le service d’impression CUPS. Pour ajouter la prise en charge d’une
imprimante à un système Guix, ajoutez un cups-service
à la définition
du système d’exploitation :
Le type de service pour un serveur d’impression CUPS. Sa valeur devrait être une configuration CUPS valide (voir plus bas). Pour utiliser les paramètres par défaut, écrivez simplement :
La configuration de CUPS contrôle les paramètres de base de votre installation CUPS : sur quelles interfaces il doit écouter, que faire si un travail échoue, combien de journalisation il faut faire, etc. Pour ajouter une imprimante, vous devrez visiter l’URL http://localhost:631 ou utiliser un outil comme les services de configuration d’imprimante de GNOME. Par défaut, la configuration du service CUPS générera un certificat auto-signé si besoin, pour les connexions sécurisée avec le serveur d’impression.
Supposons que vous souhaitiez activer l’interface Web de CUPS et ajouter le
support pour les imprimantes Epson via le paquet
epson-inkjet-printer-escpr
et pour les imprimantes HP via le paquet
hplip-minimal
. Vous pouvez le faire directement, comme ceci (vous
devez utiliser le module (gnu packages cups)
) :
(service cups-service-type
(cups-configuration
(web-interface? #t)
(extensions
(list cups-filters epson-inkjet-printer-escpr hplip-minimal))))
Remarque : Si vous souhaitez utiliser la GUI basée sur Qt5 qui provient du paquet hplip, nous vous suggérons d’installer le paquet
hplip
, soit dans votre configuration d’OS, soit en tant qu’utilisateur.
Les paramètres de configuration disponibles sont les suivants. Chaque
définition des paramètres est précédé par son type ; par exemple,
‘string-list toto’ indique que le paramètre toto
devrait être
spécifié comme une liste de chaînes de caractères. Il y a aussi une manière
de spécifier la configuration comme une chaîne de caractères, si vous avez
un vieux fichier cupsd.conf
que vous voulez porter depuis un autre
système ; voir la fin pour plus de détails.
Les champs de cups-configuration
disponibles sont :
cups-configuration
:package cups ¶Le paquet CUPS.
cups-configuration
:package-list extensions (par défaut : (list brlaser cups-filters epson-inkjet-printer-escpr foomatic-filters hplip-minimal splix)
) ¶Pilotes et autres extensions du paquet CUPS.
cups-configuration
:files-configuration files-configuration ¶Configuration de l’emplacement où écrire les journaux, quels répertoires utiliser pour les travaux d’impression et les paramètres de configuration privilégiés liés.
Les champs files-configuration
disponibles sont :
files-configuration
:log-location access-log ¶Définit le fichier de journal d’accès. Spécifier un nom de fichier vide
désactive la génération de journaux d’accès. La valeur stderr
fait
que les entrées du journal seront envoyés sur l’erreur standard lorsque
l’ordonnanceur est lancé au premier plan ou vers le démon de journal système
lorsqu’il tourne en tâche de fond. La valeur syslog
fait que les
entrées du journal sont envoyées au démon de journalisation du système. Le
nom du serveur peut être inclus dans les noms de fichiers avec la chaîne
%s
, comme dans /var/log/cups/%s-access_log
.
La valeur par défaut est ‘"/var/log/cups/access_log"’.
files-configuration
:file-name cache-dir ¶L’emplacement où CUPS devrait mettre les données en cache.
La valeur par défaut est ‘"/var/cache/cups"’.
files-configuration
:string config-file-perm ¶Spécifie les permissions pour tous les fichiers de configuration que l’ordonnanceur écrit.
Remarquez que les permissions pour le fichier printers.conf sont actuellement masqués pour ne permettre que l’accès par l’utilisateur de l’ordonnanceur (typiquement root). La raison est que les URI des imprimantes contiennent des informations d’authentification sensibles qui ne devraient pas être connues sur le système. Il n’est pas possible de désactiver cette fonctionnalité de sécurité.
La valeur par défaut est ‘"0640"’.
files-configuration
:log-location error-log ¶Définit le fichier de journal d’erreur. Spécifier un nom de fichier vide
désactive la génération de journaux d’erreur. La valeur stderr
fait
que les entrées du journal seront envoyés sur l’erreur standard lorsque
l’ordonnanceur est lancé au premier plan ou vers le démon de journalisation
du système lorsqu’il tourne en tâche de fond. La valeur syslog
fait
que les entrées du journal sont envoyées au démon de journalisation du
système. Le nom du serveur peut être inclus dans les noms de fichiers avec
la chaîne %s
, comme dans /var/log/cups/%s-error_log
.
La valeur par défaut est ‘"/var/log/cups/error_log"’.
files-configuration
:string fatal-errors ¶Spécifie quelles erreurs sont fatales, qui font terminer l’ordonnanceur. Les types de chaînes sont :
none
Aucune erreur n’est fatale.
all
Toutes les erreurs ci-dessous sont fatales.
browse
Les erreurs d’initialisation de la navigation sont fatales, par exemple les connexion échouées au démon DNS-SD.
config
Les erreurs de syntaxe du fichier de configuration sont fatale.
listen
Les erreurs d’écoute ou de port sont fatales, sauf pour les erreurs d’IPv6
sur la boucle locale ou les adresses any
.
log
Les erreurs de création ou d’écriture des fichiers de journal sont fatales.
permissions
Les mauvaises permissions des fichiers de démarrage sont fatales, par exemple un certificat TLS et des fichiers de clefs avec des permissions permettant la lecture à tout le monde.
La valeur par défaut est ‘"all -browse"’.
files-configuration
:boolean file-device? ¶Spécifie si le fichier de pseudo-périphérique peut être utilisé pour de nouvelles queues d’impression. L’URI file:///dev/null est toujours permise.
La valeur par défaut est ‘#f’.
files-configuration
:string group ¶Spécifie le nom ou l’ID du groupe qui sera utilisé lors de l’exécution de programmes externes.
La valeur par défaut est ‘"lp"’.
files-configuration
:string log-file-group ¶Spécifie le nom ou l’ID du groupe qui sera utilisé pour les fichiers de journaux.
La valeur par défaut est ‘"lpadmin"’.
files-configuration
:string log-file-perm ¶Spécifie les permissions pour tous les fichiers de journal que l’ordonnanceur écrit.
La valeur par défaut est ‘"0644"’.
files-configuration
:log-location page-log ¶Définit le fichier de journal de page. Spécifier un nom de fichier vide
désactive la génération de journaux de pages. La valeur stderr
fait
que les entrées du journal seront envoyés sur l’erreur standard lorsque
l’ordonnanceur est lancé au premier plan ou vers le démon de journal système
lorsqu’il tourne en tâche de fond. La valeur syslog
fait que les
entrées du journal sont envoyées au démon de journalisation du système. Le
nom du serveur peut être inclus dans les noms de fichiers avec la chaîne
%s
, comme dans /var/log/cups/%s-page_log
.
La valeur par défaut est ‘"/var/log/cups/page_log"’.
files-configuration
:string remote-root ¶Spécifie le nom d’utilisateur associé aux accès non authentifiés par des
clients qui se disent être l’utilisateur root. La valeur par défaut est
remroot
.
La valeur par défaut est ‘"remroot"’.
files-configuration
:file-name request-root ¶Spécifie le répertoire qui contient les travaux d’impression et d’autres données des requêtes HTTP.
La valeur par défaut est ‘"/var/spool/cups"’.
files-configuration
:sandboxing sandboxing ¶Spécifie le niveau d’isolation de sécurité appliqué aux filtres
d’impression, aux moteurs et aux autres processus fils de l’ordonnanceur ;
soit relaxed
soit strict
. Cette directive n’est actuellement
utilisée et supportée que sur macOS.
La valeur par défaut est ‘strict’.
files-configuration
:file-name server-keychain ¶Spécifie l’emplacement des certifications TLS et des clés privées. CUPS cherchera les clés publiques et privées dans ce répertoire : un fichier .crt pour un certificat encodé en PEM et le fichier .key correspondant pour la clé privée encodée en PEM.
La valeur par défaut est ‘"/etc/cups/ssl"’.
files-configuration
:file-name server-root ¶Spécifie le répertoire contenant les fichiers de configuration du serveur.
La valeur par défaut est ‘"/etc/cups"’.
files-configuration
:boolean sync-on-close? ¶Spécifie si l’ordonnanceur appelle fsync(2) après avoir écrit la configuration ou les fichiers d’état.
La valeur par défaut est ‘#f’.
files-configuration
:space-separated-string-list system-group ¶Spécifie le groupe ou les groupes à utiliser pour l’authentification du
groupe @SYSTEM
.
files-configuration
:file-name temp-dir ¶Spécifie le répertoire où les fichiers temporaires sont stockés.
La valeur par défaut est ‘"/var/spool/cups/tmp"’.
files-configuration
:string user ¶Spécifie le nom d’utilisateur ou l’ID utilisé pour lancer des programmes externes.
La valeur par défaut est ‘"lp"’.
files-configuration
:string set-env ¶Indique que la variable d’environnement spécifiée doit être passée aux processus fils.
La valeur par défaut est ‘"variable value"’.
cups-configuration
:access-log-level access-log-level ¶Spécifie le niveau de journalisation pour le fichier AccessLog. Le niveau
config
enregistre les ajouts, suppressions et modifications
d’imprimantes et de classes et lorsque les fichiers de configuration sont
accédés ou mis à jour. Le niveau actions
enregistre la soumission,
la suspension, la libération, la modification et l’annulation des travaux et
toutes les conditions de config
. Le niveau all
enregistre
toutes les requêtes.
La valeur par défaut est ‘actions’.
cups-configuration
:boolean auto-purge-jobs? ¶Spécifie s’il faut vider l’historique des travaux automatiquement lorsqu’il n’est plus nécessaire pour les quotas.
La valeur par défaut est ‘#f’.
cups-configuration
:comma-separated-string-list browse-dns-sd-sub-types ¶Specifies a list of DNS-SD sub-types to advertise for each shared printer.
The default ‘(list "_cups" "_print" "_universal")’ tells clients that CUPS sharing, IPP Everywhere, AirPrint, and Mopria are supported.
cups-configuration
:browse-local-protocols browse-local-protocols ¶Spécifie les protocoles à utiliser pour partager les imprimantes sur le réseau local.
La valeur par défaut est ‘dnssd’.
cups-configuration
:boolean browse-web-if? ¶Spécifie si l’interface web de CUPS est annoncée.
La valeur par défaut est ‘#f’.
cups-configuration
:boolean browsing? ¶Spécifie si les imprimantes partagées sont annoncées.
La valeur par défaut est ‘#f’.
cups-configuration
:default-auth-type default-auth-type ¶Spécifie le type d’authentification par défaut à utiliser.
La valeur par défaut est ‘Basic’.
cups-configuration
:default-encryption default-encryption ¶Spécifie si le chiffrement sera utilisé pour les requêtes authentifiées.
La valeur par défaut est ‘Required’.
cups-configuration
:string default-language ¶Spécifie la langue par défaut à utiliser pour le contenu textuel et web.
La valeur par défaut est ‘"en"’.
cups-configuration
:string default-paper-size ¶Spécifie la taille de papier par défaut pour les nouvelles queues d’impression. ‘"Auto"’ utilise la valeur par défaut du paramètre de régionalisation, tandis que ‘"None"’ spécifie qu’il n’y a pas de taille par défaut. Des noms de tailles spécifique sont par exemple ‘"Letter"’ et ‘"A4"’.
La valeur par défaut est ‘"Auto"’.
cups-configuration
:string default-policy ¶Spécifie la politique d’accès par défaut à utiliser.
La valeur par défaut est ‘"default"’.
Spécifie si les imprimantes locales sont partagées par défaut.
La valeur par défaut est ‘#t’.
cups-configuration
:entier-non-négatif dirty-clean-interval ¶Spécifie le délai pour mettre à jour les fichiers de configuration et d’état. Une valeur de 0 fait que la mise à jour arrive aussi vite que possible, typiquement en quelques millisecondes.
La valeur par défaut est ‘30’.
cups-configuration
:error-policy error-policy ¶Spécifie ce qu’il faut faire si une erreur a lieu. Les valeurs possibles
sont abort-job
, qui supprimera les travaux d’impression en échec ;
retry-job
, qui tentera de nouveau l’impression plus tard ;
retry-current-job
, qui retentera l’impression immédiatement ; et
stop-printer
qui arrête l’imprimante.
La valeur par défaut est ‘stop-printer’.
cups-configuration
:entier-non-négatif filter-limit ¶Spécifie le coût maximum des filtres qui sont lancés en même temps, pour minimiser les problèmes de ressources de disque, de mémoire et de CPU. Une limite de 0 désactive la limite de filtrage. Une impression standard vers une imprimante non-PostScript requiert une limite de filtre d’environ 200. Une imprimante PostScript requiert environ la moitié (100). Mettre en place la limite en dessous de ces valeurs limitera l’ordonnanceur à un seul travail d’impression à la fois.
La valeur par défaut est ‘0’.
cups-configuration
:entier-non-négatif filter-nice ¶Spécifie la priorité des filtres de l’ordonnanceur qui sont lancés pour imprimer un travail. La valeur va de 0, la plus grande priorité, à 19, la plus basse priorité.
La valeur par défaut est ‘0’.
cups-configuration
:host-name-lookups host-name-lookups ¶Spécifie s’il faut faire des résolutions inverses sur les clients qui se
connectent. Le paramètre double
fait que cupsd
vérifie que le
nom d’hôte résolu depuis l’adresse correspond à l’une des adresses renvoyées
par ce nom d’hôte. Les résolutions doubles évitent aussi que des clients
avec des adresses non enregistrées ne s’adressent à votre serveur.
N’initialisez cette valeur qu’à #t
ou double
que si c’est
absolument nécessaire.
La valeur par défaut est ‘#f’.
cups-configuration
:entier-non-négatif job-kill-delay ¶Spécifie le nombre de secondes à attendre avant de tuer les filtres et les moteurs associés avec un travail annulé ou suspendu.
La valeur par défaut est ‘30’.
cups-configuration
:entier-non-négatif job-retry-interval ¶Spécifie l’intervalle des nouvelles tentatives en secondes. C’est
typiquement utilisé pour les queues de fax mais peut aussi être utilisé avec
des queues d’impressions normales dont la politique d’erreur est
retry-job
ou retry-current-job
.
La valeur par défaut est ‘30’.
cups-configuration
:entier-non-négatif job-retry-limit ¶Spécifie le nombre de nouvelles tentatives pour les travaux. C’est
typiquement utilisé pour les queues de fax mais peut aussi être utilisé pour
les queues d’impressions dont la politique d’erreur est retry-job
ou
retry-current-job
.
La valeur par défaut est ‘5’.
cups-configuration
:boolean keep-alive? ¶Spécifie s’il faut supporter les connexion HTTP keep-alive.
La valeur par défaut est ‘#t’.
cups-configuration
:entier-non-négatif limit-request-body ¶Spécifie la taille maximale des fichiers à imprimer, des requêtes IPP et des données de formulaires HTML. Une limite de 0 désactive la vérification de la limite.
La valeur par défaut est ‘0’.
cups-configuration
:multiline-string-list listen ¶Écoute sur les interfaces spécifiées. Les valeurs valides sont de la forme
adresse:port, où adresse est soit une adresse IPv6 dans
des crochets, soit une adresse IPv4, soit *
pour indiquer toutes les
adresses. Les valeurs peuvent aussi être des noms de fichiers de socket
UNIX domain. La directive Listen est similaire à la directive Port mais
vous permet de restreindre l’accès à des interfaces ou des réseaux
spécifiques.
cups-configuration
:location-access-control-list location-access-controls ¶Spécifie un ensemble de contrôles d’accès supplémentaires.
Les champs de location-access-controls
disponibles sont :
location-access-controls
:file-name path ¶Spécifie le chemin d’URI auquel les contrôles d’accès s’appliquent.
location-access-controls
:access-control-list access-controls ¶Les contrôles d’accès pour tous les accès à ce chemin, dans le même format
que le champ access-controls
de operation-access-control
.
La valeur par défaut est ‘'()’.
location-access-controls
:method-access-control-list method-access-controls ¶Contrôles d’accès pour les accès spécifiques à la méthode à ce chemin.
La valeur par défaut est ‘'()’.
Les champs de method-access-controls
disponibles sont :
method-access-controls
:boolean reverse? ¶Si la valeur est #t
, applique les contrôles d’accès à toutes les
méthodes sauf les méthodes listées. Sinon, applique le contrôle uniquement
aux méthodes listées.
La valeur par défaut est ‘#f’.
method-access-controls
:method-list methods ¶Les méthodes auxquelles ce contrôle d’accès s’applique.
La valeur par défaut est ‘'()’.
method-access-controls
:access-control-list access-controls ¶Directives de contrôle d’accès, en tant que liste de chaines de caractères. Chaque chaine devrait être une directive, comme ‘"Order allow,deny"’.
La valeur par défaut est ‘'()’.
cups-configuration
:entier-non-négatif log-debug-history ¶Spécifie le nombre de messages de débogage qui sont retenu pour la journalisation si une erreur arrive dans un travail d’impression. Les messages de débogage sont journalisés indépendamment du paramètre LogLevel.
La valeur par défaut est ‘100’.
cups-configuration
:log-level log-level ¶Spécifie le niveau de journalisation du fichier ErrorLog. La valeur
none
arrête toute journalisation alors que debug2
enregistre
tout.
La valeur par défaut est ‘info’.
cups-configuration
:log-time-format log-time-format ¶Spécifie le format de la date et de l’heure dans les fichiers de journaux.
La valeur standard
enregistre les secondes entières alors que
usecs
enregistre les microsecondes.
La valeur par défaut est ‘standard’.
cups-configuration
:entier-non-négatif max-clients ¶Spécifie le nombre maximum de clients simultanés qui sont autorisés par l’ordonnanceur.
La valeur par défaut est ‘100’.
cups-configuration
:entier-non-négatif max-clients-per-host ¶Spécifie le nombre maximum de clients simultanés permis depuis une même adresse.
La valeur par défaut est ‘100’.
cups-configuration
:entier-non-négatif max-copies ¶Spécifie le nombre maximum de copies qu’un utilisateur peut imprimer pour chaque travail.
La valeur par défaut est ‘9999’.
cups-configuration
:entier-non-négatif max-hold-time ¶Spécifie la durée maximum qu’un travail peut rester dans l’état de
suspension indefinite
avant qu’il ne soit annulé. La valeur 0
désactive l’annulation des travaux suspendus.
La valeur par défaut est ‘0’.
cups-configuration
:entier-non-négatif max-jobs ¶Spécifie le nombre maximum de travaux simultanés autorisés. La valeur 0 permet un nombre illimité de travaux.
La valeur par défaut est ‘500’.
cups-configuration
:entier-non-négatif max-jobs-per-printer ¶Spécifie le nombre maximum de travaux simultanés autorisés par imprimante.
La valeur 0 permet au plus max-jobs
travaux par imprimante.
La valeur par défaut est ‘0’.
cups-configuration
:entier-non-négatif max-jobs-per-user ¶Spécifie le nombre maximum de travaux simultanés permis par utilisateur. La
valeur 0 permet au plus max-jobs
travaux par utilisateur.
La valeur par défaut est ‘0’.
cups-configuration
:entier-non-négatif max-job-time ¶Spécifie la durée maximum qu’un travail peut prendre avant qu’il ne soit annulé, en secondes. Indiquez 0 pour désactiver l’annulation des travaux « coincés ».
La valeur par défaut est ‘10800’.
cups-configuration
:entier-non-négatif max-log-size ¶Spécifie la taille maximale des fichiers de journaux avant qu’on ne les fasse tourner, en octets. La valeur 0 désactive la rotation.
La valeur par défaut est ‘1048576’.
cups-configuration
parameter :non-negative-integer max-subscriptions ¶Specifies the maximum number of simultaneous event subscriptions that are allowed. Set to ‘0’ to allow an unlimited number of subscriptions.
La valeur par défaut est ‘0’.
cups-configuration
parameter :non-negative-integer max-subscriptions-per-job ¶Specifies the maximum number of simultaneous event subscriptions that are
allowed per job. A value of ‘0’ allows up to max-subscriptions
per job.
La valeur par défaut est ‘0’.
cups-configuration
parameter :non-negative-integer max-subscriptions-per-printer ¶Specifies the maximum number of simultaneous event subscriptions that are
allowed per printer. A value of ‘0’ allows up to
max-subscriptions
per printer.
La valeur par défaut est ‘0’.
cups-configuration
parameter :non-negative-integer max-subscriptions-per-user ¶Specifies the maximum number of simultaneous event subscriptions that are
allowed per user. A value of ‘0’ allows up to max-subscriptions
per user.
La valeur par défaut est ‘0’.
cups-configuration
:entier-non-négatif multiple-operation-timeout ¶Spécifie la durée maximale à permettre entre les fichiers d’un travail en contenant plusieurs, en secondes.
La valeur par défaut est ‘900’.
cups-configuration
:environment-variables environment-variables ¶Passe les variables d’environnement spécifiées aux processus fils ; une liste de chaînes de caractères.
La valeur par défaut est ‘'()’.
cups-configuration
:policy-configuration-list policies ¶Spécifie des politiques de contrôle d’accès nommées.
Les champs de policy-configuration
disponibles sont :
policy-configuration
:string name ¶Nom de la politique.
policy-configuration
:string job-private-access ¶Spécifie une liste d’accès pour les valeurs privées du travail.
@ACL
correspond aux valeurs requesting-user-name-allowed ou
requesting-user-name-denied de l’imprimante. @OWNER
correspond au
propriétaire du travail. @SYSTEM
correspond aux groupes listés dans
le champ system-group
de la configuration files-configuration
,
qui est réifié dans le fichier cups-files.conf(5)
. Les autres
éléments possibles de la liste d’accès sont des noms d’utilisateurs
spécifiques et @group
pour indiquer les membres d’un groupe
spécifique. La liste d’accès peut aussi être simplement all
ou
default
.
La valeur par défaut est ‘"@OWNER @SYSTEM"’.
policy-configuration
:string job-private-values ¶Spécifie la liste des valeurs de travaux à rendre privée, ou all
,
default
, ou none
.
La valeur par défaut est ‘"job-name job-originating-host-name job-originating-user-name phone"’.
policy-configuration
:string subscription-private-access ¶Spécifie un liste d’accès pour les valeurs privées de la souscription.
@ACL
correspond aux valeurs requesting-user-name-allowed ou
requesting-user-name-denied de l’imprimante. @OWNER
correspond au
propriétaire du travail. @SYSTEM
correspond aux groupes listés dans
le champ system-group
de la configuration files-configuration
,
qui est réifié dans le fichier cups-files.conf(5)
. Les autres
éléments possibles de la liste d’accès sont des noms d’utilisateurs
spécifiques et @group
pour indiquer les membres d’un groupe
spécifique. La liste d’accès peut aussi être simplement all
ou
default
.
La valeur par défaut est ‘"@OWNER @SYSTEM"’.
policy-configuration
:string subscription-private-values ¶Spécifie la liste des valeurs de travaux à rendre privée, ou all
,
default
, ou none
.
La valeur par défaut est ‘"notify-events notify-pull-method notify-recipient-uri notify-subscriber-user-name notify-user-data"’.
policy-configuration
:operation-access-control-list access-controls ¶Contrôle d’accès par les actions IPP.
La valeur par défaut est ‘'()’.
cups-configuration
:booléen-ou-entier-non-négatif preserve-job-files ¶Spécifie si les fichiers de travaux (les documents) sont préservés après qu’un travail est imprimé. Si une valeur numérique est spécifiée, les fichiers de travaux sont préservés pour le nombre de secondes indiquées après l’impression. Sinon, une valeur booléenne s’applique indéfiniment.
La valeur par défaut est ‘86400’.
cups-configuration
:booléen-ou-entier-non-négatif preserve-job-history ¶Spécifie si l’historique des travaux est préservé après qu’un travail est
imprimé. Si une valeur numérique est spécifiée, l’historique des travaux
est préservé pour le nombre de secondes indiquées après l’impression. Si la
valeur est #t
, l’historique des travaux est préservé jusqu’à
atteindre la limite MaxJobs.
La valeur par défaut est ‘#t’.
cups-configuration
parameter :comma-separated-string-list-or-#f ready-paper-sizes ¶Specifies a list of potential paper sizes that are reported as ready, that is: loaded. The actual list will contain only the sizes that each printer supports.
The default value of #f
is a special case: CUPS will use ‘(list
\"Letter\" \"Legal\" \"Tabloid\" \"4x6\" \"Env10\")’ if the default paper
size is \"Letter\", and ‘(list \"A3\" \"A4\" \"A5\" \"A6\" \"EnvDL\")’
otherwise.
cups-configuration
:entier-non-négatif reload-timeout ¶Spécifie la durée d’attente pour la fin des travaux avant de redémarrer l’ordonnanceur.
La valeur par défaut est ‘30’.
cups-configuration
:string server-admin ¶Spécifie l’adresse de courriel de l’administrateur système.
La valeur par défaut est ‘"root@localhost.localdomain"’.
cups-configuration
:host-name-list-or-* server-alias ¶La directive ServerAlias est utilisée pour la validation des en-tête HTTP
Host lorsque les clients se connectent à l’ordonnanceur depuis des
interfaces externes. Utiliser le nom spécial *
peut exposer votre
système à des attaques connues de recombinaison DNS dans le navigateur, même
lorsque vous accédez au site à travers un pare-feu. Si la découverte
automatique des autres noms ne fonctionne pas, nous vous recommandons de
lister chaque nom alternatif avec une directive SeverAlias plutôt que
d’utiliser *
.
La valeur par défaut est ‘*’.
cups-configuration
:string server-name ¶Spécifie le nom d’hôte pleinement qualifié du serveur.
La valeur par défaut est ‘"localhost"’.
cups-configuration
:server-tokens server-tokens ¶Spécifie les informations incluses dans les en-têtes Server des réponses
HTTP. None
désactive l’en-tête Server. ProductOnly
rapporte
CUPS
. Major
rapporte CUPS 2
. Minor
rapporte
CUPS 2.0
. Minimal
rapporte CUPS 2.0.0
. OS
rapporte CUPS 2.0.0 (uname)
où uname est la sortie de la
commande uname
. Full
rapporte CUPS 2.0.0 (uname)
IPP/2.0
.
La valeur par défaut est ‘Minimal’.
cups-configuration
:multiline-string-list ssl-listen ¶Écoute des connexions chiffrées sur les interfaces spécifiées. Les valeurs
valides sont de la forme adresse:port, où adresse est soit
une adresse IPv6 dans des crochets, soit une adresse IPv4, soit *
pour indiquer toutes les interfaces.
La valeur par défaut est ‘'()’.
cups-configuration
:ssl-options ssl-options ¶Indique les options de chiffrement. Par défaut, CUPS ne supporte que le
chiffrement avec TLS v1.0 ou plus avec des suites de chiffrement connues
pour être sures. La sécurité peut être réduite en utilisant les options
Allow
, et améliorée en utilisant les options Deny
. L’option
AllowRC4
active les suites de chiffrement 128-bits RC4, qui sont
requises pour certains vieux. L’option AllowSSL3
active SSL v3.0,
qui est requis par certains vieux clients qui ne supportent pas TLS v1.0.
L’option DenyCBC
désactive toutes les suites CBC. L’option
DenyTLS1.0
désactive la prise en charge de TLS v1.0 — la version
minimale du protocole est donc TLS v1.1.
La valeur par défaut est ‘'()’.
cups-configuration
:boolean strict-conformance? ¶Spécifie si l’ordonnanceur demande aux clients d’adhérer aux spécifications IPP.
La valeur par défaut est ‘#f’.
cups-configuration
:entier-non-négatif timeout ¶Spécifie le délai d’attente des requêtes HTTP, en secondes.
La valeur par défaut est ‘900’.
cups-configuration
:boolean web-interface? ¶Spécifie si l’interface web est activée.
La valeur par défaut est ‘#f’.
Maintenant, vous vous dîtes peut-être « oh là là, cher manuel de Guix, je
t’aime bien mais arrête maintenant avec ces options de configuration
»35. En
effet. cependant, encore un point supplémentaire : vous pouvez avoir un
fichier cupsd.conf
existant que vous pourriez vouloir utiliser. Dans
ce cas, vous pouvez passer un opaque-cups-configuration
en
configuration d’un cups-service-type
.
Les champs de opaque-cups-configuration
disponibles sont :
opaque-cups-configuration
:package cups ¶Le paquet CUPS.
opaque-cups-configuration
:string cupsd.conf ¶Le contenu de cupsd.conf
, en tant que chaîne de caractères.
opaque-cups-configuration
:string cups-files.conf ¶Le contenu du fichier cups-files.conf
, en tant que chaîne de
caractères.
Par exemple, si vos fichiers cupsd.conf
et cups-files.conf
sont dans des chaînes du même nom, pouvez instancier un service CUPS de
cette manière :
(service cups-service-type
(opaque-cups-configuration
(cupsd.conf cupsd.conf)
(cups-files.conf cups-files.conf)))
Suivant: Services de son, Précédent: Services d’impression, Monter: Services [Table des matières][Index]
Le module (gnu services desktop)
fournit des services qui sont
habituellement utiles dans le contexte d’une installation « de bureau » —
c’est-à-dire sur une machine qui fait tourner un service d’affichage
graphique, éventuellement avec des interfaces utilisateurs graphiques, etc.
Il définit aussi des services qui fournissent des environnements de bureau
spécifiques comme GNOME, Xfce et MATE.
Pour simplifier les choses, le module définit une variable contenant l’ensemble des services que les utilisateurs s’attendent en général à avoir sur une machine avec un environnement graphique et le réseau :
C’est la liste des services qui étend %base-services
en ajoutant ou
en ajustant des services pour une configuration « de bureau » typique.
In particular, it adds a graphical login manager (voir gdm-service-type
), screen lockers, a network management tool
(voir network-manager-service-type
) with
modem support (voir modem-manager-service-type
), energy and color management services,
the elogind
login and seat manager, the Polkit privilege service, the
GeoClue location service, the AccountsService daemon that allows authorized
users change system passwords, a NTP client (voir Services réseau)
and the Avahi daemon.
La variable %desktop-services
peut être utilisée comme champ
services
d’une déclaration operating-system
(voir services
).
Additionally, the following procedures add one (or more!) desktop environments to a system.
gnome-desktop-service-type
adds GNOME,
plasma-desktop-service-type
adds KDE Plasma,
enlightenment-desktop-service-type
adds Enlightenment,
lxqt-desktop-service-type
adds LXQt,
mate-desktop-service-type
adds MATE, and
xfce-desktop-service
adds Xfce.
These service types add “metapackages” such as gnome
or
plasma
to the system profile, but most of them also set up other
useful services that mere packages can’t do.
For example, they may elevate privileges on a limited number of special-purpose system interfaces and programs. This allows backlight adjustment helpers, power management utilities, screen lockers, and other integrated functionality to work as expected.
Les environnement de bureau dans Guix utilisent le service d’affichage Xorg
par défaut. Si vous voulez utiliser le protocole de serveur d’affichage
plus récent Wayland, vous devez activer la prise en charge de Wayland dans
GDM (voir wayland-gdm). Une autre solution consiste à utiliser
sddm-service
à la place de GDM comme gestionnaire de connexion
graphique. Vous devriez ensuite sélectionner la session « GNOME (Wayland) »
dans SDDM. Autrement, vous pouvez essayer de démarrer GNOME sur Wayland
manuellement depuis un TTY avec la commande
XDG_SESSION_TYPE=wayland exec dbus-run-session gnome-session
.
Actuellement seul GNOME support Wayland.
C’est le type de service qui ajoute l’environnement de bureau
GNOME. Sa valeur est un objet
gnome-desktop-configuration
(voir plus bas).
Ce service ajoute le paquet gnome
au profil du système et étend
polkit avec les actions de gnome-settings-daemon
.
Configuration record for the GNOME desktop environment. Available
gnome-desktop-configuration
fields are:
core-services
(type: list-of-packages)A list of packages that the GNOME Shell and applications may rely on.
shell
(type: list-of-packages)A list of packages that constitute the GNOME Shell, without applications.
utilities
(type: list-of-packages)A list of packages that serve as applications to use on top of the GNOME Shell.
gnome
(type: maybe-package)This field used to be the only configuration point and specified a GNOME meta-package to install system-wide. Since the meta-package itself provides neither sources nor the actual packages and is only used to propagate them, this field is deprecated.
extra-packages
(type: list-of-packages)A list of GNOME-adjacent packages to also include. This field is intended for users to add their own packages to their GNOME experience. Note, that it already includes some packages that are considered essential by some (most?) GNOME users.
udev-ignorelist
(default: ()
) (type: list-of-strings)A list of regular expressions denoting udev rules or hardware file names provided by any package that should not be installed. By default, every udev rule and hardware file specified by any package referenced in the other fields are installed.
polkit-ignorelist
(default: ()
) (type: list-of-strings)A list of regular expressions denoting polkit rules provided by any package that should not be installed. By default, every polkit rule added by any package referenced in the other fields are installed.
This is the type of the service that adds the
Plasma desktop environment. Its
value is a plasma-desktop-configuration
object (see below).
This service adds the plasma
package to the system profile.
Configuration record for the Plasma desktop environment.
plasma
(default: plasma
)The Plasma package to use.
C’est le type de service qui lance l’environnement de bureau https://xfce.org/. Sa valeur est un objet
xfce-desktop-configuration
(voir plus bas).
Ce service ajoute le paquet xfce
au profil du système et étend polkit
avec la possibilité pour thunar
de manipuler le système de fichier en
root depuis une session utilisateur, après que l’utilisateur s’authentifie
avec le mot de passe administrateur.
Remarquez que xfce4-panel
et ses paquets de greffons devraient être
installés dans le même profil pour assurer la compatibilité. Lorsque vous
utilisez ce service, vous devriez ajouter les greffons supplémentaires
(xfce4-whiskermenu-plugin
, xfce4-weather-plugin
, etc) au champ
packages
de votre operating-system
.
Enregistrement de la configuration de l’environnement de bureau Xfce.
xfce
(par défaut : xfce
)Le paquet Xfce à utiliser.
C’est le type de service qui lance l’environnement de bureau MATE. Sa valeur est un objet
mate-desktop-configuration
(voir plus bas).
Ce service ajoute le paquet mate
au profil du système, et étend
polkit avec les actions de mate-settings-daemon
.
Enregistrement de configuration pour l’environnement de bureau MATE.
mate
(par défaut : mate
)Le paquet MATE à utiliser.
C’est le type de service qui lance l’environnement de bureau LXQt. Sa valeur est un objet
lxqt-desktop-configuration
(voir plus bas).
Ce service ajoute le paquet lxqt
au profil du système.
Enregistrement de la configuration de l’environnement de bureau LXQt.
lxqt
(par défaut : lxqt
)Le paquet LXQT à utiliser.
This is the type of the service that runs the
Sugar desktop environment. Its value is a
sugar-desktop-configuration
object (see below).
This service adds the sugar
package to the system profile, as well as
any selected Sugar activities. By default it only includes a minimal set of
activities.
Configuration record for the Sugar desktop environment.
sugar
(default: sugar
)The Sugar package to use.
gobject-introspection
(default: gobject-introspection
)The gobject-introspection
package to use. This package is used to
access libraries installed as dependencies of Sugar activities.
activities
(default: (list sugar-help-activity)
)A list of Sugar activities to install.
The following example configures the Sugar desktop environment with a number of useful activities:
(use-modules (gnu)) (use-package-modules sugar) (use-service-modules desktop) (operating-system ... (services (cons* (service sugar-desktop-service-type (sugar-desktop-configuration (activities (list sugar-browse-activity sugar-help-activity sugar-jukebox-activity sugar-typing-turtle-activity)))) %desktop-services)) ...)
Renvoie un service qui ajoute le paquet enlightenment
et étend dbus
avec les actions de efl
.
enlightenment
(par défaut : enlightenment
)Le paquet enlightenment à utiliser.
Comme les services de bureau GNOME, Xfce et MATE récupèrent tant de paquet,
la variable %desktop-services
par défaut n’inclut aucun d’entre eux.
Pour ajouter GNOME, Xfce ou MATE, utilisez cons
pour les ajouter à
%desktop-services
dans le champ services
de votre
operating-system
:
(use-modules (gnu)) (use-service-modules desktop) (operating-system ... ;; cons* ajoute des éléments à la liste donnée en dernier argument. (services (cons* (service gnome-desktop-service-type) (service xfce-desktop-service) %desktop-services)) ...)
Ces environnements de bureau seront alors disponibles comme une option dans la fenêtre de connexion graphique.
Les définitions de service qui sont vraiment incluses dans
%desktop-services
et fournies par (gnu services dbus)
et
(gnu services desktop)
sont décrites plus bas.
Type for a service that runs the D-Bus “system bus”. 36
The value for this service type is a <dbus-configuration>
record.
Data type representing the configuration for dbus-root-service-type
.
dbus
(default: dbus
) (type: file-like)Package object for dbus.
services
(default: '()
) (type: list)List of packages that provide an etc/dbus-1/system.d directory
containing additional D-Bus configuration and policy files. For example, to
allow avahi-daemon to use the system bus, services must be equal to
(list avahi)
.
verbose?
(default: #f
) (type: boolean)When #t
, D-Bus is launched with environment variable
‘DBUS_VERBOSE’ set to ‘1’. A verbose-enabled D-Bus package such
as dbus-verbose
should be provided to dbus in this
scenario. The verbose output is logged to /var/log/dbus-daemon.log.
Elogind is a login and seat management daemon that also handles most system-level power events for a computer, for example suspending the system when a lid is closed, or shutting it down when the power button is pressed.
It also provides a D-Bus interface that can be used to know which users are logged in, know what kind of sessions they have open, suspend the system, inhibit system suspend, reboot the system, and other tasks.
Type of the service that runs elogind
, a login and seat management
daemon. The value for this service is a <elogind-configuration>
object.
Data type representing the configuration of elogind
.
elogind
(default: elogind
) (type: file-like)...
kill-user-processes?
(default: #f
) (type: boolean)...
kill-only-users
(default: '()
) (type: list)...
kill-exclude-users
(default: '("root")
) (type: list-of-string)...
inhibit-delay-max-seconds
(default: 5
) (type: integer)...
handle-power-key
(default: 'poweroff
) (type: symbol)...
handle-suspend-key
(default: 'suspend
) (type: symbol)...
handle-hibernate-key
(default: 'hibernate
) (type: symbol)...
handle-lid-switch
(default: 'suspend
) (type: symbol)...
handle-lid-switch-docked
(default: 'ignore
) (type: symbol)...
handle-lid-switch-external-power
(default: *unspecified*
) (type: symbol)...
power-key-ignore-inhibited?
(default: #f
) (type: boolean)...
suspend-key-ignore-inhibited?
(default: #f
) (type: boolean)...
hibernate-key-ignore-inhibited?
(default: #f
) (type: boolean)...
lid-switch-ignore-inhibited?
(default: #t
) (type: boolean)...
holdoff-timeout-seconds
(default: 30
) (type: integer)...
idle-action
(default: 'ignore
) (type: symbol)...
idle-action-seconds
(default: (* 30 60)
) (type: integer)...
runtime-directory-size-percent
(default: 10
) (type: integer)...
runtime-directory-size
(default: #f
) (type: integer)...
remove-ipc?
(default: #t
) (type: boolean)...
suspend-state
(default: '("mem" "standby" "freeze")
) (type: list)...
suspend-mode
(default: '()
) (type: list)...
hibernate-state
(default: '("disk")
) (type: list)...
hibernate-mode
(default: '("platform" "shutdown")
) (type: list)...
hybrid-sleep-state
(default: '("disk")
) (type: list)...
hybrid-sleep-mode
(default: '("suspend" "platform" "shutdown")
) (type: list)...
hibernate-delay-seconds
(default: *unspecified*
) (type: integer)...
suspend-estimation-seconds
(default: *unspecified*
) (type: integer)...
Type for the service that runs AccountsService, a system service that can list available accounts, change their passwords, and so on. AccountsService integrates with PolicyKit to enable unprivileged users to acquire the capability to modify their system configuration. See AccountsService for more information.
The value for this service is a file-like object, by default it is set to
accountsservice
(the package object for AccountsService).
Type for the service that runs the Polkit privilege management service, which allows system administrators to grant access to privileged operations in a structured way. By querying the Polkit service, a privileged system component can know when it should grant additional capabilities to ordinary users. For example, an ordinary user can be granted the capability to suspend the system if the user is logged in locally.
The value for this service is a <polkit-configuration>
object.
Service qui ajoute le groupe wheel
comme administrateur au service
Polkit. Cela fait en sorte qu’on demande le mot de passe des utilisateurs
du groupe wheel
eux-mêmes pour effectuer des tâches d’administration
au lieu du mot de passe root
, comme le fait sudo
.
Service qui lance upowerd
,
un moniteur système de consommation d’énergie et de niveau de batterie, avec
les paramètres de configuration donnés.
Il implémente l’interface D-Bus org.freedesktop.UPower
et est
notamment utilisé par GNOME.
Type de données représentant la configuration de UPower.
upower
(par défaut : upower)Paquet à utiliser pour upower
.
watts-up-pro?
(par défaut : #f
)Active le périphérique Watts Up Pro.
poll-batteries?
(par défaut : #t
)Active les requêtes au noyau pour les changements de niveau de batterie.
ignore-lid?
(par défaut : #f
)Ignore l’état de l’écran, ce qui peut être utile s’il est incorrect sur un appareil.
use-percentage-for-policy?
(par défaut : #t
)Indique s’il faut utiliser une politique basée sur le pourcentage de batterie plutôt que l’estimation du temps restant. Une politique basée sur le pourcentage de batterie est souvent plus fiable.
percentage-low
(par défaut : 20
)Lorsque use-percentage-for-policy?
est #t
, cela indique à quel
niveau la batterie est considérée comme faible.
percentage-critical
(par défaut : 5
)Lorsque use-percentage-for-policy?
est #t
, cela indique à quel
niveau la batterie est considérée comme critique.
percentage-action
(par défaut : 2
)Lorsque use-percentage-for-policy?
est #t
, cela indique à quel
niveau l’action sera prise.
time-low
(par défaut : 1200
)Lorsque use-percentage-for-policy?
est #f
, cela indique à
quelle durée restante en secondes la batterie est considérée comme faible.
time-critical
(par défaut : 300
)Lorsque use-percentage-for-policy?
est #f
, cela indique à
quelle durée restante en secondes la batterie est considérée comme critique.
time-action
(par défaut : 120
)Lorsque use-percentage-for-policy?
est #f
, cela indique à
quelle durée restante en secondes l’action sera prise.
critical-power-action
(par défaut : 'hybrid-sleep
)L’action à prendre lorsque percentage-action
ou time-action
est atteint (en fonction de la configuration de
use-percentage-for-policy?
).
Les valeurs possibles sont :
'power-off
'hibernate
'hybrid-sleep
.
Type for the service that runs
UDisks, a disk
management daemon that provides user interfaces with notifications and ways
to mount/unmount disks. Programs that talk to UDisks include the
udisksctl
command, part of UDisks, and GNOME Disks. Note that
Udisks relies on the mount
command, so it will only be able to use
the file-system utilities installed in the system profile. For example if
you want to be able to mount NTFS file-systems in read and write fashion,
you’ll need to have ntfs-3g
installed system-wide.
The value for this service is a <udisks-configuration>
object.
Data type representing the configuration for udisks-service-type
.
udisks
(default: udisks
) (type: file-like)Package object for UDisks.
Type for the service that provides virtual file systems for GIO
applications, which enables support for trash://
, ftp://
,
sftp://
and many other location schemas in file managers like
Nautilus (GNOME Files) and Thunar.
The value for this service is a <gvfs-configuration>
object.
Data type representing the configuration for gvfs-service-type
.
gvfs
(default: gvfs
) (type: file-like)Package object for GVfs.
C’est le type de service qui lance colord
, un service système avec
une interface D-Bus pour gérer les profils de couleur des périphériques
d’entrées et de sorties comme les écrans et les scanners. Il est notamment
utilisé par l’outil graphique GNOME Color Manager. Voir
le site web de colord
pour plus d’informations.
Ce service fournit un accès aux scanner via
SANE en installant les règles udev
nécessaires. Il est inclus dans %desktop-services
(voir Services de bureaux) et s’appuie sur le paquet sane-backends-minimal
par défaut
(voir plus bas) pour la prise en charge matérielle.
Le paquet par défaut installé par le sane-service-type
. Il prend en
charge beaucoup de scanners récents.
Ce paquet inclus la prise en charge de tous les scanners pris en charge par
sane-backends-minimal
, plus les scanners Hewlett-Packard plus anciens
pris en charges par le paquet hplip
. Pour l’utiliser sur un système
qui utiliser les %desktop-services
, vous pouvez utiliser
modify-services
(voir modify-services
)
comme montré ci-dessous :
(use-modules (gnu)) (use-service-modules … desktop) (use-package-modules … scanner) (define %my-desktop-services ;; Liste des services de bureau qui prennent en charge un plus grand nombre de scanners. (modify-services %desktop-services (sane-service-type _ => sane-backends))) (operating-system ;; … (services %my-desktop-services))
Renvoie une configuration qui permet d’accéder aux données de localisation
de GeoClue. name est l’ID Desktop de l’application, sans la partie en
.desktop
. Si allowed? est vraie, l’application aura droit
d’accéder aux informations de localisation par défaut. Le booléen
system? indique si une application est un composant système ou non.
Enfin users est la liste des UID des utilisateurs pour lesquels cette
application a le droit d’accéder aux informations de géolocalisation. Une
liste d’utilisateurs vide indique que tous les utilisateurs sont autorisés.
La liste standard de configuration des application GeoClue connues, qui permet à l’utilitaire date-and-time de GNOME de demander l’emplacement actuel pour initialiser le fuseau horaire et aux navigateurs web IceCat et Epiphany de demander les informations de localisation. IceCat et Epiphany demandent tous deux à l’utilisateur avant de permettre à une page web de connaître l’emplacement de l’utilisateur.
Type for the service that runs the GeoClue location service. This service provides a D-Bus interface to allow applications to request access to a user’s physical location, and optionally to add information to online location databases.
The value for this service is a <geoclue-configuration>
object.
C’est le type pour le système Linux Bluetooth
Protocol Stack (BlueZ), qui génère le fichier de configuration
/etc/bluetooth/main.conf. La valeur de ce type est un enregistrement
bluetooth-configuration
comme dans cet exemple :
Voir plus bas pour des détails sur bluetooth-configuration
.
Type de données représentant la configuration pour bluetooth-service
.
bluez
(par défaut : bluez
)Le paquet bluez
à utiliser.
name
(par défaut : "BlueZ"
)Nom de l’adaptateur par défaut.
class
(par défaut : #x000000
)Classe de périphérique par défaut. Seuls les bits de classe de périphérique majeurs et mineurs sont pris en compte.
discoverable-timeout
(par défaut : 180
)Indique le temps pendant lequel rester en mode découvrable avant de repasser en mode non-découvrable. La valeur est en secondes.
always-pairable?
(par défaut : #f
)Permet de toujours s’appairer même s’il n’y a aucun agent enregistré.
pairable-timeout
(par défaut : 0
)Indique combien de temps rester en mode d’appairage avant de repasser en mode non-découvrable. La valeur est en secondes.
device-id
(par défaut : #f
)Utilise les informations de source de l’identifiant de fabriquant (assignateur), de fabriquant, de produit et de version pour la prise en charge du profil DID. Les valeurs sont séparées par « : » et assignateur, fabriquant, produit et version.
Les valeurs possibles sont :
#f
pour le désactiver,
"assignateur:1234:5678:abcd"
, où assignateur est soit
usb
(par défaut) soit bluetooth
.
reverse-service-discovery?
(par défaut : #t
)Utilise la découverte de service inversée pour les périphériques précédemment inconnus qui se connectent. Pour BR/EDR cette option n’est vraiment requise que pour la qualification cate le testeur BITE n’aime pas la découverte inversée dans certains cas de tests, pour LE cela désactive la fonctionnalité cliente GATT donc elle peut être utilisée pour les systèmes qui n’opèrent que comme un périphérique.
name-resolving?
(par défaut : #t
)Active la résolution de nom après la requête. Indiquez #f
si vous
n’avez pas besoin des noms des périphériques distants et souhaitez avoir un
cycle de découverte plus court.
debug-keys?
(par défaut : #f
)Active la persistance des clés de lien de débogage à l’exécution. La valeur par défaut est fausse et rend les clés de lien de débogage valides uniquement pour la durée de la connexion pour laquelle elles ont été créées.
controller-mode
(par défaut : 'dual
)Restreint tous les contrôleurs à leur transport spécifié. 'dual
signifie que BR/EDR et LE sont tous deux activés (si cela est pris en charge
par le matériel).
Les valeurs possibles sont :
'dual
'bredr
'le
multi-profile
(par défaut : 'off
)Active la prise en charge de la spécification multi-profil. Cela permet de spécifier si le système ne prend en charge que la configuration multi-profil mono-appareil (MPSD) ou à la fois la configuration multi-profil mono-appareil (MPSD) et multi-profil multi-appareil (MPMD).
Les valeurs possibles sont :
'off
'single
'multiple
fast-connectable?
(par défaut : #f
)Active le paramètre Fast Connectable de manière permanente pour les adaptateurs qui le prennent en charge. Lorsqu’il est activé les autres appareils peuvent se connecter plus rapidement, cependant le compromis est l’augmentation de la consommation électrique. Ce paramètre ne fonctionnera correctement que sur les versions du noyau 4.1 et supérieur.
privacy
(par défaut : 'off
)Paramètres de vie privée par défaut.
'off
: désactive la vie privée locale
'network/on
: un appareil n’acceptera pas de paquets d’annonce
d’appareils appairés qui contiennent des adresses privées. Cela peut ne pas
être compatible avec certains anciens appareils car ils nécessitent
l’utilisation continue de RPA
'device
: un appareil dans le mode de vie privée pour l’appareil ne
se souci que de la vie privée de l’appareil et acceptera les paquets
d’annonces d’appareils appairés qui contiennent leur adresse d’identité
ainsi que ceux qui contiennent une adresse privée, même si l’appareil a
distribué son IRK par le passé
et en plus, si controller-mode vaut 'dual
:
'limited-network
: applique le mode de découverte limité aux
annonces, qui suivent la même politique que BR/EDR qui publie l’adresse
d’identité en mode découvrable, et le mode de vie privée réseau pour scanner
'limited-device
: applique le mode de découverte limitée aux
annonces, qui suit la même politique que BR/EDR qui publie d’adresse
d’identité en mode découvrable, et le mode de vie privé de l’appareil pour
le scan.
just-works-repairing
(par défaut : 'never
)Spécifie la politique de ré-appairage JUST-WORKS du pair.
Les valeurs possibles sont :
'never
'confirm
'always
temporary-timeout
(par défaut : 30
)Le temps pendant lequel garder les appareils temporaires. La valeur est en
secondes. 0
désactive complètement l’horloge.
refresh-discovery?
(par défaut : #t
)Permet au périphérique d’envoyer une requête SDP pour mettre à jour les services connus quand le profil est connecté.
experimental?
(par défaut : #f
)Active les fonctionnalités et les interfaces expérimentales, ou bien une liste d’UUID.
Les valeurs possibles sont :
#t
#f
(list (uuid <uuid-1>) (uuid <uuid-2>) ...)
.
La liste des UUID possibles :
d4992530-b9ec-469f-ab01-6c481c47da1c
: le débogage expérimental de
BlueZ,
671b10b5-42c0-4696-9227-eb28d1b049d6
: simultanément central et
périphérique expérimental de BlueZ,
15c0a148-c273-11ea-b3de-0242ac130004
: vie privée LL expérimentale de
BlueZ,
330859bc-7506-492d-9370-9a6f0614037f
: rapport de qualité Bluetooth
expérimental de BlueZ,
a6695ace-ee7f-4fb9-881a-5fac66c629af
: codecs de déchargement
expérimentaux de BlueZ.
remote-name-request-retry-delay
(par défaut : 300
)La durée pour éviter de réessayer de résoudre le nom d’un pair, si l’essai précédent a échoué.
page-scan-type
(par défaut : #f
)type d’activité de scan de page BR/EDR.
page-scan-interval
(par défaut : #f
)Intervalle d’activité de scan de page BR/EDR.
page-scan-window
(par défaut : #f
)Fenêtre d’activité de scan de page BR/EDR.
inquiry-scan-type
(par défaut : #f
)Type d’activité de scan de requête BR/EDR.
inquiry-scan-interval
(par défaut : #f
)Intervalle d’activité de scan de requête BR/EDR.
inquiry-scan-window
(par défaut : #f
)Fenêtre d’activité de scan de requête BR/EDR.
link-supervision-timeout
(par défaut : #f
)Délai d’attente de supervision du lien BR/EDR.
page-timeout
(par défaut : #f
)Délai d’attente de page BR/EDR.
min-sniff-interval
(par défaut : #f
)Intervalle de sniff minimum BR/EDR.
max-sniff-interval
(par défaut : #f
)Intervalle de sniff maximum BR/EDR.
min-advertisement-interval
(par défaut : #f
)Intervalle d’annonce minimum LE (utilisé pour les anciens types d’annonces uniquement).
max-advertisement-interval
(par défaut : #f
)Intervalle d’annonce maximum LE (utilisé pour les anciens types d’annonce uniquement).
multi-advertisement-rotation-interval
(par défaut : #f
)Intervalle de rotation des multi-annonces LE.
scan-interval-auto-connect
(par défaut : #f
)Intervalle de scan LE utilisé pour le scan passif avec connexion automatique.
scan-window-auto-connect
(par défaut : #f
)Fenêtre de scan LE utilisé pour le scan passive avec prise en charge de la connexion automatique.
scan-interval-suspend
(par défaut : #f
)Intervalle de scan LE utilisé pour le scan actif avec prise en charge du réveil.
scan-window-suspend
(par défaut : #f
)Fenêtre de scan LE utilisée pour le scan actif avec prise en charge du réveil.
scan-interval-discovery
(par défaut : #f
)Intervalle de scan LE utilisé pour le scan actif avec prise en charge de la découverte.
scan-window-discovery
(par défaut : #f
)Fenêtre de scan LE utilisée pour le scan actif avec prise en charge de la découverte.
scan-interval-adv-monitor
(par défaut : #f
)Intervalle de scan LE utilisé pour le scan passif avec prise en charge des API de surveillance des annonces.
scan-window-adv-monitor
(par défaut : #f
)Fenêtre de scan LE utilisée pour le scan passif avec prise en charge des API de surveillance des annonces.
scan-interval-connect
(par défaut : #f
)Intervalle de scan LE utilisé pour l’établissement de connexion.
scan-window-connect
(par défaut : #f
)Fenêtre de scan LE utilisée pour l’établissement de connexion.
min-connection-interval
(par défaut : #f
)Intervalle minimal de connexion LE par défaut. Cette valeur est remplacée par toute valeur spécifique de l’interface de chargement des paramètres de connexion.
max-connection-interval
(par défaut : #f
)Intervalle maximal de connexion LE par défaut. Cette valeur est remplacée par toute valeur spécifique de l’interface de chargement des paramètres de connexion.
connection-latency
(par défaut : #f
)Latence de connexion LE. Cette valeur est remplacée par toute valeur spécifique de l’interface de chargement des paramètres de connexion.
connection-supervision-timeout
(par défaut : #f
)Délai d’attente de supervision de la connexion LE par défaut. Cette valeur est remplacée par toute valeur spécifique de l’interface de chargement des paramètres de connexion.
autoconnect-timeout
(par défaut : #f
)Délai d’attente de connexion automatique LE par défaut. Cette valeur est remplacée par toute valeur spécifique de l’interface de chargement des paramètres de connexion.
adv-mon-allowlist-scan-duration
(par défaut : 300
)Durée du scan Allowlist pendant le scan entrelacé. Utilisé uniquement pour scanner des moniteurs ADV. L’unité est en msec.
adv-mon-no-filter-scan-duration
(par défaut : 5
)Durée du scan sans filtre pendant le scan entrelacé. Utilisé uniquement pour scanner des moniteurs ADV. L’unité est en msec.
enable-adv-mon-interleave-scan?
(par défaut : #t
)Active ou désactive le scan entrelacé des moniteurs d’annonce pour la batterie.
cache
(par défaut : 'always
)Cache des attributs GATT.
Les valeurs possibles sont :
'always
: toujours mettre en cache les attributs même pour les
périphériques non appairés, c’est recommandé car l’option est la plus
adaptée pour l’interopérabilité, avec des temps de reconnexions plus
constants, et cela active le suivi correct des notifications de tous les
appareils
'yes
: ne met en cache que les attributs des périphériques appairés
'no
: ne met aucun attribut en cache.
key-size
(par défaut : 0
)Minimum requis pour la taille de clé de chiffrement pour accéder aux caractéristiques sécurisées.
Les valeurs possibles sont :
0
: on s’en fiche
7 <= N <= 16
exchange-mtu
(par défaut : 517
)Taille de MTU pour les échanges. Les valeurs possibles sont :
23 <= N <= 517
att-channels
(par défaut : 3
)Nombre de canaux ATT. Les valeurs possibles sont :
1
: désactive EATT
2 <= N <= 5
session-mode
(par défaut : 'basic
)Mode de canal AVDTP L2CAP.
Les valeurs possibles sont :
'basic
: utiliser le mode de base L2CAP
'ertm
: utiliser le mode de retransmission amélioré L2CAP.
stream-mode
(par défaut : 'basic
)Mode de canal de transport AVDTP L2CAP.
Les valeurs possibles sont :
'basic
: utiliser le mode de base L2CAP
'streaming
: utiliser le mode de flux L2CAP.
reconnect-uuids
(par défaut : '()
)ReconnectUUIDs défini l’ensemble des services distants auxquels on devrait essayer de se reconnecter en cas de perte de lien (délai d’attente dépassés sur la supervision du lien). Le greffon de politique devrait contenir un ensemble de valeurs par défaut correct, mais cette liste peut être modifiée ici. En indiquant la liste vide, la fonctionnalité de reconnexion est désactivée.
Les valeurs possibles sont :
'()
(list (uuid <uuid-1>) (uuid <uuid-2>) ...)
.
reconnect-attempts
(par défaut : 7
)Défini le nombre de tentatives de reconnexion après la perte d’un lien. La valeur 0 désactive la fonctionnalité de reconnexion.
reconnect-intervals
(par défaut : '(1 2 4 8 16 32 64)
)Défini une liste d’intervalles en secondes à utiliser entre les tentatives. Si le nombre de tentatives défini dans reconnect-attempts est plus grand que la liste d’intervalles, le dernier intervalle est répété jusqu’à la dernière tentative.
auto-enable?
(par défaut : #f
)Défini l’option pour activer tous les contrôleurs quand ils sont trouvés. Cela comprend les adaptateurs présents au démarrage ainsi que les adaptateurs branchés plus tard.
resume-delay
(par défaut : 2
)Les périphériques audio qui ont été déconnectés à cause d’une hibernation seront reconnectés au redémarrage. resume-delay détermine le délai entre le retour du contrôleur de veille et la tentative de connexion. Un délai plus long est préférable pour une meilleure coexistence avec le Wi-Fi. La valeur est en secondes.
rssi-sampling-period
(par défaut : #xFF
)Période d’échantillonnage RSSI par défaut. C’est utilisé quand un client enregistre un moniteur d’annonce et laisse RSSISamplingPeriod sans valeur.
Les valeurs possibles sont :
#x0
: rapporte toutes les annonces
N = #xXX
: rapporte les annonces toutes les N × 100 msec (de #x01 à
#xFE)
#xFF
: rapporte seulement une annonce par périphérique pendant la
période de monitoring.
C’est le type de service qui ajoute
GNOME Keyring. Sa
valeur est un objet gnome-keyring-configuration
(voir plus bas).
Ce service ajoute le paquet gnome-keyring
au profil du système et
étend PAM avec des entrées avec pam_gnome_keyring.so
, permettant de
déverrouiller un porteclé utilisateur à la connexion ou de spécifier son mot
de passe avec passwd.
Enregistrement de la configuration du service GNOME Keyring.
keyring
(par défaut : gnome-keyring
)Le paquet GNOME keyring à utiliser.
pam-services
Une liste de paires (service . type)
dénotant des
services PAM à étendre, où service est le nom d’un service existant à
étendre et type est login
ou passwd
.
S’il s’agit de login
, cela ajoute un pam_gnome_keyring.so
facultatif au bloc d’authentification sans argument et au bloc de session
avec auto_start
. S’il s’agit de passwd
, cela ajoute un
pam_gnome_keyring.so
facultatif au bloc de mot de passe sans
argument.
Par défaut, ce champ contient « gdm-password » avec la valeur login
et « passwd » avec la valeur passwd
.
seatd est un démon de gestion de siège.
La gestion des sièges prend en charge la médiation de l’accès aux périphériques partagés (d’affichage, de saisie), sans nécessiter que les applications n’aient besoin d’être root.
(append
(list
;; s'assure que seatd est lancé
(service seatd-service-type))
;; normalement vous avez besoin de %base-services
%base-services)
seatd
agit sur un socket domaine UNIX, et libseat
fournit le
côté client du protocole. Les applications qui ont accès aux ressources
partagées par seatd
(p. ex. sway
) doivent pouvoir parler
sur ce socket. Vous pouvez y arriver en ajoutant l’utilisateur sous lequel
ils tournent au groupe auquel appartient le socket de seatd
(habituellement « seat »), comme ceci :
(user-account
(name "alice")
(group "users")
(supplementary-groups '("wheel" ; permet d'utiliser sudo, etc.
"seat" ; gestion des sièges
"audio" ; carte son
"video" ; périphériques réseaux comme les webcams
"cdrom")) ; le bon vieux CD-ROM
(comment "Bob's sister"))
En fonction de votre configuration, vous devrez non seulement ajouter des utilisateur normaux, mais aussi des utilisateurs systèmes à ce groupe. Par exemple, certains écrans d’accueil greetd nécessitent les graphismes et doivent donc négocier avec seatd.
Enregistrement de la configuration du service du démon seatd.
seatd
(par défaut : seatd
)Le paquet seatd à utiliser.
group
(par défaut : ‘"seat"’)Groupe qui possède le socket seatd.
socket
(par défaut : ‘"/run/seatd.sock"’)Indique où créer le socket seatd.
logfile
(par défaut : ‘"/var/log/seatd.log"’)Fichier journal où écrire.
loglevel
(par défaut : ‘"error"’)Niveau de journalisation pour l’affichage des journaux. Les valeurs possibles sont : ‘"silent"’, ‘"error"’, ‘"info"’ et ‘"debug"’.
Suivant: File Search Services, Précédent: Services de bureaux, Monter: Services [Table des matières][Index]
Le module (gnu services sound)
fournit un service pour configurer le
système ALSA (architecture son linux avancée), qui fait de PulseAudio le
pilote de sortie préféré d’ALSA.
C’est le type pour le système Advanced
Linux Sound Architecture (ALSA), qui génère le fichier de configuration
/etc/asound.conf. La valeur de ce type est un enregistrement
alsa-configuration
comme dans cet exemple :
Voir plus bas pour des détails sur alsa-configuration
.
Type de données représentant la configuration pour alsa-service
.
alsa-plugins
(par défaut : alsa-plugins)Le paquet alsa-plugins
à utiliser.
pulseaudio?
(par défaut : #t)Indique si les applications ALSA devraient utiliser le serveur de son PulseAudio de manière transparente pour elles.
Utiliser PulseAudio vous permet dans lancer plusieurs applications qui
produisent du son en même temps et de les contrôler individuellement via
pavucontrol
entre autres choses.
extra-options
(par défaut : "")Chaîne à ajouter au fichier /etc/asound.conf.
Les utilisateurs individuels qui veulent modifier la configuration système d’ALSA peuvent le faire avec le fichier ~/.asoundrc :
# Dans guix, il faut spécifier le chemin absolu des greffons. pcm_type.jack { lib "/home/alice/.guix-profile/lib/alsa-lib/libasound_module_pcm_jack.so" } # Faire passer ALSA par Jack : # <http://jackaudio.org/faq/routing_alsa.html>. pcm.rawjack { type jack playback_ports { 0 system:playback_1 1 system:playback_2 } capture_ports { 0 system:capture_1 1 system:capture_2 } } pcm.!default { type plug slave { pcm "rawjack" } }
Voir https://www.alsa-project.org/main/index.php/Asoundrc pour les détails.
C’est le type de service pour le serveur de son
PulseAudio. Sa valeur est un
pulseaudio-configuration
(voir plus bas).
Attention : This service overrides per-user configuration files. If you want PulseAudio to honor configuration files in ~/.config/pulse, you have to unset the environment variables
PULSE_CONFIG
andPULSE_CLIENTCONFIG
in your ~/.bash_profile.
Attention : Ce service seul ne s’assure pas que le paquet
pulseaudio
existe sur votre machine. Il ajoute seulement des fichiers de configuration, comme décrit plus bas. Dans le cas (vraiment improbable) où vous n’auriez pas de paquetpulseaudio
, vous pouvez l’activer à travers le servicealsa-service-type
plus haut.
Type de données représentant la configuration pour
pulseaudio-service
.
client-conf
(par défaut : '()
)Liste les paramètres à indiquer dans client.conf. Accepte une liste de chaines ou de paires symboles-valeurs. Une chaine sera insérée telle quelle avec un saut de ligne. Une paire sera formatée en « clé = valeur » avec un saut de ligne.
daemon-conf
(par défaut : '((flat-volumes . no))
)Liste les paramètres à indiquer dans daemon.conf, formaté comme client-conf.
script-file
(par défaut : (file-append pulseaudio "/etc/pulse/default.pa")
)Le fichier de script à utiliser en tant que default.pa. Si le champ
extra-script-files
ci-dessous est utilisé, une directive
.include
pointant vers /etc/pulse/default.pa.d est ajoutée au
script fourni.
extra-script-files
(par défaut : '()
)Une liste d’objet simili-fichiers qui définissent des scripts PulseAudio
supplémentaires à lancer à l’initialisation du démon pulseaudio
,
après le script-file
principal. Les scripts sont déployés dans le
répertoire /etc/pulse/default.pa.d. Ils devraient avoir l’extension
de nom de fichier ‘.pa’. Pour une référence sur les commandes
disponibles, consultez man pulse-cli-syntax
.
system-script-file
(par défaut : (file-append pulseaudio "/etc/pulse/system.pa")
)Fichier de script à utiliser comme system.pa.
L’exemple ci-dessous initialise le profil de carte PulseAudio par défaut, le drain par défaut et la source par défaut à utiliser pour une ancienne carte son SoundBlaster Audigy :
(pulseaudio-configuration
(extra-script-files
(list (plain-file "audigy.pa"
(string-append "\
set-card-profile alsa_card.pci-0000_01_01.0 \
output:analog-surround-40+input:analog-mono
set-default-source alsa_input.pci-0000_01_01.0.analog-mono
set-default-sink alsa_output.pci-0000_01_01.0.analog-surround-40\n")))))
Remarquez que pulseaudio-service-type
fait partie de
%desktop-services
. Si votre déclaration de système d’exploitation
dérive d’un des modèles pour ordinateur de bureau, vous devrez ajuster
l’exemple ci-dessus pour modifier le service pulseaudio-service-type
existant avec modify-services
(voir modify-services
), au lieu de le définir à nouveau.
This service sets the LADSPA_PATH variable, so that programs, which respect it, e.g. PulseAudio, can load LADSPA plugins.
L’exemple suivant met en place le service pour activer les modules du paquet
swh-plugins
:
(service ladspa-service-type
(ladspa-configuration (plugins (list swh-plugins))))
Voir http://plugin.org.uk/ladspa-swh/docs/ladspa-swh.html pour les détails.
Suivant: Services de bases de données, Précédent: Services de son, Monter: Services [Table des matières][Index]
The services in this section populate file databases that let you
search for files on your machine. These services are provided by the
(gnu services admin)
module.
The first one, file-database-service-type
, periodically runs the
venerable updatedb
command (voir Invoking updatedb dans GNU
Findutils). That command populates a database of file names that you can
then search with the locate
command (voir Invoing locate dans GNU Findutils), as in this example:
locate important-notes.txt
You can enable this service with its default settings by adding this snippet to your operating system services:
This updates the database once a week, excluding files from
/gnu/store—these are more usefully handled by guix locate
(voir Invoking guix locate
). You can of course provide a custom
configuration, as described below.
This is the type of the file database service, which runs updatedb
periodically. Its associated value must be a
file-database-configuration
record, as described below.
Record type for the file-database-service-type
configuration, with
the following fields:
package
(default: findutils
)The GNU Findutils package from which the updatedb
command is
taken.
schedule
(default: %default-file-database-update-schedule
)String or G-exp denoting an mcron schedule for the periodic
updatedb
job (voir Guile Syntax dans GNU mcron).
excluded-directories
(default %default-file-database-excluded-directories
)List of regular expressions of directories to ignore when building the file
database. By default, this includes /tmp and /gnu/store; the
latter should instead be indexed by guix locate
(voir Invoking guix locate
). This list is passed to the --prunepaths option of
updatedb
(voir Invoking updatedb dans GNU Findutils).
The second service, package-database-service-type
, builds the
database used by guix locate
, which lets you search for packages
that contain a given file (voir Invoking guix locate
). The service
periodically updates a system-wide database, which will be readily available
to anyone running guix locate
on the system. To use this service
with its default settings, add this snippet to your service list:
This will run guix locate --update
once a week.
This is the service type for periodic guix locate
updates
(voir Invoking guix locate
). Its value must be a
package-database-configuration
record, as shown below.
Data type to configure periodic package database updates. It has the following fields:
package
(default: guix
)Le paquet Guix à utiliser.
schedule
(default: %default-package-database-update-schedule
)String or G-exp denoting an mcron schedule for the periodic guix
locate --update
job (voir Guile Syntax dans GNU mcron).
method
(default: 'store
)Indexing method for guix locate
. The default value,
'store
, yields a more complete database but is relatively expensive
in terms of CPU and input/output.
channels
(par défaut : #~%default-channels
)G-exp denoting the channels to use when updating the database (voir Canaux).
Suivant: Services de courriels, Précédent: File Search Services, Monter: Services [Table des matières][Index]
Le module (gnu services databases)
fournit les services suivants.
The service type for the PostgreSQL database server. Its value should be a
valid postgresql-configuration
object, documented below. The
following example describes a PostgreSQL service with the default
configuration.
(service postgresql-service-type
(postgresql-configuration
(postgresql postgresql)))
Si les services ne démarrent pas, cela peut être dû à une grappe incompatible déjà présente dans data-directory. Ajustez-la (ou, si vous n’avez plus besoin de la grappe, supprimez data-directory) puis redémarrez le service.
L’authentification des pairs est utilisé par défaut et le compte utilisateur
postgres
n’a pas de shell, ce qui évite l’exécution directe de
psql
en tant que cet utilisateur. Pour utiliser psql
, vous
pouvez vous authentifier temporairement en tant que postgres
avec un
shell, créer un superutilisateur PostgreSQL avec le même nom qu’un des
utilisateurs du système et créer la base de données associée.
sudo -u postgres -s /bin/sh createuser --interactive createdb $MY_USER_LOGIN # Remplacez comme vous voulez.
Type de données représentant la configuration de
postgresql-service-type
.
postgresql
Le paquet PostgreSQL à utiliser pour ce service.
port
(par défaut : 5432
)Port sur lequel PostgreSQL écoutera.
locale
(par défaut : "en_US.utf8"
)Paramètre linguistique à utiliser par défaut lors de la création de la grappe de bases de données.
config-file
(par défaut : (postgresql-config-file)
)Le fichier de configuration à utiliser pour lancer PostgreSQL. Le comportement par défaut est d’utiliser l’enregistrement postgresql-config-file avec les valeurs par défaut pour les champs.
log-directory
(default: "/var/log/postgresql"
)Le répertoire où la sortie de pg_ctl
sera écrite, dans un fichier
nommé "pg_ctl.log"
. Ce fichier peut être utile pour déboguer les
erreurs de configuration de PostgreSQL par exemple.
data-directory
(par défaut : "/var/lib/postgresql/data"
)Répertoire dans lequel stocker les données.
extension-packages
(par défaut : '()
) ¶Des extensions supplémentaires peuvent être chargées à partir de paquets
listés dans extension-packages. Les extensions sont disponibles à
l’exécution. Par exemple, pour créer une base de données géographique avec
l’extension postgis
, on peut configurer postgresql-service de cette
manière :
(use-package-modules databases geo) (operating-system ... ;; postgresql is required to run `psql' but postgis is not required for ;; proper operation. (packages (cons* postgresql %base-packages)) (services (cons* (service postgresql-service-type (postgresql-configuration (postgresql postgresql) (extension-packages (list postgis)))) %base-services)))
Ensuite l’extension devient visible et vous pouvez initialiser une base de données géographique de cette manière :
psql -U postgres > create database postgistest; > \connect postgistest; > create extension postgis; > create extension postgis_topology;
Vous n’avez pas besoin d’ajouter ce champ pour les extensions « contrib » comme hstore ou dblink comme elles sont déjà exploitables par postgresql. Ce champ n’est requis que pour ajouter des extensions fournies par d’autres paquets.
create-account?
(default: #t
)Whether or not the postgres
user and group should be created.
uid
(par défaut : #f
)Explicitly specify the UID of the postgres
daemon account. You
normally do not need to specify this, in which case a free UID will be
automatically assigned.
One situation where this option might be useful is if the data-directory is located on a mounted network share.
gid
(default: #f
)Explicitly specify the GID of the postgres
group.
Type de données représentant le fichier de configuration de PostgreSQL. Comme montré dans l’exemple suivant, on peut l’utiliser pour personnaliser la configuration de PostgreSQL. Remarquez que vous pouvez utiliser n’importe quelle G-expression ou nom de fichier à la place de cet enregistrement, si par exemple vous avez déjà un fichier de configuration que vous voulez utiliser.
(service postgresql-service-type
(postgresql-configuration
(config-file
(postgresql-config-file
(log-destination "stderr")
(hba-file
(plain-file "pg_hba.conf"
"
local all all trust
host all all 127.0.0.1/32 md5
host all all ::1/128 md5"))
(extra-config
'(("session_preload_libraries" "auto_explain")
("random_page_cost" 2)
("auto_explain.log_min_duration" "100 ms")
("work_mem" "500 MB")
("logging_collector" #t)
("log_directory" "/var/log/postgresql")))))))
log-destination
(par défaut : "syslog"
)La méthode de journalisation de PostgreSQL. Plusieurs valeurs sont possibles, séparées par des virgules.
hba-file
(par défaut : %default-postgres-hba
)Nom de fichier ou G-expression pour la configuration de l’authentification par hôte.
ident-file
(par défaut : %default-postgres-ident
)Nom de fichier ou G-expression pour la configuration de la correspondance de noms d’utilisateurs.
socket-directory
(par défaut : "/var/run/postgresql"
)Spécifie le répertoire des sockets Unix-domain sur lesquels PostgreSQL
écoutera les connexion d’applications clientes. Si la valeur est ""
,
PostgreSQL n’écoute sur aucun socket Unix-domain, auquel cas seuls les
socket TCP/IP permettent de se connecter au serveur.
Par défaut, la valeur #false
signifie que la valeur par défaut de
PostgreSQL sera utilisée, actuellement ‘/tmp’.
extra-config
(par défaut : '()
)Liste de clés et valeurs supplémentaires à inclure dans le fichier de configuration de PostgreSQL. Chaque entrée dans la liste devrait être une liste où le premier élément est la clé, et les autres éléments sont les valeurs.
Les valeurs peuvent être des nombres, des booléens ou des chaînes et seront
transformées en types de paramètres de PostgreSQL Boolean
,
String
, Numeric
, Numeric with Unit
et Enumerated
décrits ici.
Ce service permet de créer des rôles PostgreSQL et des bases de données après le démarrage du service PostgreSQL. Voici un exemple d’utilisation.
(service postgresql-role-service-type
(postgresql-role-configuration
(roles
(list (postgresql-role
(name "test")
(create-database? #t))))))
Ce service peut être étendu avec des rôles supplémentaires, comme dans cet exemple :
(service-extension postgresql-role-service-type
(const (postgresql-role
(name "alice")
(create-database? #t))))
PostgreSQL gère les permissions d’accès à la base de données en utilisant le concept de rôle. Un rôle est soit comme un utilisateur de la base de données, soit un groupe d’utilisateurs, en fonction du paramétrage du rôle. Les rôles peuvent posséder des objets de la base (par exemple des tables) et peuvent assigner des privilèges sur ces objets à d’autres rôles pour contrôler qui a accès à quels objets.
name
Le nom du rôle.
permissions
(par défaut : '(createdb login)
)La liste des permissions du rôle. Les permissions prises en charge sont
bypassrls
, createdb
, createrole
, login
,
replication
et superuser
.
create-database?
(par défaut : #f
)whether to create a database with the same name as the role.
encoding
(default: "UTF8"
)The character set to use for storing text in the database.
collation
(default: "en_US.utf8"
)The string sort order locale setting.
ctype
(default: "en_US.utf8"
)The character classification locale setting.
template
(default: "template1"
)The default template to copy the new database from when creating it. Use
"template0"
for a pristine database with no system-local
modifications.
Type de données représentant la configuration de postgresql-role-service-type.
host
(par défaut : "/var/run/postgresql"
)L’hôte PostgreSQL sur lequel se connecter.
log
(par défaut : "/var/log/postgresql_roles.log"
)Nom du fichier du fichier de journal.
roles
(par défaut : '()
)Les rôles PostgreSQL initiaux à créer.
C’est le type du service pour une base de donnée MySQL ou MariaDB. Sa
valeur est un objet mysql-configuration
, qui spécifie le paquet à
utiliser ainsi que divers paramètres pour le démon mysqld
.
Type de données représentant la configuration de mysql-service-type.
mysql
(par défaut : mariadb)Objet paquet du serveur de base de données MySQL, qui peut être soit mariadb, soit mysql.
Pour MySQL, un mot de passe root temporaire sera affiché à l’activation. Pour MariaDB, le mot de passe root est vide.
bind-address
(par défaut : "127.0.0.1"
)L’IP sur laquelle écouter les connexions réseau. Utilisez "0.0.0.0"
pour écouter sur toutes les interfaces réseaux.
port
(par défaut : 3306
)Port TCP sur lequel le serveur de base de données écoute les connexions entrantes.
socket
(par défaut : "/run/mysqld/mysqld.sock"
)Fichier de socket à utiliser pour les connexions locales (pas via le réseau).
extra-content
(par défaut : ""
)Paramètres supplémentaires pour le fichier de configuration my.cnf.
extra-environment
(par défaut : #~'()
)Liste de variables d’environnement passées au processus mysqld
.
auto-upgrade?
(par défaut : #t
)Indique s’il faut automatiquement lancer mysql_upgrade
après avoir
démarré le service. C’est nécessaire pour mettre à jour le schéma
système après une mise à jour « majeure » (comme de passer de MariaDB 10.4
à 10.5), mais peut être désactivé si vous voulez plutôt le faire
manuellement.
C’est le type de service pour le service Memcached qui fournit un cache en mémoire distribué. La valeur pour le
type de service est un objet memcached-configuration
.
Type de données représentant la configuration de memcached.
memcached
(par défaut : memcached
)Le paquet Memcached à utiliser.
interfaces
(par défaut : '("0.0.0.0")
)Les interfaces réseaux sur lesquelles écouter.
tcp-port
(par défaut : 11211
)Port sur lequel accepter les connexions.
udp-port
(par défaut : 11211
)Port sur lequel accepter les connexions UDP, une valeur de 0 désactive l’écoute en UDP.
additional-options
(par défaut : '()
)Options de la ligne de commande supplémentaires à passer à memcached
.
C’est le type de service pour la base clef-valeur Redis dont la valeur est un objet redis-configuration
.
Type de données représentant la configuration de redis.
redis
(par défaut : redis
)Le paquet Redis à utiliser.
bind
(par défaut : "127.0.0.1"
)Interface réseau sur laquelle écouter.
port
(par défaut : 6379
)Port sur lequel accepter les connexions, une valeur de 0 désactive l’écoute sur un socket TCP.
working-directory
(par défaut : "/var/lib/redis"
)Répertoire dans lequel stocker la base de données et les fichiers liés.
Suivant: Services de messagerie, Précédent: Services de bases de données, Monter: Services [Table des matières][Index]
Le module (gnu services mail)
fournit des définitions de services
Guix pour les services de courriel : des serveurs IMAP, POP3 et LMTP ainsi
que des MTA (Mail Transport Agent). Que d’acronymes ! Ces services sont
détaillés dans les sous-sections ci-dessous.
Type for the service that runs the Dovecot IMAP/POP3/LMTP mail server, whose
value is a <dovecot-configuration>
object.
Par défaut, Dovecot n’a pas besoin de beaucoup de configuration ; l’objet de
configuration par défaut créé par (dovecot-configuration)
suffira si
votre courriel est livré dans ~/Maildir
. Un certificat auto-signé
sera généré pour les connexions TLS, bien que Dovecot écoutera aussi sur les
ports non chiffrés par défaut. Il y a quelques options cependant, que les
administrateurs peuvent avoir besoin de changer et comme c’est le cas avec
d’autres services, Guix permet aux administrateurs systèmes de spécifier ces
paramètres via une interface Scheme unifiée.
Par exemple, pour spécifier que les courriels se trouvent dans
maildir~/.mail
, on peut instancier Dovecot de cette manière :
(service dovecot-service-type
(dovecot-configuration
(mail-location "maildir:~/.mail")))
Les paramètres de configuration disponibles sont les suivants. Chaque
définition des paramètres est précédé par son type ; par exemple,
‘string-list toto’ indique que le paramètre toto
devrait être
spécifié comme une liste de chaînes de caractères. Il y a aussi une manière
de spécifier la configuration comme une chaîne de caractères, si vous avez
un vieux fichier dovecot.conf
que vous voulez porter depuis un autre
système ; voir la fin pour plus de détails.
Les champs de dovecot-configuration
disponibles sont :
dovecot-configuration
:package dovecot ¶Le paquet dovecot.
dovecot-configuration
:comma-separated-string-list listen ¶Une liste d’IP ou d’hôtes à écouter pour les connexions. ‘*’ écoute sur toutes les interfaces IPv4, ‘::’ écoute sur toutes les interfaces IPv6. Si vous voulez spécifier des ports différents de la valeur par défaut ou quelque chose de plus complexe, complétez les champs d’adresse et de port de ‘inet-listener’ des services spécifiques qui vous intéressent.
dovecot-configuration
:protocol-configuration-list protocols ¶Liste des protocoles que vous voulez servir. Les protocoles disponibles comprennent ‘imap’, ‘pop3’ et ‘lmtp’.
Les champs protocol-configuration
disponibles sont :
protocol-configuration
:string name ¶Le nom du protocole.
protocol-configuration
:string auth-socket-path ¶Le chemin d’un socket UNIX vers le serveur d’authentification maître pour trouver les utilisateurs. C’est utilisé par imap (pour les utilisateurs partagés) et lda. Sa valeur par défaut est ‘"/var/run/dovecot/auth-userdb"’.
protocol-configuration
:boolean imap-metadata? ¶Indique s’il faut activer l’extension IMAP METADATA
définie dans
RFC 5464, qui permet aux
clients d’indiquer et récupérer des métadonnées et des annotations pour
chaque boîte aux lettres et chaque utilisateur par IMAP.
Si la valeur est ‘#t’, vous devez spécifier un dictionnaire via le
paramètre mail-attribute-dict
.
La valeur par défaut est ‘#f’.
protocol-configuration
:space-separated-string-list managesieve-notify-capabilities ¶Les capacités NOTIFY à rapporter aux clients qui se connectent pour la première fois au service ManageSieve, avant l’authentification. Elles peuvent être différentes des capacités offertes aux utilisateurs authentifiés. Si ce champ est vide, rapporte ce que l’interpréteur Sieve prend en charge par défaut.
La valeur par défaut est ‘'()’.
protocol-configuration
:space-separated-string-list managesieve-sieve-capability ¶Les capacités SIEVE à rapporter aux clients qui se connectent pour la première fois au service ManageSieve, avant l’authentification. Elles peuvent être différentes des capacités offertes aux utilisateurs authentifiés. Si ce champ est vide, rapporte ce que l’interpréteur Sieve prend en charge par défaut.
La valeur par défaut est ‘'()’.
protocol-configuration
:space-separated-string-list mail-plugins ¶Liste de greffons à charger séparés par des espaces.
protocol-configuration
:entier-non-négatif mail-max-userip-connections ¶Nombre maximum de connexions IMAP permises pour un utilisateur depuis chaque adresse IP. Remarque : la comparaison du nom d’utilisateur est sensible à la casse. Par défaut ‘10’.
dovecot-configuration
:service-configuration-list services ¶Liste des services à activer. Les services disponibles comprennent ‘imap’, ‘imap-login’, ‘pop3’, ‘pop3-login’, ‘auth’ et ‘lmtp’.
Les champs de service-configuration
disponibles sont :
service-configuration
:string kind ¶Le type de service. Les valeurs valides comprennent director
,
imap-login
, pop3-login
, lmtp
, imap
, pop3
,
auth
, auth-worker
, dict
, tcpwrap
,
quota-warning
ou n’importe quoi d’autre.
service-configuration
:listener-configuration-list listeners ¶Les auditeurs du service. Un auditeur est soit un
unix-listener-configuration
, soit un
fifo-listener-configuration
, soit un
inet-listener-configuration
. La valeur par défaut est ‘'()’.
Les champs de unix-listener-configuration
disponibles sont :
unix-listener-configuration
:string path ¶Chemin vers le fichier, relativement au champ base-dir
. C’est aussi
utilisé comme nom de section.
unix-listener-configuration
:string mode ¶Le mode d’accès pour le socket. La valeur par défaut est ‘"0600"’.
unix-listener-configuration
:string user ¶L’utilisateur à qui appartient le socket. La valeur par défaut est ‘""’.
unix-listener-configuration
:string group ¶Le groupe auquel appartient le socket. La valeur par défaut est ‘""’.
Les champs de fifo-listener-configuration
disponibles sont :
fifo-listener-configuration
:string path ¶Chemin vers le fichier, relativement au champ base-dir
. C’est aussi
utilisé comme nom de section.
fifo-listener-configuration
:string mode ¶Le mode d’accès pour le socket. La valeur par défaut est ‘"0600"’.
fifo-listener-configuration
:string user ¶L’utilisateur à qui appartient le socket. La valeur par défaut est ‘""’.
fifo-listener-configuration
:string group ¶Le groupe auquel appartient le socket. La valeur par défaut est ‘""’.
Les champs de inet-listener-configuration
disponibles sont :
inet-listener-configuration
:string protocol ¶Le protocole à écouter.
inet-listener-configuration
:string address ¶L’adresse sur laquelle écouter, ou la chaîne vide pour toutes les adresses. La valeur par défaut est ‘""’.
inet-listener-configuration
:entier-non-négatif port ¶Le port sur lequel écouter.
inet-listener-configuration
:boolean ssl? ¶S’il faut utiliser SSL pour ce service ; ‘yes’, ‘no’ ou ‘required’. La valeur par défaut est ‘#t’.
service-configuration
:entier-non-négatif client-limit ¶Connexions de clients simultanées maximum par processus. Une fois ce nombre
de connections atteint, la connexion suivante fera en sorte que Dovecot
démarre un autre processus. Si la valeur est 0, default-client-limit
est utilisé à la place.
La valeur par défaut est ‘0’.
service-configuration
:entier-non-négatif service-count ¶Nombre de connexions à gérer avant de démarrer un nouveau processus. Typiquement les valeurs utiles sont 0 (sans limite) ou 1. 1 est plus sûr, mais 0 est plus rapide. <doc/wiki/LoginProcess.txt>. La valeur par défaut est ‘1’.
service-configuration
:entier-non-négatif process-limit ¶Nombre de processus maximum qui peut exister pour ce service. Si la valeur
est 0, default-process-limit
est utilisé à la place.
La valeur par défaut est ‘0’.
service-configuration
:entier-non-négatif process-min-avail ¶Nombre de processus à toujours garder en attente de connexions. La valeur par défaut est ‘0’.
service-configuration
:entier-non-négatif vsz-limit ¶Si vous mettez ‘service-count 0’, vous avez sans doute besoin d’augmenter ce paramètre. La valeur par défaut est ‘256000000’.
dovecot-configuration
:dict-configuration dict ¶Configuration du dictionnaire, créé par le constructeur
dict-configuration
.
Les champs de dict-configuration
disponibles sont :
dict-configuration
:free-form-fields entries ¶Une liste de paires de clefs-valeurs que ce dictionnaire contient. La valeur par défaut est ‘'()’.
dovecot-configuration
:passdb-configuration-list passdbs ¶Une liste de configurations passdb, chacune créée par le constructeur
passdb-configuration
.
Les champs de passdb-configuration
disponibles sont :
passdb-configuration
:string driver ¶Le pilote à utiliser par passdb. Les valeur valides comprennent ‘pam’, ‘passwd’, ‘shadow’, ‘bsdauth’ et ‘static’. La valeur par défaut est ‘"pam"’.
passdb-configuration
:space-separated-string-list args ¶Liste d’arguments pour le pilote passdb séparés par des espaces. La valeur par défaut est ‘""’.
dovecot-configuration
:userdb-configuration-list userdbs ¶Liste des configurations userdb, chacune créée par le constructeur
userdb-configuration
.
Les champs de userdb-configuration
disponibles sont :
userdb-configuration
:string driver ¶Le pilote que userdb devrait utiliser. Les valeurs valides comprennent ‘passwd’ et ‘static’. La valeur par défaut est ‘"passwd"’.
userdb-configuration
:space-separated-string-list args ¶Liste des arguments du pilote userdb séparés par des espaces. La valeur par défaut est ‘""’.
userdb-configuration
:free-form-args override-fields ¶Remplace des champs de passwd. La valeur par défaut est ‘'()’.
dovecot-configuration
:plugin-configuration plugin-configuration ¶Configuration du greffon, créé par le constructeur
plugin-configuration
.
dovecot-configuration
:list-of-namespace-configuration namespaces ¶Liste d’espaces de noms. Chaque élément de la liste est créé par le
constructeur namespace-configuration
.
Les champs de namespace-configuration
disponibles sont :
namespace-configuration
:string name ¶Nom de cet espace de nom.
namespace-configuration
:string type ¶Type d’espace de nom : ‘private’, ‘shared’ ou ‘public’. La valeur par défaut est ‘"private"’.
namespace-configuration
:string separator ¶Séparateur de hiérarchie à utiliser. Vous devriez utiliser le même séparateur pour tous les espaces de noms ou certains clients seront confus. ‘/’ est généralement une bonne valeur. La valeur par défaut dépend cependant du format de stockage sous-jacent. La valeur par défaut est ‘""’.
namespace-configuration
:string prefix ¶Préfixe requis pour accéder à cet espace de nom. Ce paramètres doit être différent pour tous les espaces de noms. Par exemple ‘Public/’. La valeur par défaut est ‘""’.
namespace-configuration
:string location ¶Emplacement physique de la boîte aux lettres. C’est le même format que mail_location, qui est aussi la valeur par défaut. La valeur par défaut est ‘""’.
namespace-configuration
:boolean inbox? ¶Il ne peut y avoir qu’un INBOX, et ce paramètre définit l’espace de nom qui le possède. La valeur par défaut est ‘#f’.
Si l’espace de nom est caché, il n’est pas annoncé auprès des clients par l’extension NAMESPACE. Vous voudrez aussi sans doute indiquer ‘list? #f’. C’est surtout utile lors de la conversion depuis un autre serveur avec des espaces de noms différents que vous voulez rendre obsolètes sans les casser. Par exemple vous pouvez cacher les espaces de noms avec les préfixes ‘~/mail/’, ‘~%u/mail/’ et ‘mail/’. La valeur par défaut est ‘#f’.
namespace-configuration
:boolean list? ¶Montre les boîtes aux lettres sons cet espace de nom avec la commande LIST.
Cela rend l’espace de nom visible pour les clients qui ne supportent pas
l’extension NAMESPACE. La valeur spéciale children
liste les boîtes
aux lettres filles mais cache le préfixe de l’espace de nom. La valeur par
défaut est ‘#t’.
namespace-configuration
:boolean subscriptions? ¶Les espaces de noms gèrent leur propre souscription. Si la valeur est
#f
, l’espace de nom parent s’en charge. Le préfixe vide devrait
toujours avoir cette valeur à #t
. La valeur par défaut est
‘#t’.
namespace-configuration
:mailbox-configuration-list mailboxes ¶Liste des boîtes aux lettres prédéfinies dans cet espace de nom. La valeur par défaut est ‘'()’.
Les champs de mailbox-configuration
disponibles sont :
mailbox-configuration
:string name ¶Nom de cette boîte aux lettres.
mailbox-configuration
:string auto ¶‘create’ créera automatiquement cette boîte aux lettres. ‘subscribe’ créera et souscrira à la boîte aux lettres. La valeur par défaut est ‘"no"’.
mailbox-configuration
:space-separated-string-list special-use ¶Liste des attributs SPECIAL-USE
IMAP spécifiés par la RFC 6154. Les
valeurs valides sont \All
, \Archive
, \Drafts
,
\Flagged
, \Junk
, \Sent
et \Trash
. La valeur par
défaut est ‘'()’.
dovecot-configuration
:file-name base-dir ¶Répertoire de base où stocker les données d’exécution. La valeur par défaut est ‘"/var/run/dovecot/"’.
dovecot-configuration
:string login-greeting ¶Message d’accueil pour les clients. La valeur par défaut est ‘"Dovecot ready."’.
dovecot-configuration
:space-separated-string-list login-trusted-networks ¶Liste des groupes d’adresses de confiance. Les connexions depuis ces IP sont autorisées à modifier leurs adresses IP et leurs ports (pour la connexion et la vérification d’authentification). ‘disable-plaintext-auth’ est aussi ignoré pour ces réseaux. Typiquement vous voudrez spécifier votre mandataire IMAP ici. La valeur par défaut est ‘'()’.
dovecot-configuration
:space-separated-string-list login-access-sockets ¶Liste des sockets de vérification d’accès de connexion (p. ex. tcpwrap). La valeur par défaut est ‘'()’.
dovecot-configuration
:boolean verbose-proctitle? ¶Montre des titres de processus plus verbeux (dans ps). Actuellement, montre le nom d’utilisateur et l’adresse IP. Utile pour voir qui utilise en réalité les processus IMAP (p. ex. des boîtes aux lettres partagées ou si le même uid est utilisé pour plusieurs comptes). La valeur par défaut est ‘#f’.
dovecot-configuration
:boolean shutdown-clients? ¶Indique si les processus devraient toujours être tués lorsque le processus
maître de Dovecot est éteint. La valeur #f
signifie que Dovecot peut
être mis à jour sans forcer les connexions clientes existantes à se fermer
(bien que cela puisse être un problème si la mise à jour est un correctif de
sécurité par exemple). La valeur par défaut est ‘#t’.
dovecot-configuration
:entier-non-négatif doveadm-worker-count ¶Si la valeur n’est pas zéro, lance les commandes de courriel via ce nombre de connexions au serveur doveadm au lieu de les lancer dans le même processus. La valeur par défaut est ‘0’.
dovecot-configuration
:string doveadm-socket-path ¶Socket UNIX ou hôte:port utilisé pour se connecter au serveur doveadm. La valeur par défaut est ‘"doveadm-server"’.
dovecot-configuration
:space-separated-string-list import-environment ¶Liste des variables d’environnement qui sont préservées au démarrage de Dovecot et passées à tous ses processus fils. Vous pouvez aussi donner des paires clef=valeur pour toujours spécifier ce paramètre.
dovecot-configuration
:boolean disable-plaintext-auth? ¶Désactive la commande LOGIN et toutes les autres authentifications en texte clair à moins que SSL/TLS ne soit utilisé (capacité LOGINDISABLED). Remarquez que si l’IP distante correspond à l’IP locale (c.-à-d. que vous vous connectez depuis le même ordinateur), la connexion est considérée comme sécurisée et l’authentification en texte clair est permise. Voir aussi le paramètre ‘ssl=required’. La valeur par défaut est ‘#t’.
dovecot-configuration
:entier-non-négatif auth-cache-size ¶Taille du cache d’authentification (p. ex. ‘#e10e6’). 0 signifie qu’il est désactivé. Remarquez que bsdauth, PAM et vpopmail ont besoin que ‘cache-key’ soit indiqué pour que le cache soit utilisé. La valeur par défaut est ‘0’.
dovecot-configuration
:string auth-cache-ttl ¶Durée de vie des données en cache. Après l’expiration du TTL l’enregistrement en cache n’est plus utilisé *sauf* si la requête à la base de données principale revoie une erreur interne. Nous essayons aussi de gérer les changements de mot de passe automatiquement : si l’authentification précédente de l’utilisateur était réussie mais pas celle-ci, le cache n’est pas utilisé. Pour l’instant cela fonctionne avec l’authentification en texte clair uniquement. La valeur par défaut est ‘"1 hour"’.
dovecot-configuration
:string auth-cache-negative-ttl ¶TTL pour les résultats négatifs (l’utilisateur n’est pas trouvé ou le mot de passe ne correspond pas). 0 désactive la mise en cache complètement. La valeur par défaut est ‘"1 hour"’.
dovecot-configuration
:space-separated-string-list auth-realms ¶Liste des domaines pour les mécanismes d’authentification SASL qui en ont besoin. Vous pouvez laisser ce paramètre vide si vous ne voulez pas utiliser plusieurs domaines. Beaucoup de clients utilisent le premier domaine listé ici, donc gardez celui par défaut en premier. La valeur par défaut est ‘'()’.
dovecot-configuration
:string auth-default-realm ¶Domaine par défaut à utiliser si aucun n’est spécifié. C’est utilisé pour les domaines SASL et pour ajouter @domaine au nom d’utilisateur dans les authentification en texte clair. La valeur par défaut est ‘""’.
dovecot-configuration
:string auth-username-chars ¶Liste des caractères autorisés dans les noms d’utilisateur. Si le nom d’utilisateur donné par l’utilisateur contient un caractère qui n’est pas listé ici, la connexion échoue automatiquement. C’est juste une vérification supplémentaire pour s’assure que l’utilisateur ne puisse pas exploiter des vulnérabilités potentielles d’échappement de guillemets avec les bases de données SQL/LDAP. Si vous voulez autoriser tous les caractères, indiquez la liste vide.
dovecot-configuration
:string auth-username-translation ¶Traduction de caractères dans les noms d’utilisateur avant qu’ils ne soient cherchés en base. La valeur contient une série de caractère de -> à. Par exemple ‘#@/@’ signifie que ‘#’ et ‘/’ sont traduits en ‘@’. La valeur par défaut est ‘""’.
dovecot-configuration
:string auth-username-format ¶Format des noms d’utilisateur avant qu’ils ne soient cherchés en base. Vous pouvez utiliser les variables standard ici, p. ex. %Lu est le nom d’utilisateur en minuscule, %n enlève le domaine s’il est donné ou ‘%n-AT-%d’ changerait le ‘@’ en ‘-AT-’. Cette traduction est faite après les changements de ‘auth-username-translation’. La valeur par défaut est ‘"%Lu"’.
dovecot-configuration
:string auth-master-user-separator ¶Si vous voulez permettre aux utilisateurs maîtres de se connecter en spécifiant le nom d’utilisateur maître dans la chaîne de nom d’utilisateur normal (c.-à-d. sans utiliser le support du mécanisme SASL pour cela), vous pouvez spécifier le caractère de séparation ici. Le format est ensuite <nom d’utilisateur><séparateur><nom d’utilisateur maître>. UW-IMAP utilise ‘*’ comme séparateur, donc ça pourrait être un bon choix. La valeur par défaut est ‘""’.
dovecot-configuration
:string auth-anonymous-username ¶Nom d’utilisateur à utiliser pour les utilisateurs qui se connectent avec le mécanisme SASL ANONYMOUS. La valeur par défaut est ‘"anonymous"’.
dovecot-configuration
:entier-non-négatif auth-worker-max-count ¶Nombre maximum de processus de travail dovecot-auth. Ils sont utilisés pour exécuter des requêtes passdb et userdb bloquantes (p. ex. MySQL et PAM). Ils sont créés automatiquement et détruits au besoin. La valeur par défaut est ‘30’.
dovecot-configuration
:string auth-gssapi-hostname ¶Nom d’hôte à utiliser dans les noms GSSAPI principaux. La valeur par défaut est d’utiliser le nom renvoyé par gethostname(). Utilisez ‘$ALL’ (avec des guillemets) pour permettre toutes les entrées keytab. La valeur par défaut est ‘""’.
dovecot-configuration
:string auth-krb5-keytab ¶Keytab Kerberos à utiliser pour le mécanisme GSSAPI. Utilisera la valeur par défaut du système (typiquement /etc/krb5.keytab) s’il n’est pas spécifié. Vous pourriez avoir besoin de faire en sorte que le service d’authentification tourne en root pour pouvoir lire ce fichier. La valeur par défaut est ‘""’.
dovecot-configuration
:boolean auth-use-winbind? ¶Effectue l’authentification NTLM et GSS-SPNEGO avec le démon winbind de Samba et l’utilitaire ‘ntlm-auth’. <doc/wiki/Authentication/Mechanisms/Winbind.txt>. La valeur par défaut est ‘#f’.
dovecot-configuration
:file-name auth-winbind-helper-path ¶Chemin du binaire ‘ntlm-auth’ de samba. La valeur par défaut est ‘"/usr/bin/ntlm_auth"’.
dovecot-configuration
:string auth-failure-delay ¶Durée d’attente avant de répondre à des authentifications échouées. La valeur par défaut est ‘"2 secs"’.
dovecot-configuration
:boolean auth-ssl-require-client-cert? ¶Requiert un certification client SSL valide ou l’authentification échoue. La valeur par défaut est ‘#f’.
dovecot-configuration
:boolean auth-ssl-username-from-cert? ¶Prend le nom d’utilisateur du certificat SSL client, avec
X509_NAME_get_text_by_NID()
qui renvoie le CommonName du DN du
sujet. La valeur par défaut est ‘#f’.
dovecot-configuration
:space-separated-string-list auth-mechanisms ¶Liste des mécanismes d’authentification souhaités. Les mécanismes supportés sont : ‘plain’, ‘login’, ‘digest-md5’, ‘cram-md5’, ‘ntlm’, ‘rpa’, ‘apop’, ‘anonymous’, ‘gssapi’, ‘otp’, ‘skey’ et ‘gss-spnego’. Voir aussi le paramètre ‘disable-plaintext-auth’.
dovecot-configuration
:space-separated-string-list director-servers ¶Liste des IP ou des noms d’hôtes des serveurs directeurs, dont soi-même. Les ports peuvent être spécifiés avec ip:port. Le port par défaut est le même que le ‘inet-listener’ du service directeur. La valeur par défaut est ‘'()’.
dovecot-configuration
:space-separated-string-list director-mail-servers ¶Liste des IP ou des noms d’hôtes de tous les serveurs de courriel de la grappe. Les intervalles sont aussi permis, comme 10.0.0.10-10.0.0.30. La valeur par défaut est ‘'()’.
dovecot-configuration
:string director-user-expire ¶Combien de temps avant de rediriger les utilisateurs à un serveur spécifique après qu’il n’y a plus de connexion. La valeur par défaut est ‘"15 min"’.
dovecot-configuration
:string director-username-hash ¶La manière de traduire le nom d’utilisateur avant de le hasher. Les valeurs utiles comprennent %Ln si l’utilisateur peut se connecter avec ou sans @domain, %Ld si les boîtes aux lettres sont partagées dans le domaine. La valeur par défaut est ‘"%Lu"’.
dovecot-configuration
:string log-path ¶Fichier de journal à utiliser pour les messages d’erreur. ‘syslog’ journalise vers syslog, ‘/dev/stderr’ vers la sortie d’erreur. La valeur par défaut est ‘"syslog"’.
dovecot-configuration
:string info-log-path ¶Fichier de journal à utiliser pour les messages d’information. La valeur par défaut est ‘log-path’. La valeur par défaut est ‘""’.
dovecot-configuration
:string debug-log-path ¶Fichier de journal à utiliser pour les messages de débogage. La valeur par défaut est ‘info-log-path’. La valeur par défaut est ‘""’.
dovecot-configuration
:string syslog-facility ¶Dispositif syslog à utiliser si vous journalisez avec syslog. Normalement si vous ne voulez pas utiliser ‘mail’, vous voudrez utiliser local0..local7. D’autres dispositifs standard sont supportés. La valeur par défaut est ‘"mail"’.
dovecot-configuration
:boolean auth-verbose? ¶Indique s’il faut enregistrer les tentatives de connexion échouées et la raison de leur échec. La valeur par défaut est ‘#f’.
dovecot-configuration
:string auth-verbose-passwords ¶Dans le cas où le mot de passe n’était pas correct, indique s’il faut enregistrer le mauvais mot de passe. Les valeurs valides sont « no », « plain » et « sha1 ». Il peut être utile d’indiquer « sha1 » pour discriminer des attaques par force brute d’utilisateurs qui réessayent encore et encore le même mot de passe. Vous pouvez aussi tronquer la valeur à n caractères en ajoutant « :n » (p. ex. « sha1:6 »). La valeur par défaut est ‘"no"’.
dovecot-configuration
:boolean auth-debug? ¶Journaux encore plus verbeux pour le débogage. Cela montre par exemple les requêtes SQL effectuées. La valeur par défaut est ‘#f’.
dovecot-configuration
:boolean auth-debug-passwords? ¶Dans le cas où le mot de passe était incorrect, indique s’il faut enregistrer les mots de passe et les schémas utilisés pour que le problème puisse être débogué. Activer cette option active aussi ‘auth-debug’. La valeur par défaut est ‘#f’.
dovecot-configuration
:boolean mail-debug? ¶Indique s’il faut activer le débogage du traitement des courriels. Cela peut vous aider à comprendre pourquoi Dovecot ne trouve pas vos courriels. La valeur par défaut est ‘#f’.
dovecot-configuration
:boolean verbose-ssl? ¶Indique s’il faut montrer les erreurs au niveau SSL. La valeur par défaut est ‘#f’.
dovecot-configuration
:string log-timestamp ¶Préfixe à utiliser devant chaque ligne écrite dans le fichier journal. Les codes % sont au format strftime(3). La valeur par défaut est ‘"\"%b %d %H:%M:%S \""’.
dovecot-configuration
:space-separated-string-list login-log-format-elements ¶Liste des éléments qu’il faut enregistrer. Les éléments qui ont une variable non vide sont agrégés pour former une chaîne de mots séparés par des virgules.
dovecot-configuration
:string login-log-format ¶Format du journal de connexion. %s contient la chaîne ‘login-log-format-elements’, %$ contient la donnée à enregistrer. La valeur par défaut est ‘"%$: %s"’.
dovecot-configuration
:string mail-log-prefix ¶Préfixe à utiliser devant chaque ligne du fichier de journal pour les processus traitant les courriels. Voir doc/wiki/Variables.txt pour trouver la liste des variables que vous pouvez utiliser. La valeur par défaut est ‘"\"%s(%u)<%{pid}><%{session}>: \""’.
dovecot-configuration
:string deliver-log-format ¶Format à utiliser pour enregistrer les livraisons de courriels. Vous pouvez utiliser ces variables :
%$
Message de statut de la livraison (p. ex. ‘saved to INBOX’)
%m
Message-ID
%s
Objet
%f
Adresse « de »
%p
Taille physique
%w
Taille virtuelle.
La valeur par défaut est ‘"msgid=%m: %$"’.
dovecot-configuration
:string mail-location ¶Emplacement des boîtes à lettre des utilisateurs. La valeur par défaut est vide, ce qui signifie que Dovecot essaiera de trouver les boîte aux lettres automatiquement. Cela ne fonctionnera pas si l’utilisateur n’a aucun courriel, donc il vaut mieux indiquer explicitement le bon emplacement à Dovecot.
Si vous utilisez mbox, il ne suffit pas de donner le chemin vers le fichier INBOX (p. ex. /var/mail/%u). Vous devrez aussi dire à Dovecot où les autres boîtes aux lettres se trouvent. Cela s’appelle le « répertoire racine des courriels » et il doit être le premier chemin donné à l’option ‘mail-location’.
Il y a quelques variables spéciales que vous pouvez utiliser, p. ex :
nom d’utilisateur
la partie « utilisateur » dans « utilisateur@domaine », comme %u s’il n’y a pas de domaine
la partie « domaine » dans « utilisateur@domaine », vide s’il n’y a pas de domaine
répertoire personnel
Voir doc/wiki/Variables.txt pour la liste complète. Quelques exemple :
La valeur par défaut est ‘""’.
dovecot-configuration
:string mail-uid ¶Utilisateur et groupe système utilisé pour accéder aux courriels. Si vous utilisez multiple, userdb peut remplacer ces valeurs en renvoyant les champs uid et gid. Vous pouvez utiliser soit des nombres, soit des noms. <doc/wiki/UserIds.txt>. La valeur par défaut est ‘""’.
dovecot-configuration
:string mail-gid ¶La valeur par défaut est ‘""’.
dovecot-configuration
:string mail-privileged-group ¶Groupe à activer temporairement pour les opérations privilégiées. Actuellement cela est utilisé uniquement avec INBOX lors de sa création initiale et quand le verrouillage échoie. Typiquement, vous pouvez utiliser ‘"mail"’ pour donner accès à /var/mail. La valeur par défaut est ‘""’.
dovecot-configuration
:string mail-access-groups ¶Donne l’accès à ces groupes supplémentaires aux processus de courriel. Ils
sont typiquement utilisés pour mettre en place l’accès à des boites aux
lettres partagées. Remarquez qu’il peut être dangereux d’utiliser cette
option si l’utilisateur peut créer des liens symboliques (p. ex. si le
groupe ‘mail’ est utilisé ici, ln -s /var/mail ~/mail/var
peut
permettre à un utilisateur de supprimer les boites aux lettres des autres,
ou ln -s /secret/shared/box ~/mail/mybox
lui permettrait de la
lire). La valeur par défaut est ‘""’.
dovecot-configuration
:string mail-attribute-dict ¶L’emplacement d’un dictionnaire utilisé pour stocker les IMAP
METADATA
définies par RFC 5464.
Les commandes IMAP METADATA sont disponibles seulement si le champ
imap-metadata?
de la configuration du protocol « imap » vaut
‘#t’.
La valeur par défaut est ‘""’.
dovecot-configuration
:boolean mail-full-filesystem-access? ¶Permet l’accès complet au système de fichiers pour les clients. Il n’y a pas de vérification d’accès autres que ce que le système d’exploitation fait avec les UID/GID. Cela fonctionne aussi bien avec maildir qu’avec mbox, ce qui vous permet de préfixer les noms des boites aux lettres avec p. ex. /chemin/ ou ~utilisateur/. La valeur par défaut est ‘#f’.
dovecot-configuration
:boolean mmap-disable? ¶Ne pas du tout utiliser mmap()
. Cela est requis si vous stockez les
index dans des systèmes de fichiers partagés (NFS ou clusterfs). La valeur
par défaut est ‘#f’.
dovecot-configuration
:boolean dotlock-use-excl? ¶S’appuyer sur ‘O_EXCL’ lors de la création de fichiers de verrouillage. NFS supporte ‘O_EXCL’ depuis la version 3, donc cette option est sûre de nos jours. La valeur par défaut est ‘#t’.
dovecot-configuration
:string mail-fsync ¶Quand utiliser les appels à fsync() ou fdatasync() :
optimized
Lorsque cela est nécessaire pour éviter de perdre des données importantes
always
Utile lorsque par exemple les write()
de NFS sont retardées
never
Ne l’utilisez pas (ça a de meilleures performances, mais les crashs font perdre toutes les données).
La valeur par défaut est ‘"optimized"’.
dovecot-configuration
:boolean mail-nfs-storage? ¶Le stockage des courriels se fait sur NFS. Utilisez cette option pour que Dovecot vide les caches NFS lorsque c’est nécessaire. Si vous utilisez seulement un simple serveur de courriel, ce n’est pas nécessaire. La valeur par défaut est ‘#f’.
dovecot-configuration
:boolean mail-nfs-index? ¶Les fichiers d’index de courriels sont sur un système de fichiers NFS. Pour utiliser cette option, vous aurez besoin de ‘mmap-disable? #t’ et ‘fsync-disable? #f’. La valeur par défaut est ‘#f’.
dovecot-configuration
:string lock-method ¶Méthode de verrouillage des fichiers d’index. Les alternatives sont fcntl, flock et dotlock. Le verrouillage-point (dotlocking) utilise des astuces qui peuvent créer plus d’utilisation du disque que les autres méthodes de verrouillage. Pour les utilisateurs de NFS, flock ne marche pas, et rappelez-vous de modifier ‘mmap-disable’. La valeur par défaut est ‘"fcntl"’.
dovecot-configuration
:file-name mail-temp-dir ¶Le répertoire dans lequel LDA/LMTP stockent temporairement les courriels de plus de 128 Ko. La valeur par défaut est ‘"/tmp"’.
dovecot-configuration
:entier-non-négatif first-valid-uid ¶L’intervalle d’UID valides pour les utilisateurs. Cette option est surtout utile pour s’assurer que les utilisateurs ne peuvent pas s’authentifier en tant que démon ou qu’un autre utilisateur système. Remarquez que la connexion en root est interdite en dur dans le binaire de dovecot et qu’on ne peut pas l’autoriser même si ‘first-valid-uid’ vaut 0. La valeur par défaut est ‘500’.
dovecot-configuration
:entier-non-négatif last-valid-uid ¶La valeur par défaut est ‘0’.
dovecot-configuration
:entier-non-négatif first-valid-gid ¶Li’ntervalle de GID valides pour les utilisateurs. Les utilisateurs qui ont un GID non-valide comme numéro de groupe primaire ne peuvent pas se connecter. Si l’utilisateur appartient à un groupe avec un GID non valide, ce groupe n’est pas utilisable. La valeur par défaut est ‘1’.
dovecot-configuration
:entier-non-négatif last-valid-gid ¶La valeur par défaut est ‘0’.
dovecot-configuration
:entier-non-négatif mail-max-keyword-length ¶Longueur maximale autorisée pour les mots-clefs. Elle n’est utilisée que lors de la création de nouveaux mots-clefs. La valeur par défaut est ‘50’.
dovecot-configuration
:colon-separated-file-name-list valid-chroot-dirs ¶Liste des répertoires sous lesquels le chroot est permis pour les processus de traitement des courriels (c.-à-d. /var/mail permettra aussi de se chrooter dans /var/mail/toto/titi). Ce paramètre n’affecte pas ‘login-chroot’ ‘mail-chroot’ ou les paramètres de chroot de l’authentification. Si ce paramètre est vide, ‘/./’ dans les répertoires personnels sont ignorés. ATTENTION : n’ajoutez jamais de répertoires ici que les utilisateurs locaux peuvent modifier, puisque ça pourrait permettre d’escalader les privilèges. Normalement vous ne devriez le faire que si les utilisateurs n’ont pas d’accès shell. <doc/wiki/Chrooting.txt>. La valeur par défaut est ‘'()’.
dovecot-configuration
:string mail-chroot ¶Répertoire chroot par défaut pour les processus de traitement des courriels. Cela peut être modifié pour des utilisateurs particuliers dans la base de donnée en donnant ‘/./’ dans le répertoire personnel (p. ex. ‘/home/./utilisateur’ permet de se chrooter dans /home). Remarquez qu’il n’y a d’habitude pas besoin de se chrooter. Dovecot ne permet pas aux utilisateurs d’accéder aux fichiers en dehors de leur répertoire de courriels de toute façon. Si vos répertoires personnels sont préfixés par le répertoire de chroot, ajoutez ‘/.’ à ‘mail-chroot’. <doc/wiki/Chrooting.txt>. La valeur par défaut est ‘""’.
dovecot-configuration
:file-name auth-socket-path ¶Chemin de socket UNIX vers le serveur d’authentification maître pour trouver les utilisateurs. C’est utilisé par imap (pour les utilisateurs partagés) et lda. La valeur par défaut est ‘"/var/run/dovecot/auth-userdb"’.
dovecot-configuration
:file-name mail-plugin-dir ¶Répertoire où trouver les greffons. La valeur par défaut est ‘"/usr/lib/dovecot"’.
dovecot-configuration
:space-separated-string-list mail-plugins ¶Liste des greffons à charger pour tous les services. Les greffons spécifiques à IMAP, LDA, etc. sont ajoutés à cette liste dans leur propre fichiers .conf. La valeur par défaut est ‘'()’.
dovecot-configuration
:entier-non-négatif mail-cache-min-mail-count ¶Le nombre minimal de courriels dans une boîte aux lettres avant de mettre à jour le fichier de cache. Cela permet d’optimiser le comportement de Dovecot pour qu’il fasse moins d’écriture disque contre plus de lecture disque. La valeur par défaut est ‘0’.
dovecot-configuration
:string mailbox-idle-check-interval ¶Lorsque la commande IDLE est lancée, la boîte aux lettres est vérifiée de temps en temps pour voir s’il y a de nouveaux messages ou d’autres changements. Ce paramètre défini le temps d’attente minimum entre deux vérifications. Dovecot peut aussi utilise dnotify, inotify et kqueue pour trouver immédiatement les changements. La valeur par défaut est ‘"30 secs"’.
dovecot-configuration
:boolean mail-save-crlf? ¶Sauvegarder les courriels avec CR+LF plutôt que seulement LF. Cela permet de consommer moins de CPU en envoyant ces courriels, surtout avec l’appel système sendfile() de Linux et FreeBSD. Mais cela crée un peu plus d’utilisation du disque, ce qui peut aussi le ralentir. Remarquez aussi que si d’autres logiciels lisent les mbox/maildirs, ils peuvent se tromper dans leur traitement de ces CR supplémentaires et causer des problèmes. La valeur par défaut est ‘#f’.
dovecot-configuration
:boolean maildir-stat-dirs? ¶Par défaut la commande LIST renvoie toutes les entrées du maildir qui commencent par un point. Activer cette option permet à Dovecot de renvoyer uniquement les entrées qui sont des répertoires. Cela se fait avec stat() sur chaque entrée, ce qui cause plus d’utilisation du disque. For systems setting struct ‘dirent->d_type’ this check is free and it’s done always regardless of this setting). La valeur par défaut est ‘#f’.
dovecot-configuration
:boolean maildir-copy-with-hardlinks? ¶Lors de la copie d’un message, le faire avec des liens en dur si possible. Cela améliore un peu la performance et n’a que peu de chance d’avoir des effets secondaires.
dovecot-configuration
:boolean maildir-very-dirty-syncs? ¶Suppose que Dovecot est le seul MUA qui accède à Maildir : scanne le répertoire cur/ seulement lorsque son mtime change de manière inattendue ou lorsqu’il ne peut pas trouver le courriel autrement. La valeur par défaut est ‘#f’.
dovecot-configuration
:space-separated-string-list mbox-read-locks ¶La méthode de verrouillage à utiliser pour verrouiller le boîtes aux lettres mbox. Il y en a quatre :
dotlock
Crée un fichier <mailbox>.lock. C’est la solution la plus ancienne et la plus sûr pour NFS. Si vous voulez utiliser /var/mail/, les utilisateurs auront besoin de l’accès en écriture à ce répertoire.
dotlock-try
Comme pour dotlock, mais si elle échoue à cause d’un problème de permission ou parce qu’il n’y a pas assez d’espace disque, l’ignore.
fcntl
Utilisez cette méthode si possible. Elle fonctionne aussi avec NFS si vous utilisez lockd.
flock
Peut ne pas exister sur tous les systèmes. Ne fonctionne pas avec NFS.
lockf
Peut ne pas exister sur tous les systèmes. Ne fonctionne pas avec NFS.
Vous pouvez utiliser plusieurs méthodes de verrouillage ; dans ce cas l’ordre dans lequel elles sont déclarées est important pour éviter des interblocages si d’autres MTA/MUA utilisent aussi plusieurs méthodes. Certains systèmes d’exploitation ne permettent pas d’utiliser certaines méthodes en même temps.
dovecot-configuration
:space-separated-string-list mbox-write-locks ¶dovecot-configuration
:string mbox-lock-timeout ¶Temps d’attente maximal pour un verrou (tous les verrous) avant d’abandonner. La valeur par défaut est ‘"5 mins"’.
dovecot-configuration
:string mbox-dotlock-change-timeout ¶Si le fichier dotlock existe mais que la boîte aux lettres n’est pas modifiée, remplacer le fichier de verrouillage après ce temps d’attente. La valeur par défaut est ‘"2 mins"’.
dovecot-configuration
:boolean mbox-dirty-syncs? ¶Lorsqu’un mbox change ne manière inattendue, il faut le lire en entier pour savoir ce qui a changé. Si le mbox est assez grand cela peut prendre beaucoup de temps. Comme le changement est habituellement un simple courriel supplémentaire, il serait plus rapide de lire le nouveaux courriels. Si ce paramètre est activé, Dovecot fait cela mais revient toujours à relire le fichier mbox complet si le fichier n’est pas comme attendu. Le seul réel inconvénient à ce paramètre est que certains MUA changent les drapeaux des messages, et dans ce cas Dovecot ne s’en rend pas immédiatement compte. Remarquez qu’une synchronisation complète est effectuée avec les commandes SELECT, EXAMINE, EXPUNGE et CHECK. La valeur par défaut est ‘#t’.
dovecot-configuration
:boolean mbox-very-dirty-syncs? ¶Comme ‘mbox-dirty-syncs’, mais ne synchronise pas complètement même avec les commandes SELECT, EXAMINE, EXPUNGE ou CHECK. Si l’option n’est pas activée, ‘mbox-dirty-syncs’ est ignorée. La valeur par défaut est ‘#f’.
dovecot-configuration
:boolean mbox-lazy-writes? ¶Attendre avant d’écrire les en-têtes mbox jusqu’à la prochaine synchronisation des écritures (les commandes EXPUNGE et CHECK et quand on ferme la boîte aux lettres). C’est surtout utile pour POP3 où les clients suppriment souvent tous les courriels. L’inconvénient c’est que vos changements ne sont pas immédiatement visibles pour les autres MUA. La valeur par défaut est ‘#t’.
dovecot-configuration
:entier-non-négatif mbox-min-index-size ¶Si la taille du fichier mbox est plus petite que cela (p. ex. 100k), ne pas écrire de fichier d’index. Si un fichier d’index existe déjà il est toujours lu, mais pas mis à jour. La valeur par défaut est ‘0’.
dovecot-configuration
:entier-non-négatif mdbox-rotate-size ¶Taille du fichier dbox maximale avant rotation. La valeur par défaut est ‘10000000’.
dovecot-configuration
:string mdbox-rotate-interval ¶Âge maximum du fichier dbox avant rotation. Typiquement en jours. Les jours commencent à minuit, donc 1d signifie aujourd’hui, 2d pour hier, etc. 0 pour désactiver la vérification. La valeur par défaut est ‘"1d"’.
dovecot-configuration
:boolean mdbox-preallocate-space? ¶Lors de la création des fichiers mdbox, préallouer immédiatement leur taille à ‘mdbox-rotate-size’. Ce paramètre ne fonctionne actuellement que dans Linux avec certains systèmes de fichiers (ext4, xfs). La valeur par défaut est ‘#f’.
dovecot-configuration
:string mail-attachment-dir ¶sdbox et mdbox supportent la sauvegarde des pièces-jointes dans des fichiers externes, ce qui permet de les stocker une seule fois. Les autres moteurs ne le supportent pas pour le moment.
ATTENTION : Cette fonctionnalité n’a pas été beaucoup testée. Utilisez-la à vos risques et périls.
Racine du répertoire où stocker les pièces-jointes. Désactivé si vide. La valeur par défaut est ‘""’.
dovecot-configuration
:entier-non-négatif mail-attachment-min-size ¶Les pièces-jointes plus petites que cela ne sont pas enregistrées à part. Il est aussi possible d’écrire un greffon pour désactiver l’enregistrement externe de certaines pièces-jointes spécifiques. La valeur par défaut est ‘128000’.
dovecot-configuration
:string mail-attachment-fs ¶Moteur du système de fichier à utiliser pour sauvegarder les pièces-jointes :
posix
Pas de SiS (single instance storage) par Dovecot (mais cela peut aider la déduplication du système de fichier)
sis posix
SiS avec comparaison bit-à-bit immédiate pendant la sauvegarde
sis-queue posix
SiS avec déduplication et comparaison différées.
La valeur par défaut est ‘"sis posix"’.
dovecot-configuration
:string mail-attachment-hash ¶Format de hash à utiliser dans les noms de fichiers des pièces-jointes.
Vous pouvez ajouter n’importe quel texte ou variable : %{md4}
,
%{md5}
, %{sha1}
, %{sha256}
, %{sha512}
,
%{size}
. Les variables peuvent être tronquées, p. ex.
%{sha256:80}
renvoie seulement les 80 premiers bits. La valeur par
défaut est ‘"%{sha1}"’.
dovecot-configuration
:entier-non-négatif default-process-limit ¶La valeur par défaut est ‘100’.
dovecot-configuration
:entier-non-négatif default-client-limit ¶La valeur par défaut est ‘1000’.
dovecot-configuration
:entier-non-négatif default-vsz-limit ¶Limite VSZ (taille mémoire virtuelle) par défaut pour les processus de service. C’est surtout pour attraper et tuer les processus qui font fuiter la mémoire avant qu’ils ne l’utilisent en entier. La valeur par défaut est ‘256000000’.
dovecot-configuration
:string default-login-user ¶Utilisateur de connexion utilisé en interne par les processus de connexion. C’est l’utilisateur avec la confiance minimale pour Dovecot. Il ne devrait avoir accès à rien du tout. La valeur par défaut est ‘"dovenull"’.
dovecot-configuration
:string default-internal-user ¶Utilisateur utilisé en interne par les processus non privilégiés. Il devrait être différent de l’utilisateur de connexion, pour que les processus de connexion ne puissent pas perturber les autres processus. La valeur par défaut est ‘"dovecot"’.
dovecot-configuration
:string ssl? ¶Support SSL/TLS : yes, no, required. <doc/wiki/SSL.txt>. La valeur par défaut est ‘"required"’.
dovecot-configuration
:string ssl-cert ¶Certificat SSL/TLS X.509 encodé en PEM (clef publique). La valeur par défaut est ‘"</etc/dovecot/default.pem"’.
dovecot-configuration
:string ssl-key ¶Clef privée SSL/TLS encodée en PEM. La clef est ouverte avant l’abandon des privilèges root, donc laissez-la non-lisible pour les utilisateurs. La valeur par défaut est ‘"</etc/dovecot/private/default.pem"’.
dovecot-configuration
:string ssl-key-password ¶Si le fichier de clef est protégé par un mot de passe, donnez-le ici. Autrement, donnez-le en démarrant dovecot avec le paramètre -p. Comme ce fichier est souvent lisible pour tout le monde, vous pourriez vouloir placer ce paramètre dans un autre fichier. La valeur par défaut est ‘""’.
dovecot-configuration
:string ssl-ca ¶Certificat de l’autorité de confiance encodé en PEM. Indiquez cette valeur si vous voulez utiliser ‘ssl-verify-client-cert? #t’. Le fichier devrait contenir les certificats de CA suivi par les CRL correspondants (p. ex. ‘ssl-ca </etc/ssl/certs/ca.pem’). La valeur par défaut est ‘""’.
dovecot-configuration
:boolean ssl-require-crl? ¶Indique si les certificats clients doivent réussir la vérification du CRL. La valeur par défaut est ‘#t’.
dovecot-configuration
:boolean ssl-verify-client-cert? ¶Demande aux clients d’envoyer un certificat. Si vous voulez aussi le requérir, indiquez ‘auth-ssl-require-client-cert? #t’ dans la section auth. La valeur par défaut est ‘#f’.
dovecot-configuration
:string ssl-cert-username-field ¶Le champ du certificat à utiliser pour le nom d’utilisateur. Les choix habituels sont commonName et X500UniqueIdentifier. Vous devrez aussi indiquer ‘auth-ssl-username-from-cert? #t’. La valeur par défaut est ‘"commonName"’.
dovecot-configuration
:string ssl-min-protocol ¶Version minimale de SSL à accepter. La valeur par défaut est ‘"TLSv1"’.
dovecot-configuration
:string ssl-cipher-list ¶Méthodes de chiffrement à utiliser. La valeur par défaut est ‘"ALL:!kRSA:!SRP:!kDHd:!DSS:!aNULL:!eNULL:!EXPORT:!DES:!3DES:!MD5:!PSK:!RC4:!ADH:!LOW@STRENGTH"’.
dovecot-configuration
:string ssl-crypto-device ¶Moteur cryptographique SSL à utiliser. Pour les valeur valides, lancez « openssl engine ». La valeur par défaut est ‘""’.
dovecot-configuration
:string postmaster-address ¶Adresse à utiliser pour envoyer les courriels de rejet. %d correspond au domaine du destinataire. La valeur par défaut est ‘"postmaster@%d"’.
dovecot-configuration
:string hostname ¶Nom d’hôte à utiliser dans diverses parties des courriels envoyés (p. ex. dans Message-Id) et dans les réponses LMTP. La valeur par défaut est le nomdhôte@domaine réel du système. La valeur par défaut est ‘""’.
dovecot-configuration
:boolean quota-full-tempfail? ¶Si l’utilisateur dépasse le quota, renvoie un échec temporaire au lieu de rejeter le courriel. La valeur par défaut est ‘#f’.
dovecot-configuration
:file-name sendmail-path ¶Binaire à utiliser pour envoyer des courriels. La valeur par défaut est ‘"/usr/sbin/sendmail"’.
dovecot-configuration
:string submission-host ¶Si la valeur est non vide, envoyer les courriels à ce serveur SMTP hôte[:port] au lieu de sendmail. La valeur par défaut est ‘""’.
dovecot-configuration
:string rejection-subject ¶En-tête d’objet à utiliser pour les courriels de rejet. Vous pouvez utiliser les mêmes variables que pour ‘rejection-reason’ ci-dessous. La valeur par défaut est ‘"Rejected: %s"’.
dovecot-configuration
:string rejection-reason ¶Message d’erreur pour les humains dans les courriels de rejet. Vous pouvez utiliser ces variables :
%n
CRLF
%r
raison
%s
objet du courriel de départ
%t
destinataire
La valeur par défaut est ‘"Your message to <%t> was automatically rejected:%n%r"’.
dovecot-configuration
:string recipient-delimiter ¶Caractère de délimitation entre la partie locale et le détail des adresses de courriel. La valeur par défaut est ‘"+"’.
dovecot-configuration
:string lda-original-recipient-header ¶En-tête où l’adresse du destinataire d’origine (l’adresse RCPT TO de SMTP) est récupérée si elle n’est pas disponible ailleurs. Le paramètre -a de dovecot-lda le remplace. L’en-tête couramment utilisée pour cela est X-Original-To. La valeur par défaut est ‘""’.
dovecot-configuration
:boolean lda-mailbox-autocreate? ¶Sauvegarder un courriel dans un fichier qui n’existe pas devrait-il le créer ? La valeur par défaut est ‘#f’.
dovecot-configuration
:boolean lda-mailbox-autosubscribe? ¶Devrait-on aussi se souscrire aux boîtes aux lettres nouvellement créées ? La valeur par défaut est ‘#f’.
dovecot-configuration
:entier-non-négatif imap-max-line-length ¶Longueur maximale de la ligne de commande IMAP. Certains clients génèrent des lignes de commandes très longues avec des boîtes aux lettres énormes, donc vous pourriez avoir besoin d’augmenter cette limite si vous obtenez les erreurs « Too long argument » ou « IMAP command line too large ». La valeur par défaut est ‘64000’.
dovecot-configuration
:string imap-logout-format ¶Format de la chaîne de déconnexion IMAP :
%i
nombre d’octets lus par le client
%o
nombre total d’octets envoyés au client.
Voir doc/wiki/Variables.txt pour une liste de toutes les variables utilisables. La valeur par défaut est ‘"in=%i out=%o deleted=%{deleted} expunged=%{expunged} trashed=%{trashed} hdr_count=%{fetch_hdr_count} hdr_bytes=%{fetch_hdr_bytes} body_count=%{fetch_body_count} body_bytes=%{fetch_body_bytes}"’.
dovecot-configuration
:string imap-capability ¶Remplace la réponse CAPABILITY d’IMAP. Si la valeur commence par « + », ajoute les capacités données en haut des valeur par défaut (p. ex. +XFOO XBAR). La valeur par défaut est ‘""’.
dovecot-configuration
:string imap-idle-notify-interval ¶Temps d’attente entre les notifications « OK Still here » lorsque le client est en IDLE. La valeur par défaut est ‘"2 mins"’.
dovecot-configuration
:string imap-id-send ¶Noms des champs ID et de leur valeur à envoyer aux clients. « * » signifie la valeur par défaut. Les champs suivants ont actuellement des valeurs par défaut : name, version, os, os-version, support-url, support-email. La valeur par défaut est ‘""’.
dovecot-configuration
:string imap-id-log ¶Champs ID envoyés par le client à enregistrer. « * » signifie tout. La valeur par défaut est ‘""’.
dovecot-configuration
:space-separated-string-list imap-client-workarounds ¶Contournements pour divers bogues de certains client :
delay-newmail
Envoi des notifications de nouveau message EXISTS/RECENT seulement en réponse aux commandes NOOP et CHECK. Certains clients les ignorent autrement, par exemple OSX Mail (< v2.1). Outlook Express est encore plus cassé, sans cela il peut montrer des erreurs de type « Le message n’est plus sur le serveur ». Remarquez que OE6 est toujours cassé même avec ce contournement si la synchronisation est à « En-têtes seulement ».
tb-extra-mailbox-sep
Thunderbird se mélange les pinceaux avec LAYOUT=fs (mbox et dbox) et ajoute un suffixe ‘/’ supplémentaire sur les noms des boîtes aux lettres. Cette option fait que dovecot ignore le ‘/’ supplémentaire au lieu de le traiter comme un nom de boîte aux lettres invalide.
tb-lsub-flags
Montre les drapeaux \Noselect pour les réponses LSUB avec LAYOUT=fs (p. ex. mbox). Cela fait que Thunderbird réalise qu’ils ne sont pas sélectionnables et les montre en grisé, au lieu de montrer un popup « non sélectionnable » après coup.
La valeur par défaut est ‘'()’.
dovecot-configuration
:string imap-urlauth-host ¶Hôte autorisé dans les URL URLAUTH envoyés par les clients. « * » les autorise tous. La valeur par défaut est ‘""’.
Ouf ! Tant d’options de configuration. La bonne nouvelle, c’est que Guix a une interface complète avec le langage de configuration de Dovecot. Cela permet non seulement de déclarer la configuration de manière agréable, mais aussi d’offrir des capacités de réflexion : les utilisateurs peuvent écrire du code pour inspecter et transformer les configuration depuis Scheme.
Cependant, vous pourriez avoir un fichier dovecot.conf
déjà tout
prêt. Dans ce cas, vous pouvez passer un objet
opaque-dovecot-configuration
comme paramètre #:config
à
dovecot-service
. Comme son nom l’indique, une configuration opaque
n’a pas les capacités de réflexions.
Les champs de opaque-dovecot-configuration
disponibles sont :
opaque-dovecot-configuration
:package dovecot ¶Le paquet dovecot.
opaque-dovecot-configuration
:string string ¶Le contenu de dovecot.conf
, en tant que chaîne de caractères.
Par exemple, si votre dovecot.conf
est simplement la chaîne vide,
vous pouvez instancier un service dovecot comme cela :
(dovecot-service #:config
(opaque-dovecot-configuration
(string "")))
C’est le type de service de OpenSMTPD,
dont la valeur devrait être un objet opensmtpd-configuration
comme
dans cet exemple :
(service opensmtpd-service-type
(opensmtpd-configuration
(config-file (local-file "./my-smtpd.conf"))))
Type de données représentant la configuration de opensmtpd.
package
(par défaut : opensmtpd)Objet de paquet du serveur SMTP OpenSMTPD.
rshepherd-equirement
(par défaut : '()
)Vous pouvez utiliser cette option pour fournir une liste de symboles nommant
des services Shepherd dont ce service dépend, comme 'networking
si
vous voulez configurer OpenSMTPD pour écouter sur les interfaces autres que
celles de rebouclage.
config-file
(par défaut : %default-opensmtpd-config-file
)Objet simili-fichier du fichier de configuration de OpenSMTPD à utiliser.
Par défaut il écoute sur l’interface de boucle locale et accepte les
courriels des utilisateurs et des démons de la machine locale, et autorise
l’envoi de courriels à des serveurs distants. Lancez man
smtpd.conf
pour plus d’information.
setgid-commands?
(par défaut : #t
)Rend les commandes suivantes setgid à smtpq
pour qu’elles puissent
être exécutées : smtpctl
, sendmail
, send-mail
,
makemap
, mailq
et
newalsiases
. Voir Privileged Programs, pour plus d’informations
sur les programmes setgid.
C’est le type de l’agent de transfert de courriel (MTA)
Exim, dont la valeur devrait être un objet
exim-configuration
comme dans cet exemple :
(service exim-service-type
(exim-configuration
(config-file (local-file "./my-exim.conf"))))
Pour utilise le service exim-service-type
vous devez aussi avoir un
service mail-aliases-service-type
dans votre operating-system
(même sans alias).
Type de données représentant la configuration d’exim.
package
(par défaut : exim)Objet de paquet du serveur Exim.
config-file
(par défaut : #f
)Objet simili-fichier du fichier de configuration d’Exim à utiliser. Si sa
valeur est #f
alors le service utilisera la configuration par défaut
du paquet fournit dans package
. Le fichier de configuration qui en
résulte est chargé après avoir mis en place les variables de configuration
exim_user
et exim_group
.
C’est le type du service de récupération de courriels
Getmail, dont la valeur devrait
être un objet getmail-configuration
.
Les champs de getmail-configuration
disponibles sont :
getmail-configuration
:symbol name ¶Un symbole pour identifier le service getmail.
La valeur par défaut est ‘"unset"’.
getmail-configuration
:package package ¶Le paquet getmail à utiliser.
getmail-configuration
:string user ¶L’utilisateur qui lance getmail.
La valeur par défaut est ‘"getmail"’.
getmail-configuration
:string group ¶Le groupe qui lance getmail.
La valeur par défaut est ‘"getmail"’.
getmail-configuration
:string directory ¶Le répertoire getmail à utiliser.
La valeur par défaut est ‘"/var/lib/getmail/default"’.
getmail-configuration
:getmail-configuration-file rcfile ¶Le fichier de configuration de getmail à utiliser.
Les champs de getmail-configuration-file
disponibles sont :
getmail-configuration-file
:getmail-retriever-configuration retriever ¶Le compte de courriel duquel récupérer les courriel, et comme accéder à ce compte.
Les champs de getmail-retriever-configuration
disponibles sont :
getmail-retriever-configuration
:string type ¶Le type de récupérateur de courriel à utiliser. Des valeurs valides sont ‘passwd’ et ‘static’.
La valeur par défaut est ‘"SimpleIMAPSSLRetriever"’.
getmail-retriever-configuration
:string server ¶Utilisateur avec lequel se connecter au serveur de courriel.
La valeur par défaut est ‘unset’.
getmail-retriever-configuration
:string username ¶Utilisateur avec lequel se connecter au serveur de courriel.
La valeur par défaut est ‘unset’.
getmail-retriever-configuration
:entier-non-négatif port ¶Numéro de port sur lequel se connecter.
La valeur par défaut est ‘#f’.
getmail-retriever-configuration
:string password ¶Remplace des champs de passwd.
La valeur par défaut est ‘""’.
getmail-retriever-configuration
:list password-command ¶Remplace des champs de passwd.
La valeur par défaut est ‘'()’.
getmail-retriever-configuration
:string keyfile ¶Fichier de clés au format PEM pour la négociation TLS.
La valeur par défaut est ‘""’.
getmail-retriever-configuration
:string certfile ¶Fichier de certificat au format PEM à utiliser pour la négociation TLS.
La valeur par défaut est ‘""’.
getmail-retriever-configuration
:string ca-certs ¶Certificats d’autorité à utiliser.
La valeur par défaut est ‘""’.
getmail-retriever-configuration
:parameter-alist extra-parameters ¶Paramètres supplémentaires pour le récupérateur.
La valeur par défaut est ‘'()’.
getmail-configuration-file
:getmail-destination-configuration destination ¶Que faire avec les message récupérés.
Les champs de getmail-destination-configuration
disponibles sont :
getmail-destination-configuration
:string type ¶Le type de destination des courriels. Des valeurs valides sont ‘Mailldir’, ‘Mboxrd’ et ‘MDA external’.
La valeur par défaut est ‘unset’.
getmail-destination-configuration
:string-or-filelike path ¶L’option de chemin pour la destination du courriel. Le comportement dépend du type choisi.
La valeur par défaut est ‘""’.
getmail-destination-configuration
:parameter-alist extra-parameters ¶Paramètres supplémentaires pour la destination
La valeur par défaut est ‘'()’.
getmail-destination-configuration
:getmail-options-configuration options ¶Configurer getmail.
Les champs de getmail-options-configuration
disponibles sont :
getmail-options-configuration
:non-negative-integer verbose ¶Si la valeur est ‘0’, getmail n’affichera que les avertissements et les erreurs. Une valeur de ‘1’ signifie que des messages à propos de la récupération et de la suppression de messages seront affichés. Si la valeur est ‘2’, getmail affichera des messages pour chacune de ses actions.
La valeur par défaut est ‘1’.
getmail-options-configuration
:boolean read-all ¶Si la valeur est vraie, getmail récupérera tous les messages disponibles. Sinon, il récupérera les message qu’il n’a pas déjà vu.
La valeur par défaut est ‘#t’.
getmail-options-configuration
:boolean delete ¶Si la valeur est vraie, les messages seront supprimées du serveur après les avoir récupérés et les avoir livrés correctement. Sinon, les messages seront laissés sur le serveur.
La valeur par défaut est ‘#f’.
getmail-options-configuration
:entier-non-négatif delete-after ¶Getmail supprimera les messages après un certain nombre de jours après les avoir vu, s’ils ont été livrés. Cela signifie que les messages resteront sur le serveur quelques jours après qu’ils ont été livrés. Une valeur de ‘0’ désactive cette fonctionnalité.
La valeur par défaut est ‘0’.
getmail-options-configuration
:entier-non-négatif delete-bigger-than ¶Supprime les messages plus grands que cette quantité d’octets après les avoir récupérés, même si les options delete et delete-after sont désactivées. La valeur ‘0’ permet de désactiver cette fonctionnalité.
La valeur par défaut est ‘0’.
getmail-options-configuration
:entier-non-négatif max-bytes-per-session ¶Récupère les message jusqu’à ce nombre d’octets avant de fermer la session avec le serveur. La valeur ‘0’ désactive cette fonctionnalité.
La valeur par défaut est ‘0’.
getmail-options-configuration
:entier-non-négatif max-message-size ¶Ne récupère pas les messages plus grands que cette valeur en octets. La valeur ‘0’ désactive cette fonctionnalité.
La valeur par défaut est ‘0’.
getmail-options-configuration
:boolean delivered-to ¶Si la valeur est vraie, getmail ajoutera un en-tête Delivered-To aux messages.
La valeur par défaut est ‘#t’.
getmail-options-configuration
:boolean received ¶Si la valeur est indiquée, getmail ajoute un en-tête Received aux messages.
La valeur par défaut est ‘#t’.
getmail-options-configuration
:string message-log ¶Getmail enregistrera un journal de ses actions dans le fichier ainsi nommé. La valeur ‘""’ désactive la fonctionnalité.
La valeur par défaut est ‘""’.
getmail-options-configuration
:boolean message-log-syslog ¶Si la valeur est vraie, getmail enregistrera un journal de ses actions en utilisant le démon de journalisation du système.
La valeur par défaut est ‘#f’.
getmail-options-configuration
:boolean message-log-verbose ¶Si la valeur est vraie, getmail enregistrera un journal de ses action à propos des messages non-récupérés et la raison pour laquelle ils n’ont pas été récupérés, en plus de lignes d’informations sur le début et la fin des opérations.
La valeur par défaut est ‘#f’.
getmail-options-configuration
:parameter-alist extra-parameters ¶Options supplémentaires à inclure.
La valeur par défaut est ‘'()’.
getmail-options-configuration
:list idle ¶Une liste de boites de courriels pour lesquels getmail devrait attendre une notification de nouveaux messages sur le serveur. Cela demande que le serveur prenne en charge l’extension IDLE.
La valeur par défaut est ‘'()’.
getmail-configuration
:list environment-variables ¶Une liste de variables d’environnement à définir pour getmail.
La valeur par défaut est ‘'()’.
C’est le type de service qui fournit /etc/aliases
et qui spécifie
comment délivrer les courriels aux utilisateurs du système.
(service mail-aliases-service-type
'(("postmaster" "bob")
("bob" "bob@example.com" "bob@example2.com")))
La configuration pour un service mail-aliases-service-type
est une
liste associative qui dénote comment délivrer les courriels qui arrivent au
système. Chaque entrée est de la forme (alias adresses ...)
avec
alias
qui spécifie l’alias local et adresses
qui spécifie où
délivrer les courriels de cet utilisateur.
Les alias n’ont pas besoin de correspondre à des utilisateurs locaux du
système. Dans l’exemple au-dessus, il n’y a pas besoin d’une entrée
postmaster
dans la liste user-accounts
du
operating-system
pour délivrer les courriels à destination de
postmaster
à bob
(qui ensuite délivrerait le courriel à
bob@example.com
et bob@example2.com
).
C’est le type du démon IMAP4 GNU Mailutils, dont la valeur devrait être un
objet imap4d-configuration
comme dans cet exemple :
(service imap4d-service-type
(imap4d-configuration
(config-file (local-file "imap4d.conf"))))
Type de données représentant la configuration de imap4d
.
package
(par défaut : mailutils
)Le paquet qui fournit imap4d
.
config-file
(par défaut : %default-imap4d-config-file
)Objet simili-fichier du fichier de configuration à utiliser. Par défaut, la
configuration fera écouter sur le port TCP 143 sur localhost
.
Voir Conf-imap4d dans GNU Mailutils Manual, pour les détails.
This is the type of the Radicale CalDAV/CardDAV
server whose value should be a radicale-configuration
. The default
configuration matches the upstream documentation.
Data type representing the configuration of radicale
. Available
radicale-configuration
fields are:
package
(default: radicale
) (type: package)Package that provides radicale
.
auth
(default: '()
) (type: radicale-auth-configuration)Configuration for auth-related variables.
Data type representing the auth
section of a radicale
configuration file. Available radicale-auth-configuration
fields
are:
type
(default: 'none
) (type: symbol)The method to verify usernames and passwords. Options are none
,
htpasswd
, remote-user
, and http-x-remote-user
. This
value is tied to htpasswd-filename
and htpasswd-encryption
.
htpasswd-filename
(default: "/etc/radicale/users"
) (type: file-name)Path to the htpasswd file. Use htpasswd or similar to generate this file.
htpasswd-encryption
(default: 'md5
) (type: symbol)Encryption method used in the htpasswd file. Options are plain
,
bcrypt
, and md5
.
delay
(default: 1
) (type: non-negative-integer)Average delay after failed login attempts in seconds.
realm
(default: "Radicale - Password Required"
) (type: string)Message displayed in the client when a password is needed.
encoding
(default: '()
) (type: radicale-encoding-configuration)Configuration for encoding-related variables.
Data type representing the encoding
section of a radicale
configuration file. Available radicale-encoding-configuration
fields
are:
request
(default: 'utf-8
) (type: symbol)Encoding for responding requests.
stock
(default: 'utf-8
) (type: symbol)Encoding for storing local collections.
headers-file
(default: none) (type: file-like)Custom HTTP headers.
logging
(default: '()
) (type: radicale-logging-configuration)Configuration for logging-related variables.
Data type representing the logging
section of a radicale
configuration file. Available radicale-logging-configuration
fields
are:
level
(default: 'warning
) (type: symbol)Set the logging level. One of debug
, info
, warning
,
error
, or critical
.
mask-passwords?
(default: #t
) (type: boolean)Whether to include passwords in logs.
rights
(default: '()
) (type: radicale-rights-configuration)Configuration for rights-related variables. This should be a
radicale-rights-configuration
.
Data type representing the rights
section of a radicale
configuration file. Available radicale-rights-configuration
fields
are:
type
(default: 'owner-only
) (type: symbol)Backend used to check collection access rights. The recommended backend is
owner-only
. If access to calendars and address books outside the
home directory of users is granted, clients won’t detect these collections
and will not show them to the user. Choosing any other method is only
useful if you access calendars and address books directly via URL. Options
are authenticate
, owner-only
, owner-write
, and
from-file
.
file
(default: ""
) (type: file-name)File for the rights backend from-file
.
server
(default: '()
) (type: radicale-server-configuration)Configuration for server-related variables. Ignored if WSGI is used.
Data type representing the server
section of a radicale
configuration file. Available radicale-server-configuration
fields
are:
hosts
(default: (list "localhost:5232")
) (type: list-of-ip-addresses)List of IP addresses that the server will bind to.
max-connections
(default: 8
) (type: non-negative-integer)Maximum number of parallel connections. Set to 0 to disable the limit.
max-content-length
(default: 100000000
) (type: non-negative-integer)Maximum size of the request body in bytes.
timeout
(default: 30
) (type: non-negative-integer)Socket timeout in seconds.
ssl?
(default: #f
) (type: boolean)Whether to enable transport layer encryption.
certificate
(default: "/etc/ssl/radicale.cert.pem"
) (type: file-name)Path of the SSL certificate.
key
(default: "/etc/ssl/radicale.key.pem"
) (type: file-name)Path to the private key for SSL. Only effective if ssl?
is
#t
.
certificate-authority
(default: ""
) (type: file-name)Path to CA certificate for validating client certificates. This can be used to secure TCP traffic between Radicale and a reverse proxy. If you want to authenticate users with client-side certificates, you also have to write an authentication plugin that extracts the username from the certificate.
storage
(default: '()
) (type: radicale-storage-configuration)Configuration for storage-related variables.
Data type representing the storage
section of a radicale
configuration file. Available radicale-storage-configuration
fields
are:
type
(default: 'multifilesystem
) (type: symbol)Backend used to store data. Options are multifilesystem
and
multifilesystem-nolock
.
filesystem-folder
(default: "/var/lib/radicale/collections"
) (type: file-name)Folder for storing local collections. Created if not present.
max-sync-token-age
(default: 2592000
) (type: non-negative-integer)Delete sync-tokens that are older than the specified time in seconds.
hook
(default: ""
) (type: string)Command run after changes to storage.
web-interface?
(default: #t
) (type: boolean)Whether to use Radicale’s built-in web interface.
This is the type of the Rspamd filtering system
whose value should be a rspamd-configuration
.
Available rspamd-configuration
fields are:
package
(default: rspamd
) (type: file-like)The package that provides rspamd.
config-file
(default: %default-rspamd-config-file
) (type: file-like)File-like object of the configuration file to use. By default all workers are enabled except fuzzy and they are binded to their usual ports, e.g localhost:11334, localhost:11333 and so on
local.d-files
(default: ()
) (type: directory-tree)Configuration files in local.d, provided as a list of two element lists where the first element is the filename and the second one is a file-like object. Settings in these files will be merged with the defaults.
override.d-files
(default: ()
) (type: directory-tree)Configuration files in override.d, provided as a list of two element lists where the first element is the filename and the second one is a file-like object. Settings in these files will override the defaults.
user
(default: %default-rspamd-account
) (type: user-account)The user to run rspamd as.
group
(default: %default-rspamd-group
) (type: user-group)The group to run rspamd as.
debug?
(par défaut : #f
) (type : booléen)Force debug output.
insecure?
(default: #f
) (type: boolean)Ignore running workers as privileged users.
skip-template?
(default: #f
) (type: boolean)Do not apply Jinja templates.
shepherd-requirements
(default: (loopback)
) (type: list-of-symbols)This is a list of symbols naming Shepherd services that this service will depend on.
Suivant: Services de téléphonie, Précédent: Services de courriels, Monter: Services [Table des matières][Index]
Le module (gnu services messaging)
fournit des définitions de
services Guix pour les services de messageries instantanées. Actuellement
il fournit les services suivants :
C’est le type pour le le serveur de communication
XMPP Prosody. Sa valeur doit être un enregistrement
prosody-configuration
comme dans cet exemple :
(service prosody-service-type
(prosody-configuration
(modules-enabled (cons* "groups" "mam" %default-modules-enabled))
(int-components
(list
(int-component-configuration
(hostname "conference.example.net")
(plugin "muc")
(mod-muc (mod-muc-configuration)))))
(virtualhosts
(list
(virtualhost-configuration
(domain "example.net"))))))
Voir plus bas pour des détails sur prosody-configuration
.
Par défaut, Prosody n’a pas besoin de beaucoup de configuration. Seul un
champ virtualhosts
est requis : il spécifie le domaine que vous
voulez voir Prosody servir.
Vous pouvez effectuer plusieurs vérifications de la configuration générée
avec la commande prosodyctl check
.
Prosodyctl vous aidera aussi à importer des certificats du répertoire
letsencrypt
pour que l’utilisateur prosody
puisse y accéder.
Voir https://prosody.im/doc/letsencrypt.
prosodyctl --root cert import /etc/certs
Les paramètres de configuration disponibles sont les suivants. Chaque
définition des paramètres est précédé par son type ; par exemple,
‘liste-de-chaines toto’ indique que le paramètre toto
devrait
être spécifié comme une liste de chaînes de caractères. Les types précédés
de peut-être-
signifient que le paramètre n’apparaîtra pas dans
prosody.cfg.lua
lorsque sa valeur est non spécifiée.
Il y a aussi une manière de spécifier la configuration en tant que chaîne de
caractères si vous avez un vieux fichier prosody.cfg.lua
que vous
voulez porter depuis un autre système ; voir la fin pour plus de détails.
Le type file-object
désigne soit un objet simili-fichier
(voir file-like objects), soit un nom de fichier.
Les champs de prosody-configuration
disponibles sont :
prosody-configuration
:package prosody ¶Le paquet Prosody.
prosody-configuration
:file-name data-path ¶Emplacement du répertoire de stockage des données de Prosody. Voir https://prosody.im/doc/configure. La valeur par défaut est ‘"/var/lib/prosody"’.
prosody-configuration
:file-object-list plugin-paths ¶Répertoires de greffons supplémentaires. Ils sont analysés dans l’ordre spécifié. Voir https://prosody.im/doc/plugins_directory. La valeur par défaut est ‘'()’.
prosody-configuration
:file-name certificates ¶Chaque hôte virtuel et composant a besoin d’un certificat pour que les clients et les serveurs puissent vérifier son identité. Prosody chargera automatiquement les clefs et les certificats dans le répertoire spécifié ici. La valeur par défaut est ‘"/etc/prosody/certs"’.
prosody-configuration
:string-list admins ¶C’est une liste des comptes administrateurs de ce serveur. Remarquez que
vous devez créer les comptes séparément. Voir
https://prosody.im/doc/admins et
https://prosody.im/doc/creating_accounts. Par exemple : (admins
'("user1@example.com" "user2@example.net"))
. La valeur par défaut est
‘'()’.
prosody-configuration
:boolean use-libevent? ¶Active l’utilisation de libevent pour de meilleures performances sous une forte charge. Voir https://prosody.im/doc/libevent. La valeur par défaut est ‘#f’.
prosody-configuration
:module-list modules-enabled ¶C’est la liste des modules que Prosody chargera au démarrage. Il cherchera
mod_modulename.lua
dans le répertoire des greffons, donc assurez-vous
qu’il existe aussi. La documentation des modules se trouve sur
https://prosody.im/doc/modules. La valeur par défaut est
‘'("roster" "saslauth" "tls" "dialback" "disco" "carbons" "private"
"blocklist" "vcard" "version" "uptime" "time" "ping" "pep" "register"
"admin_adhoc")’.
prosody-configuration
:string-list modules-disabled ¶‘"offline"’,‘"c2s"’ et ‘"s2s"’ sont chargés automatiquement, mais si vous voulez les désactiver, ajoutez-les à cette liste. La valeur par défaut est ‘'()’.
prosody-configuration
:file-object groups-file ¶Chemin vers un fichier texte où les groupes partagés sont définis. Si ce chemin est vide alors ‘mod_groups’ ne fait rien. Voir https://prosody.im/doc/modules/mod_groups. La valeur par défaut est ‘"/var/lib/prosody/sharedgroups.txt"’.
prosody-configuration
:boolean allow-registration? ¶Désactive la création de compte par défaut, pour la sécurité. Voir https://prosody.im/doc/creating_accounts. La valeur par défaut est ‘#f’.
prosody-configuration
:peut-être-ssl-configuration ssl ¶Ce sont les paramètres liés à SSL/TLS. La plupart sont désactivés pour pouvoir utiliser les paramètres par défaut de Prosody. Si vous ne comprenez pas complètement ces options, ne les ajoutez pas à votre configuration, il est aisé de diminuer la sécurité de votre serveur en les modifiant. Voir https://prosody.im/doc/advanced_ssl_config.
Les champs de ssl-configuration
disponibles sont :
ssl-configuration
:peut-être-chaine protocol ¶Cela détermine la poignée de main à utiliser.
ssl-configuration
:peut-être-nom-de-fichier key ¶Chemin vers votre fichier de clef privée.
ssl-configuration
:peut-être-nom-de-fichier certificate ¶Chemin vers votre fichier de certificat.
ssl-configuration
:file-object capath ¶Chemin vers le répertoire contenant les certificats racines que vous voulez voir Prosody utiliser lors de la vérification des certificats des serveurs distants. La valeur par défaut est ‘"/etc/ssl/certs"’.
ssl-configuration
:peut-être-fichier-objet cafile ¶Chemin vers un fichier contenant les certificats racines auxquels Prosody
devra faire confiance. Comme capath
mais avec les certificats
concaténés ensemble.
ssl-configuration
:peut-être-liste-de-chaine verify ¶Une liste d’options de vérification (qui correspondent globalement aux
drapeaux set_verify()
d’OpenSSL).
ssl-configuration
:peut-être-liste-de-chaine options ¶Une liste d’options générales liées à SSL/TLS. Elles correspondent
globalement à set_options()
d’OpenSSL. Pour une liste complète des
options disponibles dans LuaSec, voir les sources de LuaSec.
ssl-configuration
:peut-être-entier-non-négatif depth ¶Longueur maximale d’une chaîne d’autorités de certifications avant la racine.
ssl-configuration
:peut-être-chaine ciphers ¶Une chaîne de méthodes de chiffrement OpenSSL. Cela choisi les méthodes de chiffrement que Prosody offrira aux clients, et dans quel ordre de préférence.
ssl-configuration
:peut-être-nom-de-fichier dhparam ¶Un chemin vers un fichier contenant les paramètres pour l’échange de clef
Diffie-Hellman. Vous pouvez créer un tel fichier avec : openssl
dhparam -out /etc/prosody/certs/dh-2048.pem 2048
ssl-configuration
:peut-être-chaine curve ¶Courbe pour Diffie-Hellman sur courbe elliptique. La valeur par défaut de Prosody est ‘"secp384r1"’.
ssl-configuration
:peut-être-liste-de-chaine verifyext ¶Une liste d’options de vérification « supplémentaires ».
ssl-configuration
:peut-être-chaine password ¶Mot de passe pour les clefs privées chiffrées.
prosody-configuration
:boolean c2s-require-encryption? ¶S’il faut forcer toutes les connexions client-serveur à être chiffrées ou non. Voir https://prosody.im/doc/modules/mod_tls. La valeur par défaut est ‘#f’.
prosody-configuration
:string-list disable-sasl-mechanisms ¶Ensemble de mécanismes qui ne seront jamais offerts. Voir https://prosody.im/doc/modules/mod_saslauth. La valeur par défaut est ‘'("DIGEST-MD5")’.
prosody-configuration
parameter :string-list insecure-sasl-mechanisms ¶Set of mechanisms that will not be offered on unencrypted connections. See https://prosody.im/doc/modules/mod_saslauth. Defaults to ‘'("PLAIN" "LOGIN")’.
prosody-configuration
:boolean s2s-require-encryption? ¶S’il faut forcer toutes les connexion serveur-serveur à être chiffrées ou non. Voir https://prosody.im/doc/modules/mod_tls. La valeur par défaut est ‘#f’.
prosody-configuration
:boolean s2s-secure-auth? ¶S’il faut requérir le chiffrement et l’authentification du certificat. Cela fournit une sécurité idéale, mais demande que les serveurs avec lesquels vous communiquez supportent le chiffrement ET présentent un certificat valide et de confiance. Voir https://prosody.im/doc/s2s#security. La valeur par défaut est ‘#f’.
prosody-configuration
:string-list s2s-insecure-domains ¶Beaucoup de serveurs ne supportent pas le chiffrement ou ont un certificat invalide ou auto-signé. Vous pouvez lister les domaines ici qui n’ont pas besoin de s’authentifier avec des certificats. Ils seront authentifiés par DNS. Voir https://prosody.im/doc/s2s#security. La valeur par défaut est ‘'()’.
prosody-configuration
:string-list s2s-secure-domains ¶Même si vous laissez s2s-secure-auth?
désactivé, vous pouvez toujours
demander un certificat valide pour certains domaine en spécifiant la liste
ici. Voir https://prosody.im/doc/s2s#security. La valeur par défaut
est ‘'()’.
prosody-configuration
:string authentication ¶Choisi le moteur d’authentification à utiliser. Le moteur par défaut stocke les mots de passes en texte clair et utilise la configuration de stockage des données de Prosody pour stocker les données authentifiées. Si vous n’avez pas confiance dans le serveur, lisez https://prosody.im/doc/modules/mod_auth_internal_hashed pour plus d’information sur l’utilisation du moteur hashed. Voir aussi https://prosody.im/doc/authentication. La valeur par défaut est ‘"internal_plain"’.
prosody-configuration
:peut-être-chaine log ¶Indique les options de journalisation. La configuration avancée des journaux n’est pas encore supportée par le service Prosody. Voir https://prosody.im/doc/logging. La valeur par défaut est ‘"*syslog"’.
prosody-configuration
:file-name pidfile ¶Fichier où écrire le PID. Voir https://prosody.im/doc/modules/mod_posix. La valeur par défaut est ‘"/var/run/prosody/prosody.pid"’.
prosody-configuration
:peut-être-entier-non-négatif http-max-content-size ¶Taille maximum autorisée pour le corps HTTP (en octets).
prosody-configuration
:peut-être-chaine http-external-url ¶Certains modules exposent leur propre URL de diverses manières. Cette URL
est construite à partir du protocole, de l’hôte et du port utilisé. Si
Prosody se trouve derrière un proxy, l’URL publique sera
http-external-url
à la place. Voir
https://prosody.im/doc/http#external_url.
prosody-configuration
:virtualhost-configuration-list virtualhosts ¶Un hôte dans Prosody est un domaine sur lequel les comptes utilisateurs sont créés. Par exemple si vous voulez que vos utilisateurs aient une adresse comme ‘"john.smith@example.com"’ vous devrez ajouter un hôte ‘"example.com"’. Toutes les options de cette liste seront appliquées uniquement à cet hôte.
Remarque : Le nom d’hôte virtuel est utilisé dans la configuration pour éviter de le confondre avec le nom d’hôte physique réel de la machine qui héberge Prosody. Une seule instance de Prosody peut servir plusieurs domaines, chacun défini comme une entrée VirtualHost dans la configuration de Prosody. Ainsi, un serveur qui n’héberge qu’un seul domaine n’aura qu’une entrée VirtualHost.
Voir https://prosody.im/doc/configure#virtual_host_settings.
Les champs de virtualhost-configuration
disponibles sont :
all these prosody-configuration
fields: admins
,
use-libevent?
, modules-enabled
, modules-disabled
,
groups-file
, allow-registration?
, ssl
,
c2s-require-encryption?
, disable-sasl-mechanisms
,
insecure-sasl-mechanisms
, s2s-require-encryption?
,
s2s-secure-auth?
, s2s-insecure-domains
,
s2s-secure-domains
, authentication
, log
,
http-max-content-size
, http-external-url
, raw-content
,
plus:
virtualhost-configuration
:string domain ¶Domaine que vous souhaitez que Prosody serve.
prosody-configuration
:int-component-configuration-list int-components ¶Les composant sont des services supplémentaires qui sont disponibles pour les clients, habituellement sur un sous-domaine du serveur principal (comme ‘"mycomponent.example.com"’). Des exemples de composants sont des serveurs de chatroom, des répertoires utilisateurs ou des passerelles vers d’autres protocoles.
Les composants internes sont implémentés dans des greffons spécifiques à Prosody. Pour ajouter un composant interne, vous n’avez qu’à remplir le champ de nom d’hôte et le greffon que vous voulez utiliser pour le composant.
Voir https://prosody.im/doc/components. La valeur par défaut est ‘'()’.
Les champs de int-component-configuration
disponibles sont :
all these prosody-configuration
fields: admins
,
use-libevent?
, modules-enabled
, modules-disabled
,
groups-file
, allow-registration?
, ssl
,
c2s-require-encryption?
, disable-sasl-mechanisms
,
insecure-sasl-mechanisms
, s2s-require-encryption?
,
s2s-secure-auth?
, s2s-insecure-domains
,
s2s-secure-domains
, authentication
, log
,
http-max-content-size
, http-external-url
, raw-content
,
plus:
int-component-configuration
:string hostname ¶Nom d’hôte du composant.
int-component-configuration
:string plugin ¶Greffon que vous voulez utiliser pour ce composant.
int-component-configuration
:peut-être-mod-muc-configuration mod-muc ¶Le chat multi-utilisateur (MUC) est le modules de Prosody qui vous permet de créer des chatrooms/conférences pour les utilisateurs XMPP.
Des informations générales sur la configuration des salons de discussion multiutilisateurs se trouvent dans la documentation sur les salons (https://prosody.im/doc/chatrooms), que vous devriez lire si vous découvrez les salons XMPP.
Voir aussi https://prosody.im/doc/modules/mod_muc.
Les champs de mod-muc-configuration
disponibles sont :
mod-muc-configuration
:string name ¶Le nom à renvoyer dans les réponses de découverte de services. La valeur par défaut est ‘"Prosody Chatrooms"’.
mod-muc-configuration
:string-or-boolean restrict-room-creation ¶Si la valeur est ‘#t’, cela permettra uniquement aux admins de créer de nouveaux salons. Sinon n’importe qui peut créer un salon. La valeur ‘"local"’ restreint la création aux utilisateurs du domaine parent du service. P. ex. ‘user@example.com’ peut créer des salons sur ‘rooms.example.com’. La valeur ‘"admin"’ restreint ce service aux administrateurs. La valeur par défaut est ‘#f’.
mod-muc-configuration
:entier-non-négatif max-history-messages ¶Nombre maximum de messages d’historique qui seront envoyés aux membres qui viennent de rejoindre le salon. La valeur par défaut est ‘20’.
prosody-configuration
:ext-component-configuration-list ext-components ¶Les composants externes utilisent XEP-0114, que la plupart des composants supportent. Pour ajouter un composant externe, vous remplissez simplement le champ de nom d’hôte. Voir https://prosody.im/doc/components. La valeur par défaut est ‘'()’.
Les champs de ext-component-configuration
disponibles sont :
all these prosody-configuration
fields: admins
,
use-libevent?
, modules-enabled
, modules-disabled
,
groups-file
, allow-registration?
, ssl
,
c2s-require-encryption?
, disable-sasl-mechanisms
,
insecure-sasl-mechanisms
, s2s-require-encryption?
,
s2s-secure-auth?
, s2s-insecure-domains
,
s2s-secure-domains
, authentication
, log
,
http-max-content-size
, http-external-url
, raw-content
,
plus:
ext-component-configuration
:string component-secret ¶Mot de passe que le composant utilisera pour s’authentifier.
ext-component-configuration
:string hostname ¶Nom d’hôte du composant.
prosody-configuration
:liste-d'entiers-non-négatifs component-ports ¶Ports sur lesquels Prosody écoutera les connexions des composants. La valeur par défaut est ‘'(5347)’.
prosody-configuration
:string component-interface ¶Interface sur laquelle Prosody écoutera les connexions des composants. La valeur par défaut est ‘"127.0.0.1"’.
prosody-configuration
:peut-être-contenu-brut raw-content ¶Contenu brut qui sera ajouté au fichier de configuration.
Il se peut que vous ayez juste envie de lancer un fichier
prosody.cfg.lua
directement. Dans ce cas, vous pouvez passer un
enregistrement opaque-prosody-configuration
comme valeur à
prosody-service-type
. Comme son nom l’indique, une configuration
opaque n’a pas de capacités de réflexion simples. Les champs disponibles de
opaque-prosody-configuration
sont :
opaque-prosody-configuration
:package prosody ¶Le paquet prosody.
opaque-prosody-configuration
:string prosody.cfg.lua ¶Le contenu de prosody.cfg.lua
à utiliser.
Par exemple, si votre prosody.cfg.lua
est juste la chaîne vide, vous
pouvez instancier un service prosody comme ceci :
(service prosody-service-type
(opaque-prosody-configuration
(prosody.cfg.lua "")))
BitlBee est une passerelle qui fournit une interface IRC vers une variété de protocoles de messagerie instantanée comme XMPP.
C’est le type de service pour le démon de passerelle IRC
BitlBee. Sa valeur est un
bitlbee-configuration
(voir plus bas).
Pour que BitlBee écoute sur le port 6667 sur localhost, ajoutez cette ligne à vos services :
C’est la configuration de BitlBee, avec les champs suivants :
interface
(par défaut : "127.0.0.1"
)port
(par défaut : 6667
)Écoute sur l’interface réseau correspondant à l’adresse IP dans interface, sur port.
Lorsque interface vaut 127.0.0.1
, seuls les clients locaux
peuvent se connecter ; lorsqu’elle vaut 0.0.0.0
, les connexions
peuvent venir de n’importe quelle interface réseau.
bitlbee
(par défaut : bitlbee
)Le paquet BitlBee à utiliser.
plugins
(par défaut : '()
)Liste des paquets de greffons à utiliser — p. ex.
bitlbee-discord
.
extra-settings
(par défaut : ""
)Partie de configuration ajoutée telle-quelle au fichier de configuration de BitlBee.
Quassel est un client IRC distribué, ce qui signifie qu’un client ou plus peuvent s’attacher et se détacher du cœur central.
C’est le type de service pour le démon IRC
Quassel. Sa valeur est un
quassel-configuration
(voir plus bas).
C’est la configuration de Quassel, avec les champs suivants :
quassel
(par défaut : quassel
)Le paquet Quassel à utiliser.
interface
(par défaut : "::,0.0.0.0"
)port
(par défaut : 4242
)Écoute sur les interfaces réseau correspondant à l’adresse IPv4 ou IPv6 des interfaces spécifiées dans interface, une liste de chaînes délimitées par des virgules, sur port.
loglevel
(par défaut : "info"
)Le niveau de journalisation souhaité. Les valeurs acceptées sont « Debug », « Info », « Warning » et « Error ».
Suivant: Services de partage de fichiers, Précédent: Services de messagerie, Monter: Services [Table des matières][Index]
Le module (gnu services telephony)
contient des définitions de
services Guix pour les services de téléphonie. Actuellement il fournit les
services suivants :
The service type for running Jami as a service. It takes a
jami-configuration
object as a value, documented below. This section
describes how to configure a Jami server that can be used to host video (or
audio) conferences, among other uses. The following example demonstrates
how to specify Jami account archives (backups) to be provisioned
automatically:
(service jami-service-type
(jami-configuration
(accounts
(list (jami-account
(archive "/etc/jami/unencrypted-account-1.gz"))
(jami-account
(archive "/etc/jami/unencrypted-account-2.gz"))))))
Lorsque le champ de comptes est spécifié, les fichiers de compte Jami du service trouvés dans /var/lib/jami seront recréés à chaque redémarrage du service.
Les comptes Jami et leurs sauvegardes correspondantes peuvent être générés
avec les clients jami
ou jami-gnome
. Les comptes ne devraient
pas être protégés par un mot de passe, mais il vaut mieux vous assurer que
leurs fichiers ne sont lisibles que par ‘root’.
L’exemple suivant montre comme déclarer que seuls certains contact devraient pouvoir communiquer avec un compte donné :
(service jami-service-type
(jami-configuration
(accounts
(list (jami-account
(archive "/etc/jami/unencrypted-account-1.gz")
(peer-discovery? #t)
(rendezvous-point? #t)
(allowed-contacts
'("1dbcb0f5f37324228235564b79f2b9737e9a008f"
"2dbcb0f5f37324228235564b79f2b9737e9a008f")))))))
dans ce mode, seuls les allowed-contacts
déclarés peuvent débuter une
communication avec le compte Jami. Vous pouvez utiliser cela par exemple
avec des comptes de point de rendez-vous pour créer un espace de
vidéo-conférence privé.
Pour que l’administrateur système ait le contrôle complet des conférences hébergées sur son système, le service Jami prend en charge les actions suivantes :
# herd doc jami list-actions (list-accounts list-account-details list-banned-contacts list-contacts list-moderators add-moderator ban-contact enable-account disable-account)
Les actions ci-dessus ont pour but de fournir les actions les plus utiles
pour la modération, pas de couvrir l’ensemble de l’API de Jami. Si vous
souhaitez interagir avec le démon Jami depuis Guile, vous pouvez
expérimenter le module (gnu build jami-service)
, qui propulse les
actions Shepherd ci-dessus.
Les action add-moderator
et ban-contact
acceptent
l’empreinte d’un contact (un hash long de 40 caractères) comme
premier argument et l’empreinte d’un compte ou un nom d’utilisateur comme
second argument :
# herd add-moderator jami 1dbcb0f5f37324228235564b79f2b9737e9a008f \ f3345f2775ddfe07a4b0d95daea111d15fbc1199 # herd list-moderators jami Moderators for account f3345f2775ddfe07a4b0d95daea111d15fbc1199: - 1dbcb0f5f37324228235564b79f2b9737e9a008f
dans le cas de ban-contact
, le second argument est facultatif ;
lorsqu’il est omis, le compte est banni de tous les comptes de Jami :
# herd ban-contact jami 1dbcb0f5f37324228235564b79f2b9737e9a008f # herd list-banned-contacts jami Banned contacts for account f3345f2775ddfe07a4b0d95daea111d15fbc1199: - 1dbcb0f5f37324228235564b79f2b9737e9a008f
Les contacts bannis n’ont plus non plus de privilèges administrateur.
L’action disable-account
permet de déconnecter entièrement un compte
du réseau, le rendant injoignable, tandis que enable-account
fait
l’inverse. Ils acceptent un seul nom de compte ou empreinte comme premier
argument :
# herd disable-account jami f3345f2775ddfe07a4b0d95daea111d15fbc1199 # herd list-accounts jami The following Jami accounts are available: - f3345f2775ddfe07a4b0d95daea111d15fbc1199 (dummy) [disabled]
L’action list-account-details
affiche les paramètres détaillés de
chaque compte au format Recutils, ce qui signifie que vous pouvez utiliser
la commande recsel
pour choisir les comptes qui vous intéressent
(voir Selection Expressions dans GNU recutils manual). Remarquez
que les caractères point (‘.’) qui se trouvent la les clés des
paramètres deviennent des underscores (‘_’) dans la sortie, pour
satisfaire les exigences du format Recutils. L’exemple suivant vous montre
comment afficher les empreintes des comptes qui opèrent en mode rendez-vous
:
# herd list-account-details jami | \ recsel -p Account.username -e 'Account.rendezVous ~ "true"' Account_username: f3345f2775ddfe07a4b0d95daea111d15fbc1199
Les autres actions devraient être évidentes.
L’ensemble des options de configuration disponibles est donné ci-dessous.
Les champs de jami-configuration
disponibles sont :
libjami
(par défaut : libjami
) (type : paquet)Le paquet du démon Jami à utiliser.
dbus
(par défaut : dbus-for-jami
) (type : paquet)Le paquet D-Bus à utiliser pour démarrer la session D-Bus requise.
nss-certs
(par défaut : nss-certs
) (type : paquet)Le paquet nss-certs à utiliser pour utiliser les certificats TLS fournis.
enable-logging?
(par défaut : #t
) (type : booléen)Indique s’il faut activer la journalisation vers syslog.
debug?
(par défaut : #f
) (type : booléen)Indique s’il faut activer les messages de débogage.
auto-answer?
(par défaut : #f
) (type : booléen)Indique s’il faut forcer la réponse automatique aux appels entrants.
accounts
(type : peut-être-liste-de-jami-account)Une liste de comptes Jami à (re-)provisionner à chaque fois que le service du démon Jami démarre. Lorsque le champ est spécifié, les répertoires des comptes dans /var/lib/jami/ sont recréés à chaque fois que le service démarre, pour assurer un état cohérent.
Les champs de jami-account
disponibles sont :
archive
(type : string-or-computed-file)Le nom de fichier de l’archive (sauvegarde) du compte. C’est utilisé pour provisionner le compte quand le service démarre. L’archive du compte ne devrait pas être chiffrée. Il est fortement recommandé de la rendre lisible uniquement à l’utilisateur ‘root’ (c.-à-d. pas dans le dépôt), pour vous prémunir contre la fuite de la clé secrète du compte Jami sauvegardé.
allowed-contacts
(type : peut-être-liste-de-account-fingerprint)La liste des contacts permis pour le compte, saisis avec leur empreinte longue de 40 caractères. Les messages et les appels des comptes qui ne sont pas dans la liste seront rejetés. Lorsque la valeur n’est pas spécifiée, la configuration de l’archive du compte est utilisée telle-quelle par rapport aux permissions d’appels et de messages entrants, ce qui se résume par défaut à accepter tous les contacts à communiquer avec le compte.
moderators
(type : peut-être-liste-de-account-fingerprint)La liste des contacts qui devraient avoir des privilèges de modération (pour bannir, rendre muet, etc les autres utilisateur·rices) dans les conférences en rendez-vous, saisis avec leur empreinte longue de 40 caractères. Lorsque la valeur n’est pas spécifiée, la configuration de l’archive du compte est utilisée telle-quelle pour la modération, ce qui se résume par défaut à permettre à n’importe qui de modérer.
rendezvous-point?
(type : peut-être-booléen)Indique si le compte devrait opérer en mode rendez-vous. Dans ce mode, tous les appels audio et vidéos entrants sont fusionnés en une conférence. Lorsque la valeur n’est pas spécifiée, la valeur de l’archive du compte est utilisée.
peer-discovery?
(type : peut-être-booléen)Indique si la découverte de pairs devrait être activée. La découverte de pairs est utilisée pour découvrir d’autres nœuds OpenDHT sur le réseau local, ce qui peut être utile pour maintenir une connexion entre appareils locaux sur le réseau même si la connexion internet est perdue. Lorsque la valeur n’est pas spécifiée, celle de l’archive du compte est utilisée.
bootstrap-hostnames
(type: maybe-list-of-strings)Une liste des noms d’hôte ou IP pointant vers des nœuds OpenDHT, qui devraient être utilisés pour rejoindre le réseau OpenDHT au départ. Lorsque la valeur n’est pas spécifiée, la valeur de l’archive du compte est utilisée.
name-server-uri
(type : peut-être-chaine)L’URI du serveur de nom à utiliser, qui peut être utilisé pour récupérer l’empreinte du compte pour un nom d’utilisateur enregistré.
Cette section décrit comment configurer et lancer un serveur Mumble (précédemment connu sous le nom de Murmur).
This is the service to run a Mumble server. It takes a
mumble-server-configuration
object as its value, defined below.
Le type de service pour le serveur Mumble. Voici un exemple de configuration :
(service mumble-server-service-type
(mumble-server-configuration
(welcome-text
"Bienvenue sur ce serveur Mumble qui tourne sur Guix !")
(cert-required ? #t) ;désactive les connections par mot de passe
(ssl-cert "/etc/certs/mumble.example.com/fullchain.pem")
(ssl-key "/etc/certs/mumble.example.com/privkey.pem")))
Après avoir reconfiguré votre système, vous pouvez manuellement indiquer le
mot de passe SuperUser
de mumble-server avec la commande qui
s’affiche pendant la phase d’activation.
Il est recommandé d’enregistrer un compte utilisateur Mumble normal et de
lui donner les droits admin ou modérateur. Vous pouvez utiliser le client
mumble
pour vous connecter en tant que nouvel utilisateur normal,
vous enregistrer et vous déconnecter. Pour l’étape suivante, connectez-vous
avec le nom SuperUser
en utilisant le mot de passe SuperUser
que vous avez indiqué précédemment et accordez les droits administrateur ou
modérateur à vous utilisateur mumble nouvellement enregistré et créez
quelques salons.
Les champs de mumble-server-configuration
disponibles sont :
package
(par défaut : mumble
)Paquet qui contient bin/mumble-server
.
user
(par défaut : "mumble-server"
)Utilisateur qui lancera le serveur Mumble.
group
(par défaut : "mumble-server"
)Groupe de l’utilisateur qui lancera le serveur Mumble.
port
(par défaut : 64738
)Port sur lequel le serveur écoutera.
welcome-text
(par défaut : ""
)Texte de bienvenue envoyé aux clients lors de leur connexion.
server-password
(par défaut : ""
)Mot de passe que les clients devront entrer pour se connecter.
max-users
(par défaut : 100
)Nombre maximum d’utilisateurs qui peuvent se connecter à ce serveur en même temps.
max-user-bandwidth
(par défaut : #f
)Trafic de voix maximum qu’un utilisateur peut envoyer par seconde.
database-file
(par défaut : "/var/lib/mumble-server/db.sqlite"
)Nom de fichier de la base de données sqlite. L’utilisateur du service deviendra propriétaire du répertoire.
log-file
(par défaut : "/var/log/mumble-server/mumble-server.log"
)Nom du fichier de journal. L’utilisateur du service deviendra propriétaire du répertoire.
autoban-attempts
(par défaut : 10
)Nombre maximum de connexions qu’un utilisateur peut faire pendant
autoban-timeframe
sans être banni automatiquement pour
autoban-time
.
autoban-timeframe
(par défaut : 120
)Durée du temps pendant lequel le nombre de connexions est compté.
autoban-time
(par défaut : 300
)Durée du bannissement automatique en secondes.
opus-threshold
(par défaut : 100
)Pourcentage des clients qui doivent supporter opus avant de passer sur le codec audio opus.
channel-nesting-limit
(par défaut : 10
)Profondeur maximum des canaux.
channelname-regex
(par défaut : #f
)Une chaîne de la forme d’une expression régulière Qt que les noms de canaux doivent respecter.
username-regex
(par défaut : #f
)Une chaîne de la forme d’une expression régulière Qt que les noms d’utilisateurs doivent respecter.
text-message-length
(par défaut : 5000
)Taille maximum en octets qu’un utilisateur peut envoyer en un seul message textuel.
image-message-length
(par défaut : (* 128 1024)
)Taille maximum en octets qu’un utilisateur peut envoyer en une seule image.
cert-required?
(par défaut : #f
)Si la valeur est #t
les clients utilisant une authentification par
mot de passe faible ne seront pas acceptés. Les utilisateurs doivent
compléter l’assistant de configuration des certificats pour rejoindre le
serveur.
remember-channel?
(paramètre de : #f
)Indique si mumble-server devrait se rappeler du dernier canal dans lequel étaient les utilisateurs au moment de leur déconnexion et les y remettre lorsqu’ils se reconnectent.
allow-html?
(par défaut : #f
)Indique si le html est autorisé dans les messages textuels, les commentaires utilisateurs et les descriptions des canaux.
allow-ping?
(par défaut : #f
)Mettre à vrai expose le nombre d’utilisateurs, le nombre d’utilisateurs maximum et la bande passante maximale du serveur par client aux utilisateurs non connectés. Dans le client Mumble, cette information est affichée dans la boîte de dialogue de connexion.
Désactiver ce paramètre empêchera le serveur d’être publiquement listé.
bonjour?
(par défaut : #f
)Indique si le serveur s’annonce sur le réseau local à travers le protocole bonjour.
send-version?
(par défaut : #f
)Indique si la version du serveur mumble-server doit être exposée dans les requêtes ping.
log-days
(par défaut : 31
)Mumlbe stocke aussi les journaux en base de données, qui sont accessible via RPC. La valeur par défaut est 31 jours, mais vous pouvez le mettre à 0 pour les garder pour toujours ou à -1 pour désactiver la journalisation dans la base de données.
obfuscate-ips?
(par défaut : #t
)Indique si les IP enregistrées doivent être cachées pour protéger la vie privée des utilisateurs.
ssl-cert
(par défaut : #f
)Nom de fichier du certificat SSL/TLS utilisé pour les connexions chiffrées.
(ssl-cert "/etc/certs/example.com/fullchain.pem")
ssl-key
(par défaut : #f
)Chemin de fichier vers la clef privée ssl pour les connexions chiffrées.
(ssl-key "/etc/certs/example.com/privkey.pem")
ssl-dh-params
(par défaut : #f
)Nom de fichier d’un fichier encodé en PEM avec les paramètres Diffie-Hellman
pour le chiffrement SSL/TLS. Autrement vous pouvez indiquer
"@ffdhe2048"
, "@ffdhe3072"
, "@ffdhe4096"
,
"@ffdhe6144"
ou "@ffdhe8192"
pour utiliser les paramètres
inclus de la RFC 7919.
ssl-ciphers
(par défaut : #f
)L’option ssl-ciphers
permet de choisir les suites de chiffrement
disponibles pour SSL/TLS.
Cette option est spécifiée en utilisant l’OpenSSL cipher list notation.
Nous vous recommandons d’essayer votre chaîne de suites de chiffrements avec « openssl ciphers <chaîne> » avant de l’indiquer ici, pour avoir une idée des suites de chiffrement que vous aurez. Après avoir indiqué cette option, nous vous recommandons d’inspecter les journaux du serveur Mumble pour vous assurer que Mumble utilise les suites de chiffrements auxquelles vous vous attendez.
Remarque : Modifier cette option peut impacter la rétrocompatibilité de votre serveur Mumble, et peut empêcher que des clients Mumble anciens se connectent.
public-registration
(par défaut : #f
)Doit être un enregistrement
<mumble-server-public-registration-configuration>
ou #f
.
Vous pouvez aussi enregistrer votre serveur dans la liste des serveurs
publiques que le client mumble
affiche au démarrage. Vous ne pouvez
pas enregistrer votre serveur si vous avez un server-password
ou
allow-ping
à #f
.
Cela peut prendre quelques heures avant d’arriver sur la liste publique.
file
(par défaut : #f
)Version alternative de cette configuration : si vous indiquez quelque chose, le reste est ignoré.
Configuration pour l’enregistrement public du service mumble-server.
name
C’est le nom d’affichage de votre serveur. Ne pas le confondre avec le nom d’hôte.
password
Un mot de passe pour identifier votre enregistrement. Les mises à jours suivantes devront utiliser le même mot de passe. Ne le perdez pas.
url
Cela devrait être le lien http://
ou https://
vers votre site
web.
hostname
(par défaut : #f
)Par défaut votre serveur sera listé par son adresse IP. Si cette option est indiquée votre serveur sera listé par son nom d’hôte.
Avertissement d’obsolescence : Pour des raisons historiques, toutes les procédures
mumble-server-
ci-dessus sont aussi exportées avec le préfixemurmur-
à la place. Il est recommandé de commencer à utilisermumble-server-
à partir de maintenant.
Suivant: Services de surveillance, Précédent: Services de téléphonie, Monter: Services [Table des matières][Index]
Le module (gnu services file-sharing)
fournit des services qui aident
au transfert de fichiers sur des réseaux de partage en pair-à-pair.
Transmission est un client BitTorrent
flexibe qui propose un éventail d’interfaces graphiques et en ligne de
commande. Un service transmission-daemon-service-type
fournit la
variante sans interface de Transmission, transmission-daemon
, en
tant que service du système, ce qui permet aux utilisateurs de partager des
fichiers via BitTorrent même lorsqu’ils ne sont pas connectés.
Le type de service pour le démon du client BitTorrent Transmission. Sa
valeur doit être un enregistrement trasnmission-daemon-configuration
comme dans cet exemple :
(service transmission-daemon-service-type (transmission-daemon-configuration ;; Restreint l'accès à l'interface RPC ("control") (rpc-authentication-required? #t) (rpc-username "transmission") (rpc-password (transmission-password-hash "transmission" ; mot de passe souhaité "uKd1uMs9")) ; valeur de sel arbitraire ;; Accepte les requêtes de cet hôte et d'autres sur le ;; réseau local (rpc-whitelist-enabled? #t) (rpc-whitelist '("::1" "127.0.0.1" "192.168.0.*")) ;; Limite la bande passant utilisée pendant les heures de bureau (alt-speed-down (* 1024 2)) ; 2 Mo/s (alt-speed-up 512) ; 512 ko/s (alt-speed-time-enabled? #t) (alt-speed-time-day 'weekdays) (alt-speed-time-begin (+ (* 60 8) 30)) ; 8:30 (alt-speed-time-end (+ (* 60 (+ 12 5)) 30)))) ; 17:30
Une fois le service démarré, vous pouvez interagir avec le démon à travers
son interface web (sur https://localhost:9091
ou en utilisant la
ligne de commande transmission-remote
, disponible dans le paquet
transmission
. (les utilisateurs d’Emacs peuvent aussi regarder le
paquet emacs-transmission
). Les deux communiquent avec le démon à
travers son interface d’appel de procédure distante (RPC), qui est
disponible par défaut pour tous les utilisateurs du système ; vous voudrez
peut-être changer cela en indiquant des valeurs dans les paramètres
rpc-authentication-required?
, rpc-username
et
rpc-password
, comme cela est montré et documenté plus bas.
La valeur de rpc-password
doit toujours être un hash de mot de passe
du type généré et utilisé par les clients Transmission. Il peut être copié
directement d’un fichier settings.json existant, si au autre client
Transmission est déjà utilisé. Sinon, les procédures
transmission-password-hash
et transmission-random-salt
fournies par ce module peuvent être utilisées pour obtenir un hash
convenable.
Renvoie une chaîne contenant le résultat du hash de password avec
salt, au format reconnu par les clients Transmission pour leur
paramètre rpc-password
.
salt doit être une chaîne de huit caractères. La procédure
transmission-random-salt
est utile pour générer une valeur correcte
au hasard.
Renvoie une chaîne contenant une valeur de sel à huit caractères aléatoires
du type généré et utilisé par les clients de Transmission, utilisable avec
la procédure transmission-password-hash
.
Ces procédures sont disponibles dans la REPL Guile démarrée avec
guix repl
(voir Invoquer guix repl
). C’est utile pour obtenir
une valeur de sel aléatoire à donner au second paramètres de
transmission-password-hash
comme dans cet exemple de session :
$ guix repl scheme@(guix-user)> ,use (gnu services file-sharing) scheme@(guix-user)> (transmission-random-salt) $1 = "uKd1uMs9"
Autrement, vous pouvez générer un hash de mot de passe complet en une seule étape :
scheme@(guix-user)> (transmission-password-hash "transmission" (transmission-random-salt)) $2 = "{c8bbc6d1740cd8dc819a6e25563b67812c1c19c9VtFPfdsX"
La chaîne qui en résulte peut être utilisée telle quelle comme valeur de
rpc-password
, ce qui permet de garder les mots de passes cachés même
dans la configuration du système d’exploitation.
Les fichiers torrent téléchargés par le démon ne sont directement
accessibles qu’aux utilisateurs dans le groupe « transmission », qui
reçoivent l’accès en lecture seule au répertoire spécifié dans le paramètre
download-dir
(et aussi le répertoire spécifié par
incomplete-dir
si incomplete-dir-enabled?
vaut #t
). Les
fichiers téléchargés peuvent être déplacés vers un autre répertoire ou
supprimés complètement avec transmission-remote
avec les options
--move
et --remove-and-delete
.
Si le paramètre watch-dir-enabled?
vaut #t
, les utilisateurs
du groupe « transmission » peuvent aussi placer des fichiers .torrent
dans le répertoire spécifié par watch-dir
pour que les torrents
correspondants soient ajoutés par le démon. Le paramètre
trash-original-torrent-files?
indique si le démon doit supprimer ces
fichiers après les avoir traités.
Certains paramètres de configuration du démon peuvent être changés
temporairement par transmission-remote
et des outils
similaires. Pour annuler ces changements, utiliser l’action reload
du
service pour que le démon recharge ses paramètres sur disque :
# herd reload transmission-daemon
La liste complète des paramètres disponibles est définie par le type de
données transmission-daemon-configuration
.
Le type de données représentant les paramètres de configuration du démon Transmission. Ils correspondent directement aux paramètres reconnus par les clients Transmission dans le fichier settings.json.
Les champs de transmission-daemon-configuration
disponibles sont :
transmission-daemon-configuration
:package transmission ¶Le paquet Transmission à utiliser.
transmission-daemon-configuration
:entier-non-négatif stop-wait-period ¶Le temps d’attente à l’arrêt du service avant que
transmission-daemon
ne termine et tue ses processus. Cela permet
au démon de tout mettre en ordre et d’envoyer une dernière mise à jour aux
trackers avant de s’arrêter. Vous devrez peut-être augmenter cette valeur
pour les hôtes lents, ou les hôtes avec une connexion réseau lente.
La valeur par défaut est ‘10’.
transmission-daemon-configuration
:string download-dir ¶Le répertoire dans lequel les fichiers torrent sont téléchargés.
La valeur par défaut est ‘"/var/lib/transmission-daemon/downloads"’.
transmission-daemon-configuration
:boolean incomplete-dir-enabled? ¶Si la valeur est #t
, les fichiers seront gardés dans
incomplete-dir
tant que leur torrent est en cours de téléchargement,
puis déplacés vers download-dir
une fois le torrent terminé. Sinon,
les fichiers pour tous les torrents (dont ceux qui sont toujours en cours)
seront placés dans download-dir
.
La valeur par défaut est ‘#f’.
transmission-daemon-configuration
:peut-être-chaine incomplete-dir ¶Le répertoire dans lequel les fichiers des torrents incomplets seront gardé
si incomplete-dir-enabled?
vaut #t
.
La valeur par défaut est ‘disabled’.
transmission-daemon-configuration
:umask umask ¶Le masque de droits d’accès à la création des fichiers téléchargés. voir la
page de manuel de umask
pour plus d’informations.
La valeur par défaut est ‘18’.
transmission-daemon-configuration
:boolean name-partial-files? ¶Lorsque la valeur est #t
, « .part » est ajouté à la fin du nom des
fichiers partiellement téléchargés.
La valeur par défaut est ‘#t’.
transmission-daemon-configuration
:preallocation-mode preallocation ¶Le mode de préallocation d’espace pour les fichiers téléchargés, parmi
none
, fast
(ou sparse
) ou full
. Spécifiez
full
pour minimiser la fragmentation du disque en sacrifiant un peu
de vitesse de création du fichier.
La valeur par défaut est ‘fast’.
transmission-daemon-configuration
:boolean watch-dir-enabled? ¶Si la valeur est #t
, le répertoire spécifié par watch-dir
sera
surveillé en attendant de nouveaux fichiers .torrent et les torrents
qu’ils décrivent seront ajoutés automatiquement (et le fichier d’origine
supprimé, si trash-original-torrent-files?
vaut #t
).
La valeur par défaut est ‘#f’.
transmission-daemon-configuration
:peut-être-chaine watch-dir ¶Le répertoire à surveiller pour les fichiers .torrent indiquant de
nouveaux torrents à ajouter, lorsque watch-dir-enabled
vaut
#t
.
La valeur par défaut est ‘disabled’.
transmission-daemon-configuration
:boolean transh-original-torrent-files? ¶Lorsque la valeur est #t
, les fichiers .torrent seront
supprimés du répertoire de surveillance une fois leur torrent ajouté (voir
watch-directory-enabled?
).
La valeur par défaut est ‘#f’.
transmission-daemon-configuration
:boolean speed-limit-down-enabled? ¶Lorsque la valeur est #t
, la vitesse de téléchargement du démon sera
limitée par la vitesse spécifiée par speed-limit-down
.
La valeur par défaut est ‘#f’.
transmission-daemon-configuration
:entier-non-négatif speed-limit-down ¶La vitesse de téléchargement par défaut maximale, en kilooctets par seconde.
La valeur par défaut est ‘100’.
transmission-daemon-configuration
:boolean speed-limit-up-enabled? ¶Lorsque la valeur est #t
, la vitesse de téléversement du démon sera
limitée par la vitesse spécifiée par speed-limit-up
.
La valeur par défaut est ‘#f’.
transmission-daemon-configuration
:entier-non-négatif speed-limit-up ¶La vitesse globale de téléversement maximale par défaut, en kilooctets par seconde.
La valeur par défaut est ‘100’.
transmission-daemon-configuration
:boolean alt-speed-enabled? ¶Lorsque la valeur est #t
, les limites de vitesse alternatives
alt-speed-down
et alt-speed-up
sont utilisée (au lieu de
speed-limit-down
et speed-limit-up
, si elles sont activées)
pour contraindre l’utilisation de la bande passante par le démon. Elles
peuvent être programmées automatiquement à certains moment de la semaine ;
voir alt-speed-time-enabled?
.
La valeur par défaut est ‘#f’.
transmission-daemon-configuration
:entier-non-négatif alt-speed-down ¶La vitesse de téléchargement globale alternative maximale, en kilooctets par seconde.
La valeur par défaut est ‘50’.
transmission-daemon-configuration
:entier-non-négatif alt-speed-up ¶La vitesse de téléversement globale alternative maximale, en kilooctets par seconde.
La valeur par défaut est ‘50’.
transmission-daemon-configuration
:boolean alt-speed-time-enabled? ¶Lorsque la valeur est #t
, les limites de vitesses alternatives
alt-speed-down
et alt-speed-up
seront activées automatiquement
aux périodes spécifiées par alt-speed-time-day
,
alt-speed-time-begin
et alt-time-speed-end
.
La valeur par défaut est ‘#f’.
transmission-daemon-configuration
:day-list alt-speed-time-day ¶Les jours de la semaine pendant lesquels le programme de vitesse alternative
devrait être utilisé, spécifié soit comme une liste de jours (sunday
,
monday
, etc), soit en utilisant les symboles weekdays
,
weekends
ou all
.
La valeur par défaut est ‘all’.
transmission-daemon-configuration
:entier-non-négatif alt-speed-time-begin ¶Le moment de la journée auquel activer les limites de vitesse alternatives, en nombre de minutes à partir de minuit.
La valeur par défaut est ‘540’.
transmission-daemon-configuration
:entier-non-négatif alt-speed-time-end ¶Le moment de la journée auquel désactiver les limites de vitesses alternatives, en nombre de minutes à partir de minuit.
La valeur par défaut est ‘1020’.
transmission-daemon-configuration
:string bind-address-ipv4 ¶L’IP sur laquelle écouter les connexions de pairs, ou « 0.0.0.0 » pour écouter sur toutes les interfaces réseaux.
La valeur par défaut est ‘"0.0.0.0"’.
transmission-daemon-configuration
:string bind-address-ipv6 ¶L’adresse IPv6 sur laquelle écouter les connexions de pairs, ou « :: » pour écouter sur toutes les interfaces réseaux.
La valeur par défaut est ‘"::"’.
transmission-daemon-configuration
:boolean peer-port-random-on-start? ¶Si la valeur est #t
, lorsque le démon démarre il choisira un port au
hasard sur lequel écouter les connexions des pairs, à partir d’un intervalle
spécifié (inclusivement) par peer-port-random-low
et
peer-port-random-high
. Sinon, il écoutera sur le port spécifié par
peer-port
.
La valeur par défaut est ‘#f’.
transmission-daemon-configuration
:port-number peer-port-random-low ¶Le plus petit numéro de port possible lorsque
peer-port-random-on-start?
vaut #t
.
La valeur par défaut est ‘49152’.
transmission-daemon-configuration
:port-number peer-port-random-high ¶Le plus grand numéro de port possible lorsque
peer-port-random-on-start
vaut #t
.
La valeur par défaut est ‘65535’.
transmission-daemon-configuration
:port-number peer-port ¶Le port sur lequel écouter pour les connexions des pairs lorsque
peer-port-random-on-start?
vaut #f
.
La valeur par défaut est ‘51413’.
transmission-daemon-configuration
:boolean port-forwarding-enabled? ¶Si la valeur est #t
, le démon essayera de configurer le renvoie de
port vers une passerelle amont automatiquement avec UPnP et
NAT-PMP.
La valeur par défaut est ‘#t’.
transmission-daemon-configuration
:encryption-mode encryption ¶Vos préférences de chiffrement pour les connexions avec les pairs, parmi
prefer-unencrypted-connections
, prefer-encrypted-connections
et require-encrypted-connections
.
La valeur par défaut est ‘prefer-encrypted-connections’.
transmission-daemon-configuration
:peut-être-chaine peer-congestion-algorithm ¶L’algorithme de contrôle de congestion TCP à utiliser pour les connexions
avec les pairs, spécifié avec une chaîne reconnue par le système
d’exploitation dans les appels à setsockopt
. Lorsque la valeur n’est
pas spécifiée, le système d’exploitation utilise la valeur par défaut.
Remarquez que sur les systèmes GNU/Linux, le noyau doit être configuré pour permettre aux processus d’utiliser un algorithme de contrôle de congestion qui n’est pas dans l’ensemble par défaut ; sinon, il refusera les demande avec « Opération non autorisée ». Pour voir les algorithmes disponibles sur votre système et ceux qui sont actuellement autorisés, regardez le contenu des fichiers tcp_available_congestion_control et tcp_allowed_congestion_control dans le répertoire /proc/sys/net/ipv4.
Par exemple, pour que le démon Transmission utilise
l’algorithme de contrôle de
congestion TCP de basse priorité, vous devrez modifier la configuration de
votre noyau pour construire la prise en charge de cet algorithme, puis
mettre à jour votre configuration de système d’exploitation pour permettre
son utilisation en ajoutant un service sysctl-service-type
(ou en
mettant à jour la configuration de ce service s’il existe déjà) avec les
lignes suivantes :
(service sysctl-service-type
(sysctl-configuration
(settings
("net.ipv4.tcp_allowed_congestion_control" .
"reno cubic lp"))))
La configuration de démon Transmission peut être mise à jour avec
(peer-congestion-algorithm "lp")
et le système peut être reconfiguré pour que les changements prennent effet.
La valeur par défaut est ‘disabled’.
transmission-daemon-configuration
:tcp-type-of-service peer-soket-tos ¶Le type de service à demander pour les paquets TCP sortants, entre
default
, low-cost
, throughput
, low-delay
et
reliability
.
La valeur par défaut est ‘default’.
transmission-daemon-configuration
:entier-non-négatif peer-limit-global ¶La limite globale pour le nombre de pairs connectés.
La valeur par défaut est ‘200’.
transmission-daemon-configuration
:entier-non-négatif peer-limit-per-torrent ¶La limite par torrent de pairs connectés.
La valeur par défaut est ‘50’.
transmission-daemon-configuration
:entier-non-négatif upload-slots-per-torrent ¶Le nombre maximum de pairs auxquels le démon enverra des données en même temps pour chaque torrent.
La valeur par défaut est ‘14’.
transmission-daemon-configuration
:entier-non-négatif peer-id-ttl-hours ¶La durée maximum, en heures, de l’identifiant de pair associé à chaque torrent public avant qu’il ne soit régénéré.
La valeur par défaut est ‘6’.
transmission-daemon-configuration
:boolean blocklist-enabled? ¶Lorsque la valeur est #t
, le démon ignorera les pairs mentionnés dans
la dernière liste de blocage téléchargée depuis blocklist-url
.
La valeur par défaut est ‘#f’.
transmission-daemon-configuration
:peut-être-chaine blocklist-url ¶L’URL d’une liste de blocage de pairs (au format P2P-plaintext ou
eMule .dat) périodiquement téléchargés et appliqués lorsque
blocklist-enabled?
vaut #t
.
La valeur par défaut est ‘disabled’.
transmission-daemon-configuration
:boolean download-queue-enabled? ¶Si la valeur est #t
, le démon sera limité à téléchargé au plus
download-queue-size
torrents non bloqués en même temps.
La valeur par défaut est ‘#t’.
transmission-daemon-configuration
:entier-non-négatif download-queue-size ¶La taille de la queue de téléchargement du démon, qui limite le nombre de
torrents non bloqués qu’il télécharge en même temps lorsque
download-queue-enabled?
vaut #t
.
La valeur par défaut est ‘5’.
transmission-daemon-configuration
:boolean seed-queue-enabled? ¶Si la valeur est #t
, le démon sera limité à envoyer au plus
seed-queue-size
torrents non bloqués en même temps.
La valeur par défaut est ‘#f’.
transmission-daemon-configuration
:entier-non-négatif seed-queue-size ¶La taille de la queue d’envoi du démon, qui limite le nombre de torrents non
bloqué qu’il enverra en même temps lorsque seed-queue-enabled?
vaut
#t
.
La valeur par défaut est ‘10’.
transmission-daemon-configuration
:boolean queue-stalled-enabled? ¶Lorsque la valeur est #t
, le démon considère les torrents pour
lesquels il n’a pas partagé de données dans les dernières
queue-stalled-minutes
comme bloqué et ne les contera pas dans les
limites download-queue-size
et seed-queue-size
.
La valeur par défaut est ‘#t’.
transmission-daemon-configuration
:entier-non-négatif queue-stalled-minutes ¶La période maximale, en minutes, pendant laquelle un torrent peut être
inactif avant d’être considéré comme bloqué, lorsque
queue-stalled-enabled?
vaut #t
.
La valeur par défaut est ‘30’.
transmission-daemon-configuration
:boolean ratio-limit-enabled? ¶Lorsque la valeur est #t
, un torrent téléchargé sera automatiquement
mis en pause une fois qu’il atteint le ratio spécifié par
ratio-limit
.
La valeur par défaut est ‘#f’.
transmission-daemon-configuration
:non-negative-rational ratio-limit ¶Le ratio auquel un torrent téléchargé sera mis en pause, lorsque
ratio-limit-enabled?
vaut #t
.
La valeur par défaut est ‘2.0’.
transmission-daemon-configuration
:boolean idle-seeding-limit-enabled? ¶Lorsque la valeur est #t
, un torrent téléchargé sera automatiquement
mis en pause s’il est inactif depuis idle-seeding-limit
minutes.
La valeur par défaut est ‘#f’.
transmission-daemon-configuration
:entier-non-négatif idle-seeding-limit ¶La durée maximum, en minutes, pendant laquelle un torrent téléchargé peut
être inactif avant d’être mis en pause, quand
idle-seeding-limit-enabled?
vaut #t
.
La valeur par défaut est ‘30’.
transmission-daemon-configuration
:boolean dht-enabled? ¶Active le protocole de table de hash (DHT) distribuée, qui prend en charge les torrents sans tracker.
La valeur par défaut est ‘#t’.
transmission-daemon-configuration
:boolean lpd-enabled? ¶Active la découverte de pairs locaux (LPD), qui permet de découvrir des pairs sur le réseau local et peut réduire la quantité de données envoyées sur Internet.
La valeur par défaut est ‘#f’.
transmission-daemon-configuration
:boolean pex-enabled? ¶Active l’échange de pairs (PEX), qui réduit la dépendance du démon aux trackers externes et peut améliorer les performances.
La valeur par défaut est ‘#t’.
transmission-daemon-configuration
:boolean utp-enabled? ¶Active le protocole de micro transport (uTP), qui cherche à réduire l’impact du trafic BitTorrent sur les autres utilisateurs du réseau local tout en utilisant toute la bande passante disponible.
La valeur par défaut est ‘#t’.
transmission-daemon-configuration
:boolean rpc-enabled? ¶Si la valeur est #t
, active l’interface d’appel de procédures
distantes (RPC), qui permet de contrôler le démon à distance via
son interface web, le client transmission-remote
en ligne de
commande et des outils similaires.
La valeur par défaut est ‘#t’.
transmission-daemon-configuration
:string rpc-bind-address ¶L’adresse IP sur laquelle écouter les connexions RPC, ou « 0.0.0.0 » pour écouter sur toutes les adresses IP.
La valeur par défaut est ‘"0.0.0.0"’.
transmission-daemon-configuration
:port-number rpc-port ¶Le port sur lequel écouter les connexions RPC entrantes.
La valeur par défaut est ‘9091’.
transmission-daemon-configuration
:string rpc-url ¶Le préfixe de chemin à utiliser dans l’URL du point d’accès RPC.
La valeur par défaut est ‘"/transmission/"’.
transmission-daemon-configuration
:boolean rpc-authentication-required? ¶Lorsque la valeur est #t
, les clients doivent s’authentifier (voir
rpc-username
et rpc-password
) quand ils utilisent l’interface
RPC. Remarquez que cela a pour effet de bord de désactiver la
liste d’hôtes (voir rpc-host-whitelist-enabled?
).
La valeur par défaut est ‘#f’.
transmission-daemon-configuration
:peut-être-chaine rpc-username ¶Le nom d’utilisateur requis par les clients pour accéder à l’interface
RPC lorsque rpc-authentication-required?
vaut #t
.
La valeur par défaut est ‘disabled’.
transmission-daemon-configuration
:peut-être-transmission-password-hash rpc-password ¶Le mot de passe requis pour permettre aux clients d’accéder à l’interface
RPC lorsque rpc-authentication-required?
vaut #t
. Il
doit être spécifié avec un hash de mot de passe au format reconnu par les
clients de Transmission, soit copié d’un fichier settings.json
existant, soit généré avec la procédure transmission-password-hash
.
La valeur par défaut est ‘disabled’.
transmission-daemon-configuration
:boolean rpc-whitelist-enabled? ¶Lorsque la valeur est #t
, les requêtes de RPC seront
acceptées seulement si elles proviennent d’une adresse spécifiée dans
rpc-whitelist
.
La valeur par défaut est ‘#t’.
transmission-daemon-configuration
:string-list rpc-whitelist ¶La liste des adresse IP et IPv6 pour lesquelles les requêtes RPC
sont acceptées lorsque rpc-whitelist-enabled?
vaut #t
. Vous
pouvez spécifier des jokers avec ‘*’.
La valeur par défaut est ‘'("127.0.0.1" "::1")’.
transmission-daemon-configuration
:boolean rpc-host-whitelist-enabled? ¶Lorsque la valeur est #t
, les requêtes RPC seront acceptée
lorsqu’elles sont adressées à un hôte nommé dans
rpc-host-whitelist
. Remarquez que les requêtes adressées à «
localhost » ou « localhost. » ou à une adresse numérique, sont toujours
acceptées indépendamment de ce paramètre.
Remarquez aussi que cette fonctionnalité est désactivée lorsque
rpc-authentication-required?
vaut #t
.
La valeur par défaut est ‘#t’.
transmission-daemon-configuration
:string-list rpc-host-whitelist ¶La liste des noms d’hôte reconnus par le serveur RPC lorsque
rpc-host-whitelist-enabled?
vaut #t
.
La valeur par défaut est ‘'()’.
transmission-daemon-configuration
:message-level message-level ¶Le niveau de sévérité minimum des messages à enregistrer dans les journaux
(dans /var/log/transmission.log) par le démon, entre none
(par
de journalisation), error
, info
et debug
.
La valeur par défaut est ‘info’.
transmission-daemon-configuration
:boolean start-added-torrents? ¶Lorsque la valeur est #t
, les torrents sont démarrés dès qu’ils sont
ajoutés ; sinon ils sont ajouté et mis en pause.
La valeur par défaut est ‘#t’.
transmission-daemon-configuration
:boolean script-torrent-done-enabled? ¶Lorsque la valeur est #t
, le script spécifié par
script-torrent-done-filename
sera invoqué à chaque fois qu’un torrent
termine.
La valeur par défaut est ‘#f’.
transmission-daemon-configuration
:peut-être-objet-fichier script-torrent-done-filename ¶Un nom de fichier ou un simili-fichier spécifiant un script à lancer à
chaque fois qu’un torrent termine, lorsque
script-torrent-done-enabled?
est #t
.
La valeur par défaut est ‘disabled’.
transmission-daemon-configuration
:boolean scrape-paused-torrents-enabled? ¶Lorsque la valeur est #t
, le démon contactera les trackers pour le
torrent même si le torrent est en pause.
La valeur par défaut est ‘#t’.
transmission-daemon-configuration
:entier-non-négatif cache-size-mb ¶La quantité de mémoire, en mégaoctets, à allouer pour le cache mémoire du démon. Une grande valeur peut améliorer les performances en réduisant le fréquence des entrées-sorties sur le disque.
La valeur par défaut est ‘4’.
transmission-daemon-configuration
:boolean prefetch-enabled? ¶Lorsque la valeur est #t
, le démon essaiera d’améliorer les
performances des entrées-sorties en disant au système quelles données seront
probablement bientôt lues pour satisfaire les requêtes des pairs.
La valeur par défaut est ‘#t’.
Suivant: Services Kerberos, Précédent: Services de partage de fichiers, Monter: Services [Table des matières][Index]
Tailon est une application web pour visualiser et chercher des fichiers de journaux.
L’exemple suivant configurera le service avec les valeurs par défaut. Par
défaut, on peut accéder à Tailon sur le pour 8080
(http://localhost:8080
).
(service tailon-service-type)
L’exemple suivant personnalise un peu plus la configuration de Tailon, en
ajoutant sed
à la liste des commandes autorisées.
(service tailon-service-type
(tailon-configuration
(config-file
(tailon-configuration-file
(allowed-commands '("tail" "grep" "awk" "sed"))))))
Type de données représentant la configuration de Tailon. Ce type a les paramètres suivants :
config-file
(par défaut : (tailon-configuration-file)
)Le fichier de configuration à utiliser pour Tailon. Ce champ peut contenir un enregistrement tailon-configuration-file ou n’importe quelle gexp (voir G-Expressions).
Par exemple, pour utiliser un fichier local à la place, on peut utiliser la
fonction local-file
:
(service tailon-service-type
(tailon-configuration
(config-file (local-file "./my-tailon.conf"))))
package
(par défaut : tailon
)Le paquet tailon à utiliser.
Type de données représentant les options de configuration de Tailon. Ce type a les paramètres suivants :
files
(par défaut : (list "/var/log")
)Liste des fichiers à afficher. La liste peut inclure des chaînes pour des fichiers simple ou des répertoires, ou une liste, où le premier élément est le nom d’un sous-section et le reste des fichiers ou des répertoires de cette sous-section.
bind
(par défaut : "localhost:8080"
)Adresse et port sur lesquels Tailon écoute.
relative-root
(par défaut : #f
)Chemin de l’URL à utiliser pour Tailon, ou #f
pour ne pas utiliser de
chemin.
allow-transfers?
(par défaut : #t
)Permet de télécharger les journaux dans l’interface web.
follow-names?
(par défaut : #t
)Permet de surveiller des fichiers qui n’existent pas encore.
tail-lines
(par défaut : 200
)Nombre de lignes à lire initialement dans chaque fichier.
allowed-commands
(par défaut : (list "tail" "grep" "awk")
)Commandes autorisées. Par défaut, sed
est désactivé.
debug?
(par défaut : #f
)Configurez debug?
à #t
pour montrer les messages de débogage.
wrap-lines
(par défaut : #t
)État initial du retour à la ligne dans l’interface web. Configurez l’option
à #t
pour retourner à la ligne (par défaut) ou à #f
pour ne
pas retourner à la ligne au début.
http-auth
(par défaut : #f
)Type d’authentification HTTP à utiliser. Indiquez #f
pour désactiver
l’authentification (par défaut). Les valeur supportées sont "digest"
et "basic"
.
users
(par défaut : #f
)Si l’authentification HTTP est activée (voir http-auth
), l’accès sera
restreint aux identifiants fournis ici. Pour configurer des utilisateurs,
utilisez une liste de paires, où le premier élément de la paire est le nom
d’utilisateur et le second élément est le mot de passe.
(tailon-configuration-file
(http-auth "basic")
(users '(("user1" . "password1")
("user2" . "password2"))))
Darkstat est un « renifleur de paquets » qui capture le trafic réseau, calcul des statistiques sur l’utilisation et sert des rapport sur HTTP.
C’est le type de service pour le service
darkstat, sa valeur doit être un
enregistrement darkstat-configuration
comme dans cet exemple :
(service darkstat-service-type
(darkstat-configuration
(interface "eno1")))
Type de données représentant la configuration de darkstat
.
package
(par défaut : darkstat
)Le paquet darkstat à utiliser.
interface
Capture le trafic sur l’interface réseau spécifiée.
port
(par défaut : "667"
)Lie l’interface web sur le port spécifié.
bind-address
(par défaut : "127.0.0.1"
)Lie l’interface web sur l’adresse spécifiée.
base
(par défaut : "/"
)Spécifie le chemin de base des URL. C’est utile si on accède à
darkstat
à travers un proxy inverse.
L’exportateur de nœuds de Prometheus rend disponible les statistiques sur le matériel et le système d’exploitation fournies par le noyau Linux pour le système de surveillance Prometheus. Ce service devrait être déployé sur tous les nœuds physiques et les machines virtuelles, où vous voulez surveiller ces statistiques.
C’est le type de service pour le service
prometheus-node-exporter, sa valeur doit être un enregistrement
prometheus-node-exporter-configuration
.
Type de données représentant la configuration de node_exporter
.
package
(par défaut : go-github-com-prometheus-node-exporter
)Le paquet prometheus-node-exporter à utiliser.
web-listen-address
(par défaut : ":9100"
)Lie l’interface web sur l’adresse spécifiée.
textfile-directory
(par défaut : "/var/lib/prometheus/node-exporter"
)Ce répertoire est utilisable pour exporter des métriques spécifiques à cette
machine. Les fichiers contenant les métriques au format texte, dont le nom
de fichier termine par .prom
devraient être placés dans ce
répertoire.
extra-options
(par défaut : '()
)Options supplémentaires à passer au lancement de l’exportateur de nœuds de Prometheus.
vnStat is a network traffic monitor that uses interface statistics provided by the kernel rather than traffic sniffing. This makes it a light resource monitor, regardless of network traffic rate.
This is the service type for the vnStat
daemon and accepts a vnstat-configuration
value.
The following example will configure the service with default values:
Available vnstat-configuration
fields are:
package
(default: vnstat
) (type: file-like)The vnstat package.
database-directory
(default: "/var/lib/vnstat"
) (type: string)Specifies the directory where the database is to be stored. A full path must be given and a leading ’/’ isn’t required.
5-minute-hours
(default: 48
) (type: maybe-integer)Data retention duration for the 5 minute resolution entries. The
configuration defines for how many past hours entries will be stored. Set
to -1
for unlimited entries or to 0
to disable the data
collection of this resolution.
64bit-interface-counters
(default: -2
) (type: maybe-integer)Select interface counter handling. Set to 1
for defining that all
interfaces use 64-bit counters on the kernel side and 0
for defining
32-bit counter. Set to -1
for using the old style logic used in
earlier versions where counter values within 32-bits are assumed to be
32-bit and anything larger is assumed to be a 64-bit counter. This may
produce false results if a 64-bit counter is reset within the 32-bits. Set
to -2
for using automatic detection based on available kernel
datastructures.
always-add-new-interfaces?
(default: #t
) (type: maybe-boolean)Enable or disable automatic creation of new database entries for interfaces not currently in the database even if the database file already exists when the daemon is started. New database entries will also get created for new interfaces seen while the daemon is running. Pseudo interfaces ‘lo’, ‘lo0’ and ‘sit0’ are always excluded from getting added.
bandwidth-detection?
(default: #t
) (type: maybe-boolean)Try to automatically detect max-bandwidth value for each monitored interface. Mostly only ethernet interfaces support this feature. max-bandwidth will be used as fallback value if detection fails. Any interface specific max-BW configuration will disable the detection for the specified interface. In Linux, the detection is disabled for tun interfaces due to the Linux kernel always reporting 10 Mbit regardless of the used real interface.
bandwidth-detection-interval
(default: 5
) (type: maybe-integer)How often in minutes interface specific detection of max-bandwidth is
done for detecting possible changes when bandwidth-detection is
enabled. Can be disabled by setting to 0
. Value range:
‘0’..‘30’
boot-variation
(default: 15
) (type: maybe-integer)Time in seconds how much the boot time reported by system kernel can variate between updates. Value range: ‘0’..‘300’
check-disk-space?
(default: #t
) (type: maybe-boolean)Enable or disable the availability check of at least some free disk space before a database write.
create-directories?
(default: #t
) (type: maybe-boolean)Enable or disable the creation of directories when a configured path doesn’t exist. This includes database-directory.
daemon-group
(type: maybe-user-group)Specify the group to which the daemon process should switch during startup.
Set to %unset-value
to disable group switching.
daemon-user
(type: maybe-user-account)Specify the user to which the daemon process should switch during startup.
Set to %unset-value
to disable user switching.
daily-days
(default: 62
) (type: maybe-integer)Data retention duration for the one day resolution entries. The
configuration defines for how many past days entries will be stored. Set to
-1
for unlimited entries or to 0
to disable the data
collection of this resolution.
database-synchronous
(default: -1
) (type: maybe-integer)Change the setting of the SQLite "synchronous" flag which controls how much
care is taken to ensure disk writes have fully completed when writing data
to the database before continuing other actions. Higher values take extra
steps to ensure data safety at the cost of slower performance. A value of
0
will result in all handling being left to the filesystem itself.
Set to -1
to select the default value according to database mode
controlled by database-write-ahead-logging setting. See SQLite
documentation for more details regarding values from 1
to 3
.
Value range: ‘-1’..‘3’
database-write-ahead-logging?
(default: #f
) (type: maybe-boolean)Enable or disable SQLite Write-Ahead Logging mode for the database. See SQLite documentation for more details and note that support for read-only operations isn’t available in older SQLite versions.
hourly-days
(default: 4
) (type: maybe-integer)Data retention duration for the one hour resolution entries. The
configuration defines for how many past days entries will be stored. Set to
-1
for unlimited entries or to 0
to disable the data
collection of this resolution.
log-file
(type: maybe-string)Specify log file path and name to be used if use-logging is set to
1
.
max-bandwidth
(type: maybe-integer)Maximum bandwidth for all interfaces. If the interface specific traffic exceeds the given value then the data is assumed to be invalid and rejected. Set to 0 in order to disable the feature. Value range: ‘0’..‘50000’
max-bw
(type: maybe-alist)Same as max-bandwidth but can be used for setting individual limits for selected interfaces. This is an association list of interfaces as strings to integer values. For example,
(max-bw `(("eth0" . 15000)
("ppp0" . 10000)))
bandwidth-detection is disabled on an interface specific level for each max-bw configuration. Value range: ‘0’..‘50000’
monthly-months
(default: 25
) (type: maybe-integer)Data retention duration for the one month resolution entries. The
configuration defines for how many past months entries will be stored. Set
to -1
for unlimited entries or to 0
to disable the data
collection of this resolution.
month-rotate
(default: 1
) (type: maybe-integer)Day of month that months are expected to change. Usually set to 1 but can be set to alternative values for example for tracking monthly billed traffic where the billing period doesn’t start on the first day. For example, if set to 7, days of February up to and including the 6th will count for January. Changing this option will not cause existing data to be recalculated. Value range: ‘1’..‘28’
month-rotate-affects-years?
(default: #f
) (type: maybe-boolean)Enable or disable month-rotate also affecting yearly data. Applicable only when month-rotate has a value greater than one.
offline-save-interval
(default: 30
) (type: maybe-integer)How often in minutes cached interface data is saved to file when all monitored interfaces are offline. Value range: save-interval..‘60’
pid-file
(default: "/var/run/vnstatd.pid"
) (type: maybe-string)Specify pid file path and name to be used.
poll-interval
(default: 5
) (type: maybe-integer)How often in seconds interfaces are checked for status changes. Value range: ‘2’..‘60’
rescan-database-on-save?
(type: maybe-boolean)Automatically discover added interfaces from the database and start monitoring. The rescan is done every save-interval or offline-save-interval minutes depending on the current activity state.
save-interval
(default: 5
) (type: maybe-integer)How often in minutes cached interface data is saved to file. Value range: ( update-interval / 60 )..‘60’
save-on-status-change?
(default: #t
) (type: maybe-boolean)Enable or disable the additional saving to file of cached interface data when the availability of an interface changes, i.e., when an interface goes offline or comes online.
time-sync-wait
(default: 5
) (type: maybe-integer)How many minutes to wait during daemon startup for system clock to sync if
most recent database update appears to be in the future. This may be needed
in systems without a real-time clock (RTC) which require some time after
boot to query and set the correct time. 0
= wait disabled. Value
range: ‘0’..‘60’
top-day-entries
(default: 20
) (type: maybe-integer)Data retention duration for the top day entries. The configuration defines
how many of the past top day entries will be stored. Set to -1
for
unlimited entries or to 0
to disable the data collection of this
resolution.
trafficless-entries?
(default: #t
) (type: maybe-boolean)Create database entries even when there is no traffic during the entry’s time period.
update-file-owner?
(default: #t
) (type: maybe-boolean)Enable or disable the update of file ownership during daemon process startup. During daemon startup, only database, log and pid files will be modified if the user or group change feature ( daemon-user or daemon-group ) is enabled and the files don’t match the requested user or group. During manual database creation, this option will cause file ownership to be inherited from the database directory if the directory already exists. This option only has effect when the process is started as root or via sudo.
update-interval
(default: 20
) (type: maybe-integer)How often in seconds the interface data is updated. Value range: poll-interval..‘300’
use-logging
(default: 2
) (type: maybe-integer)Enable or disable logging. Accepted values are: 0
= disabled,
1
= logfile and 2
= syslog.
use-utc?
(type: maybe-boolean)Enable or disable using UTC as timezone in the database for all entries. When enabled, all entries added to the database will use UTC regardless of the configured system timezone. When disabled, the configured system timezone will be used. Changing this setting will not result in already existing data to be modified.
yearly-years
(default: -1
) (type: maybe-integer)Data retention duration for the one year resolution entries. The
configuration defines for how many past years entries will be stored. Set
to -1
for unlimited entries or to 0
to disable the data
collection of this resolution.
Zabbix est un système de surveillance très performant qui peut récupérer des données de plusieurs sources et fournir les résultats sur une interface web. Les alertes et les rapport sont inclus, ainsi que les modèles pour les métriques communes des systèmes d’exploitation comme l’utilisation du réseau, la charge CPU et la consommation de l’espace disque.
Ce service fournit le service de surveillance Zabbix central. Vous aurez
aussi besoin de zabbix-front-end-service-type
pour configurer Zabbix et afficher les résultats et éventuellement de
zabbix-agent-service-type
sur les machines qui
doivent être surveillées (d’autres sources de données sont prises en charge,
comme Prometheus Node Exporter).
C’est le type de service pour le service du serveur Zabbix. Sa valeur doit
être un enregistrement zabbix-serveur-configuration
, décrit
ci-dessous.
Les champs de zabbix-server-configuration
disponibles sont :
zabbix-server
(par défaut : zabbix-server
) (type : simili-fichier)Le paquet zabbix-server.
user
(par défaut : "zabbix"
) (type : chaine)Utilisateur qui lancera le serveur Zabbix.
group
(par défaut : "zabbix"
) (type : chaine)Groupe qui lancera le serveur Zabbix.
db-host
(par défaut : "127.0.0.1"
) (type : chaine)Le nom d’hôte de la base de données.
db-name
(par défaut : "zabbix"
) (type : chaine)Nom de la base de données.
db-user
(par défaut : "zabbix"
) (type : chaine)Utilisateur de la base de données.
db-password
(par défaut : ""
) (type : chaine)Mot de passe de la base de données. Utilisez plutôt include-files
avec DBPassword=SECRET
dans le fichier spécifié à la place.
db-port
(par défaut : 5432
) (type : entier)Port de la base de données.
log-type
(par défaut : ""
) (type : chaine)Spécifie où les messages de journalisation seront écrits :
system
- syslog.
file
- fichier spécifié par le paramètre log-file
.
console
- sortie standard.
log-file
(par défaut : "/var/log/zabbix/server.log"
) (type : chaine)Nom du fichier de journal lorsque le paramètre log-type
vaut
file
.
pid-file
(par défaut : "/var/run/zabbix/zabbix_server.pid"
) (type : chaine)Nom du fichier de PID.
ssl-ca-location
(par défaut : "/etc/ssl/certs/ca-certificates.crt"
) (type : chaine)Emplacement des fichiers d’autorités de certification (AC) pour la vérification des certificats SSL du serveur.
ssl-cert-location
(par défaut : "/etc/ssl/certs"
) (type : chaine)Emplacement des certificats SSL des clients.
extra-options
(par défaut : ""
) (type : extra-options)Options supplémentaires ajoutées à la fin du fichier de configuration du serveur Zabbix.
include-files
(par défaut : '()
) (type : include-files)Vous pouvez inclure des fichiers individuels ou tous les fichiers d’un répertoire dans le fichier de configuration.
L’agent Zabbix récupère les informations sur le système pour le serveur de surveillance Zabbix. Il a plusieurs vérificateurs intégrés et peut être étendu avec des paramètres utilisateurs personnalisés.
C’est le type de service du service de l’agent Zabbix. Sa valeur doit être
un enregistrement zabbix-agent-configuration
, décrit ci-dessous.
Les champs de zabbix-agent-configuration
disponibles sont :
zabbix-agent
(par défaut : zabbix-agentd
) (type : simili-fichier)Le paquet zabbix-agent.
user
(par défaut : "zabbix"
) (type : chaine)Utilisateur qui lancera l’agent Zabbix.
group
(par défaut : "zabbix"
) (type : chaine)Groupe qui lancera l’agent Zabbix.
hostname
(par défaut : ""
) (type : chaine)Noms d’hôte unique et sensible à la casse requis pour les vérifications actives et qui doit correspondre au nom d’hôte configuré sur le serveur.
log-type
(par défaut : ""
) (type : chaine)Spécifie où les messages de journalisation seront écrits :
system
- syslog.
file
— fichier spécifié par
le paramètre log-file
.
console
- sortie standard.
log-file
(par défaut : "/var/log/zabbix/agent.log"
) (type : chaine)Nom du fichier de journal lorsque le paramètre log-type
vaut
file
.
pid-file
(par défaut : "/var/run/zabbix/zabbix_agent.pid"
) (type : chaine)Nom du fichier de PID.
server
(par défaut : '("127.0.0.1")
) (type : liste)Liste d’adresses IP, éventuellement en notation CIDR ou de noms d’hôtes de serveurs Zabbix et de mandataires Zabbix. Les connexions entrantes ne seront acceptées que si elles viennent des hôtes listés ici.
server-active
(par défaut : '("127.0.0.1")
) (type : liste)Liste de paires d’IP:port (ou nom d’hôte:port) de serveurs Zabbix et de mandataires Zabbix pour les vérifications actives. Si le port n’est pas spécifié, le port par défaut est utilisé. Si ce paramètre n’est pas spécifié, les vérifications actives sont désactivées.
extra-options
(par défaut : ""
) (type : extra-options)Options supplémentaires ajoutées à la fin du fichier de configuration du serveur Zabbix.
include-files
(par défaut : '()
) (type : include-files)Vous pouvez inclure des fichiers individuels ou tous les fichiers d’un répertoire dans le fichier de configuration.
L’interface Zabbix fournit une interface web à Zabbix. Il n’a pas besoin de tourner sur la même machine que le serveur Zabbix. Ce service fonctionne en étendant les service PHP-FPM et NGINX avec la configuration nécessaire à charger l’interface utilisateur Zabbix.
C’est le type de service de l’interface web de Zabbix. Sa valeur doit être
un enregistrement virtlog-configuration
, décrit plus bas.
Les champs de zabbix-front-end-configuration
disponibles sont :
zabbix-server
(par défaut : zabbix-server
) (type : simili-fichier)Le paquet du serveur Zabbix à utiliser.
nginx
(par défaut : '()
) (type : liste)Liste de blocs
nginx-server-configuration
pour
l’interface Zabbix. Lorsque la valeur est vide, un bloc par défaut qui
écoute sur le port 80 est utilisé.
db-host
(par défaut : "localhost"
) (type : chaine)Le nom d’hôte de la base de données.
db-port
(par défaut : 5432
) (type : entier)Port de la base de données.
db-name
(par défaut : "zabbix"
) (type : chaine)Nom de la base de données.
db-user
(par défaut : "zabbix"
) (type : chaine)Utilisateur de la base de données.
db-password
(par défaut : ""
) (type : chaine)Mot de passe de la base de données. Utilisez plutôt db-secret-file
.
db-secret-file
(par défaut : ""
) (type : chaine)Fichier de secrets qui sera ajouté au fichier zabbix.conf.php. Ce fichier contient les paramètres d’authentification utilisés par Zabbix. On s’attend à ce que vous le créiez manuellement.
zabbix-host
(par défaut : "localhost"
) (type : chaine)Nom d’hôte du serveur Zabbix.
zabbix-port
(par défaut : 10051
) (type : nombre)Port du serveur Zabbix.
Suivant: Services LDAP, Précédent: Services de surveillance, Monter: Services [Table des matières][Index]
Le module (gnu services kerberos)
fournit des services liés au
protocole d’authentification Kerberos.
Les programmes qui utilisent une bibliothèque cliente Kerberos s’attendent à trouver un fichier de configuration dans /etc/krb5.conf. Ce service génère un tel fichier à partir d’une définition fournie par la déclaration de système d’exploitation. Il ne démarre aucun démon.
Aucun fichier « keytab » n’est fourni par ce service — vous devez les créer
explicitement. Ce service est connu pour fonctionner avec la bibliothèque
cliente MIT, mit-krb5
. Les autres implémentations n’ont pas été
testées.
Un type de service pour les clients Kerberos 5.
Voici un exemple d’utilisation :
(service krb5-service-type
(krb5-configuration
(default-realm "EXAMPLE.COM")
(allow-weak-crypto? #t)
(realms (list
(krb5-realm
(name "EXAMPLE.COM")
(admin-server "groucho.example.com")
(kdc "karl.example.com"))
(krb5-realm
(name "ARGRX.EDU")
(admin-server "kerb-admin.argrx.edu")
(kdc "keys.argrx.edu"))))))
Cet exemple fournit une configuration cliente Kerberos 5 qui :
Les types krb5-realm
et krb5-configuration
ont de nombreux
champs. Seuls les plus communs sont décrits ici. Pour une liste complète,
et plus de détails sur chacun d’entre eux, voir la documentation de MIT
krb5.conf.
name
Ce champ est une chaîne identifiant le nom d’un domaine. Une convention courante est d’utiliser le nom pleinement qualifié de votre organisation, converti en majuscule.
admin-server
Ce champ est une chaîne identifiant l’hôte où le serveur d’administration tourne.
kdc
Ce champ est une chaîne identifiant le centre de distribution de clefs pour ce domaine.
allow-weak-crypto?
(par défaut : #f
)Si ce drapeau est #t
les services qui n’offrent que des algorithmes
de chiffrement faibles seront acceptés.
default-realm
(par défaut : #f
)Ce champ devrait être une chaîne identifiant le domaine Kerberos par défaut
pour le client. Vous devriez mettre le nom de votre domaine Kerberos dans
ce champ. Si cette valeur est #f
alors un domaine doit être spécifié
pour chaque principal Kerberos à l’invocation des programmes comme
kinit
.
realms
Cela doit être une liste non-vide d’objets krb5-realm
, auxquels les
clients peuvent accéder. Normalement, l’un d’entre eux aura un champ
name
qui correspond au champ default-realm
.
Le service pam-krb5
permet la connexion et la gestion des mots de
passe par Kerberos. Vous aurez besoin de ce service si vous voulez que les
applications qui utilisent PAM puissent authentifier automatiquement les
utilisateurs avec Kerberos.
Un type de service pour le module PAM Kerberos 5.
Type de données représentant la configuration du module PAM Kerberos 5. Ce type a les paramètres suivants :
pam-krb5
(par défaut : pam-krb5
)Le paquet pam-krb5 à utiliser.
minimum-uid
(par défaut : 1000
)Le plus petite ID utilisateur pour lequel les authentifications Kerberos devraient être tentées. Les comptes locaux avec une valeur plus petite échoueront silencieusement leur authentification Kerberos.
Suivant: Services web, Précédent: Services Kerberos, Monter: Services [Table des matières][Index]
Le module (gnu services authentication)
fournit le type de service
nslcd-service-type
, qui peut être utilisé pour l’authentification par
LDAP. En plus de configurer le service lui-même, vous pouvez ajouter
ldap
comme service de noms au Name Service Switch. Voir Name Service Switch pour des informations détaillées.
Voici une déclaration de système d’exploitation simple avec une
configuration par défaut pour nslcd-service-type
et une configuration
du Name Service Switch qui consulte le service de noms ldap
en
dernier :
(use-service-modules authentication) (use-modules (gnu system nss)) ... (operating-system ... (services (cons* (service nslcd-service-type) (service dhcp-client-service-type) %base-services)) (name-service-switch (let ((services (list (name-service (name "db")) (name-service (name "files")) (name-service (name "ldap"))))) (name-service-switch (inherit %mdns-host-lookup-nss) (password services) (shadow services) (group services) (netgroup services) (gshadow services)))))
Les champs de nslcd-configuration
disponibles sont :
nslcd-configuration
:package nss-pam-ldapd ¶Le paquet nss-pam-ldapd
à utiliser.
nslcd-configuration
:peut-être-nombre threads ¶Le nombre de threads à démarrer qui peuvent gérer les requête et effectuer des requêtes LDAP. Chaque thread ouvre une connexion séparée au serveur LDAP. La valeur par défaut est de 5 threads.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:string uid ¶Cela spécifie l’id de l’utilisateur sous lequel le démon devrait tourner.
La valeur par défaut est ‘"nslcd"’.
nslcd-configuration
:string gid ¶Cela spécifie l’id du groupe sous lequel le démon devrait tourner.
La valeur par défaut est ‘"nslcd"’.
nslcd-configuration
:log-option log ¶Cette option contrôle la journalisation via une liste contenant le schéma et le niveau. Le schéma peut être soit un symbole ‘none’, ‘syslog’, soit un nom de fichier absolu. Le niveau est facultatif et spécifie le niveau de journalisation. Le niveau de journalisation peut être l’un des symboles suivants :‘crit’, ‘error’, ‘warning’, ‘notice’, ‘info’ ou ‘debug’. Tous les messages avec le niveau spécifié ou supérieurs sont enregistrés.
La valeur par défaut est ‘'("/var/log/nslcd" info)’.
nslcd-configuration
:list uri ¶La liste des URI des serveurs LDAP. Normalement, seul le premier serveur sera utilisé avec les serveurs suivants comme secours.
La valeur par défaut est ‘'("ldap://localhost:389/")’.
nslcd-configuration
:peut-être-chaine ldap-version ¶La version du protocole LDAP à utiliser. La valeur par défaut est d’utiliser la version maximum supportée par la bibliothèque LDAP.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine binddn ¶Spécifie le nom distingué avec lequel se lier au serveur de répertoire pour les recherches. La valeur par défaut est de se lier anonymement.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine bindpw ¶Spécifie le mot de passe avec lequel se lier. Cette option n’est valable que lorsqu’elle est utilisée avec binddn.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine rootpwmoddn ¶Spécifie le nom distingué à utiliser lorsque l’utilisateur root essaye de modifier le mot de passe d’un utilisateur avec le module PAM.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine rootpwmodpw ¶Spécifie le mot de passe à utiliser pour se lier si l’utilisateur root essaye de modifier un mot de passe utilisateur. Cette option n’est valable que si elle est utilisée avec rootpwmoddn
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine sasl-mech ¶Spécifie le mécanisme SASL à utiliser lors de l’authentification SASL.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine sasl-realm ¶Spécifie le royaume SASL à utiliser pour effectuer une authentification SASL.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine sasl-authcid ¶Spécifie l’identité d’authentification à utiliser pour effectuer une authentification SASL.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine sasl-authzid ¶Spécifie l’identité d’autorisation à utiliser lors d’une authentification SASL.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-booléen sasl-canonicalize? ¶Détermine si le nom d’hôte du serveur LDAP devrait être canonalisé. Si c’est activé la bibliothèque LDAP effectuera une recherche de nom d’hôte inversée. Par défaut, il est laissé à la bibliothèque LDAP le soin de savoir si la vérification doit être effectuée ou non.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine krb5-ccname ¶Indique le nom du cache d’informations de connexion de GSS-API Kerberos.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:string base ¶La base de recherche de répertoires.
La valeur par défaut est ‘"dc=example,dc=com"’.
nslcd-configuration
:scope-option scope ¶Spécifie la portée de la recherche (subtree, onelevel, base ou children). La portée par défaut est subtree ; la portée base n’est presque jamais utile pour les recherches de service de noms ; la portée children n’est pas prise en charge par tous les serveurs.
La valeur par défaut est ‘'(subtree)’.
nslcd-configuration
:peut-être-deref-option deref ¶Spécifie la politique de déréférencement des alias. La politique par défaut est de ne jamais déréférencer d’alias.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-booléen referrals ¶Spécifie s’il faut activer le suivi de référence. Le comportement par défaut est de suivre les références.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:list-of-map-entries maps ¶Cette option permet d’ajouter des attributs personnalisés à rechercher à la place des attributs par défaut de la RFC 2307. C’est une liste de correspondances, consistant chacune en un nom, en l’attribut RFC 2307 à utiliser et l’expression de la requête pour l’attribut tel qu’il sera disponible dans le répertoire.
La valeur par défaut est ‘'()’.
nslcd-configuration
:list-of-filter-entries filters ¶Une liste de filtres consistant en le nom d’une correspondance à laquelle applique le filtre et en une expression de filtre de recherche LDAP.
La valeur par défaut est ‘'()’.
nslcd-configuration
:peut-être-nombre bind-timelimit ¶Spécifie la limite de temps en seconds à utiliser lors de la connexion au serveur de répertoire. La valeur par défaut est de 10 secondes.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-nombre timelimit ¶Spécifie la limite de temps (en secondes) à attendre une réponse d’un serveur LDAP. La valeur de zéro, par défaut, permet d’attendre indéfiniment la fin des recherches.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-nombre idle-timelimit ¶Spécifie la période d’inactivité (en seconde) après laquelle la connexion au serveur LDAP sera fermée. La valeur par défaut est de ne jamais la fermer.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-nombre reconnect-sleeptime ¶Spécifie le nombre de secondes pendant laquelle attendre lorsque la connexion à tous les serveurs LDAP a échouée. Par défaut, il y a une seconde d’attente entre le premier échec et la tentative suivante.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-nombre reconnect-retrytime ¶Spécifie la durée après laquelle le serveur LDAP est considéré comme définitivement inatteignable. Une fois cette durée atteinte, les tentatives de connexions n’auront plus lieu qu’une fois par cet intervalle de temps. La valeur par défaut est de 10 secondes.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-ssl-option ssl ¶Spécifie s’il faut utiliser SSL/TLS ou non (la valeur par défaut est non). Si ’start-tls est spécifié alors StartTLS est utilisé à la place de LDAP sur SSL.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-tls-reqcert-option tls-reqcert ¶Spécifie quelles vérifications effectuer sur les certificats donnés par les serveurs. La signification des valeurs est décrite dans la page de manuel de ldap.conf(5).
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine tls-cacertdir ¶Spécifie le répertoire contenant les certificats X.509 pour l’authentification des pairs. Ce paramètre est ignoré quand il est utilisé avec GnuTLS.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine tls-cacertfile ¶Spécifie le chemin des certificats X.509 pour l’authentification des pairs.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine tls-randfile ¶Spécifie le chemin d’une source d’entropie. Ce paramètre est ignoré quand il est utilisé avec GnuTLS.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine tls-ciphers ¶Spécifie les suites de chiffrements à utiliser pour TLS en tant que chaîne de caractères.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine tls-cert ¶Spécifie le chemin vers le fichier contenant le certificat local pour l’authentification TLS du client.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine tls-key ¶Spécifie le chemin du fichier contenant la clef privée pour l’authentification TLS du client.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-nombre pagesize ¶Indiquez un nombre plus grand que 0 pour demander des résultats paginés au serveur LDAP en accord avec la RFC 2696. La valeur par défaut (0) est de ne pas demander de pagination des résultats.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-ignore-users-option nss-initgroups-ignoreusers ¶Cette option évite les recherches d’appartenance au groupe à travers le LDAP pour les utilisateurs spécifiés. Autrement, la valeur ’all-local peut être utilisée. Avec cette valeur nslcd construit une liste complète des utilisateurs non-LDAP au démarrage.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-nombre nss-min-uid ¶Cette option s’assure que les utilisateurs LDAP avec un id utilisateur numérique plus petit que la valeur spécifiée sont ignorés.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-nombre nss-uid-offset ¶Cette option spécifie un décalage à ajouter à tous les id utilisateurs numériques LDAP. Cela peut être utile pour éviter des collisions d’id utilisateurs avec des utilisateurs locaux.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-nombre nss-gid-offset ¶Cette option spécifie un décalage à ajouter à tous les id de groupe numériques LDAP. Cela peut être utile pour éviter des collisions d’id utilisateurs avec des groupes locaux.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-booléen nss-nested-groups ¶Si cette option est indiquée, l’attribut de membre de groupe peut pointer vers un autre groupe. Les membres de groupes imbriqués sont aussi renvoyés dans le groupe de haut-niveau et les groupes parents sont renvoyés lorsqu’on recherche un utilisateur spécifique. La valeur par défaut est de ne pas effectuer de recherche supplémentaire sur les groupes imbriqués.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-booléen nss-getgrent-skipmembers ¶Si cette option est indiqée, la liste de membres du groupe n’est pas récupérée lorsqu’on cherche un groupe. Les recherches pour trouver les groupes auxquels un utilisateur appartient resteront fonctionnelles donc l’utilisateur obtiendra probablement les bons groupes à la connexion.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-booléen nss-disable-enumeration ¶Si cette option est indiquée, les fonctions qui causent le chargement de toutes les entrées d’utilisateur et de groupe depuis le répertoire ne pourront pas le faire. Cela peut grandement diminuer la charge du serveur LDAP dans des situations où il y a beaucoup d’utilisateurs et de groupes. Cette option n’est pas recommandées pour la plupart des configurations.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine validnames ¶Cette option peut être utilisée pour spécifier comment les noms d’utilisateurs et de groupes sont vérifiés sur le système. Ce motif est utilisé pour vérifier tous les noms d’utilisateurs et de groupes qui sont demandés et renvoyés par le LDAP.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-booléen ignorecase ¶Cela spécifie s’il faut ou non effectuer des recherches avec une correspondance sensible à la casse. Activer cela pourrait mener à des vulnérabilités de type contournement d’authentification sur le système et introduire des vulnérabilité d’empoisonnement de cache nscd qui permettent un déni de service.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-booléen pam-authc-ppolicy ¶Cette option spécifie si des contrôles de la politique de mots de passe sont demandés et gérés par le serveur LDAP à l’authentification de l’utilisateur.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine pam-authc-search ¶Par défaut nslcd effectue une recherche LDAP avec le mot de passe de l’utilisateur après BIND (authentification) pour s’assurer que l’opération BIND a bien réussi. La recherche par défaut est une simple vérification que le DN de l’utilisateur existe. Un filtre de recherche peut être spécifié pour l’utiliser à la place. Il devrait renvoyer au moins une entrée.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine pam-authz-search ¶Cette option permet la configuration fine et flexible de la vérification d’autorisation qui devrait être effectuée. Le filtre de recherche est exécuté et si une entrée correspond, l’accès est autorisé, sinon il est refusé.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:peut-être-chaine pam-password-prohibit-message ¶Si cette option est indiquée, la modification de mot de passe par pam_ldap sera refusée et le message spécifié sera présenté à l’utilisateur à la place. Le message peut être utilisé pour rediriger les utilisateurs vers une autre méthode pour changer leur mot de passe.
La valeur par défaut est ‘disabled’.
nslcd-configuration
:list pam-services ¶Liste de noms de service pam pour lesquels l’authentification LDAP devrait suffire.
La valeur par défaut est ‘'()’.
Le module (gnu services ldap)
fournit le
directory-server-service-type
, qui peut être utilisé pour créer et
lancer une instance du serveur LDAP.
Voici un exemple de configuration du directory-server-service-type
:
(use-service-modules ldap) ... (operating-system ... (services (cons (service directory-server-service-type (directory-server-instance-configuration (slapd (slapd-configuration (root-password "{PBKDF2_SHA256}AAAgAG…ABSOLUTELYSECRET"))))) %base-services)))
Le mot de passe root devrait être généré avec l’utilitaire pwdhash
fourni par le paquet 389-ds-base
.
Remarquez que les changements de configuration du serveur de répertoire ne seront pas appliqués aux instances existantes. Vous devrez sauvegarder et restaurer les données du serveur manuellement. Seules les nouvelles instances du serveur de répertoire seront créées à la reconfiguration du système.
Les champs de directory-server-configuration
disponibles sont :
package
(par défaut : 389-ds-base
) (type : simili-fichier)Le paquet 389-ds-base
.
config-version
(par défaut : 2
) (type : entier)Indique la version du format du fichier de configuration. Pour utiliser le
fichier INF avec dscreate
, ce paramètre doit être 2.
full-machine-name
(par défaut : "localhost"
) (type : chaine)Indique le nom d’hôte pleinement qualifié (FQDN) de ce système.
selinux
(par défaut : #false
) (type : booléen)Active la détection et l’intégration de SELinux pendant l’installation de
cette instance. Si la valeur est #true
, dscreate
détecte
automatiquement si SELinux est activé.
strict-host-checking
(par défaut : #true
) (type : booléen)Indique si le serveur doit vérifier le champ DNS avant et inverse dans le
paramètre full-machine-name
. Lorsque vous installez cette instance
avec l’authentification GSSAPI derrière un répartiteur de charge, indiquez
#false
.
systemd
(par défaut : #false
) (type : booléen)Active les fonctionnalité de la plateforme systemd. Si la valeur est
#true
, dscreate
détecte automatiquement si systemd est
installé.
slapd
(type : slapd-configuration)Configuration de slapd.
Les champs de slapd-configuration
disponibles sont :
instance-name
(par défaut : "localhost"
) (type : chaine)Indique le nom de cette instance. Vous pouvez utiliser cette valeur dans
d’autres paramètres de ce fichier INF avec la variable
{instance_name}
. Remarquez que ce nom ne peut pas être changé après
l’installation !
user
(par défaut : "dirsrv"
) (type : chaine)Indique le nom d’utilisateur que le processus ns-slapd utilisera après le démarrage du service.
group
(par défaut : "dirsrv"
) (type : chaine)Indique le nom de groupe que le processus ns-slapd utilisera après le démarrage du service.
port
(par défaut : 389
) (type : nombre)Indique le port TCP que l’instance doit utiliser pour les connexions LDAP.
secure-port
(par défaut : 636
) (type : entier)Indique le port TCP que l’instance doit utiliser pour les connexions LDAP sécurisés par TLS (LDAPS).
root-dn
(par défaut : "cn=Directory Manager"
) (type : chaine)Indique le nom distingué (DN) du compte administratif de cette instance.
root-password
(par défaut : "{invalid}YOU-SHOULD-CHANGE-THIS"
) (type : chaine)Indique le mot de passe du compte spécifié dans le paramètre
root-dn
. Vous pouvez soit utiliser un mot de passe en texte clair que
dscreate
hash pendant l’installation ou une chaine de « hash »
générée par l’utilitaire pwdhash
pour ce paramètre. Remarquez
qu’utiliser un mot de passe en clair peut présenter un risque de sécurité si
les utilisateurs et utilisatrices peuvent lire ce fichier INF !
self-sign-cert
(par défaut : #true
) (type : booléen)Indique si l’installation doit créer un certificat auto-signé et activer le chiffrement TLS pendant l’installation. Ce n’est pas convenable pour la production, mais cela vous permet d’utiliser TLS directement après l’installation. Vous pouvez remplacer le certificat auto-signé par un certificat fournit par une autorité de certification.
self-sign-cert-valid-months
(par défaut : 24
) (type : nombre)Indique le nombre de mois pour lequel le certificat auto-signé généré sera valide.
backup-dir
(par défaut : "/var/lib/dirsrv/slapd-{instance_name}/bak"
) (type : chaine)Indique le répertoire de sauvegarde de cette instance.
cert-dir
(par défaut : "/etc/dirsrv/slapd-{instance_name}"
) (type : chaine)Indique le répertoire de la base de données Network Security Services (NSS) de cette instance.
config-dir
(par défaut : "/etc/dirsrv/slapd-{instance_name}"
) (type : chaine)Indique le répertoire de configuration de l’instance.
db-dir
(par défaut : "/var/lib/dirsrv/slapd-{instance_name}/db"
) (type : chaine)Indique le répertoire de la base de données de l’instance.
initconfig-dir
(par défaut : "/etc/dirsrv/registry"
) (type : chaine)Indique le répertoire contenant le répertoire de configuration rc du système d’exploitation.
ldif-dir
(par défaut : "/var/lib/dirsrv/slapd-{instance_name}/ldif"
) (type : chaine)Indique le répertoire d’export et d’import LDIF de l’instance.
lock-dir
(par défaut : "/var/lock/dirsrv/slapd-{instance_name}"
) (type : chaine)Indique le répertoire de verrouillage de l’instance.
log-dir
(par défaut : "/var/log/dirsrv/slapd-{instance_name}"
) (type : chaine)Indique le répertoire de journalisation de l’instance.
run-dir
(par défaut : "/run/dirsrv"
) (type : chaine)Indique le répertoire pour le PID de l’instance.
schema-dir
(par défaut : "/etc/dirsrv/slapd-{instance_name}/schema"
) (type : chaine)Indique le répertoire des schémas de l’instance.
tmp-dir
(par défaut : "/tmp"
) (type : chaine)Indique le répertoire temporaire de l’instance.
backend-userroot
(type : backend-userroot-configuration)Configuration du moteur userroot.
Les champs de backend-userroot-configuration
disponibles sont :
create-suffix-entry?
(par défaut : #false
) (type : booléen)utilisez la valeur #true
pour créer une entrée de nœud racine
générique pour le suffixe dans la base.
require-index?
(par défaut : #false
) (type : booléen)Utilisez la valeur #true
pour refuser les recherches non indexées
dans cette base de données.
sumple-entries
(par défaut : "no"
) (type : chaine)Utilisez la valeur "yes"
pour ajouter la dernière version des entrées
échantillonnées dans cette base de données. Sinon, utilisez
"001003006"
pour utiliser la version 1.3.6 des entrées
échantillonées. Utilisez cette option par exemple pour créer une base de
données de test.
suffix
(type : peut-être-chaine)Indique le suffixe de la racine stocké dans cette base. Si vous n’indiquez pas l’attribut de suffixe le processus d’installation ne créera pas le moteur/suffixe. Vous pouvez également créer plusieurs moteurs/suffixes en dupliquant cette section.
Suivant: Services de certificats, Précédent: Services LDAP, Monter: Services [Table des matières][Index]
Le module (gnu services web)
fournit le serveur Apache HTTP, le
serveur web nginx et aussi un démon fastcgi.
Type de service pour le serveur Apache HTTP
(httpd). La valeur de ce type de service est un enregistrement
httpd-configuration
.
Un exemple de configuration simple est donné ci-dessous.
(service httpd-service-type
(httpd-configuration
(config
(httpd-config-file
(server-name "www.example.com")
(document-root "/srv/http/www.example.com")))))
D’autres services peuvent aussi étendre httpd-service-type
pour être
ajouté à la configuration.
(simple-service 'www.example.com-server httpd-service-type
(list
(httpd-virtualhost
"*:80"
(list (string-join '("ServerName www.example.com"
"DocumentRoot /srv/http/www.example.com")
"\n")))))
Les détails des types d’enregistrement httpd-configuration
,
httpd-module
, httpd-config-file
et httpd-virtualhost
sont donnés plus bas.
Ce type de données représente la configuration du service httpd.
package
(par défaut : httpd
)Le paquet httpd à utiliser.
pid-file
(par défaut : "/var/run/httpd"
)Le fichier de pid utilisé par le service shepherd.
config
(par défaut : (httpd-config-file)
)Le fichier de configuration à utiliser avec le service httpd. La valeur par
défaut est un enregistrement httpd-config-file
mais cela peut aussi
être un G-expression qui génère un fichier, par exemple un
plain-file
. Un fichier en dehors du dépôt peut aussi être spécifié
avec une chaîne de caractères.
Ce type de données représente un module pour le service httpd.
name
Le nom du module.
file
Le fichier pour le module. Cela peut être relatif au paquet httpd utilisé,
l’emplacement absolu d’un fichier ou une G-expression pour un fichier dans
le dépôt, par exemple (file-append mod-wsgi "/modules/mod_wsgi.so")
.
Une liste par défaut des objets httpd-module
.
Ce type de données représente un fichier de configuration pour le service httpd.
modules
(par défaut : %default-httpd-modules
)Les modules à charger. Les modules supplémentaires peuvent être ajoutés ici ou chargés par des configuration supplémentaires.
Par exemple, pour gérer les requêtes pour des fichiers PHP, vous pouvez
utiliser le module mod_proxy_fcgi
d’Apache avec
php-fpm-service-type
:
(service httpd-service-type (httpd-configuration (config (httpd-config-file (modules (cons* (httpd-module (name "proxy_module") (file "modules/mod_proxy.so")) (httpd-module (name "proxy_fcgi_module") (file "modules/mod_proxy_fcgi.so")) %default-httpd-modules)) (extra-config (list "\ <FilesMatch \\.php$> SetHandler \"proxy:unix:/var/run/php-fpm.sock|fcgi://localhost/\" </FilesMatch>")))))) (service php-fpm-service-type (php-fpm-configuration (socket "/var/run/php-fpm.sock") (socket-group "httpd")))
server-root
(par défaut : httpd
)Le ServerRoot
dans le fichier de configuration, par défaut le paquet
httpd. Les directives comme Include
et LoadModule
sont prises
relativement à la racine du serveur.
server-name
(par défaut : #f
)Le ServerName
dans le fichier de configuration, utilisé pour
spécifier le schéma de requête, le nom d’hôte et le port que le serveur
utilise pour s’identifier.
Cela n’a pas besoin d’être dans la configuration du serveur, et peut être
spécifié dans les hôtes virtuels. La valeur par défaut est #f
pour
ne pas spécifier de ServerName
.
document-root
(par défaut : "/srv/http"
)Le DocumentRoot
depuis lequel les fichiers seront servis.
listen
(par défaut : '("80")
)La liste des valeurs pour les directives Listen
dans le fichier de
configuration. La valeur devrait être une liste de chaînes, où chacune
spécifie le port sur lequel écouter et éventuellement une adresse IP et un
protocole à utiliser.
pid-file
(par défaut : "/var/run/httpd"
)Le PidFile
à utiliser. Cela devrait correspondre à pid-file
indiqué dans httpd-configuration
pour que le service Shepherd soit
correctement configuré.
error-log
(par défaut : "/var/log/httpd/error_log"
)Le ErrorLog
où le serveur écrit les journaux d’erreurs.
user
(par défaut : "httpd"
)Le User
en tant que lequel le serveur répondra aux requêtes.
group
(par défaut : "httpd"
)Le Group
que le serveur utilisera pour répondre aux requêtes.
extra-config
(par défaut : (list "TypesConfig etc/httpd/mime.types")
)Une liste plate de chaînes et de G-expressions qui seront ajoutées à la fin du fichier de configuration.
N’importe quelle valeur avec laquelle le service est étendu sera ajouté à cette liste.
Ce type de données représente la configuration d’un hôte virtuel pour le service httpd.
Ils devraient être ajoutés à extra-config dans httpd-service.
(simple-service 'www.example.com-server httpd-service-type
(list
(httpd-virtualhost
"*:80"
(list (string-join '("ServerName www.example.com"
"DocumentRoot /srv/http/www.example.com")
"\n")))))
addresses-and-ports
L’adresse et le port pour la directive VirtualHost
.
contents
Le contenu de la directive VirtualHost
, cela devrait être une liste
de chaîne et de G-expressions.
Type de service pour le serveur web NGinx. La
valeur de ce service est un enregistrement <nginx-configuration>
.
Un exemple de configuration simple est donné ci-dessous.
(service nginx-service-type
(nginx-configuration
(server-blocks
(list (nginx-server-configuration
(server-name '("www.example.com"))
(root "/srv/http/www.example.com"))))))
En plus d’ajouter des blocs de serveurs dans la configuration du service directement, ce service peut être étendu par d’autres services pour ajouter des blocs de serveurs, comme dans cet exemple :
(simple-service 'my-extra-server nginx-service-type
(list (nginx-server-configuration
(root "/srv/http/extra-website")
(try-files (list "$uri" "$uri/index.html")))))
Au démarrage, nginx
n’a pas encore lu son fichier de
configuration, donc il utilise les fichiers par défaut pour les messages
d’erreur. S’il échoue à charger sa configuration, c’est là où les messages
seront enregistrés. Après la lecture du fichier de configuration, le
fichier de journal d’erreur par défaut change en fonction de celle-ci. Dans
notre cas, les messages d’erreur au démarrage se trouvent dans
/var/run/nginx/logs/error.log et après la configuration dans
/var/log/nginx/error.log. Ce second emplacement peut être modifié
avec l’option de configuration log-directory.
Ce type de données représente la configuration de NGinx. Certaines configurations peuvent se faire ici et d’autres fournissent des types d’enregistrement ou éventuellement, on peut fournir un fichier de configuration.
nginx
(par défaut : nginx
)Le paquet nginx à utiliser.
rshepherd-equirement
(par défaut : '()
)C’est une liste de symboles nommant les services du Shepherd dont les services nginx dépendent.
C’est utile si vous voulez que nginx
démarre après qu’un serveur
web en arrière-plan ou qu’un service de journalisation comme Anonip a été
démarré.
log-directory
(par défaut : "/var/log/nginx"
)Le répertoire dans lequel NGinx écrira ses fichiers journaux.
log-level
(default: 'error
) (type: symbol)Logging level, which can be any of the following values: 'debug
,
'info
, 'notice
, 'warn
, 'error
, 'crit
,
'alert
, or 'emerg
.
run-directory
(par défaut : "/var/run/nginx"
)Le répertoire dans lequel NGinx créera un fichier de pid et écrira des fichiers temporaires.
server-blocks
(par défaut : '()
)Une liste de blocs serveur à créer dans le fichier de configuration
généré, dont les éléments sont de type <nginx-server-configuration>
.
L’exemple suivant paramètre NGinx pour servir www.example.com
depuis
le répertoire /srv/http/www.example.com
sans utiliser HTTPS.
(service nginx-service-type
(nginx-configuration
(server-blocks
(list (nginx-server-configuration
(server-name '("www.example.com"))
(root "/srv/http/www.example.com"))))))
upstream-blocks
(par défaut : '()
)Une liste de blocs amont à créer dans le fichier de configuration
généré, dont les éléments sont de type
<nginx-upstream-configuration>
.
Configurer les serveurs amont à travers les upstream-blocks
peut être
utile en combinaison avec locations
dans les enregistrements
<nginx-server-configuration>
. L’exemple suivant crée une
configuration de serveur avec une configuration « location » qui sera
mandataire pour une configuration amont, qui gérera les requêtes avec deux
serveurs.
(service
nginx-service-type
(nginx-configuration
(server-blocks
(list (nginx-server-configuration
(server-name '("www.example.com"))
(root "/srv/http/www.example.com")
(locations
(list
(nginx-location-configuration
(uri "/path1")
(body '("proxy_pass http://server-proxy;"))))))))
(upstream-blocks
(list (nginx-upstream-configuration
(name "server-proxy")
(servers (list "server1.example.com"
"server2.example.com")))))))
file
(par défaut : #f
)Si un fichier de configuration file est fourni, il sera utilisé au
lieu de générer un fichier de configuration à partir des
log-directory
, run-directory
, server-blocks
et
upstream-blocks
fournis. Pour un bon fonctionnement, ces arguments
devraient correspondre à ce qui se trouve dans file pour s’assurer que
les répertoires sont créé lorsque le service est activé.
Cela peut être utile si vous avez déjà un fichier de configuration existant ou s’il n’est pas possible de faire ce dont vous avez besoin avec les autres parties de l’enregistrement nginx-configuration.
server-names-hash-bucket-size
(par défaut : #f
)Taille du seau pour les tables de hashage des noms de serveurs, par dauft
#f
pour utilise la taille des lignes de cache du processeur.
server-names-hash-bucket-max-size
(par défaut : #f
)Taille maximum des seaux pour les tables de hashage des serveurs de noms.
modules
(par défaut : '()
)Liste de modules dynamiques de nginx à charger. Cela devrait être une liste de noms de fichiers de modules chargeables, comme dans cet exemple :
(modules
(list
(file-append nginx-accept-language-module "\
/etc/nginx/modules/ngx_http_accept_language_module.so")
(file-append nginx-lua-module "\
/etc/nginx/modules/ngx_http_lua_module.so")))
lua-package-path
(par défaut : '()
)Liste des paquets lua à charger. Cela devrait être une liste de noms de paquets de modules lua chargeables, comme dans cet exemple :
(lua-package-path (list lua-resty-core
lua-resty-lrucache
lua-resty-signal
lua-tablepool
lua-resty-shell))
lua-package-cpath
(par défaut : '()
)Liste de paquets lua C à charger. cela devrait être une liste de noms de paquets de modules lua C, comme dans cet exemple :
(lua-package-cpath (list lua-resty-signal))
global-directives
(par défaut : '((events . ()))
)Liste d’association des directives globales pour le plus haut niveau de la configuration de nginx. Les valeurs peuvent elles-mêmes être des listes d’association.
(global-directives
`((worker_processes . 16)
(pcre_jit . on)
(events . ((worker_connections . 1024)))))
extra-content
(par défaut : ""
)Additional content to be appended to the http
block. Can either be a
value that can be lowered into a string or a list of such values. In the
former case, it is inserted directly. In the latter, it is prefixed with
indentation and suffixed with a newline. Nested lists are flattened into
one line.
(extra-content "include /etc/nginx/custom-config.conf;") (extra-content `("include /etc/nginx/custom-config.conf;" ("include " ,%custom-config.conf ";")))
Type de données représentant la configuration d’un bloc serveur de nginx. Ce type a les paramètres suivants :
listen
(par défaut : '("80" "443 ssl")
)Chaque directive listen
indique l’adresse et le port pour le
protocole IP ou le chemin d’un socket UNIX-domain sur lequel le serveur
acceptera les connexions. On peut spécifier l’adresse et le port, ou juste
l’adresse ou juste le port. Une adresse peut aussi être un nom d’hôte, par
exemple :
'("127.0.0.1:8000" "127.0.0.1" "8000" "*:8000" "localhost:8000")
server-name
(par défaut : (list 'default)
)Une liste de noms de serveurs que ce serveur représente. 'default
représente le serveur par défaut pour les connexions qui ne correspondent à
aucun autre serveur.
root
(par défaut : "/srv/http"
)Racine du site web que sert nginx.
locations
(par défaut : '()
)Une liste d’enregistrements nginx-location-configuration ou nginx-named-location-configuration à utiliser dans ce bloc serveur.
index
(par défaut : (list "index.html")
)Fichiers d’index à chercher lorsque les clients demandent un répertoire. S’il ne peut pas être trouvé, Nginx enverra la liste des fichiers dans le répertoire.
try-files
(par défaut : '()
)Une liste de fichiers dont l’existence doit être vérifiée dans l’ordre
spécifié. nginx
utilisera le premier fichier trouvé pour satisfaire
la requête.
ssl-certificate
(par défaut : #f
)Où trouver les certificats pour les connexions sécurisées. Indiquez
#f
si vous n’avez pas de certificats et que vous ne voulez pas
utiliser HTTPS.
ssl-certificate-key
(par défaut : #f
)Où trouver la clef privée pour les connexions sécurisées. Indiquez
#f
si vous n’avez pas de clef et que vous ne voulez pas utiliser
HTTPS.
server-tokens?
(par défaut : #f
)Indique si le serveur devrait ajouter sa configuration dans les réponses.
raw-content
(par défaut : '()
)A list of strings or file-like objects to be appended to the server block. Each item is prefixed with indentation and suffixed with a new line. Nested lists are flattened.
Type de données représentant la configuration d’un bloc upstream
nginx. Ce type a les paramètres suivants :
name
Nome de ces groupe de serveurs.
serveurs
Spécifie les adresses des serveurs dans le groupe. L’adresse peut être spécifié avec une adresse IP (p. ex. ‘127.0.0.1’), un nom de domaine (p. ex. ‘backend1.example.com’) ou un chemin vers un socket UNIX avec le préfixe ‘unix:’. Pour les adresse utilisant une adresse IP ou un nom de domaine, le port par défaut est 80 et un port différent peut être spécifié explicitement.
extra-content
Additional content to be appended to the upstream block. Can be a string or file-like object or list of thereof. In case of list, each item is prefixed with indentation and suffixed with a new line. Nested lists are flattened.
(extra-content "include /etc/nginx/custom-config.conf;") (extra-content `("include /etc/nginx/custom-config.conf;" ("include " ,%custom-config.conf ";")))
Type de données représentant la configuration d’un bloc location
nginx. Ce type a les paramètres suivants :
uri
URI qui correspond à ce bloc.
body
Body of the location block, specified as a list of strings or file-like objects. Each item is prefixed with indentation and suffixed with a new line. Nested lists are flattened.
For example, to pass requests to a upstream server group defined using an
nginx-upstream-configuration
block, the following directive would be
specified in the body ‘(list "proxy_pass http://upstream-name;")’.
Type de données représentant la configuration d’un bloc location nginx nommé. Les blocs location nommés sont utilisé les redirections de requêtes et pas pour le traitement des requêtes normales. Ce type a les paramètres suivants :
name
Nom pour identifier ce bloc location.
body
Voir nginx-location-configuration body, comme le corps d’un bloc location
nommé peut être utilisé de la même manière que
nginx-location-configuration body
. Une restriction est que le corps
d’un bloc location nommé ne peut pas contenir de bloc location.
Varnish est un serveur de cache rapide qui se trouve entre les applications web et les utilisateurs. Il sert de serveur mandataire pour les requêtes des clients et met les URL accédées en cache pour que plusieurs requêtes à la même ressource ne crée qu’une requête au moteur.
Type de service pour le démon Varnish.
Type de données représentant la configuration du service varnish
. Ce
type a les paramètres suivants :
package
(par défaut : varnish
)Le paquet Varnish à utiliser.
name
(par défaut : "default"
)Un nom pour cet instance de Varnish. Varnish va créer un répertoire dans /var/varnish/ avec ce nom et gardera des fichiers temporaires à cet endroit. Si le nom commence par une barre oblique, il est interprété comme un nom de répertoire absolu.
Passez l’argument -n
aux autres programmes Varnish pour vous
connecter à l’instance nommée, p. ex. varnishncsa -n default
.
backend
(par défaut : "localhost:8080"
)Le moteur à utiliser. Cette option n’a pas d’effet si vcl
est vrai.
vcl
(par défaut : #f)Le programme VCL (Varnish Configuration Language) à lancer. Si la
valeur est #f
, Varnsh servira de mandataire pour backend
avec
la configuration par défaut. Sinon, ce doit être un objet simili-fichier
avec une syntaxe VCL valide.
Par exemple, pour créer un miroir de www.gnu.org avec VCL vous pouvez faire quelque chose comme cela :
(define %gnu-mirror (plain-file "gnu.vcl" "vcl 4.1; backend gnu { .host = \"www.gnu.org\"; }")) (operating-system ;; … (services (cons (service varnish-service-type (varnish-configuration (listen '(":80")) (vcl %gnu-mirror))) %base-services)))
On peut inspecter la configuration d’une instance Varnish actuellement
lancée en utilisant le programme varnishadm
.
Consultez le guide utilisateur de varnish et le livre varnish pour une documentation complète sur Varnish et son langage de configuration.
listen
(par défaut : '("localhost:80")
)Liste des adresses sur lesquelles écoute Varnish.
storage
(par défaut : '("malloc,128m")
)Liste de moteurs de stockage qui seront disponibles en VCL.
parameters
(par défaut : '()
)Liste des paramètres à l’exécution de la forme '(("parameter"
. "value"))
.
extra-options
(par défaut : '()
)Arguments supplémentaires à passer au processus varnishd
.
Whoogle Search is a
self-hosted, ad-free, privacy-respecting meta search engine that collects
and displays Google search results. By default, you can configure it by
adding this line to the services
field of your operating system
declaration:
As a result, Whoogle Search runs as local Web server, which you can access
by opening ‘http://localhost:5000
’ in your browser. The
configuration reference is given below.
Service type for Whoogle Search. Its value must be a
whoogle-configuration
record—see below.
Data type representing Whoogle Search service configuration.
package
(default: whoogle-search
)The Whoogle Search package to use.
host
(par défaut : "127.0.0.1"
)The host address to run Whoogle on.
port
(par défaut : 5000
)The port where Whoogle will be exposed.
environment-variables
(par défaut : '()
)A list of strings with the environment variables to configure Whoogle. You can consult its environment variables template for the list of available options.
Patchwork est un système de suivi de correctifs. Il peut récupérer des correctifs envoyés à une liste de diffusion, et les afficher sur une interface web.
Type de service pour Patchwork.
L’exemple suivant est un exemple de service Patchwork minimal, pour le
domaine patchwork.example.com
.
(service patchwork-service-type
(patchwork-configuration
(domain "patchwork.example.com")
(settings-module
(patchwork-settings-module
(allowed-hosts (list domain))
(default-from-email "patchwork@patchwork.example.com")))
(getmail-retriever-config
(getmail-retriever-configuration
(type "SimpleIMAPSSLRetriever")
(server "imap.example.com")
(port 993)
(username "patchwork")
(password-command
(list (file-append coreutils "/bin/cat")
"/etc/getmail-patchwork-imap-password"))
(extra-parameters
'((mailboxes . ("Patches"))))))))
Il y a trois enregistrements pour configurer le service Patchwork. Le
<patchwork-configuration>
correspond à la configuration de Patchwork
dans le service HTTPD.
Le champ settings-module
dans l’enregistrement
<patchwork-configuration>
peut être rempli avec l’enregistrement
<patchwork-settings-modules>
, qui décrit un module de paramètres
généré dans le dépôt de Guix.
Pour le champ database-configuration
dans
<patchwork-settings-module>
, il faut utiliser un
<patchwork-dataase-configuration>
.
Type de données représentant la configuration du service Patchwork. Ce type a les paramètres suivants :
patchwork
(par défaut : patchwork
)Le paquet Patchwork à utiliser.
domain
Le domaine à utiliser pour Patchwork, utilisé comme hôte virtuel dans le service HTTPD.
settings-module
Le module de paramètres à utiliser pour Patchwork. En tant qu’application
Django, Patchwork est configuré avec un module Python contenant les
paramètres. Il peut s’agir d’une instance de l’enregistrement
<patchwork-settings-module>
, de n’importe quel enregistrement qui
représente les paramètres dans le dépôt, ou un répertoire en dehors du
dépôt.
static-path
(par défaut : "/static/"
)Le chemin dans lequel le service HTTPD devrait servir les fichiers statiques.
getmail-retriever-config
La valeur d’enregistrement getmail-retriever-configuration à utiliser avec Patchwork. getmail sera configuré avec cette valeur, les messages seront livrés à Patchwork.
Type de données représentant le module de paramètres de Patchwork. Certains de ces paramètres sont liés à Patchwork, mais d’autres sont liés à Django, le cadriciel web utilisé par Patchwork, ou la bibliothèque Django Rest Framework. Ce type a les paramètres suivants :
database-configuration
(par défaut : (patchwork-database-configuration)
)Les paramètres de connexion à la base de données à utiliser pour Patchwork.
Voir le type d’enregistrement <patchwork-database-configuration>
pour
plus d’information.
secret-key-file
(par défaut : "/etc/patchwork/django-secret-key"
)Patchwork, en tant qu’application web Django, utilise une clé secrète pour signer des valeurs avec de la cryptographie. Ce fichier devrait contenir une valeur unique imprévisible.
Si ce fichier n’existe pas, il sera créé avec une valeur aléatoire par le service patchwork-setup.
Ce paramètre est lié à Django.
allowed-hosts
Une liste des hôtes valides pour ce service Patchwork. Cela doit au minimum
inclure le domaine spécifié dans l’enregistrement
<patchwork-configuration>
.
C’est un paramètre pour Django.
default-from-email
L’adresse de courriel sur laquelle Patchwork devrait envoyer les courriels par défaut.
C’est un paramètre de Patchwork.
static-url
(par défaut : #f
)L’URL à utiliser pour servir les ressources statiques. Cela peut être un
bout d’URL ou une URL complète, mais doit finir par /
.
Si la valeur par défaut est utilisée, la valeur static-path
de
<patchwork-configuration>
sera utilisée.
C’est un paramètre pour Django.
admins
(par défaut : '()
)Adresses de courriel auxquelles envoyer le détails des erreurs s’il y en a. Chaque valeur de la liste contient deux éléments, le nom et l’adresse de courriel.
C’est un paramètre pour Django.
debug?
(par défaut : #f
)Indique s’il faut lancer Patchwork en mode de débogage. Si la valeur est
#t
, les messages d’erreur détaillés seront affichés.
C’est un paramètre pour Django.
enable-rest-api?
(par défaut : #t
)Indique s’il faut activer l’API REST de Patchwork.
C’est un paramètre de Patchwork.
enable-xmlrpc?
(par défaut : #t
)Indique s’il faut active l’API RPC en XML.
C’est un paramètre de Patchwork.
force-https-links?
(par défaut : #t
)Indique s’il faut utiliser des liens HTTPS sur les pages de Patchwork.
C’est un paramètre de Patchwork.
extra-settings
(par défaut : ""
)Code supplémentaire à placer à la fin du module de paramètres de Patchwork.
Type de données représentant la configuration de la base de données de Patchwork.
engine
(par défaut : "django.db.backends.postgresql_psycopg2"
)Le moteur de base de données à utiliser.
name
(par défaut : "patchwork"
)Le nom de la base de données à utiliser.
user
(par défaut : "httpd"
)L’utilisateur à utiliser pour se connecter à la base de données.
password
(par défaut : ""
)Le mot de passe à utiliser lors de la connexion à la base de données.
host
(par défaut : ""
)L’hôte sur lequel se connecter à la base de données.
port
(par défaut : ""
)Le port sur lequel se connecter à la base de données.
Mumi is a Web interface to the Debbugs bug tracker, by default for the GNU instance. Mumi is a Web server, but it also fetches and indexes mail retrieved from Debbugs.
Le type de service pour Mumi.
Type de données représentant la configuration du service Mumi. Ce type a les champs suivants :
mumi
(par défaut : mumi
)Le paquet Mumi à utiliser.
mailer?
(par défaut : #true
)Indique s’il faut activer le composant d’envoie de courriels.
mumi-configuration-sender
L’adresse de courriel utilisée comme expéditeur pour les commentaires.
mumi-configuration-smtp
Une URI pour configurer les paramètres SMTP pour Mailutils. Cela peut être
quelque chose comme sendmail:///path/to/bin/msmtp
ou toute autre URI
prise en charge par Mailutils. Voir SMTP Mailboxes dans GNU Mailutils.
FastCGI est une interface entre le frontal et le moteur d’un service web. C’est un dispositif quelque peu désuet ; les nouveaux services devraient généralement juste parler HTTP entre le frontal et le moteur. Cependant il y a un certain nombre de services de moteurs comme PHP ou l’accès aux dépôts Git optimisé en HTTP qui utilisent FastCGI, donc nous le supportons dans Guix.
Pour utiliser FastCGI, vous configurez le serveur web frontal (p. ex.
nginx) pour envoyer un sous-ensemble de ses requêtes au moteur fastcgi, qui
écoute sur un socket UNIX ou TCP local. Il y a un programme fcgiwrap
intermédiaire qui se trouve entre le processus du moteur et le serveur web.
Le frontal indique quel moteur lancer, en passant cette information au
processus fcgiwrap
.
Un type de service pour le mandataire FastCGI fcgiwrap
.
Type de données représentant la configuration du service fcgiwrap
.
Ce type a les paramètres suivants :
package
(par défaut : fcgiwrap
)Le paquet fcgiwrap à utiliser.
socket
(par défaut : tcp:127.0.0.1:9000
)Le socket sur lequel le processus fcgiwrap
écoute, en tant que chaîne
de caractères. Les valeurs valides de socket sont
unix:/path/to/unix/socket
,
tcp:dot.ted.qu.ad:port
et
tcp6:[ipv6_addr]:port
.
user
(par défaut : fcgiwrap
)group
(par défaut : fcgiwrap
)Les noms de l’utilisateur et du groupe, en tant que chaînes de caractères,
sous lesquels lancer le processus fcgiwrap
. Le service
fastcgi
s’assurera que si l’utilisateur demande les noms
d’utilisateurs et de groupes fcgiwrap
l’utilisateur et le groupe
correspondant seront présents sur le système.
Il est possible de configurer un service web soutenu par FastCGI pour passer
les informations d’authentification HTTP depuis le frontal jusqu’au moteur,
et de permettre à fcgiwrap
dans lancer le processus de moteur avec
l’utilisateur local correspondant. Pour activer cette fonctionnalité sur le
moteur, lancez fcgiwrap
en tant qu’utilisateur et groupe
root
. Remarquez que cette fonctionnalité doit aussi être configurée
sur le frontal.
PHP-FPM (FastCGI Process Manager) est une implémentation FastCGI de PHP alternative avec quelques fonctionnalités supplémentaires utiles pour les sites de toutes tailles.
Ces fonctionnalités comprennent :
… et bien plus.
Un type de service pour php-fpm
.
Type de données pour la configuration du service php-fpm.
php
(par défaut : php
)Le paquet php à utiliser.
socket
(par défaut : (string-append "/var/run/php" (version-major (package-version php)) "-fpm.sock")
)L’adresse sur laquelle accepter les requêtes FastCGI. Les syntaxes valides sont :
"ip.add.re.ss:port"
Écoute sur un socket TCP sur l’adresse spécifiée sur un port spécifié.
"port"
Écoute sur un socket TCP sur toutes les adresse sur un port spécifique.
"/path/to/unix/socket"
Écoute sur un socket unix.
user
(par défaut : php-fpm
)Utilisateur à qui appartiendra le processus de travail de php.
group
(par défaut : php-fpm
)Groupe du processus de travail.
socket-user
(par défaut : php-fpm
)Utilisateur qui peut parler au socket php-fpm.
socket-group
(par défaut : nginx
)Groupe qui peut parler au socket php-fpm.
pid-file
(par défaut : (string-append "/var/run/php" (version-major (package-version php)) "-fpm.pid")
)Le pid de php-fpm est écrit dans ce fichier une fois que le service a démarré.
log-file
(par défaut : (string-append "/var/log/php" (version-major (package-version php)) "-fpm.log")
)Fichier de journal pour le processus maître de php-fpm.
process-manager
(par défaut : (php-fpm-dynamic-process-manager-configuration)
)Configuration détaillée pour le gestionnaire de processus de php-fpm. Il doit s’agir soit de :
<php-fpm-dynamic-process-manager-configuration>
<php-fpm-static-process-manager-configuration> ou
<php-fpm-on-demand-process-manager-configuration>
display-errors
(par défaut : #f
)Détermine si les erreurs et les avertissements php doivent être envoyés aux clients et affichés dans leur navigateur. Cela est utile pour un développement php local, mais un risque pour la sécurité pour les sites publics, comme les messages d’erreur peuvent révéler des mots de passes et des données personnelles.
timezone
(par défaut : #f
)Spécifie le paramètre php_admin_value[date.timezone]
.
workers-logfile
(par défaut : (string-append "/var/log/php" (version-major (package-version php)) "-fpm.www.log")
)Ce fichier enregistrera la sortie stderr
des processus de travail de
php. On peut indiquer #f
pour désactiver la journalisation.
file
(par défaut : #f
)Une version alternative de la configuration complète. Vous pouvez utiliser
la fonction mixed-text-file
ou un chemin de fichier absolu.
php-ini-file
(par défaut : #f
)Une version alternative de la configuration de php par défaut. Il peut
s’agir de n’importe quel objet « simili-fichier » (voir file-like objects). Vous pouvez utiliser la fonction
mixed-text-file
ou un chemin de fichier absolu.
Pour le développement local il est utile d’indiquer un long délai d’attente et une limite mémoire plus importante pour les processus php créés. Cela se fait avec les bouts de configuration systèmes suivants :
(define %local-php-ini (plain-file "php.ini" "memory_limit = 2G max_execution_time = 1800")) (operating-system ;; … (services (cons (service php-fpm-service-type (php-fpm-configuration (php-ini-file %local-php-ini))) %base-services)))
Consultez les principales directives de php.ini pour une documentation complète sur les directives php.ini possibles.
Type de données pour le gestionnaire de processus dynamic
de
php-fpm. Avec le gestionnaire de processus dynamic
, des processus de
travail de secours sont gardés en fonction des limites configurées.
max-children
(par défaut : 5
)Nombre maximum de processus de travail.
start-servers
(par défaut : 2
)Nombre de processus de travail au démarrage.
min-spare-servers
(par défaut : 1
)Nombre de processus de travail de secours minimum qui doivent rester à disposition.
max-spare-servers
(par défaut : 3
)Nombre maximum de processus de travail de secours qui peuvent rester à disposition.
Type de données pour le gestionnaire de processus static
de php-fpm.
Avec le gestionnaire de processus static
, un nombre constant de
processus de travail est créé.
max-children
(par défaut : 5
)Nombre maximum de processus de travail.
Type de données pour le gestionnaire de processus on-demand
de
php-fpm. Avec le gestionnaire de processus on-demand
, les processus
de travail ne sont créés que lorsque les requêtes arrivent.
max-children
(par défaut : 5
)Nombre maximum de processus de travail.
process-idle-timeout
(par défaut : 10
)La durée en secondes après laquelle un processus sans requête sera tué.
Une fonction d’aide pour ajouter rapidement php à un
nginx-server-configuration
.
Une configuration simple de services pour php ressemble à ceci :
(services (cons* (service dhcp-client-service-type)
(service php-fpm-service-type)
(service nginx-service-type
(nginx-server-configuration
(server-name '("example.com"))
(root "/srv/http/")
(locations
(list (nginx-php-location)))
(listen '("80"))
(ssl-certificate #f)
(ssl-certificate-key #f)))
%base-services))
Le générateur d’avatar de chat est un simple service pour démontrer
l’utilisation de php-fpm dans Nginx
. Il permet de générer des
avatars de chats à partir d’une graine, par exemple le hash de l’adresse de
courriel d’un utilisateur.
Renvoie un nginx-server-configuration qui hérite de configuration
.
Il étend la configuration nginx pour ajouter un bloc de serveur qui sert
package
, une version de cat-avatar-generator. Pendant l’exécution,
cat-avatar-generator pourra utiliser cache-dir
comme répertoire de
cache.
Une configuration simple de cat-avatar-generator ressemble à ceci :
(services (cons* (cat-avatar-generator-service
#:configuration
(nginx-server-configuration
(server-name '("example.com"))))
...
%base-services))
Le programme hpcguix-web est une interface web personnalisable pour naviguer dans les paquets Guix, initialement conçue pour les utilisateurs des grappes de calcul de haute performance (HPC).
Le type de service pour hpcguix-web
.
Type de données pour la configuration du service hpcguix-web.
specs
(par défaut : #f
)Soit #f
, soit une gexp (voir G-Expressions) qui spécifie la
configuration du service hpcguix-web en tant qu’enregistrement
hpcguix-web-configuration
. Les principaux champs de ce type
d’enregistrement sont :
title-prefix
(par défaut : "hpcguix | "
)Le préfixe du titre des pages.
guix-command
(par défaut : "guix"
)La commande guix
à utiliser dans les exemples qui apparaissent sur
les pages HTML.
package-filter-proc
(par défaut : (const #t)
)Une procédure qui spécifie comment filtrer les paquets qui seront affichés.
package-page-extension-proc
(par défaut : (const '())
)Paquet d’extensions pour hpcguix-web
.
menu
(par défaut : '()
)Entrée supplémentaire dans la page menu
.
channels
(par défaut : %default-channels
)Liste des canaux depuis lesquels la liste des paquets est construite (voir Canaux).
package-list-expiration
(par défaut : (* 12 3600)
)Le temps d’expiration, en secondes, après lequel la liste des paquets est reconstruite depuis les dernières instance des canaux donnés.
Voir le dépôt hpcguix-web pour un exemple complet.
package
(par défaut : hpcguix-web
)Le paquet hpcguix-web à utiliser.
address
(par défaut : "127.0.0.1"
)L’adresse IP sur laquelle écouter.
port
(par défaut : 5000
)Le numéro de port sur lequel écouter.
Une déclaration de service hpcguix-web typique ressemble à cela :
(service hpcguix-web-service-type
(hpcguix-web-configuration
(specs
#~(hpcweb-configuration
(title-prefix "Guix-HPC - ")
(menu '(("/about" "ABOUT")))))))
Remarque : Le service hpcguix-web met régulièrement à jour la liste des paquets qu’il publie en récupérant les canaux depuis Git. Pour cela, il doit accéder aux certificats X.509 pour qu’il puisse authentifier les serveurs Git quand il communique en HTTPS, et il suppose que /etc/ssl/certs contient ces certificats.
A certificate package,
nss-certs
, is provided by default as part of%base-packages
. Certificats X.509, for more information on X.509 certificates.
Le programme gmnisrv est un serveur simple pour le protocole Gemini.
C’est le type du service gmnisrv, dont la valeur devrait être un objet
gmnisrv-configuration
comme dans cet exemple :
(service gmnisrv-service-type
(gmnisrv-configuration
(config-file (local-file "./my-gmnisrv.ini"))))
Type données qui représente la configuration de gmnisrv.
package
(par défaut : gmnisrv)Objet de paquet du serveur gmnisrv.
config-file
(par défaut : %default-gmnisrv-config-file
)Objet simili-fichier du fichier de configuration de gmnisrv à utiliser. La
configuration par défaut écoute sur le port 1965 et sert les fichiers de
/srv/gemini. Les certificats sont stockés dans
/var/lib/gemini/certs. Pour plus d’informations, lancez man
gmnisrv
et man gmnisrv.ini
.
Le programme Agate (page GitHub sur HTTPS) est un serveur simple pour le protocole Gemini écrit en Rust.
C’est le type du service agate, dont la valeur devrait être un objet
agate-service-type
comme dans cet exemple :
(service agate-service-type
(agate-configuration
(content "/srv/gemini")
(certificates "/srv/gemini-certs")))
The example above represents the minimal tweaking necessary to get Agate up and running. Specifying the path to the certificate and key directory is always necessary, as the Gemini protocol requires TLS by default.
If the specified certificates
path is writable by Agate, and contains
no valid pre-generated key and certificate, Agate will try to generate them
on the first start. In this case you should pass at least one hostname
using the hostnames
option. If the specified directory is read-only,
key and certificate should be pre-generated by the user.
To obtain a certificate and a key in DER format, you could, for example, use OpenSSL, running commands similar to the following example:
openssl genpkey -out key.der -outform DER -algorithm RSA \ -pkeyopt rsa_keygen_bits:4096 openssl req -x509 -key key.der -outform DER -days 3650 -out cert.der \ -subj "/CN=example.com"
Of course, you’ll have to replace example.com with your own domain name,
and then point the Agate configuration towards the path of the directory
with the generated key and certificate using the certificates
option.
Type de données représentant la configuration d’Agate.
package
(par défaut : agate
)Objet de paquet du serveur Agate.
content
(par défaut : "/srv/gemini")Le répertoire à partir duquel Agate servira ses fichiers.
certificates
(default: "/srv/gemini-certs")Root of the certificate directory. Must be filled in with a value from the user.
addresses
(default: '("[::]:1965" "0.0.0.0:1965")
)Une liste des adresses sur lesquelles écouter.
hostnames
(default: '()
)Virtual hosts for the Gemini server. If multiple values are specified,
corresponding directory names should be present in the content
directory. Optional.
languages
(default: #f
)Codes de langues RFC 4646 pour les documents text/gemini. Facultatif.
only-tls13?
(default: #f
)Set to #t
to disable support for TLSv1.2.
serve-secret?
(par défaut : #f
)Indiquez #t
pour servir des fichiers secrets (des fichiers et
répertoires commençant par un point).
central-configuration?
(default: #f
)Set to #t
to look for the .meta configuration file in the
content
root directory and will ignore .meta
files in other
directories
ed25519?
(default: #f
)Set to #t
to generate keys using the Ed25519 signature algorithm
instead of the default ECDSA.
skip-port-check?
(default: #f
)Set to #t
to skip URL port check even when a hostname
is
specified.
log-ip?
(par défaut : #t
)Indique si l’adresse IP de sortie doit être journalisée.
user
(par défaut : "agate"
)Propriétaire du processus agate
.
group
(par défaut : "agate"
)Groupe du propriétaire du processus agate
.
log-file
(par défaut : "/var/log/agate.log"
)Le fichier qui devrait contenir la sortie de journal d’Agate.
Suivant: Services DNS, Précédent: Services web, Monter: Services [Table des matières][Index]
Le module (gnu services certbot)
fournit un service qui récupère
automatiquement un certificat TLS valide de l’autorité de certification
Let’s Encrypt. Ces certificats peuvent ensuite être utilisés pour servir du
contenu de manière sécurisée sur HTTPS et d’autres protocoles basés sur TLS,
en sachant que le client sera capable de vérifier l’authenticité du serveur.
Let’s Encrypt fournit l’outil certbot
pour automatiser le processus de certification. Cet outil génère d’abord un
clef sur le serveur de manière sécurisée. Ensuite il demande à l’autorité
de certification Let’s Encrypt de signer la clef. La CA vérifie que la
requête provient de l’hôte en question en utilisant un protocole de
défi-réponse, ce qui requiert que le serveur fournisse sa réponse par
HTTP. Si ce protocole se passe sans encombre, la CA signe la clef et on
obtient un certificat. Ce certificat est valide pour une durée limitée et
donc, pour continuer à fournir des services en TLS, le serveur doit
régulièrement demander à la CA de renouveler sa signature.
Le service certbot automatise ce processus : la génération initiale de la clef, la demande de certification initiale au service Let’s Encrypt, l’intégration du protocole de défi/réponse dans le serveur web, l’écriture du certificat sur le disque, les renouvellements périodiques et les tâches de déploiement avec le renouvellement (p. ex. recharger les services, copier les clefs avec d’autres permissions).
Certbot est lancé deux fois par jour, à une minute aléatoire dans l’heure. Il ne fera rien sauf si vos certificats doivent être renouvelés ou sont révoqués, mais le lancer régulièrement permettra à vos services de rester en ligne si Let’s Encrypt décide de révoquer votre certificat.
En utilisant ce service, vous acceptez le document « ACME Subscriber Agreement », qu’on peut trouver ici : https://acme-v01.api.letsencrypt.org/directory.
Un type de service pour le client Let’s Encrypt certbot
. Sa valeur
doit être un enregistrement certbot-configuration
comme dans cet
exemple :
(service certbot-service-type
(certbot-configuration
(email "foo@example.net")
(certificates
(list
(certificate-configuration
(domains '("example.net" "www.example.net")))
(certificate-configuration
(domains '("bar.example.net")))))))
Voir plus bas pour des détails sur certbot-configuration
.
Type données représentant la configuration du service certbot
. Ce
type a les paramètres suivants :
package
(par défaut : certbot
)Le paquet certbot à utiliser.
webroot
(par défaut : /var/www
)Le répertoire depuis lequel servir les fichiers du défi/réponse de Let’s Encrypt.
certificates
(par défaut : '()
)Une liste de certificates-configuration
pour lesquels générer des
certificats et demander des signatures. Chaque certificat a un name
et plusieurs domains
.
email
(par défaut : #f
)Adresse de courriel facultative pour la création de compte et le contact de récupération de compte. Il est recommandé de l’indiquer car cela vous permet de recevoir des notifications importantes à propos de votre compte et des certificats créés.
server
(par défaut : #f
)URL facultative d’un serveur ACME. Indiquer ce paramètre remplace la valeur de certbot par défaut, qui est le serveur de Let’s Encrypt.
rsa-key-size
(par défaut : 2048
)Taille de la clef RSA.
default-location
(par défaut : voir plus bas)Le nginx-location-configuration
par défaut. Comme certbot
doit pouvoir servir les défis et les réponses, il doit être capable de
lancer un serveur web. Cela se fait en étendant le service web nginx
avec un nginx-server-configuration
qui écoute sur les domains
sur le port 80 et qui a un nginx-location-configuration
pour le
chemin /.well-known/
utilisé par Let’s Encrypt. Voir Services web
pour plus d’information sur les types de données de la configuration de
nginx.
Les requêtes vers d’autres URL correspondra à default-location
, qui,
s’il est présent, sera ajout é à tous les nginx-server-configuration
.
Par défaut, le default-location
sera une redirection de
http://domain/…
vers https://domain/…
, en vous
laissant définir ce que vous voulez servir sur votre site en https
.
Passez #f
pour ne pas utiliser de location par défaut.
Type de données représentant la configuration d’un certificat. Ce type a les paramètres suivants :
name
(par défaut : voir plus bas)Ce nom est utilisé par Certbot pour ses tâches quotidiennes et dans les
chemins de fichiers ; il n’affecte pas le contenu des certificats
eux-mêmes. Pour voir les noms des certificats, lancez certbot
certificates
.
Sa valeur par défaut est le premier domaine spécifié.
domains
(par défaut : '()
)Le premier domaine spécifié sera le CN du sujet du certificat, et tous les domaines seront les noms alternatifs du sujet dans le certificat.
challenge
(par défaut : #f
)Le type de défi à utiliser avec certbot. Si #f
est spécifié, le défi
HTTP par défaut sera utilisé. Si une valeur est spécifiée, le greffon
manuel sera utilisé par défaut (voir authentication-hook
,
cleanup-hook
et la documentation sur
https://certbot.eff.org/docs/using.html#hooks), et donne à Let’s
Encrypt la permission d’enregistrer l’adresse IP publique de la machine qui
a fait la demande.
csr
(par défaut : #f
)Nom de fichier d’une Demande de Signature de Certificat (CSR) au format DER
ou PEM. Si #f
est spécifié, cet argument ne sera pas passé à
certbot
. Si une valeur est spécifiée, certbot
l’utilisera pour
obtenir un certificat, au lieu d’utiliser une CSR auto-signée. Le(s) nom(s)
de domaine mentionné(s) dans domains
doivent être en cohérence avec
ceux mentionné(s) dans le fichier CSR.
authentication-hook
(par défaut : #t
)Commande à lancer dans un shell une fois par défi de certificat auquel
répondre. Pour cette commande, la variable shell $CERTBOT_DOMAIN
contiendra le domaine à authentifier, $CERTBOT_VALIDATION
contiendra
la chaîne de validation et $CERTBOT_TOKEN
contiendra le nom de
fichier de la ressource demandée pour le défi HTTP-01.
cleanup-hook
(par défaut : #f
)Commande à lancer dans un shell une fois par défi de certificat auquel
auth-hook
a répondu. Pour cette commande, les variables shell
disponibles dans le script auth-hook
sont toujours disponibles, et en
plus $CERTBOT_AUTH_OUTPUT
contiendra la sortie standard du script
auth-hook
.
deploy-hook
(par défaut : #f
)Commande à lancer dans un shell une fois par certificat récupéré avec
succès. Pour cette commande, la variable $RENEWED_LINEAGE
pointera
sur le sous-répertoire live (par exemple,
‘"/etc/letsencrypt/live/example.com"’) contenant le nouveau certificat
et la clef ; la variable $RENEWED_DOMAINS
contiendra les noms de
domaines séparés par des espaces (par exemple ‘"example.com
www.example.com"’).
start-self-signed?
(default: #t
)Whether to generate an initial self-signed certificate during system
activation. This option is particularly useful to allow nginx
to
start before certbot
has run, because certbot
relies on
nginx
running to perform HTTP challenges.
Pour chaque certificate-configuration
, le certificat est sauvegardé
dans /etc/certs/name/fullchain.pem
et la clef est sauvegardée
dans /etc/certs/name/privkey.pem
.
Suivant: Services VNC, Précédent: Services de certificats, Monter: Services [Table des matières][Index]
Le module (gnu services dns)
fournit des services liés au
système de noms de domaines (DNS). Il fournit un service de serveur
pour héberger un serveur DNS faisant autorité pour plusieurs zones,
en esclave ou en maître. Ce service utilise Knot DNS. Il fournit aussi un service de cache et de renvoie DNS pour le
LAN, qui utilise dnsmasq.
Voici un exemple de configuration pour un serveur faisant autorité sur deux zone, un maître et un esclave :
(define-zone-entries example.org.zone ;; Name TTL Class Type Data ("@" "" "IN" "A" "127.0.0.1") ("@" "" "IN" "NS" "ns") ("ns" "" "IN" "A" "127.0.0.1")) (define master-zone (knot-zone-configuration (domain "example.org") (zone (zone-file (origin "example.org") (entries example.org.zone))))) (define slave-zone (knot-zone-configuration (domain "plop.org") (dnssec-policy "default") (master (list "plop-master")))) (define plop-master (knot-remote-configuration (id "plop-master") (address (list "208.76.58.171")))) (operating-system ;; ... (services (cons* (service knot-service-type (knot-configuration (remotes (list plop-master)) (zones (list master-zone slave-zone)))) ;; ... %base-services)))
C’est le type pour le serveur DNS Knot.
Knot DNS est un serveur DNS faisant autorité, ce qui signifie qu’il peut servir plusieurs zones, c’est-à-dire des noms de domaines que vous achetez à un registrar. Ce serveur n’est pas un résolveur, ce qui signifie qu’il ne peut pas résoudre les noms pour lesquels il ne fait pas autorité. Ce serveur peut être configuré pour servir des zones comme un serveur maître ou comme un serveur esclave, en fonction des zones. Les zones esclaves récupèrent leurs données des maîtres, et seront servies comme faisant autorité. Du point de vue d’un résolveur, il n’y a pas de différence entre un maître et un esclave37.
Les types de données suivants sont utilisés pour configurer le serveur DNS Knot :
Type de données représentant une clef. Ce type a les paramètres suivants :
id
(par défaut : ""
)Un identifiant pour d’autres champs de configuration qui se réfèrent à cette clef. Les ID doivent être uniques et non vides.
algorithm
(par défaut : #f
)L’algorithme à utiliser. Choisissez entre #f
, 'hmac-md5
,
'hmac-sha1
, 'hmac-sha224
, 'hmac-sha256
,
'hmac-sha384
et 'hmac-sha512
.
secret
(par défaut : ""
)La clef secrète elle-même.
Type de données représentant une configuration de liste de contrôle d’accès (ACL). Ce type a les paramètres suivants :
id
(par défaut : ""
)Un identifiant pour d’autres champs de configuration qui se réfèrent à cette clef. Les ID doivent être uniques et non vides.
address
(par défaut : '()
)Une liste ordonnée d’adresses IP, de sous-réseaux ou d’intervalles de réseaux représentés par des chaînes de caractères. La requête doit correspondre à l’une d’entre elles. La valeur vide signifie que l’adresse n’a pas besoin de correspondre.
key
(par défaut : '()
)Une liste ordonnées de références à des clefs représentés par des chaînes.
La chaîne doit correspondre à un ID définie dans un
knot-key-configuration
. Aucune clef signifie qu’une clef n’est pas
nécessaire pour correspondre à l’ACL.
action
(par défaut : '()
)Une liste ordonnée d’actions permises ou interdites par cet ACL. Les
valeurs possibles sont une liste de zéro ou plus d’éléments entre
'transfer
, 'notify
et 'update
.
deny?
(par défaut : #f
)Lorsque la valeur est vraie, l’ACL définie des restrictions. Les actions listées sont interdites. Lorsque la valeur est fausse, les actions listées sont autorisées.
Type de données représentant une entrée dans un fichier de zone. Ce type a les paramètres suivants :
name
(par défaut : "@"
)Le nom de l’enregistrement. "@"
se réfère à l’origine de la zone.
Les noms sont relatifs à l’origine de la zone. Par exemple, dans la zone
example.org
, "ns.example.org"
se réfère en fait à
ns.example.org.example.org
. Les noms qui finissent par un point sont
absolus, ce qui signifie que "ns.example.org."
se réfère bien à
ns.example.org
.
ttl
(par défaut : ""
)La durée de vie (TTL) de cet enregistrement. S’il n’est pas indiqué, le TTL par défaut est utilisé.
class
(par défaut : "IN"
)La classe de l’enregistrement. Knot ne supporte actuellement que
"IN"
et partiellement "CH"
.
type
(par défaut : "A"
)Le type d’enregistrement. Les types usuels sont A (une adresse IPv4), NS (serveur de nom) et MX (serveur de courriel). Bien d’autres types sont définis.
data
(par défaut : ""
)Les données contenues dans l’enregistrement. Par exemple une adresse IP associée à un enregistrement A, ou un nom de domaine associé à un enregistrement NS. Rappelez-vous que les noms de domaines sont relatifs à l’origine à moins qu’ils ne finissent par un point.
Type données représentant le contenu d’un fichier de zone. Ce type a les paramètres suivants :
entries
(par défaut : '()
)La liste des entrées. On s’occupe de l’enregistrement SOA, donc vous n’avez
pas besoin de l’ajouter dans la liste des entrées. Cette liste devrait
contenir une entrée pour votre serveur DNS primaire faisant autorité. En
plus d’utiliser une liste des entrées directement, vous pouvez utiliser
define-zone-entries
pour définir un objet contenant la liste des
entrées plus facilement, que vous pouvez ensuite passer au champ
entries
de zone-file
.
origin
(par défaut : ""
)Le nom de votre zone. Ce paramètre ne peut pas être vide.
ns
(par défaut : "ns"
)Le domaine de votre serveur DNS primaire faisant autorité. Le nom est relatif à l’origine, à moins qu’il finisse par un point. Il est nécessaire que ce serveur DNS primaire corresponde à un enregistrement NS dans la zone et qu’il soit associé à une adresse IP dans la liste des entrées.
mail
(par défaut : "hostmaster"
)Une adresse de courriel pour vous contacter en tant que propriétaire de la
zone. Cela se transforme en <mail>@<origin>
.
serial
(par défaut : 1
)Le numéro de série de la zone. Comme c’est utilisé pour vérifier les changements à la fois par les esclaves et par les résolveurs, il est nécessaire qu’il ne décroisse jamais. Incrémentez-le toujours quand vous faites un changement sur votre zone.
refresh
(par défaut : (* 2 24 3600)
)La fréquence à laquelle les esclaves demanderont un transfert de zone.
Cette valeur est un nombre de secondes. On peut le calculer avec des
multiplications ou avec (string->duration)
.
retry
(par défaut : (* 15 60)
)La période après laquelle un esclave essaiera de contacter son maître lorsqu’il échoue à le faire la première fois.
expiry
(par défaut : (* 14 24 3600)
)TTL par défaut des enregistrements. Les enregistrements existants sont considérés corrects pour au moins cette durée. Après cette période, les résolveurs invalideront leur cache et vérifieront de nouveau qu’ils existent toujours.
nx
(par défaut : 3600
)TTL par défaut des enregistrement inexistants. Ce TTL est habituellement court parce que vous voulez que vous nouveaux domaines soient disponibles pour tout le monde le plus rapidement possible.
Type de données représentant une configuration de serveurs distants. Ce type a les paramètres suivants :
id
(par défaut : ""
)Un identifiant pour que les autres champs de configuration se réfèrent à ce serveur distant. les ID doivent être uniques et non vides.
address
(par défaut : '()
)Une liste ordonnée d’adresses IP de destination. Ces adresses sont essayées
en séquence. Un port facultatif peut être donné avec le séparateur @. Par
exemple (list "1.2.3.4" "2.3.4.5@53")
. Le port par défaut est le
53.
via
(par défaut : '()
)Une liste ordonnée d’adresses IP sources. Une liste vide fera choisir une IP source appropriée à Knot. Un port facultatif peut être donné avec le séparateur @. La valeur par défaut est de choisir aléatoirement.
key
(par défaut : #f
)Une référence à une clef, c’est-à-dire une chaîne contenant l’identifiant
d’une clef définie dans un champ knot-key-configuration
.
Type de données représentant une base de clefs pour garder les clefs dnssec. Ce type a les paramètres suivants :
id
(par défaut : ""
)L’id de cette base de clefs. Il ne doit pas être vide.
backend
(par défaut : 'pem
)Le moteur de stockage des clefs. Cela peut être 'pem
ou
'pkcs11
.
config
(par défaut : "/var/lib/knot/keys/keys"
)La chaine de configuration du moteur. Voici un exemple pour PKCS#11 :
"pkcs11:token=knot;pin-value=1234
/gnu/store/.../lib/pkcs11/libsofthsm2.so"
. Pour le moteur pem, la chaine
représente un chemin dans le système de fichiers.
Type de données représentant une politique dnssec. Knot DNS est capable de signer automatiquement vos zones. Il peut soit générer et gérer vos clefs automatiquement ou utiliser des clefs que vous générez.
Dnssec est habituellement implémenté avec deux clefs : une KSK (key signing key) qui est utilisé pour signer une seconde, la ZSK (zone signing key) qui est utilisée pour signer la zone. Pour pouvoir être de confiance, la KSK doit être présente dans la zone parente (normalement un domaine de haut niveau). Si votre registrar supporte dnssec, vous devrez leur envoyer le hash de votre KSK pour qu’il puisse ajouter un enregistrement DS dans la zone parente. Ce n’est pas automatique et vous devrez le faire à chaque fois que vous changerez votre KSK.
La politique définie aussi la durée de vie des clefs. Habituellement, la ZSK peut être changée facilement et utilise des fonctions cryptographiques plus faibles (avec un paramètre plus faible) pour signer les enregistrements rapidement, donc elles sont changées très régulièrement. La KSK en revanche requiert une interaction manuelle avec le registrar, donc elle change moins souvent et utilise des paramètres plus robustes puisqu’elle ne signe qu’un seul enregistrement.
Ce type a les paramètres suivants :
id
(par défaut : ""
)L’id de la politique. Il ne doit pas être vide.
keystore
(par défaut : "default"
)Une référence à une base de clefs, c’est-à-dire une chaîne contenant
l’identifiant d’une base de clefs définie dans un champ
knot-keystore-configuration
. L’identifiant "default"
signifie
la base par défaut (une base de données kasp initialisée par ce service).
manual?
(par défaut : #f
)Indique si la clef est gérée manuellement ou automatiquement.
single-type-signing?
(par défaut : #f
)Lorsque la valeur est #t
, utilise le schéma de signature Single-Type.
algorithm
(par défaut : "ecdsap256sha256"
)Un algorithme de clef de signature et de signatures.
ksk-size
(par défaut : 256
)La longueur de la KSK. Remarquez que cette valeur est correcte pour l’algorithme par défaut, mais ne serait pas sécurisée pour d’autres algorithmes.
zsk-size
(par défaut : 256
)La longueur de la ZSK. Remarquez que cette valeur est correcte pour l’algorithme par défaut, mais ne serait pas sécurisée pour d’autres algorithmes.
dnskey-ttl
(par défaut : 'default
)La valeur du TTL pour les enregistrements DNSKEY ajoutés au sommet de la
zone. La valeur spéciale 'default
signifie la même valeur que le TTL
du SOA de la zone.
zsk-lifetime
(par défaut : (* 30 24 3600)
)La période entre la publication d’une ZSK et l’initialisation d’un nouveau changement.
propagation-delay
(par défaut : (* 24 3600)
)Un délai supplémentaire pour chaque étape du changement. Cette valeur devrait être assez grande pour couvrir le temps de propagation des données entre le serveur primaire et tous les secondaires.
rrsig-lifetime
(par défaut : (* 14 24 3600)
)Une période de validité des nouvelles signatures.
rrsig-refresh
(par défaut : (* 7 24 3600)
)Une période qui indique combien de temps avant l’expiration d’une signature elle sera rafraîchie.
nsec3?
(par défaut : #f
)Lorsque la valeur est #t
, on utilisera NSEC3 au lien de NSEC.
nsec3-iterations
(par défaut : 5
)Le nombre de fois supplémentaires que le hash est effectué.
nsec3-salt-length
(par défaut : 8
)La longueur du champ de sel en octets, ajouté au nom du propriétaire avant de hasher.
nsec3-salt-lifetime
(par défaut : (* 30 24 3600)
)La période de validité des nouveaux champs sel.
Type de données représentant la zone servie par Knot. ce type a les paramètres suivants :
domain
(par défaut : ""
)Le domaine servi par cette configuration. Il ne doit pas être vide.
file
(par défaut : ""
)Le fichier où la zone est sauvegardée. Ce paramètre est ignoré pour les zones maîtres. La valeur vide signifie l’emplacement par défaut qui dépend du nom de domaine.
zone
(par défaut : (zone-file)
)Le contenu du fichier de zone. Ce paramètre est ignoré par les zones esclaves. Il doit contenir un enregistrement zone-file.
master
(par défaut : '()
)Une liste des serveurs distants maîtres. Lorsque la liste est vide, cette zone est un maître. Lorsque la valeur est indiquée, cette zone est un esclave. C’est al liste des identifiants des serveurs distants.
ddns-master
(par défaut : #f
)Le maître principal. Lorsque la valeur est vide, la valeur par défaut est le premier maître de la liste des maîtres.
notify
(par défaut : '()
)Une liste d’identifiants de groupe de serveurs esclaves.
acl
(par défaut : '()
)Une liste d’identifiants d’ACL.
semantic-checks?
(par défaut : #f
)Lorsque la valeur est indiquée, cela ajoute plus de vérifications sémantiques à la zone.
zonefile-sync
(par défaut : 0
)Le délai entre une modification en mémoire et sur le disque. 0 signifie une synchronisation immédiate.
zonefile-load
(par défaut : #f
)La manière dont le contenu du fichier de zone influe sur le chargement de la zone. Les valeurs possibles sont :
#f
pour utilise la valeur par défaut de Knot,
'none
pour ne pas utiliser le fichier de zone du tout,
'difference
pour calculer les différences entre le contenu déjà disponible
et le contenu du fichier de zone et les appliquer au contenu actuel de la
zone,
'difference-no-serial
pour la même chose que 'difference
, mais
en ignorant le serial du SOA du fichier de zone, pour que le serveur s’en
charge automatiquement.
'whole
pour charger le contenu de la zone depuis le fichier de zone.
journal-content
(par défaut : #f
)La manière dont le journal est utilisé pour stocker la zone et ses
changements. Les valeurs possibles sont 'none
pour ne pas l’utiliser
du tout, 'changes
pour stocker les changements et 'all
pour
stocker le contenu. #f
ne met pas en place cette option et la valeur
par défaut de Knot est utilisée.
max-journal-usage
(par défaut : #f
)La taille maximale du journal sur le disque. #f
ne met pas en place
cette option et la valeur par défaut de Knot est utilisée.
max-journal-depth
(par défaut : #f
)La taille maximale de l’historique. #f
ne met pas en place cette
option et la valeur par défaut de Knot est utilisée.
max-zone-size
(par défaut : #f
)La taille maximale du fichier de zone. Cette limite est prise en charge
pour les transferts entrants et les mises à jour. #f
ne met pas en
place cette option et la valeur par défaut de Knot est utilisée.
dnssec-policy
(par défaut : #f
)Une référence à un enregistrement knot-policy-configuration
, ou le
nom spécial "default"
. Si la valeur est #f
, cette zone n’est
pas signée.
serial-policy
(par défaut : 'increment
)Une politique entre 'increment
et 'unixtime
.
Type de données représentant la configuration de Knot. Ce type a les paramètres suivants :
knot
(par défaut : knot
)Le paquet Knot.
run-directory
(par défaut : "/var/run/knot"
)Le répertoire de travail. Ce répertoire sera utilisé pour le fichier pid et les sockets.
includes
(par défaut : '()
)Une liste plate de chaînes ou d’objets simili-fichiers qui seront inclus en haut du fichier de configuration.
Cela peut être utile pour gérer des secrets hors-bande. Par exemple, on
peut stocker des clefs secrètes dans un fichier hors-bande qui n’est pas
géré par Guix, et donc pas visible dans /gnu/store — p. ex. vous
pouvez stocker la configuration des clefs secrètes dans
/etc/knot/secrets.conf et ajouter ce fichier à la lite
includes
.
On peut générer une clé secrète tsig (pour nsupdate et les transferts de zones) avec la commande keymgr du paquet knot. Remarquez que le paquet n’est pas automatiquement installé par le service. L’exemple suivant montre comment générer une nouvelle clé tsig :
keymgr -t mysecret > /etc/knot/secrets.conf chmod 600 /etc/knot/secrets.conf
Remarquez aussi que la clé générée sera nommée mysecret, donc c’est le
nom qui est requis dans le champ key de l’enregistrement
knot-acl-configuration
et aux autres endroits qui se réfèrent à cette
clé.
Cela peut aussi être utilisé pour ajouter des configurations qui ne sont pas prises en charge par cette interface.
listen-v4
(par défaut : "0.0.0.0"
)Une adresse IP sur laquelle écouter.
listen-v6
(par défaut : "::"
)Une adresse IP sur laquelle écouter.
listen-port
(par défaut : 53
)Un port sur lequel écouter.
keys
(par défaut : '()
)La liste des knot-key-configuration utilisés par cette configuration.
acls
(par défaut : '()
)La liste des knot-acl-configuration utilisés par cette configuration.
remotes
(par défaut : '()
)La liste des knot-remote-configuration utilisés par cette configuration.
zones
(par défaut : '()
)La liste des knot-zone-configuration utilisés par cette configuration.
C’est le type du service de résolution de knot, dont la valeur devrait être
un objet knot-resolver-configuration
comme dans cet exemple :
(service knot-resolver-service-type
(knot-resolver-configuration
(kresd-config-file (plain-file "kresd.conf" "
net.listen('192.168.0.1', 5353)
user('knot-resolver', 'knot-resolver')
modules = { 'hints > iterate', 'stats', 'predict' }
cache.size = 100 * MB
"))))
Pour plus d’information, consultez son manuel.
Type de données représentant la configuration de knot-resolver.
package
(par défaut : knot-resolver)Objet de paquet du résolveur DNS knot.
kresd-config-file
(par défaut : %kresd.conf)Objet simili-fichier du fichier de configuration de kresd à utiliser. Par
défaut il écoutera sur 127.0.0.1
et ::1
.
garbage-collection-interval
(par défaut : 1000)Nombre de millisecondes correspondant à la périodicité avec laquelle
kres-cache-gc
nettoie le cache.
C’est le type du service dnsmasq, dont la valeur devrait être un objet
dnsmasq-configuration
comme dans cet exemple :
(service dnsmasq-service-type
(dnsmasq-configuration
(no-resolv? #t)
(servers '("192.168.1.1"))))
Type de données qui représente la configuration de dnsmasq.
package
(par défaut : dnsmasq)L’objet de paquet du serveur dnsmasq.
no-hosts?
(par défaut : #f
)Lorsque la valeur est vraie, ne pas lire les noms d’hôte dans /etc/hosts.
port
(par défaut : 53
)Le port sur lequel écouter. Le mettre à zéro désactive complètement les réponses DNS, ce qui ne laisse que les fonctions DHCP et TFTP.
local-service?
(par défaut : #t
)Accepte les requêtes DNS seulement des hôtes dont les adresses sont sur le sous-réseau local, c.-à-d. sur un sous-réseau pour lequel une interface existe sur le serveur.
listen-addresses
(par défaut : '()
)Écoute sur le adresses IP données.
resolv-file
(par défaut : "/etc/resolv.conf"
)Le fichier où lire l’adresse IP des serveurs de noms en amont.
no-resolv?
(par défaut : #f
)Lorsque la valeur est vraie, ne pas lire resolv-file.
forward-private-reverse-lookup?
(par défaut : #t
)Lorsque la valeur est fausse, toutes les requêtes inverses pour les intervalles d’IP privées reçoivent la réponse « le domaine n’existe pas » plutôt qu’être renvoyé en amont.
query-servers-in-order?
(par défaut : #f
)Lorsque la valeur est vraie, dnsmasq demande aux serveurs dans le même ordre qu’ils apparaissent dans servers.
servers
(par défaut : '()
)Spécifiez l’adresse IP des serveurs en amont directement.
servers-file
(par défaut : #f
)Specify file containing upstream servers. This file is re-read when dnsmasq receives SIGHUP. Could be either a string or a file-like object.
addresses
(par défaut : '()
)Pour chaque entrée, spécifie une adresse IP à renvoyer pour les hôtes des domaines donnés. Les requêtes dans les domaines ne sont jamais envoyés et la réponse sera toujours l’adresse IP spécifiée.
C’est utile pour rediriger des hôtes localement, comme dans cet exemple :
(service dnsmasq-service-type
(dnsmasq-configuration
(addresses
'(; Redirige vers un serveur web local.
"/example.org/127.0.0.1"
; Redirige un sous-domaine vers une adresse IP spécifique.
"/subdomain.example.org/192.168.1.42"))))
Remarquez que les règles dans /etc/hosts prennent le pas sur celles-ci.
cache-size
(par défaut : 150
)Indique la taille du cache de dnsmasq. Indiquer 0 désactive le cache.
negative-cache?
(par défaut : #t
)Lorsque la valeur est fausse, désactive le cache des réponses négatives.
cpe-id
(par défaut : #f
)Si une valeur est indiquée, ajoute un identifiant CPE (Customer-Premises Equipment) aux requêtes DNS qui sont renvoyées en amont.
tftp-enable?
(par défaut : #f
)Indique s’il faut activer le serveur TFTP inclus.
tftp-no-fail?
(par défaut : #f
)Si la valeur est vraie, dnsmasq n’échoue pas si le serveur TFTP ne peut pas démarrer.
tftp-single-port?
(par défaut : #f
)Indique s’il faut utiliser un seul port pour TFTP.
tftp-secure?
(par défaut : #f
)Si la valeur est vraie, seuls les fichiers appartenant à l’utilisateur sous lequel tourne dnsmasq sont accessibles.
Si dnsmasq est lancé en root, des règles différentes s’appliquent :
tft-secure?
n’a pas d’effet, mais seuls les fichiers qui ont le bit
de lecture pour tout le monde sont accessibles.
tftp-max
(par défaut : #f
)Si une valeur est indiquée, indique le nombre maximal de connexions permises en parallèle.
tftp-mtu
(par défaut : #f
)Si une valeur est indiquée, indique le MTU pour les paquets TFTP.
tftp-no-blocksize?
(par défaut : #f
)Si la valeur est vraie, empêche que le serveur TFTP ne négocie la taille de bloc avec un client.
tftp-lowercase?
(par défaut : #f
)Indique s’il faut convertir tous les noms de fichiers dans les requêtes TFTP en minuscule.
tftp-port-range
(par défaut : #f
)Si une valeur est indiquée, fixe les ports dynamiques (un par client) à la
zone données ("<début>,<fin>"
).
tftp-root
(par défaut : /var/empty,lo
)Cherche les fichiers à transférer avec TFTP relativement au répertoire donné. Lorsque la valeur est indiquée, les chemins TFTP qui contiennent ‘..’ sont rejeté, pour éviter que les client n’arrivent en dehors de la racine donnée. Les chemins absolus (commençant par ‘/’) sont permis, mais ils doivent être à l’intérieur de la racine de TFTP. Si un argument d’interface facultatif est donné, le répertoire n’est utilisé que pour les requêtes TFTP via cette interface.
tftp-unique-root
(par défaut : #f
)Si une valeur est indiquée, ajoute d’IP ou l’adresse matérielle du client TFTP en tant que composant du chemin à la fin de la racine TFTP. Valide uniquement si une racine TFTP est indiquée et que le répertoire existe. La valeur par défaut ajoute l’adresse IP (au format à trois points standard).
Par exemple, si --tftp-root est ‘/tftp’ et que le client ‘1.2.3.4’ demande le fichier monfichier alors le chemin effectif sera /tftp/1.2.3.4/monfichier si /tftp/1.2.3.4 existe, ou /tftp/monfichier sinon. Avec ‘=mac’, c’est l’adresse MAC qui sera ajoutée à la place, en utilisant des nombres en minuscule à taille fixe et séparés par des tirets, p. ex. : ‘01-02-03-04-aa-bb’. Remarquez que la résolution d’une adresse MAC n’est possible que si le client est sur le réseau local ou a obtenu un bail DHCP de dnsmasq.
extra-options
(par défaut : '()
)Cette option fournit un « mécanisme de secours » pour que l’utilisateur·rice
puisse ajouter des arguments arbitraires en ligne de commande à
dnsmasq
comme une liste de chaînes de caractères.
Suivant: Services VPN, Précédent: Services DNS, Monter: Services [Table des matières][Index]
le module (gnu services vnc)
fournit les services liés à
l’informatique virtuelle en réseau (VNC), qui rend possible
l’utilisation locale d’applications Xorg graphiques qui tournent sur une
machine distante. Avec un gestionnaire graphique qui prend en charge le
protocole de contrôle de gestion de l’affichage X, comme GDM
(voir gdm) ou LightDM (voir lightdm), il est possible de rendre un
bureau à distance complet pour un environnement multi-utilisateur.
Xvnc est un serveur VNC qui démarre son propre serveur X. Cela signifie
qu’il peut lancer des serveurs sans affichage. Les implémentations de Xvnc
fournies par tigervnc-server
et turbovnc
se veulent rapides et
efficaces.
The xvnc-service-type
service can be configured via the
xvnc-configuration
record, documented below. A second virtual
display could be made available on a remote machine via the following
configuration:
(service xvnc-service-type
(xvnc-configuration (display-number 10)))
Pour l’exemple, la commande xclock
peut ensuite être démarrée sur
la machine à distance sur l’affichage numéro 10, et elle peut être affichée
localement via la commande vncviewer
:
# Démarre xclock sur la machine distante. ssh -L5910:localhost:5910 votre-hôte -- guix shell xclock -- env DISPLAY=:10 xclock \ --env DISPLAY=:10 xclock # On y accède via VNC. guix shell tigervnc-client -- vncviewer localhost:5910
La configuration suivante combine XDMCP et Inetd pour permettre à plusieurs utilisateurs ou utilisatrices d’utiliser le système à distance et de se connecter via le gestionnaire d’affichage GDM en même temps :
(operating-system
[...]
(services (cons*
[...]
(service xvnc-service-type (xvnc-configuration
(display-number 5)
(localhost? #f)
(xdmcp? #t)
(inetd? #t)))
(modify-services %desktop-services
(gdm-service-type config => (gdm-configuration
(inherit config)
(auto-suspend? #f)
(xdmcp? #t)))))))
Vous pouvez ensuite vous connecter à distance en utilisant la commande
vncviewer
ou un client VNC compatible et démarrer une session de
bureau de votre choix :
vncviewer hôte-distant:5905
Attention : À moins que votre machine ne se trouve dans un environnement contrôlé, pour des raisons de sécurité, la configuration
localhost?
de l’enregistrementxvnc-configuration
devrait garder sa valeur par défaut#t
et être exposé par un moyen sécurisé comme la redirection de port SSH. Le port XDMCP, UDP 177 devrait aussi être bloqué de l’extérieur par un pare-feu, car ce n’est pas un protocole sécurisé et peut exposer les identifiants en clair.
Les champs de xvnc-configuration
disponibles sont :
xvnc
(par défaut : tigervnc-server
) (type : simili-fichier)Le paquet qui fournit le binaire Xvnc.
display-number
(par défaut : 0
) (type : nombre)Le numéro d’affichage utilisé par Xvnc. Vous devriez le paramétrer à un numéro non utilisé par un serveur Xorg.
geometry
(par défaut : "1024x768"
) (type : chaine)La taille du bureau à créer.
depth
(par défaut : 24
) (type : color-depth)La profondeur de pixel en bits du bureau à créer . Les valeurs possibles sont 16, 24 et 32.
port
(type : peut-être-port)Le port sur lequel écouter les connexions entrantes des visualiseurs. Si la valeur n’est pas spécifiée, écoute sur le port 5900 plus le numéro d’affichage par défaut.
ipv4?
(par défaut : #t
) (type : booléen)Utiliser IPv4 pour les connexions entrantes et sortantes.
ipv6?
(par défaut : #t
) (type : booléen)Utiliser IPv6 pour les connexions entrantes et sortantes.
password-file
(type : peut-être-chaine)Le mot de passe à utiliser, si vous en voulez un. Consultez vncpasswd(1) pour apprendre à générer un tel fichier.
xdmcp?
(par défaut : #f
) (type : booléen)Demande une session au serveur XDMCP. Cela permet aux utilisateurs et aux
utilisatrices de se connecter à une session de bureau depuis l’écran du
gestionnaire de connexion. Pour un scénario à plusieurs utilisateurs et
utilisatrices, vous devrez également activer l’option inetd?
pour que
chaque connexion au serveur VNC soit gérée séparément, plutôt qu’elles
soient partagées.
inetd?
(par défaut : #f
) (type : booléen)Utiliser un service de type Inetd, qui lance le serveur Xvnc à la demande.
frame-rate
(par défaut : 60
) (type : entier)Le nombre maximum de mise à jour par seconde envoyées à chaque client.
security-types
(par défaut : '("None")
) (type : types-de-sécurité)Les schémas de sécurité autorisés à utiliser pour les connexions entrantes. La valeur par défaut est "None", ce qui est sûr étant donné que Xvnc est configuré pour authentifier les personnes via le gestionnaire d’affichage et seulement pour les connexions locales. Les valeurs acceptées sont les suivantes : ("None" "VncAuth" "Plain" "TLSNone" "TLSVnc" "TLSPlain" "X509None" "X509Vnc")
localhost?
(par défaut : #t
) (type : booléen)Ne permettre que les connexions de la même machine. La valeur est #true par défaut par sécurité, ce qui signifie que SSH ou d’autres manières sécurisées doivent être utilisés pour exposer le port distant.
log-level
(par défaut : 30
) (type : niveau-de-journalisation)Le niveau de journalisation, un nombre entre 0 et 100, 100 étant la sortie la plus verbeuse. Les messages de journalisation sont envoyés au syslog.
extra-options
(par défaut : '()
) (type : chaines)On peut utiliser cette option pour fournir des options Xvnc supplémentaires qui ne sont pas proposées par cet enregistrement <xvnc-configuration>.
Suivant: Système de fichiers en réseau, Précédent: Services VNC, Monter: Services [Table des matières][Index]
Le module (gnu services vpn)
fournit des services liés aux
réseaux privés virtuels (VPN).
Un type de service pour le client VPN Bitmask. Il rend le client disponible dans le système et charge sa
politique Polkit. Remarquez que le client attend un polkit-agent
actif, lancé soit par votre environnement de bureau soit par vous
manuellement.
It provides a client service for your machine to connect to a VPN,
and a server service for your machine to host a VPN. Both
openvpn-client-service-type
and openvpn-server-service-type
can be run simultaneously.
Type of the service that runs openvpn
, a VPN daemon, as a client.
The value for this service is a <openvpn-client-configuration>
object.
Type of the service that runs openvpn
, a VPN daemon, as a server.
The value for this service is a <openvpn-server-configuration>
object.
Les champs de openvpn-client-configuration
disponibles sont :
openvpn
(par défaut : openvin
) (type : simili-fichier)Le paquet OpenVPN.
pid-file
(par défaut : "/var/run/openvpn/openvpn.pid"
) (type : chaine)Le fichier de PID d’OpenVPN.
proto
(par défaut : udp
) (type : proto)Le protocole (UDP ou TCP) utilisé pour ouvrir un canal entre les clients et les serveurs.
dev
(par défaut : tun
) (type : dev)Le périphérique utilisé pour représenter la connexion VPN.
ca
(par défaut : "/etc/openvpn/ca.crt"
) (type : peut-être-chaine)L’autorité de certification qui sert à vérifier les connexions.
certe
(par défaut : "/etc/openvpn/client.crt"
) (type : peut-être-chaine)Le certificat de la machine sur laquelle tourne le démon. Il devrait être
signé par l’autorité indiquée dans ca
.
key
(par défaut : "/etc/openvpn/client.key"
) (type : peut-être-chaine)La clef de la machine sur laquelle tourne le démon. Elle doit être la clef
dont le certificat est donné dans cert
.
comp-lzo?
(par défaut : #t
) (type : booléen)Indique s’il faut utiliser l’algorithme de compression lzo.
persist-key?
(par défaut : #t
) (type : booléen)Ne pas relire les fichiers de clefs entre les SIGUSR1 et les –ping-restart.
persist-tun?
(par défaut : #t
) (type : booléen)Ne pas fermer et rouvrir les périphériques TUN/TAP ou lancer de scripts de démarrage/d’arrêt entre les SIGUSR1 et les –ping-restart.
fast-io?
(par défaut : #f
) (type : booléen)(Expérimental) Optimise les écritures TUN/TAP/UDP en évitant d’appeler poll/epoll/select avant l’opération d’écriture.
verbosity
(par défaut : 3
) (type : entier)Niveau de verbosité.
tls-auth
(par défaut : #f
) (type : tls-auth-client)Ajoute une couche d’authentification HMAC supplémentaire au dessus du canal de contrôle TLS pour se protéger contre les attaques DoS.
auth-user-pass
(type : peut-être-chaine)S’authentifie avec le serveur en utilisant le nom d’utilisateur et le mot de passe. L’option est un fichier contenant le nom d’utilisateur et le mot de passe sur deux lignes. N’utilisez pas un objet simili-fichier car il serait ajouté au dépôt et serait lisible pour n’importe quel utilisateur.
verify-key-usage?
(par défaut : #t
) (type : key-usage)Indique s’il faut vérifier que le certificat du serveur a l’extension d’utilisation.
bind?
(par défaut : #f
) (type : bind)Se lier à un port spécifique.
resolv-retry?
(par défaut : #t
) (type : resolv-retry)Réessayer de résoudre l’adresse du serveur.
remote
(par défaut : '()
) (type : liste-de-openvpn-remote)Une liste de serveurs distants sur lesquels se connecter.
Les champs de openvpn-remote-configuration
disponibles sont :
name
(par défaut : "my-server"
) (type : chaine)Nom du serveur.
port
(par défaut : 1194
) (type : nombre)Numéro de port sur lequel écoute le serveur.
Les champs de openvpn-server-configuration
disponibles sont :
openvpn
(par défaut : openvin
) (type : simili-fichier)Le paquet OpenVPN.
pid-file
(par défaut : "/var/run/openvpn/openvpn.pid"
) (type : chaine)Le fichier de PID d’OpenVPN.
proto
(par défaut : udp
) (type : proto)Le protocole (UDP ou TCP) utilisé pour ouvrir un canal entre les clients et les serveurs.
dev
(par défaut : tun
) (type : dev)Le périphérique utilisé pour représenter la connexion VPN.
ca
(par défaut : "/etc/openvpn/ca.crt"
) (type : peut-être-chaine)L’autorité de certification qui sert à vérifier les connexions.
certe
(par défaut : "/etc/openvpn/client.crt"
) (type : peut-être-chaine)Le certificat de la machine sur laquelle tourne le démon. Il devrait être
signé par l’autorité indiquée dans ca
.
key
(par défaut : "/etc/openvpn/client.key"
) (type : peut-être-chaine)La clef de la machine sur laquelle tourne le démon. Elle doit être la clef
dont le certificat est donné dans cert
.
comp-lzo?
(par défaut : #t
) (type : booléen)Indique s’il faut utiliser l’algorithme de compression lzo.
persist-key?
(par défaut : #t
) (type : booléen)Ne pas relire les fichiers de clefs entre les SIGUSR1 et les –ping-restart.
persist-tun?
(par défaut : #t
) (type : booléen)Ne pas fermer et rouvrir les périphériques TUN/TAP ou lancer de scripts de démarrage/d’arrêt entre les SIGUSR1 et les –ping-restart.
fast-io?
(par défaut : #f
) (type : booléen)(Expérimental) Optimise les écritures TUN/TAP/UDP en évitant d’appeler poll/epoll/select avant l’opération d’écriture.
verbosity
(par défaut : 3
) (type : entier)Niveau de verbosité.
tls-auth
(par défaut : #f
) (type : tls-auth-server)Ajoute une couche d’authentification HMAC supplémentaire au dessus du canal de contrôle TLS pour se protéger contre les attaques DoS.
port
(par défaut : 1194
) (type : nombre)Spécifie le numéro de port sur lequel les serveurs écoutent.
server
(par défaut : "10.8.0.0 255.255.255.0"
) (type : ip-mask)Une ip et un masque de sous-réseau spécifiant le sous-réseau dans le réseau virtuel.
server-ipv6
(par défaut : #f
) (type : cidr6)Une notation CIDR pour spécifier le sous-réseau IPv6 dans le réseau virtuel.
dh
(par défaut : "/etc/openvpn/dh2048.pem"
) (type : chaine)Le fichier de paramètres Diffie-Hellman.
ifconfig-pool-persist
(par défaut : "/etc/openvpn/ipp.txt"
) (type : chaine)Le fichier qui enregistre les IP des clients.
redirect-gateway?
(par défaut : #f
) (type : gateway)Lorsque la valeur est vraie, le serveur agira comme une passerelle pour ses clients.
client-to-client?
(par défaut : #f
) (type : booléen)Lorsque la valeur est vraie, les clients sont autorisés à se parler entre eux dans le VPN.
keepalive
(par défaut : (10 120)
) (type : keepalive)Fait que des messages de ping sont envoyés régulièrement dans les deux sens
pour que chaque côté sache quand l’autre n’est plus disponible.
keepalive
a besoin d’une paire. Le premier élément est la période
d’envoi du ping, et le second élément est le délai d’attente avant de
considéré que l’autre côté n’est plus disponible.
max-clients
(par défaut : 100
) (type : nombre)Le nombre maximum de clients.
status
(par défaut : "/var/run/openvpn/status"
) (type : chaine)Le fichier de statut. Ce fichier montre un court rapport sur les connexions actuelles. Il est tronqué et réécrit toutes les minutes.
client-config-dir
(par défaut : '()
) (type : liste-de-openvpn-ccd)La liste des configuration pour certains clients.
Pour l’instant, le service strongSwan
fournit seulement une
configuration héritée des version précédentes avec des fichiers
ipsec.conf et ipsec.secrets.
Un type de service pour configurer strongSwan pour un VPN (réseau
privé virtuel) IPsec. Sa valeur doit être un enregistrement
strongswan-configuration
comme dans cet exemple :
(service strongswan-service-type
(strongswan-configuration
(ipsec-conf "/etc/ipsec.conf")
(ipsec-secrets "/etc/ipsec.secrets")))
Le type de données représentant la configuration du service StrongSwan.
strongswan
Le paquet strongSwan à utiliser pour ce service.
ipsec-conf
(par défaut : #f
)Le nom de fichier de votre ipsec.conf. Si différent de #f
,
alors cette valeur et ipsec-secrets
doivent toutes deux être des
chaînes de caractères.
ipsec-secrets
(par défaut : #f
)Le nom de fichier de votre ipsec.secrets. Si différent de #f
,
alors cette valeur et ipsec-conf
doivent toutes deux être des chaînes
de caractères.
Un type de service pour une interface de tunnel Wireguard. Sa valeur doit
être un enregistrement wireguard-configuration
comme dans cet exemple
:
(service wireguard-service-type
(wireguard-configuration
(peers
(list
(wireguard-peer
(name "my-peer")
(endpoint "my.wireguard.com:51820")
(public-key "hzpKg9X1yqu1axN6iJp0mWf6BZGo8m1wteKwtTmDGF4=")
(allowed-ips '("10.0.0.2/32")))))))
Le type de données représentant la configuration du service Wireguard.
wireguard
Le paquet wireguard à utiliser pour ce service.
interface
(par défaut : "wg0"
)Le nom d’interface pour le VPN.
addresses
(par défaut : "10.0.01/32"
)Les adresses IP à assigner à l’interface ci-dessus.
port
(par défaut : 51820
)Le port sur lequel écouter les connexions entrantes.
dns
(default: '())
)Les serveurs DNS à annoncer aux clients VPN via DHCP.
monitor-ips?
(default: #f
) ¶Whether to monitor the resolved Internet addresses (IPs) of the endpoints of
the configured peers, resetting the peer endpoints using an IP address that
no longer correspond to their freshly resolved host name. Set this to
#t
if one or more endpoints use host names provided by a dynamic DNS
service to keep the sessions alive.
monitor-ips-interval
(default: '(next-minute (range 0 60 5))
)The time interval at which the IP monitoring job should run, provided as an mcron time specification (voir (mcron)Guile Syntax).
private-key
(par défaut : "/etc/wireguard/private.key"
)Le fichier de clé privée pour l’interface. Il est automatiquement généré si le fichier n’existe pas.
peers
(par défaut : '()
)Les pairs autorisés sur cette interface. C’est une liste d’enregistrements wireguard-peer.
pre-up
(par défaut : '()
)Les commandes de script à lancer avant de configurer l’interface.
post-up
(par défaut : '()
)Les commandes de script à lancer après la configuration de l’interface.
pre-down
(par défaut : '()
)Les commandes de script à lancer avec d’arrêter l’interface.
post-down
(par défaut : '()
)Les commandes de script à lancer après l’arrêt de l’interface.
table
(par défaut : "auto"
)La table de routage à laquelle les routes sont ajoutées, en tant que
chaine. Il y a deux valeurs spéciales : "off"
qui désactive la
création de route complètement, et "auto"
(par défaut) qui ajoute les
routes à la table par défaut et active la gestion spéciale des routes par
défaut.
Type de données représentant un pair Wireguard attaché à une interface donnée.
name
Le nom du pair.
endpoint
(par défaut : #f
)Le point d’entrée facultatif du pair, comme
"demo.wireguard.com:51820"
.
public-key
La clé publique du pair, représentée par une chaîne en base64.
preshared-key
(par défaut : #f
)Une clé pré-partagée facultative pour ce pair. Le fichier donné ne sera pas généré automatiquement.
allowed-ips
Une liste d’adresses IP à partir desquelles le trafic entrant pour ce pair est autorisé et vers lesquelles le trafic à destination de ce pair est dirigé.
keep-alive
(par défaut : #f
)Une durée en seconde facultative. Un paquet sera régulièrement envoyé au serveur après cette durée. Cela aide à recevoir les connexions entrantes de ce pair si vous êtes derrière un NAT ou un pare-feu.
Suivant: Services Samba, Précédent: Services VPN, Monter: Services [Table des matières][Index]
Le module (gnu services nfs)
fournit les services suivants, qui sont
tous utilisés pour monter et exporter des arborescences de répertoires en
network file systems (NFS).
Bien qu’il soit possible d’utiliser des composants individuels qui forment
ensemble un service de système de fichiers en réseau, nous recommandons de
configurer un serveur NFS avec nfs-service-type
.
Le service NFS s’occupe de paramétrer tous les services composant NFS, les systèmes de fichiers de configuration du noyau et installe les fichiers de configuration aux endroit attendus par NFS.
Un type de service pour un serveur NFS complet.
Ce type de données représente la configuration d’un service NFS et de tous ses sous-systèmes.
Il prend les paramètres suivants :
nfs-utils
(par défaut : nfs-utils
)Le paquet nfs-utils à utiliser.
nfs-versions
(par défaut : '("4.2" "4.1" "4.0")
)Si une liste de chaines est fournie, le démon rpc.nfsd
sera limité
à la prise en charge des versions données du protocole NFS.
exports
(par défaut : '()
)C’est une liste de répertoires que le serveur NFS devrait exporter. Chaque entrée est une liste consistant en deux éléments : un nom de répertoire et une chaine de caractères contenant toutes les options. Voici un exemple dans lequel le répertoire /export est servi à tous les clients en lecture-seule :
(nfs-configuration
(exports
'(("/export"
"*(ro,insecure,no_subtree_check,crossmnt,fsid=0)"))))
rpcmountd-port
(par défaut : #f
)Le port réseau que le démon rpc.mountd
devrait utiliser.
rpcstatd-port
(par défaut : #f
)Le port réseau que le démon rpc.statd
devrait utiliser.
rpcbind
(par défaut : rpcbind
)Le paquet rpcbind à utiliser.
idmap-domain
(par défaut : "localdomain"
)Le nom de domaine NFSv4 local.
nfsd-port
(par défaut : 2049
)Le port réseau que le démon nfsd
devrait utiliser.
nfsd-threads
(par défaut : 8
)Le nombre de thread à utiliser par le démon nfsd
.
nfsd-tcp?
(par défaut : #t
)Indique si le démon nfsd
devrait écouter sur une socket TCP.
nfsd-udp?
(par défaut : #f
)Indique si le démon nfsd
devrait écouter sur une socket UDP.
pipefs-directory
(par défaut : "/var/lib/nfs/rpc_pipefs"
)Le répertoire où le système de fichier pipefs doit être monté.
debug
(par défaut : '()"
)Une liste des sous-systèmes pour lesquels la sortie de débogage est
activée. C’est une liste de symboles. Ces symboles sont valides :
nfsd
, nfs
, rpc
, idmap
, statd
et
mountd
.
Si vous n’avez pas besoin d’un service NFS complet ou préférez le construire vous-même vous pouvez utiliser les composants individuels décrit plus bas.
Le service RPC Bind fournit un dispositif pour faire correspondre les numéros de programmes à des adresses universelles. De nombreux services liés à NFS utilisent ce dispositif. Donc il est automatiquement démarré lorsqu’un service qui en dépend est démarré.
Un type de service pour le démon RPC portmapper.
Type données représentant la configuration du service RPC Bind. Ce type a les paramètres suivants :
rpcbind
(par défaut : rpcbind
)Le paquet rpcbind à utiliser.
warm-start?
(par défaut : #t
)Si ce paramètre est #t
, alors le démon lira un fichier d’état au
démarrage ce qui lui fait recharger les informations d’états sauvegardés par
une instance précédente.
Le système de fichiers pipefs est utilisé pour transférer des données liées à NFS entre le noyau et les programmes en espace utilisateur.
Un type de service pour le pseudo-système de fichiers pipefs.
Type de données représentant la configuration du service du pseudo-système de fichiers pipefs. Ce type a les paramètres suivants :
mount-point
(par défaut : "/var/lib/nfs/rpc_pipefs"
)Le répertoire dans lequel le système de fichiers est attaché.
Le démon du système de sécurité global (GSS) fournit une sécurité
forte pour les protocoles basés sur des RPC. Avant d’échanger des requêtes
RPC, un client RPC doit établir un contexte sécurisé. Typiquement cela se
fait avec la commande Kerberos kinit
ou automatiquement à la
connexion avec les services PAM (voir Services Kerberos).
Un type de service pour le démon du système de sécurité global (GSS).
Type de données représentant la configuration du service du démon GSS. Ce type a les paramètres suivants :
nfs-utils
(par défaut : nfs-utils
)Le paquet dans lequel la commande rpc.gssd
se trouve.
pipefs-directory
(par défaut : "/var/lib/nfs/rpc_pipefs"
)Le répertoire où le système de fichier pipefs doit être monté.
Le service du démon idmap fournit une correspondance entre les ID utilisateur et les noms d’utilisateurs. Typiquement, cela est requis pour accéder aux systèmes de fichiers montés via NFSv4.
Un type de service pour le démon de correspondance d’identité (IDMAP).
Type de données représentant la configuration du service du démon IDMAP. Ce type a les paramètres suivants :
nfs-utils
(par défaut : nfs-utils
)Le paquet dans lequel se trouve la commande rpc.idmapd
.
pipefs-directory
(par défaut : "/var/lib/nfs/rpc_pipefs"
)Le répertoire où le système de fichier pipefs doit être monté.
domain
(par défaut : #f
)Le nom de domaine NFSv4 local. Il faut que ce soit une chaîne de caractères
ou #f
. Si la valeur est #f
le démon utilisera le nom de
domaine pleinement qualifié de l’hôte.
verbosity
(par défaut : 0
)Le niveau de verbosité du démon.
Suivant: Intégration continue, Précédent: Système de fichiers en réseau, Monter: Services [Table des matières][Index]
Le module (gnu services samba)
fournit des définitions de services
pour les services Samba ainsi que d’autres services utilitaires.
Actuellement il fournit les services suivants.
Samba fournit des partages réseau pour les répertoires et les imprimantes qui utilisent le protocole SMB/CIFS souvent utilisé sous Windows. Il peut aussi se comporter comme un contrôleur de domaine Active Directory (AD DC) pour les autres hôtes dans un réseau hétérogène avec plusieurs types d’ordinateurs.
Le type de service pour activer les services samba samba
,
nmbd
, smbd
et winbindd
. Par défaut ce type de service
ne lance aucun démon Samba. Ils doivent être activés individuellement.
voici un exemple de base qui configure un partage de fichiers Samba simple et anonyme (sans authentification) qui expose le répertoire /public.
Astuce : Le répertoire /public et sont contenu doivent être disponible en lecture-écriture pour le monde entier, donc vous devrez utiliser ‘chmod -R 777 /public’ dessus.
Attention : Une telle configuration Samba ne devrait être utilisée que dans des environnements contrôlés et vous ne devriez pas partage des fichiers privés avec, car n’importe qui se connectant à votre réseau y aurait accès.
(service samba-service-type (samba-configuration
(enable-smbd? #t)
(config-file (plain-file "smb.conf" "\
[global]
map to guest = Bad User
logging = syslog@1
[public]
browsable = yes
path = /public
read only = no
guest ok = yes
guest only = yes\n"))))
Configuration record for the Samba suite.
package
(par défaut : samba
)Le paquet samba à utiliser.
config-file
(par défaut : #f
)Le fichier de configuration à utiliser. Pour comprendre sa syntaxe, lancez ‘man smb.conf’.
enable-samba?
(par défaut : #f
)Active le démon samba
.
enable-smbd?
(par défaut : #f
)Active le démon smbd
.
enable-nmbd?
(par défaut : #f
)Active le démon nmbd
.
enable-winbindd?
(par défaut : #f
)Active le démon winbindd
.
Le WSDD (démon de découverte des services web) implémente le protocole de découverte dynamique des services web qui permet des découvrir des hôtes sur le DNS multicast, de la même manière que Avahi. C’est un remplaçant pour les hôtes SMB qui ont désactivé leur SMBv1 pour des raisons de sécurité.
Type pour le démon hôte WSD. La valeur de ce type de service est un
enregistrement wssd-configuration
. Les détails du type
d’enregistrement wsdd-configuration
sont fournis plus bas.
Ce type de données représente la configuration du service wsdd.
package
(par défaut : wsdd
)Le paquet wsdd à utiliser.
ipv4only?
(par défaut : #f
)N’écoute que sur le adresses IPv4.
ipv6only
(par défaut : #f
)N’écoute que sur les adresses IPv6. Remarquez : activer les deux options n’est pas possible, car il n’y aurait aucune version d’IP sur laquelle écouter.
chroot
(par défaut : #f
)Entre dans un chroot dans un répertoire séparé pour empêcher l’accès à
d’autres répertoires. Cela permet d’améliorer la sécurité en cas de
vulnérabilité dans wsdd
.
hop-limit
(par défaut : 1
)Limite le niveau de sauts pour les paquets multicast. La valeur par défaut est 1, ce qui devrait éviter aux paquets de quitter le réseau local.
interface
(par défaut : '()
)Limite l’écoute aux interfaces listées. Par défaut wsdd écoutera sur toutes les interfaces. Sauf l’interface de rebouclage qui n’est jamais utilisée.
uuid-device
(par défaut : #f
)Le protocole WSD nécessite qu’un périphérique ait un UUID. Indiquez ce paramètre pour assigner manuellement un UUID au service.
domain
(par défaut : #f
)Notifie que cet hôte est membre d’un Active Directory.
host-name
(par défaut : #f
)Indique le nom d’hôte manuellement au lieu de laisser wsdd
hériter
du nom de cet hôte. Seul la partie du nom d’hôte d’un éventuel nom de
domaine pleinement qualifié sera utilisé dans le cas par défaut.
preserve-case?
(par défaut : #f
)Par défaut wsdd
convertira le nom d’hôte dans le groupe de travail
en majuscules. L’inverse est vrai pour les noms d’hôtes dans les
domaines. Indiquer ce paramètre préservera la casse.
workgroup
(par défaut : "WORKGROUP")Change le nom du groupe de travail. Par défaut wsdd
rapport cet
hôte comme étant membre d’un groupe de travail.
Suivant: Services de gestion de l’énergie, Précédent: Services Samba, Monter: Services [Table des matières][Index]
Cuirass est un outil d’intégration continue pour Guix. On peut l’utiliser aussi bien pour le développement que pour fournir des substituts à d’autres (voir Substituts).
Le module (gnu services cuirass)
fournit le service suivant.
Le type du service Cuirass. Sa valeur doit être un objet
cuirass-configuration
, décrit ci-dessous.
Pour ajouter des travaux de construction, vous devez indiquer le champ
specifications
de la configuration. Par exemple, voici un exemple
qui construira tous les paquets fournis par le canal my-channel
.
(define %cuirass-specs #~(list (specification (name 'my-channel) (build '(channels my-channel)) (channels (cons (channel (name 'my-channel) (url "https://my-channel.git")) %default-channels))))) (service cuirass-service-type (cuirass-configuration (specifications %cuirass-specs)))
Pour construire le paquet linux-libre
défini par le canal Guix par
défaut, on peut utiliser la configuration suivante.
(define %cuirass-specs #~(list (specification (name 'my-linux) (build '(packages "linux-libre"))))) (service cuirass-service-type (cuirass-configuration (specifications %cuirass-specs)))
Les autres possibilités de configuration, ainsi que l’enregistrement de spécification lui-même sont décrits dans le manuel de Cuirass (voir Specifications dans Cuirass).
Tandis que les informations liés aux travaux de construction sont
directement dans les spécifications, les paramètres globaux pour le
processus cuirass
sont accessibles dans les autres champs de
cuirass-configuration
.
Type de données représentant la configuration de Cuirass.
cuirass
(par défaut : cuirass
)Le paquet Cuirass à utiliser.
log-file
(par défaut : "/var/log/cuirass.log"
)Emplacement du fichier de journal.
web-log-file
(par défaut : "/var/log/cuirass-web.log"
)Emplacement du fichier journal utilisé par l’interface web.
cache-directory
(par défaut : "/var/cache/cuirass"
)Emplacement du cache du dépôt.
user
(par défaut : "cuirass"
)Propriétaire du processus cuirass
.
group
(par défaut : "cuirass"
)Groupe du propriétaire du processus cuirass
.
interval
(par défaut : 60
)Nombre de secondes entre les mises à jour du dépôt suivis des travaux de Cuirass.
ttl
(default: 2592000
)Duration to keep build results’ GC roots alive, in seconds.
threads
(default: #f
)Number of kernel threads to use for Cuirass. The default value should be appropriate for most cases.
parameters
(par défaut : #f
)Lit les paramètres dans le fichier parameters. Les paramètres pris en charges sont décrits ici (voir Parameters dans Cuirass).
remote-server
(par défaut : #f
)Un enregistrement cuirass-remote-server-configuration
pour utiliser
le mécanisme de construction distante ou #f
pour utiliser le
mécanisme de construction par défaut.
database
(par défaut : "dbname=cuirass host=/var/run/postgresql"
)Utiliser database comme base de données contenant les travaux et les
résultats des constructions passées. Comme Cuirass utilise PostgreSQL comme
moteur de base de données, database doit être une chaîne de la même
forme que "dbname=cuirass host=localhost"
.
port
(par défaut : 8081
)Numéro de port utilisé pour le serveur HTTP.
host
(par défaut : "localhost"
)Écoute sur l’interface réseau de host. La valeur par défaut est d’accepter les connexions depuis localhost.
specifications
(par défaut : #~'()
)Une gexp (voir G-Expressions) qui s’évalue en une liste d’enregistrement de spécifications. L’enregistrement de spécification est décrit dans le manuel de Cuirass (voir Specifications dans Cuirass).
one-shot?
(par défaut : #f
)N’évaluer les spécification et construire les dérivations qu’une seule fois.
fallback?
(par défaut : #f
)Lorsque la substitution d’un binaire pré-construit échoue, revenir à la construction locale du paquet.
extra-options
(par défaut : '()
)Extra options to pass when running the cuirass register
process.
web-extra-options
(default: '()
)Extra options to pass when running the cuirass web
process.
Cuirass prend en charge deux mécanisme pour construire les dérivations.
Pour active ce mode de construction, vous devez passer un enregistrement
cuirass-remote-server-configuration
au champ remote-server
de
l’enregistrement cuirass-configuration
. L’enregistrement
cuirass-remote-server-configuration
est décrit plus bas.
Ce mode de construction passe mieux à l’échelle que celui par défaut. C’est le mode de construction utilisé sur la ferme de construction de GNU Guix https://ci.guix.gnu.org. Vous devriez l’utiliser si vous utilisez Cuirass pour construire un grand nombre de paquets.
Le type de données représentant la configuration des serveurs distants de Cuirass.
backend-port
(par défaut : 5555
)Le port TCP pour communiquer avec les processus remote-worker
via
ZMQ. Sa valeur par défaut est 5555
.
log-port
(par défaut : 5556
)Le port TCP du serveur de journalisation. Sa valeur par défaut est
5556
.
publish-port
(par défaut : 5557
)Le port TCP du serveur de publication. Sa valeur par défaut est 5557
.
log-file
(par défaut : "/var/log/cuirass-remote-server.log"
)Emplacement du fichier de journal.
cache
(par défaut : "/var/cache/cuirass/remote"
)Utiliser le répertoire cache pour mettre les journaux en cache.
log-expiry
(default: 6 months)The duration in seconds after which build logs collected by cuirass
remote-worker
may be deleted.
trigger-url
(par défaut : #f
)Lorsqu’un substitut a été correctement récupéré, cause la préparation d’un substitut sur trigger-url.
publish?
(par défaut : #t
)Si la valeur est fausse, ne démarre pas de serveur de publication et ignore
l’argument publish-port
. Ça peut être utile s’il y a déjà un serveur
de publication indépendant qui se trouve à côté du serveur distant.
public-key
private-key
Utilise les fichiers spécifiques comme pair de clefs utilisées pour signer les éléments avant de les publier.
Au moins un serveur distant doit aussi être démarré sur une machine du réseau local pour effectivement effectuer les constructions et rapporter leur état.
Type de données représentant la configuration des serveurs distants de Cuirass.
cuirass
(par défaut : cuirass
)Le paquet Cuirass à utiliser.
workers
(par défaut : 1
)Démarre workers travailleurs en parallèle.
server
(par défaut : #f
)Ne pas utiliser Avahi pour découvrir des serveurs et se connecter à l’IP
server
donnée à la place.
systems
(par défaut : (list (%current-system))
)Ne demander des constructions que pour les systèmes systems donnés.
log-file
(par défaut : "/var/log/cuirass-remote-worker.log"
)Emplacement du fichier de journal.
publish-port
(par défaut : 5558
)Le port TCP du serveur de publication. La valeur par défaut est 5558
.
substitute-urls
(par défaut : %default-substitute-urls
)La liste des URL où trouver des substituts par défaut.
public-key
private-key
Utilise les fichiers spécifiques comme pair de clefs utilisées pour signer les éléments avant de les publier.
Laminar est service d’intégration continue léger et modulaire. Il n’a pas d’interface de configuration web et utilise plutôt des fichiers de configuration et des scripts sous contrôle de version.
Laminar encourage l’utilisation d’outils existants comme bash et cron au lieu de les réinventer.
Le type du service Laminar. Sa valeur doit être un objet
laminar-configuration
, décrit ci-dessous.
Toutes les configurations ont des valeurs par défaut, une configuration minimale pour lancer Laminar se trouve plus bas. Par défaut, l’interface web est disponible sur le port 8080.
Type données qui représente la configuration de Laminar.
laminar
(par défaut : laminar
)Le paquet Laminar à utiliser.
home-directory
(par défaut : "/var/lib/laminar"
)Le répertoire de la configuration des travaux et des répertoires d’exécution.
supplementary-groups
(default: ()
)Supplementary groups for the Laminar user account.
bind-http
(par défaut : "*:8080"
)L’interface et le port ou la socket unix sur laquelle laminard écoutera les connexions entrantes sur l’interface web.
bind-rpc
(par défaut : "unix-abstract:laminar"
)L’interface et le port ou la socket unix sur laquelle laminard écoutera les commandes entrantes comme les requêtes de construction.
title
(par défaut : "Laminar"
)Le titre de la page à afficher sur l’interface web.
keep-rundirs
(par défaut : 0
)Indiquez un entier indiquant le nombre de répertoire d’exécution garder par tâche. Les répertoires avec les numéros les plus petits seront supprimé. La valeur par défaut est 0, ce qui signifie que tous les répertoires d’exécution seront immédiatement supprimés.
archive-url
(par défaut : #f
)L’interface web servi par laminard utilisera cette URL pour former les liens vers les artefacts des travaux archivés.
base-url
(par défaut : #f
)URL de base à utiliser pour les liens vers laminar.
Suivant: Services audio, Précédent: Intégration continue, Monter: Services [Table des matières][Index]
The (gnu services pm)
module provides a Guix service definition for
the Linux Power Profiles Daemon, which makes power profiles handling
available over D-Bus.
The available profiles consist of the default ‘balanced’ mode, a ‘power-saver’ mode and on supported systems a ‘performance’ mode.
Important : The
power-profiles-daemon
conflicts with other power management tools liketlp
. Using both together is not recommended.
This is the service type for the
Power
Profiles Daemon. The value for this service is a
power-profiles-daemon-configuration
.
To enable the Power Profiles Daemon with default configuration add this line to your services:
Data type representing the configuration of
power-profiles-daemon-service-type
.
power-profiles-daemon
(default: power-profiles-daemon
) (type: file-like)Package object of power-profiles-daemon.
Le module (gnu services pm)
fournit une définition de service Guix
pour l’outil de gestion d’énergie Linux TLP.
TLP active plusieurs modes un espace utilisateur et dans le noyau.
Contrairement à upower-service
, ce n’est pas un outil passif de
surveillance, puisqu’il applique des paramètres personnalisés à chaque fois
qu’il détecte une nouvelle source d’énergie. Vous pouvez trouver plus
d’informations sur la page
d’accueil de TLP.
Le type de service pour l’outil TLP. Les paramètres par défaut sont
optimisés pour la durée de la batterie sur la plupart des systèmes, mais
vous pouvez les modifier comme vous voulez en ajoutant un
tlp-configuration
valide :
(service tlp-service-type
(tlp-configuration
(cpu-scaling-governor-on-ac (list "performance"))
(sched-powersave-on-bat? #t)))
Chaque définition de paramètre est précédée par son type ; par exemple,
‘booléen toto’ indique que le paramètre toto
doit être spécifié
comme un booléen. Les types qui commencent par peut-être-
dénotent
des paramètres qui n’apparaîtront pas dans la configuration de TLP lorsque
leur valeur est non spécifiée, ou est explicitement initialisée à la valeur
%unset-value
.
Les champs de tlp-configuration
disponibles sont :
tlp-configuration
:package tlp ¶Le paquet TLP.
tlp-configuration
:boolean tlp-enable? ¶Indiquez vrai si vous souhaitez activer TLP.
La valeur par défaut est ‘#t’.
tlp-configuration
:string tlp-default-mode ¶Mode par défaut lorsqu’aucune source d’énergie ne peut être détectée. Les possibilités sont AC et BAT.
La valeur par défaut est ‘"AC"’.
tlp-configuration
:entier-non-négatif disk-idle-secs-on-ac ¶Nombre de secondes que le noyau Linux doit attendre après que les disques s’arrêtent pour se synchroniser quand il est sur secteur.
La valeur par défaut est ‘0’.
tlp-configuration
:entier-non-négatif disk-idle-secs-on-bat ¶Comme disk-idle-ac
mais en mode batterie.
La valeur par défaut est ‘2’.
tlp-configuration
:entier-non-négatif max-lost-work-secs-on-ac ¶Périodicité du nettoyage des pages invalidées, en secondes.
La valeur par défaut est ‘15’.
tlp-configuration
:entier-non-négatif max-lost-work-secs-on-bat ¶Comme max-lost-work-secs-on-ac
mais en mode batterie.
La valeur par défaut est ‘60’.
tlp-configuration
:peut-être-liste-de-chaines-séparées-par-des-espaces cpu-scaling-governor-on-ac ¶Gouverneur de fréquence d’horloge sur secteur. Avec le pilote intel_pstate, les possibilités sont powersave et performance. Avec le pilote acpi-cpufreq, les possibilités sont ondemand, powersave, performance et conservative.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-liste-de-chaines-séparées-par-des-espaces cpu-scaling-governor-on-bat ¶Comme cpu-scaling-governor-on-ac
mais en mode batterie.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-entier-non-négatif cpu-scaling-min-freq-on-ac ¶Indique la fréquence d’horloge minimale pour le gouverneur sur secteur.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-entier-non-négatif cpu-scaling-max-freq-on-ac ¶Indique la fréquence d’horloge maximale pour le gouverneur sur secteur.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-entier-non-négatif cpu-scaling-min-freq-on-bat ¶Indique la fréquence d’horloge minimale pour le gouverneur sur batterie.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-entier-non-négatif cpu-scaling-max-freq-on-bat ¶Indique la fréquence d’horloge maximale pour le gouverneur sur batterie.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-entier-non-négatif cpu-min-perf-on-ac ¶Limite le P-état minimum pour contrôler la dissipation de puissance dans le CPU, sur secteur. Les valeurs sont indiqués comme un pourcentage des performances disponibles.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-entier-non-négatif cpu-max-perf-on-ac ¶Limite le P-état maximum pour contrôler la dissipation de puissance dans le CPU, sur secteur. Les valeurs sont indiqués comme un pourcentage des performances disponibles.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-entier-non-négatif cpu-min-perf-on-bat ¶Comme cpu-min-perf-on-ac
mais en mode batterie.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-entier-non-négatif cpu-max-perf-on-bat ¶Comme cpu-max-perf-on-ac
mais en mode batterie.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-booléen cpu-boost-on-ac? ¶Active la fonctionnalité turbo boost du CPU sur secteur.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-booléen cpu-boost-on-bat? ¶Comme cpu-boost-on-ac?
mais en mode batterie.
La valeur par défaut est ‘disabled’.
tlp-configuration
:boolean sched-powersave-on-ac? ¶Permet au noyau Linux de minimiser le nombre de cœurs/hyper-threads CPU utilisés lorsque la charge est faible.
La valeur par défaut est ‘#f’.
tlp-configuration
:boolean sched-powersave-on-bat? ¶Comme sched-powersave-on-ac?
mais en mode batterie.
La valeur par défaut est ‘#t’.
tlp-configuration
:boolean nmi-watchdog? ¶Active le chien de garde NMI du noyau Linux.
La valeur par défaut est ‘#f’.
tlp-configuration
:peut-être-chaine phc-controls ¶Pour les noyaux Linux avec le correctif PHC, change le voltage du CPU. Une valeur serait par exemple ‘"F:V F:V F:V F:V"’.
La valeur par défaut est ‘disabled’.
tlp-configuration
:string energy-perf-policy-on-ac ¶Indique le niveau de performance du CPU par rapport à la politique de gestion de l’énergie sur secteur. Les possibilités sont performance, normal et powersave.
La valeur par défaut est ‘"performance"’.
tlp-configuration
:string energy-perf-policy-on-bat ¶Comme energy-perf-policy-ac
mais en mode batterie.
La valeur par défaut est ‘"powersave"’.
tlp-configuration
:space-separated-string-list disks-devices ¶Périphériques de disque dur.
tlp-configuration
:space-separated-string-list disk-apm-level-on-ac ¶Niveau de gestion de l’énergie avancé des disques durs.
tlp-configuration
:space-separated-string-list disk-apm-level-on-bat ¶Comme disk-apm-bat
mais en mode batterie.
tlp-configuration
:peut-être-liste-de-chaines-séparées-par-des-espaces disk-spindown-timeout-on-ac ¶Délai d’attente pour arrêter de faire tourner les disques. Une valeur doit être spécifiée pour chaque disque dur déclaré.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-liste-de-chaines-séparées-par-des-espaces disk-spindown-timeout-on-bat ¶Comme disk-spindown-timeout-on-ac
mais en mode batterie.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-liste-de-chaines-séparées-par-des-espaces disk-iosched ¶Sélectionne l’ordonnanceur d’entrées-sorties pour le disque. Une valeur doit être spécifiée pour chaque disque déclaré. Les possibilités sont par exemple cfq, deadline et noop.
La valeur par défaut est ‘disabled’.
tlp-configuration
:string sata-linkpwr-on-ac ¶Niveau de gestion de l’énergie des lien SATA aggressive (ALPM). Les possibilités sont min_power, medium_power et max_performance.
La valeur par défaut est ‘"max_performance"’.
tlp-configuration
:string sata-linkpwr-on-bat ¶Comme sata-linkpwr-ac
mais en mode batterie.
La valeur par défaut est ‘"min_power"’.
tlp-configuration
:peut-être-chaine sata-linkpwr-blacklist ¶Exclu les périphériques SATA spécifiés de la gestion de l’énergie des liens.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-booléen-on-off ahci-runtime-pm-on-ac? ¶Active la gestion de l’énergie à l’exécution pour les contrôleurs AHCI et les disques, sur secteur.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-booléen-on-off ahci-runtime-pm-on-bat? ¶Comme ahci-runtime-pm-on-ac
mais en mode batterie.
La valeur par défaut est ‘disabled’.
tlp-configuration
:entier-non-négatif ahci-runtime-pm-timeout ¶Secondes d’inactivités avant de suspendre les disques.
La valeur par défaut est ‘15’.
tlp-configuration
:string pcie-aspm-on-ac ¶Niveau de gestion de l’énergie des états actifs de PCI Express. Les possibilités sont default, performance et powersave.
La valeur par défaut est ‘"performance"’.
tlp-configuration
:string pcie-aspm-on-bat ¶Comme pcie-aspm-ac
mais en mode batterie.
La valeur par défaut est ‘"powersave"’.
tlp-configuration
:peut-être-entier-non-négatif start-charge-thresh-bat0 ¶Pourcentage à partir duquel la batterie 0 doit commencer à charger. Seulement pris en charge sur les ordinateurs portables.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-entier-non-négatif stop-charge-thresh-bat0 ¶Pourcentage à partir duquel la batterie 0 devrait arrêter de charger. Seulement pris en charge sur les ordinateurs portables.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-entier-non-négatif start-charge-thresh-bat1 ¶Pourcentage à partir duquel la batterie 1 devrait commencer à charger. Seulement pris en charge sur les ordinateurs portables.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-entier-non-négatif stop-charge-thresh-bat1 ¶Pourcentage à partir duquel la batterie 1 devrait arrêter de charger. Seulement pris en charge sur les ordinateurs portables.
La valeur par défaut est ‘disabled’.
tlp-configuration
:string radeon-power-profile-on-ac ¶Niveau de vitesse de l’horloge des cartes graphiques Radeon. Les possibilités sont low, mid, high, auto et default.
La valeur par défaut est ‘"high"’.
tlp-configuration
:string radeon-power-profile-on-bat ¶Comme radeon-power-ac
mais en mode batterie.
La valeur par défaut est ‘"low"’.
tlp-configuration
:string radeon-dpm-state-on-ac ¶Méthode de gestion de l’énergie dynamique de Radeon (DPM). Les possibilités sont battery et performance.
La valeur par défaut est ‘"performance"’.
tlp-configuration
:string radeon-dpm-state-on-bat ¶Comme radeon-dpm-state-ac
mais en mode batterie.
La valeur par défaut est ‘"battery"’.
tlp-configuration
:string radeon-dpm-perf-level-on-ac ¶Niveau de performance de DPM. Les possibilités sont auto, low et high.
La valeur par défaut est ‘"auto"’.
tlp-configuration
:string radeon-dpm-perf-level-on-bat ¶Comme radeon-dpm-perf-ac
mais en mode batterie.
La valeur par défaut est ‘"auto"’.
tlp-configuration
:on-off-boolean wifi-pwr-on-ac? ¶Mode de gestion de l’énergie wifi.
La valeur par défaut est ‘#f’.
tlp-configuration
:on-off-boolean wifi-pwr-on-bat? ¶Comme wifi-power-ac?
mais en mode batterie.
La valeur par défaut est ‘#t’.
tlp-configuration
:y-n-boolean wol-disable? ¶Désactive wake on LAN.
La valeur par défaut est ‘#t’.
tlp-configuration
:entier-non-négatif sound-power-save-on-ac ¶Durée d’attente en secondes avant d’activer la gestion de l’énergie audio sur les périphériques Intel HDA et AC97. La valeur 0 désactive la gestion de l’énergie.
La valeur par défaut est ‘0’.
tlp-configuration
:entier-non-négatif sound-power-save-on-bat ¶Comme sound-powersave-ac
mais en mode batterie.
La valeur par défaut est ‘1’.
tlp-configuration
:y-n-boolean sound-power-save-controller? ¶Désactive le contrôleur en mode de gestion de l’énergie sur les périphériques Intel HDA.
La valeur par défaut est ‘#t’.
tlp-configuration
:boolean bay-poweroff-on-bat? ¶Active le périphérique optique AltraBay/MediaBay en mode batterie. Le périphérique peut être de nouveau alimenté en lâchant (et en réinsérant) le levier d’éjection ou en appuyant sur le bouton d’éjection sur les modèles plus récents.
La valeur par défaut est ‘#f’.
tlp-configuration
:string bay-device ¶Nom du périphérique optique à éteindre.
La valeur par défaut est ‘"sr0"’.
tlp-configuration
:string runtime-pm-on-ac ¶Gestion de l’énergie à l’exécution sur les bus PCI(e). Les possibilités sont on et auto.
La valeur par défaut est ‘"on"’.
tlp-configuration
:string runtime-pm-on-bat ¶Comme runtime-pm-ac
mais en mode batterie.
La valeur par défaut est ‘"auto"’.
tlp-configuration
:boolean runtime-pm-all? ¶Gestion de l’énergie à l’exécution pour tous les bus PCI(e), sauf ceux en liste noire.
La valeur par défaut est ‘#t’.
tlp-configuration
:peut-être-liste-de-chaines-séparées-par-des-espaces runtime-pm-blacklist ¶Exclue les adresses des périphériques PCI(e) spécifiés de la gestion de l’énergie à l’exécution.
La valeur par défaut est ‘disabled’.
tlp-configuration
:space-separated-string-list runtime-pm-driver-blacklist ¶Exclue les périphériques PCI(e) assignés aux pilotes spécifiés de la gestion de l’énergie à l’exécution.
tlp-configuration
:boolean usb-autosuspend? ¶Active la fonctionnalité de mise en veille automatique de l’USB.
La valeur par défaut est ‘#t’.
tlp-configuration
:peut-être-chaine usb-blacklist ¶Exclue les périphériques spécifiés de la mise en veille automatique de l’USB.
La valeur par défaut est ‘disabled’.
tlp-configuration
:boolean usb-blacklist-wwan? ¶Exclue les périphériques WWAN de la mise en veille automatique de l’USB.
La valeur par défaut est ‘#t’.
tlp-configuration
:peut-être-chaine usb-whitelist ¶Inclue les périphériques spécifiés dans la mise en veille automatique de
l’USB, même s’ils sont déjà exclus par le pilote ou via
usb-blacklist-wwan?
.
La valeur par défaut est ‘disabled’.
tlp-configuration
:peut-être-booléen usb-autosuspend-disable-on-shutdown? ¶Active la mise en veille de l’USB avant l’arrêt.
La valeur par défaut est ‘disabled’.
tlp-configuration
:boolean restore-device-state-on-startup? ¶Restaure l’état des périphériques radio (bluetooth, wifi, wwan) du dernier arrêt au démarrage du système.
La valeur par défaut est ‘#f’.
Le module (gnu services pm)
fournit une interface pour thermald, un
service de gestion de l’horloge CPU qui aide à éviter la surchauffe.
C’est le type de service pour thermald, le démon de température de Linux, responsable du contrôle de l’état thermique des processeurs et d’éviter la surchauffe.
Type de données représentant la configuration de
thermald-service-type
.
adptative?
(par défaut : #f
)Utilise les tables adaptatives DPTF (Dynamic Power and Thermal Framework) si elles sont présentes.
ignore-cpuid-check?
(par défaut : #f
)Ignore la vérification des modèles CPU supportés avec cpuid.
thermald
(par défaut : thermald)Objet du paquet de thermald.
Suivant: Services de virtualisation, Précédent: Services de gestion de l’énergie, Monter: Services [Table des matières][Index]
Le module (gnu services audio)
fournit un service qui lance MPD (le
démon de lecture de musique).
Le démon de lecture de musique (MPD) est un service qui joue de la musique tout en étant contrôlé depuis la machine locale ou à travers le réseau par divers clients.
The following example shows the simplest configuration to locally expose,
via PulseAudio, a music collection kept at /srv/music, with
mpd
running as the default ‘mpd’ user. This user will spawn
its own PulseAudio daemon, which may compete for the sound card access with
that of your own user. In this configuration, you may have to stop the
playback of your user audio applications to hear MPD’s output and
vice-versa.
(service mpd-service-type
(mpd-configuration
(music-directory "/srv/music")))
Important : The music directory must be readable to the MPD user, by default, ‘mpd’. Permission problems will be reported via ‘Permission denied’ errors in the MPD logs, which appear in /var/log/messages by default.
Most MPD clients will trigger a database update upon connecting, but you can
also use the update
action do to so:
herd update mpd
All the MPD configuration fields are documented below, and a more complex example follows.
Le type de service pour mpd
Available mpd-configuration
fields are:
package
(default: mpd
) (type: file-like)The MPD package.
user
(type: user-account)L’utilisateur qui lance mpd.
group
(type: user-group)The group to run mpd as.
The default %mpd-group
is a system group with name “mpd”.
shepherd-requirement
(default: '()
) (type: list-of-symbols)A list of symbols naming Shepherd services that this service will depend on.
environment-variables
(default: '("PULSE_CLIENTCONFIG=/etc/pulse/client.conf" "PULSE_CONFIG=/etc/pulse/daemon.conf")
) (type: list-of-strings)A list of strings specifying environment variables.
log-file
(type: maybe-string)The location of the log file. Unless specified, logs are sent to the local syslog daemon. Alternatively, a log file name can be specified, for example /var/log/mpd.log.
log-level
(type: maybe-string)Supress any messages below this threshold. The available values, in
decreasing order of verbosity, are: verbose
, info
,
notice
, warning
and error
.
music-directory
(type: maybe-string)Le répertoire à scanner pour trouver les fichiers de musique.
music-dir
(type: maybe-string)Le répertoire à scanner pour trouver les fichiers de musique.
playlist-directory
(type: maybe-string)Le répertoire où stocker les playlists.
playlist-dir
(type: maybe-string)Le répertoire où stocker les playlists.
db-file
(type: maybe-string)The location of the music database. When left unspecified, ~/.cache/db is used.
state-file
(type: maybe-string)Emplacement du fichier qui stocke l’état actuel de MPD.
sticker-file
(type: maybe-string)Emplacement de la base de données de stickers.
default-port
(default: 6600
) (type: maybe-port)The default port to run mpd on.
endpoints
(type: maybe-list-of-strings)The addresses that mpd will bind to. A port different from
default-port may be specified, e.g. localhost:6602
and IPv6
addresses must be enclosed in square brackets when a different port is
used. To use a Unix domain socket, an absolute path or a path starting with
~
can be specified here.
address
(type: maybe-string)L’adresse sur laquelle se lie mpd. Pour utiliser un socket Unix domain, un chemin absolu peut être spécifié ici.
database
(type: maybe-mpd-plugin)MPD database plugin configuration.
partitions
(default: '()
) (type: list-of-mpd-partition)List of MPD "partitions".
neighbors
(default: '()
) (type: list-of-mpd-plugin)List of MPD neighbor plugin configurations.
inputs
(default: '()
) (type: list-of-mpd-plugin)List of MPD input plugin configurations.
archive-plugins
(default: '()
) (type: list-of-mpd-plugin)List of MPD archive plugin configurations.
auto-update?
(type: maybe-boolean)Whether to automatically update the music database when files are changed in the music-directory.
input-cache-size
(type: maybe-string)MPD input cache size.
decoders
(default: '()
) (type: list-of-mpd-plugin)List of MPD decoder plugin configurations.
resampler
(type: maybe-mpd-plugin)MPD resampler plugin configuration.
filters
(default: '()
) (type: list-of-mpd-plugin)List of MPD filter plugin configurations.
outputs
(type: list-of-mpd-plugin-or-output)Les sorties audio que MPD peut utiliser. Par défaut c’est une seule sortie audio utilisant pulseaudio.
playlist-plugins
(default: '()
) (type: list-of-mpd-plugin)List of MPD playlist plugin configurations.
extra-options
(default: '()
) (type: alist)An association list of option symbols/strings to string values to be appended to the configuration.
Data type representing a mpd
plugin.
plugin
(type: maybe-string)Plugin name.
name
(type: maybe-string)Name.
enabled?
(type: maybe-boolean)Whether the plugin is enabled/disabled.
extra-options
(default: '()
) (type: alist)An association list of option symbols/strings to string values to be appended to the plugin configuration. See MPD plugin reference for available options.
Data type representing a mpd
partition.
name
(type : string)Partition name.
extra-options
(default: '()
) (type: alist)An association list of option symbols/strings to string values to be appended to the partition configuration. See Configuring Partitions for available options.
Available mpd-output
fields are:
name
(default: "MPD"
) (type: string)Le nom de la sortie audio.
type
(default: "pulse"
) (type: string)Le type de sortie audio.
enabled?
(par défaut : #t
) (type : booléen)Spécifie si cette sortie audio est activée au démarrage de MPD. Par défaut, toutes les sorties audio sont activées. C’est le paramètre par défaut s’il n’y a pas de fichier d’état ; avec un fichier d’état, l’état précédent est restauré.
format
(type: maybe-string)Force a specific audio format on output. See Global Audio Format for a more detailed description.
tags?
(default: #t
) (type: boolean)Si la valeur est #f
, MPD n’enverra pas les tags à cette sortie.
C’est utile uniquement pour les greffons de sortie qui peuvent recevoir les
tags, comme le greffon de sortie httpd
.
always-on?
(default: #f
) (type: boolean)If set to #t
, then MPD attempts to keep this audio output always
open. This may be useful for streaming servers, when you don’t want to
disconnect all listeners even when playback is accidentally stopped.
mixer-type
(type: maybe-string)This field accepts a string that specifies which mixer should be used for
this audio output: the hardware
mixer, the software
mixer, the
null
mixer (allows setting the volume, but with no effect; this can
be used as a trick to implement an external mixer External Mixer) or no
mixer (none
). When left unspecified, a hardware
mixer is used
for devices that support it.
replay-gain-handler
(type: maybe-string)This field accepts a string that specifies how
Replay
Gain is to be applied. software
uses an internal software volume
control, mixer
uses the configured (hardware) mixer control and
none
disables replay gain on this audio output.
extra-options
(default: '()
) (type: alist)An association list of option symbols/strings to string values to be appended to the audio output configuration.
The following example shows a configuration of mpd
that configures
some of its plugins and provides a HTTP audio streaming output.
(service mpd-service-type
(mpd-configuration
(outputs
(list (mpd-output
(name "streaming")
(type "httpd")
(mixer-type 'null)
(extra-options
`((encoder . "vorbis")
(port . "8080"))))))
(decoders
(list (mpd-plugin
(plugin "mikmod")
(enabled? #f))
(mpd-plugin
(plugin "openmpt")
(enabled? #t)
(extra-options `((repeat-count . -1)
(interpolation-filter . 1))))))
(resampler (mpd-plugin
(plugin "libsamplerate")
(extra-options `((type . 0)))))))
myMPD is a web server frontend for MPD that provides a mobile friendly web client for MPD.
The following example shows a myMPD instance listening on port 80, with album cover caching disabled.
(service mympd-service-type
(mympd-configuration
(port 80)
(covercache-ttl 0)))
The service type for mympd
.
Available mympd-configuration
fields are:
package
(default: mympd
) (type: file-like)The package object of the myMPD server.
shepherd-requirement
(default: '()
) (type: list-of-symbols)This is a list of symbols naming Shepherd services that this service will depend on.
user
(default: %mympd-user
) (type: user-account)Owner of the mympd
process.
The default %mympd-user
is a system user with the name “mympd”, who
is a part of the group group (see below).
group
(default: %mympd-group
) (type: user-group)Owner group of the mympd
process.
The default %mympd-group
is a system group with name “mympd”.
work-directory
(default: "/var/lib/mympd"
) (type: string)Where myMPD will store its data.
cache-directory
(default: "/var/cache/mympd"
) (type: string)Where myMPD will store its cache.
acl
(type: maybe-mympd-ip-acl)ACL to access the myMPD webserver.
covercache-ttl
(default: 31
) (type: maybe-integer)How long to keep cached covers, 0
disables cover caching.
http?
(default: #t
) (type: boolean)HTTP support.
host
(default: "[::]"
) (type: string)Host name to listen on.
port
(default: 80
) (type: maybe-port)HTTP port to listen on.
log-level
(default: 5
) (type: integer)How much detail to include in logs, possible values: 0
to 7
.
log-to
(type: maybe-string)Where to send logs. Unless specified, the service logs to the local syslog service under the ‘daemon’ facility. Alternatively, a log file name can be specified, for example /var/log/mympd.log.
lualibs
(default: "all"
) (type: maybe-string)See https://jcorporation.github.io/myMPD/scripting/#lua-standard-libraries.
uri
(type: maybe-string)Override URI to myMPD. See https://github.com/jcorporation/myMPD/issues/950.
script-acl
(default: (mympd-ip-acl (allow '("127.0.0.1")))
) (type: maybe-mympd-ip-acl)ACL to access the myMPD script backend.
ssl?
(default: #f
) (type: boolean)SSL/TLS support.
ssl-port
(default: 443
) (type: maybe-port)Port to listen for HTTPS.
ssl-cert
(type: maybe-string)Path to PEM encoded X.509 SSL/TLS certificate (public key).
ssl-key
(type: maybe-string)Path to PEM encoded SSL/TLS private key.
pin-hash
(type: maybe-string)SHA-256 hashed pin used by myMPD to control settings access by prompting a pin from the user.
save-caches?
(type: maybe-boolean)Whether to preserve caches between service restarts.
Available mympd-ip-acl
fields are:
allow
(default: '()
) (type: list-of-strings)Allowed IP addresses.
deny
(default: '()
) (type: list-of-strings)Disallowed IP addresses.
Suivant: Services de contrôle de version, Précédent: Services audio, Monter: Services [Table des matières][Index]
Le module (gnu services virtualization)
fournit des services pour les
démons libvirt et virtlog, ainsi que d’autres services liés à la
virtualisation.
libvirtd
is the server side daemon component of the libvirt
virtualization management system. This daemon runs on host servers and
performs required management tasks for virtualized guests. To connect to
the libvirt daemon as an unprivileged user, it must be added to the
‘libvirt’ group, as shown in the example below.
C’est le type du démon libvirt. Sa valeur doit
être un libvirt-configuration
.
(users (cons (user-account (name "user") (group "users") (supplementary-groups '("libvirt" "audio" "video" "wheel"))) %base-user-accounts)) (service libvirt-service-type (libvirt-configuration (tls-port "16555")))
Les champs de libvirt-configuration
disponibles sont :
libvirt-configuration
:package libvirt ¶Paquet libvirt.
libvirt-configuration
:boolean listen-tls? ¶Indique s’il faut écouter des connexions TLS sécurisées sur le port TCP/IP
public. Vous devez remplir le champ listen
pour que cela ait un
effet.
Il est nécessaire de mettre en place une CA et de créer un certificat serveur avant d’utiliser cette fonctionnalité.
La valeur par défaut est ‘#t’.
libvirt-configuration
:boolean listen-tcp? ¶Écoute des connexions non-chiffrées sur le port TCP/IP public. Vous devez
remplir le champ listen
pour que cela ait un effet.
L’utilisation des sockets TCP requiert une authentification SASL par défaut. Seuls les mécanismes SASL qui prennent en charge le chiffrement des données sont permis. Il s’agit de DIGEST_MD5 et GSSAPI (Kerberos5).
La valeur par défaut est ‘#f’.
libvirt-configuration
:string tls-port ¶Port pour accepter les connexions TLS sécurisées. Il peut s’agir d’un numéro de port ou d’un nom de service.
La valeur par défaut est ‘"16514"’.
libvirt-configuration
:string tcp-port ¶Port sur lequel accepter les connexions TCP non sécurisées. Cela peut être un numéro de port ou un nom de service.
La valeur par défaut est ‘"16509"’.
libvirt-configuration
:string listen-addr ¶Adresse IP ou nom d’hôte utilisé pour les connexions des clients.
La valeur par défaut est ‘"0.0.0.0"’.
libvirt-configuration
:boolean mdns-adv? ¶Indique s’il faut annoncer le service libvirt en mDNS.
Autrement, vous pouvez désactiver cela pour tous les services en stoppant le démon Avahi.
La valeur par défaut est ‘#f’.
libvirt-configuration
:string mdns-name ¶Nom annoncé par défaut sur mDNS. Cela doit être unique sur le réseau local.
La valeur par défaut est ‘"Virtualization Host <hostname>"’.
libvirt-configuration
:string unix-sock-group ¶Groupe propriétaire du socket Unix domain. Cela peut être utilisé pour permettre à un ensemble d’utilisateurs « de confiance » de gérer les fonctionnalités sans devenir root.
Defaults to ‘"libvirt"’.
libvirt-configuration
:string unix-sock-ro-perms ¶Permission Unix pour le socket en lecture seule. Il est utilisé pour surveiller le statut des VM uniquement.
La valeur par défaut est ‘"0777"’.
libvirt-configuration
:string unix-sock-rw-perms ¶Permission Unix pour le socket en lecture-écriture. La valeur par défaut n’autorise que root. Si PolicyKit est activé sur le socket, la valeur par défaut change et permet tout le monde (c.-à-d. 0777)
La valeur par défaut est ‘"0770"’.
libvirt-configuration
:string unix-sock-admin-perms ¶Permissions Unix pour le socket d’administration. La valeur par défaut ne permet que le propriétaire (root), ne la changez pas à moins que vous ne soyez sûr de savoir à qui vous exposez cet accès.
La valeur par défaut est ‘"0777"’.
libvirt-configuration
:string unix-sock-dir ¶Le répertoire dans lequel les sockets sont créés.
La valeur par défaut est ‘"/var/run/libvirt"’.
libvirt-configuration
:string auth-unix-ro ¶Schéma d’authentification pour les socket Unix en lecture-seule. Par défaut les permissions des socket permettent à n’importe qui de se connecter
La valeur par défaut est ‘"polkit"’.
libvirt-configuration
:string auth-unix-rw ¶Schéma d’authentification pour les socket UNIX en lecture-écriture. Par défaut les permissions du socket ne permettent que root. Si le support de PolicyKit a été compilé dans libvirt, la valeur par défaut utilise l’authentification « polkit ».
La valeur par défaut est ‘"polkit"’.
libvirt-configuration
:string auth-tcp ¶Schéma d’authentification pour les sockets TCP. Si vous n’avez pas activé SASL, alors tout le trafic TCP est en clair. Ne le faites pas en dehors de scénario de développement ou de test.
La valeur par défaut est ‘"sasl"’.
libvirt-configuration
:string auth-tls ¶Schéma d’authentification pour les sockets TLS. Les sockets TLS sont déjà chiffrés par la couche TLS, et une authentification limitée est effectuée avec les certificats.
Il est possible d’utiliser de n’importe quel mécanisme d’authentification SASL en utilisant « sasl » pour cette option
La valeur par défaut est ‘"none"’.
libvirt-configuration
:optional-list access-drivers ¶Schéma de contrôle d’accès à l’API.
Par défaut un utilisateur authentifié peut accéder à toutes les API. Les pilotes d’accès peuvent placer des restrictions là-dessus.
La valeur par défaut est ‘'()’.
libvirt-configuration
:string key-file ¶Chemin de fichier de la clef du serveur. Si la valeur est une chaîne vide, aucune clef privée n’est chargée.
La valeur par défaut est ‘""’.
libvirt-configuration
:string cert-file ¶Chemin de fichier de la clef du serveur. Si la chaîne est vide, aucun certificat n’est chargé.
La valeur par défaut est ‘""’.
libvirt-configuration
:string ca-file ¶Chemin de fichier de la clef du serveur. Si la chaîne est vide, aucun certificat de CA n’est chargé.
La valeur par défaut est ‘""’.
libvirt-configuration
:string crl-file ¶Chemin de la liste de révocation des certificats. Si la chaîne est vide, aucun CRL n’est chargé.
La valeur par défaut est ‘""’.
libvirt-configuration
:boolean tls-no-sanity-cert ¶Désactive la vérification de nos propres certificats serveurs.
Lorsque libvirtd démarre il effectue des vérifications de routine sur ses propres certificats.
La valeur par défaut est ‘#f’.
libvirt-configuration
:boolean tls-no-verify-cert ¶Désactive la vérification des certificats clients.
La vérification des certificats clients est le mécanisme d’authentification principal. Tout client qui ne présent pas de certificat signé par la CA sera rejeté.
La valeur par défaut est ‘#f’.
libvirt-configuration
:optional-list tls-allowed-dn-list ¶Liste blanche des Distinguished Name x509 autorisés.
La valeur par défaut est ‘'()’.
libvirt-configuration
:optional-list sasl-allowed-usernames ¶Liste blanche des noms d’utilisateur SASL permis. Le format des noms d’utilisateurs dépend du mécanisme d’authentification SASL.
La valeur par défaut est ‘'()’.
libvirt-configuration
:string tls-priority ¶Modifie la chaine de priorité TLS par défaut fixée à la compilation. La valeur par défaut est typiquement ‘NORMAL’ à moins qu’elle n’ait été modifiée à la compilation. Ne l’indiquez que si vous voulez que libvirt agisse différemment des paramètres par défaut globaux.
La valeur par défaut est ‘"NORMAL"’.
libvirt-configuration
:integer max-clients ¶Nombre maximum de connexions clientes en même temps sur tous les sockets.
La valeur par défaut est ‘5000’.
libvirt-configuration
:integer max-queued-clients ¶Longueur maximum de la queue de connexions en attente d’acceptation du démon. Remarquez que certains protocoles supportant la retransmission peuvent obéir à ce paramètre pour qu’une connexion ultérieure réussisse.
La valeur par défaut est ‘1000’.
libvirt-configuration
:integer max-anonymous-clients ¶Longueur maximum de la queue des clients acceptés mais pas authentifiés. Indiquez zéro pour désactiver ce paramètre
La valeur par défaut est ‘20’.
libvirt-configuration
:integer min-workers ¶Nombre de processus de travail démarrés initialement.
La valeur par défaut est ‘5’.
libvirt-configuration
:integer max-workers ¶Nombre maximum de threads de travail.
Si le nombre de clients actifs dépasse min-workers
, plus de threads
seront démarrés, jusqu’à la limite de max_workers. Typiquement vous voulez
que max_workers soit égal au nombre maximum de clients permis.
La valeur par défaut est ‘20’.
libvirt-configuration
:integer prio-workers ¶Nombre de travailleurs prioritaires. Si tous les threads de travail du groupe ci-dessus sont bloqués, certains appels marqués comme prioritaires (notamment domainDestroy) peuvent être exécutés par ce groupe.
La valeur par défaut est ‘5’.
libvirt-configuration
:integer max-requests ¶Limite globale totale sur les appels RPC concurrents.
La valeur par défaut est ‘20’.
libvirt-configuration
:integer max-client-requests ¶Limite de requêtes concurrentes depuis une connexion cliente unique. Pour éviter qu’un client ne monopolise le serveur, vous devriez indiquer une petite partie des paramètres global max_requests et max_workers.
La valeur par défaut est ‘5’.
libvirt-configuration
:integer admin-min-workers ¶Comme min-workers
mais pour l’interface d’administration.
La valeur par défaut est ‘1’.
libvirt-configuration
:integer admin-max-workers ¶Comme max-workers
mais pour l’interface d’administration.
La valeur par défaut est ‘5’.
libvirt-configuration
:integer admin-max-clients ¶Comme max-clients
mais pour l’interface d’administration.
La valeur par défaut est ‘5’.
libvirt-configuration
:integer admin-max-queued-clients ¶Comme max-queued-clients
mais pour l’interface d’administration.
La valeur par défaut est ‘5’.
libvirt-configuration
:integer admin-max-client-requests ¶Comme max-client-requests
mais pour l’interface d’administration.
La valeur par défaut est ‘5’.
libvirt-configuration
:integer log-level ¶Niveau de journalisation. 4 : erreurs, 3 : avertissements, 2 : information, 1 : débogage.
La valeur par défaut est ‘3’.
libvirt-configuration
:string log-filters ¶Filtres de journalisation.
Un filtre qui permet de sélectionner un niveau de journalisation différent pour une catégorie donnée. Le format d’un filtre est :
où nom
est une chaine de caractères qui correspond à la catégorie
donnée dans VIR_LOG_INIT()
au début de chaque fichier source de
libvirt, p. ex. ‘remote’, ‘qemu’ ou ‘util.json’ (le nom
dans le filtre peut être une sous-chaine du nom complet de la catégorie,
pour pouvoir correspondre à plusieurs catégories similaires), le préfixe
facultatif ‘+’ dit à libvirt d’enregistrer les traces de piles pour
chaque message qui correspond au nom, et x
est le niveau minimal des
messages qui devraient être enregistrés :
On peut définir plusieurs filtres dans une seule déclaration de filtres, ils doivent juste être séparés par des espaces.
La valeur par défaut est ‘"3:remote 4:event"’.
libvirt-configuration
:string log-outputs ¶Sorties de débogage.
Une sortie est l’un des endroits où les journaux sont enregistrés. Le format d’une sortie peut être :
x:stderr
la sortie va vers stderr
x:syslog:nom
utilise syslog comme sortie et utilise le nom donné comme identifiant
x:file:chemin_fichier
la sortie va vers un fichier, avec le chemin donné
x:journald
la sortie va vers le système de journalisation journald
Dans tous les cas, le préfixe x est le niveau minimal, qui agit comme un filtre
Plusieurs sorties peuvent être définies, elles doivent juste être séparées par des espaces.
La valeur par défaut est ‘"3:stderr"’.
libvirt-configuration
:integer audit-level ¶Permet de modifier l’utilisation du sous-système d’audit
La valeur par défaut est ‘1’.
libvirt-configuration
:boolean audit-logging ¶Envoie les messages d’audit via l’infrastructure de journalisation de libvirt.
La valeur par défaut est ‘#f’.
libvirt-configuration
:optional-string host-uuid ¶UUID de l’hôte. L’UUID ne doit pas avoir tous ses nombres identiques.
La valeur par défaut est ‘""’.
libvirt-configuration
:string host-uuid-source ¶Source où lire l’UUID de l’hôte.
smbios
: récupère l’UUID à partir de dmidecode -s system-uuid
machine-id
: récupère l’UUID à partir de /etc/machine-id
Si dmidecode
ne fournit pas un UUID valide, un UUID temporaire sera
généré.
La valeur par défaut est ‘"smbios"’.
libvirt-configuration
:integer keepalive-interval ¶Un message keepalive est envoyé au client après keepalive_interval
secondes d’inactivité pour vérifier si le client répond toujours. Si la
valeur est -1, libvirtd n’enverra jamais de requête keepalive ; cependant
les clients peuvent toujours en envoyer et le démon y répondra.
La valeur par défaut est ‘5’.
libvirt-configuration
:integer keepalive-count ¶Nombre maximum de messages keepalive qui peuvent être envoyés au client sans réponse avant que la connexion ne soit considérée comme cassée.
En d’autres termes, la connexion est approximativement fermée après
keepalive_interval * (keepalive_count + 1)
secondes après le dernier
message reçu de la part du client. Lorsque keepalive-count
est à 0,
les connexions seront automatiquement fermées après
keepalive-interval
secondes d’inactivité sans envoyer le moindre
message keepalive.
La valeur par défaut est ‘5’.
libvirt-configuration
:integer admin-keepalive-interval ¶Comme précédemment, mais pour l’interface d’administration.
La valeur par défaut est ‘5’.
libvirt-configuration
:integer admin-keepalive-count ¶Comme précédemment, mais pour l’interface d’administration.
La valeur par défaut est ‘5’.
libvirt-configuration
:integer ovs-timeout ¶Délai d’attente pour les appels Open vSwitch.
L’utilitaire ovs-vsctl
est utilisé pour la configuration et son
option de délai d’attente est à 5 secondes pour éviter qu’une attente
infinie ne bloque libvirt.
La valeur par défaut est ‘5’.
Le service virtlogd est un démon côté serveur qui fait partie de libvirt, utilisé pour gérer les journaux des consoles des machines virtuelles.
Ce démon n’est pas utilisé directement par les clients libvirt, mais il est
appelé pour eux par libvirtd
. En maintenant les journaux dans un
démon séparé, le démon libvirtd
principal peut être redémarré sans
risque de perte de journaux. Le démon virtlogd
a la possibilité de
ré-exécuter exec() sur lui-même quand il reçoit SIGUSR1
, pour
permettre des mises à jour à chaud sans temps mort.
Le type de service pour le démon virtlogd. Sa valeur doit être un
virtlog-configuration
.
(service virtlog-service-type
(virtlog-configuration
(max-clients 1000)))
libvirt
:package libvirt ¶Paquet libvirt.
virtlog-configuration
:integer log-level ¶Niveau de journalisation. 4 : erreurs, 3 : avertissements, 2 : information, 1 : débogage.
La valeur par défaut est ‘3’.
virtlog-configuration
:string log-filters ¶Filtres de journalisation.
Un filtre qui permet de sélectionner plusieurs niveaux de journalisation pour une catégorie donnée. Le format d’un filtre est :
où nom
est une chaîne de caractères qui correspond à la catégorie
donnée dans VIR_LOG_INIT()
au début de chaque fichier source de
libvirt, p. ex. « remote », « qemu » ou « util.json » (le nom dans le
filtre peut être une sous-chaîne du nom complet de la catégorie, pour
pouvoir correspondre à plusieurs catégories similaires), le préfixe
facultatif « + » dit à libvirt d’enregistrer les traces de piles pour chaque
message qui correspond au nom, et x
est le niveau minimal des
messages qui devraient être enregistrés :
On peut définir plusieurs filtres dans une seule déclaration de filtres, ils doivent juste être séparés par des espaces.
La valeur par défaut est ‘"3:remote 4:event"’.
virtlog-configuration
:string log-outputs ¶Sorties de débogage.
Une sortie est l’un des endroits où les journaux sont enregistrés. Le format d’une sortie peut être :
x:stderr
la sortie va vers stderr
x:syslog:nom
utilise syslog comme sortie et utilise le nom donné comme identifiant
x:file:chemin_fichier
la sortie va vers un fichier, avec le chemin donné
x:journald
la sortie va vers le système de journalisation journald
Dans tous les cas, le préfixe x est le niveau minimal, qui agit comme un filtre
Plusieurs sorties peuvent être définies, elles doivent juste être séparées par des espaces.
La valeur par défaut est ‘"3:stderr"’.
virtlog-configuration
:integer max-clients ¶Nombre maximum de connexions clientes en même temps sur tous les sockets.
La valeur par défaut est ‘1024’.
virtlog-configuration
:integer max-size ¶Taille de fichier maximale avant roulement.
La valeur par défaut est ‘2MB’
virtlog-configuration
:integer max-backups ¶Nombre maximal de fichiers de sauvegardes à garder.
La valeur par défaut est ‘3’
qemu-binfmt-service-type
fournit le support de l’émulation
transparente de binaires construits pour des architectures différentes —
p. ex. il permet d’exécuter de manière transparente des programmes ARMv7
sur une machine x86_64. Cela se fait en combinant l’émulateur
QEMU et la fonctionnalité binfmt_misc
du
noyau Linux. Cette fonctionnalité ne vous permet que d’émuler GNU/Linux sur
une architecture différente, mais regardez plus bas pour GNU/Hurd.
Le type du service QEMU/binfmt pour l’émulation transparente. Sa valeur
doit être un objet qemu-binfmt-configuration
, qui spécifie le paquet
QEMU à utiliser ainsi que l’architecture que vous voulez émuler :
(service qemu-binfmt-service-type
(qemu-binfmt-configuration
(platforms (lookup-qemu-platforms "arm" "aarch64"))))
Dans cet exemple, on active l’émulation transparente pour les plateformes
ARM et aarch64. Lancer herd stop qemu-binfmt
l’éteint et lancer
herd start qemu-binfmt
le rallume (voir the
herd
command dans The GNU Shepherd Manual).
La configuration du service qemu-binfmt
.
platforms
(par défaut : '()
)La liste des plates-formes émulées par QEMU. Chaque élément doit être un
objet platform object tel que renvoyé par lookup-qemu-platforms
(voir plus bas).
Par exemple, supposons que vous soyez sur une machine x86_64 et que vous avez ce services :
(service qemu-binfmt-service-type
(qemu-binfmt-configuration
(platforms (lookup-qemu-platforms "arm"))))
Vous pouvez lancer :
guix build -s armhf-linux inkscape
et cela construira Inkscape pour ARMv7 comme s’il s’agissait d’une construction native, de manière transparente avec QEMU pour émuler un CPU ARMv7. Plutôt pratique si vous voulez tester un paquet construit pour une architecture à laquelle vous n’avez pas accès !
qemu
(par défaut : qemu
)Le paquet QEMU à utiliser.
Renvoie la liste des objets de plates-formes QEMU correspondant à
platforms…. platforms doit être une liste de chaînes de
caractères correspondant aux noms de plates-formes, comme "arm"
,
"sparc"
, "mips64el"
etc.
Renvoie vrai s iobj est un objet de plate-forme.
Renvoie le nom de platform — une chaîne comme "arm"
.
L’agent invité de QEMU permet de contrôler le système émulé à partir de
l’hôte. Le service qemu-guest-agent
lance l’agent sur les invités
Guix. Pour contrôler l’agent à partir de l’hôte, ouvrez un socket en
invoquant QEMU avec les arguments suivants :
qemu-system-x86_64 \ -chardev socket,path=/tmp/qga.sock,server=on,wait=off,id=qga0 \ -device virtio-serial \ -device virtserialport,chardev=qga0,name=org.qemu.guest_agent.0 \ ...
Cela crée un socket dans /tmp/qga.sock sur l’hôte. Une fois l’agent
invité lancé vos pouvez exécuter des commandes avec socat
:
$ guix shell socat -- socat unix-connect:/tmp/qga.sock stdio {"execute": "guest-get-host-name"} {"return": {"host-name": "guix"}}
Voir la documentation de l’agent invité de QEMU pour les options et les commandes supplémentaires.
Type de service pour l’agent invité de QEMU.
La configuration du service qemu-guest-agent
.
qemu
(par défaut : qemu-minimal
)Le paquet QEMU à utiliser.
device
(par défaut : ""
)Le nom de périphérique ou de socket que l’agent utilise pour communiquer avec l’hôte. Si le nom est vide, QEMU utilisera un nom de fichier par défaut.
Virtual build machines or “build VMs” let you offload builds to a fully controlled environment. “How can it be more controlled than regular builds? And why would it be useful?”, you ask. Good questions.
Builds spawned by guix-daemon
indeed run in a controlled environment;
specifically the daemon spawns build processes in separate namespaces and in
a chroot, such as that build processes only see their declared dependencies
and a well-defined subset of the file system tree (voir Réglages de l’environnement de construction, for details). A few aspects of the environments are not controlled
though: the operating system kernel, the CPU model, and the date. Most of
the time, these aspects have no impact on the build process: the level of
isolation guix-daemon
provides is “good enough”.
However, there are occasionally cases where those aspects do influence the build process. A typical example is time traps: build processes that stop working after a certain date38. Another one is software that optimizes for the CPU microarchitecture it is built on or, worse, bugs that manifest only on specific CPUs.
To address that, virtual-build-machine-service-type
lets you add a
virtual build machine on your system, as in this example:
(use-modules (gnu services virtualization)) (operating-system ;; … (services (append (list (service virtual-build-machine-service-type)) %base-services)))
By default, you have to explicitly start the build machine when you need it, at which point builds may be offloaded to it (voir Utiliser le dispositif de déchargement):
herd start build-vm
With the default setting shown above, the build VM runs with its clock set to a date several years in the past, and on a CPU model that corresponds to that date—a model possibly older than that of your machine. This lets you rebuild today software from the past that would otherwise fail to build due to a time trap or other issues in its build process. You can view the VM’s config like this:
herd configuration build-vm
You can configure the build VM, as in this example:
(service virtual-build-machine-service-type
(virtual-build-machine
(cpu "Westmere")
(cpu-count 8)
(memory-size (* 1 1024))
(auto-start? #t)))
The available options are shown below.
This is the service type to run virtual build machines. Virtual build machines are configured so that builds are offloaded to them when they are running.
This is the data type specifying the configuration of a build machine. It contains the fields below:
name
(default: 'build-vm
)The name of this build VM. It is used to construct the name of its Shepherd service.
image
The image of the virtual machine (voir Créer des images systèmes). This notably
specifies the virtual disk size and the operating system running into it
(voir Référence de operating-system
). The default value is a minimal
operating system image.
qemu
(par défaut : qemu-minimal
)The QEMU package to run the image.
cpu
The CPU model being emulated as a string denoting a model known to QEMU.
The default value is a model that matches date
(see below). To see
what CPU models are available, run, for example:
qemu-system-x86_64 -cpu help
cpu-count
(default: 4
)The number of CPUs emulated by the virtual machine.
memory-size
(default: 2048
)Size in mebibytes (MiB) of the virtual machine’s main memory (RAM).
date
(default: a few years ago)Date inside the virtual machine when it starts; this must be a SRFI-19 date object (voir SRFI-19 Date dans GNU Guile Reference Manual).
port-forwardings
(default: 11022 and 11004)TCP ports of the virtual machine forwarded to the host. By default, the SSH and secrets ports are forwarded into the host.
systems
(par défaut : (list (%current-system))
)List of system types supported by the build VM—e.g.,
"x86_64-linux"
.
auto-start?
(default: #f
)Whether to start the virtual machine when the system boots.
In the next section, you’ll find a variant on this theme: GNU/Hurd virtual machines!
Le service hurd-vm
permet de lancer GNU/Hurd dans une machine
virtuelle (VM), un childhurd. Ce service est conçu pour être utilisé
sur GNU/Linux et la configuration du système GNU/Hurd donné est compilée de
manière croisée. La machine virtuelle est un service Shepherd qui a les
noms hurd-vm
et childhurd
et qui peut être contrôlé avec les
commandes suivantes :
herd start hurd-vm herd stop childhurd
Lorsque le service est lancé, vous pouvez voir sa console en vous y connectant avec un client VNC, par exemple avec :
guix shell tigervnc-client -- vncviewer localhost:5900
The default configuration (see hurd-vm-configuration
below) spawns a
secure shell (SSH) server in your GNU/Hurd system, which QEMU (the virtual
machine emulator) redirects to port 10022 on the host. By default, the
service enables offloading such that the host guix-daemon
automatically offloads GNU/Hurd builds to the childhurd (voir Utiliser le dispositif de déchargement). This is what happens when running a command like the
following one, where i586-gnu
is the system type of 32-bit GNU/Hurd:
guix build emacs-minimal -s i586-gnu
Le childhurd est volatile et sans état . il démarre avec un nouveau système
de fichier à chaque fois que vous le redémarrez. Par défaut cependant, tous
les fichiers sous /etc/childhurd sur l’hôte sont copiés tels quels
sur le système de fichiers racine du childhurd à son démarrage. Cela vous
permet d’initialiser des « secrets » à l’intérieur de la VM : les clés hôtes
SSH, les clés de substituts autorisés, etc — voir l’explication de
secret-root
ci-dessous.
You will probably find it useful to create an account for you in the
GNU/Hurd virtual machine and to authorize logins with your SSH key. To do
that, you can define the GNU/Hurd system in the usual way (voir Utiliser le système de configuration), and then pass that operating system as the os
field of hurd-vm-configuration
, as in this example:
(define childhurd-os ;; Definition of my GNU/Hurd system, derived from the default one. (operating-system (inherit %hurd-vm-operating-system) ;; Add a user account. (users (cons (user-account (name "charlie") (comment "This is me!") (group "users") (supplementary-groups '("wheel"))) ;for 'sudo' %base-user-accounts)) (services ;; Modify the SSH configuration to allow login as "root" ;; and as "charlie" using public key authentication. (modify-services (operating-system-user-services %hurd-vm-operating-system) (openssh-service-type config => (openssh-configuration (inherit config) (authorized-keys `(("root" ,(local-file "/home/charlie/.ssh/id_rsa.pub")) ("charlie" ,(local-file "/home/charlie/.ssh/id_rsa.pub")))))))))) (operating-system ;; … (services ;; Add the 'hurd-vm' service, configured to use the ;; operating system configuration above. (append (list (service hurd-vm-service-type (hurd-vm-configuration (os %childhurd-os)))) %base-services)))
That’s it! The remainder of this section provides the reference of the service configuration.
C’est le type du service du Hurd dans une machine virtuelle. Sa valeur doit
être un objet hurd-vm-configuration
, qui spécifie le système
d’exploitation (voir Référence de operating-system
) et la taille de disque
pour la machine virtuelle du Hurd, le paquet QEMU à utiliser ainsi que les
options pour le lancer.
Par exemple :
(service hurd-vm-service-type (hurd-vm-configuration (disk-size (* 5000 (expt 2 20))) ;5G (memory-size 1024))) ;1024MiB
créerait une image disque assez grande pour construire GNU Hello, avec une peu de place en plus.
Type de données représentant la configuration de
hurd-vm-service-type
.
os
(par défaut : %hurd-vm-operating-system)Le système d’exploitation à instancier. La valeur par défaut est le système
minimal avec un démon OpenSSH permissif en écoute sur le port 2222
(voir openssh-service-type
).
qemu
(par défaut : qemu-minimal
)Le paquet QEMU à utiliser.
image
(par défaut : hurd-vm-disk-image)The image object representing the disk image of this virtual machine (voir Créer des images systèmes).
disk-size
(par défaut : 'guess
)La taille de l’image disque.
memory-size
(par défaut : 512
)La taille de mémoire de la machine virtuelle en mébioctets.
options
(par défaut : '("--snapshot")
)Options supplémentaires pour lancer QEMU.
id
(par défaut : #f
)Si l’option est indiquée, c’est un entier strictement positif utilisé créer
plusieurs instances de childhurd. Il est ajouté au nom du service, p.
ex. childhurd1
.
net-options
(par défaut : hurd-vm-net-options)La procédure utilisée pour produire une liste d’options réseau pour QEMU.
Par défaut, elle produit
'("--device" "rtl8139,netdev=net0" "--netdev" (string-append "user,id=net0," "hostfwd=tcp:127.0.0.1:secrets-port-:1004," "hostfwd=tcp:127.0.0.1:ssh-port-:2222," "hostfwd=tcp:127.0.0.1:vnc-port-:5900"))
avec les ports renvoyés :
secrets-port:(+ 11004 (* 1000 ID))
ssh-port:(+ 10022 (* 1000 ID))
vnc-port:(+ 15900 (* 1000 ID))
offloading?
(default: #t
)Whether to automatically set up offloading of builds to the childhurd.
When enabled, this lets you run GNU/Hurd builds on the host and have them transparently offloaded to the VM, for instance when running a command like this:
guix build coreutils -s i586-gnu
This option automatically sets up offloading like so:
guix archive --authorize
, for more
on that).
offloading
dedicated to offloading in
the childhurd.
offloading
account in the childhurd.
secret-root
(par défaut : /etc/childhurd)Le répertoire racine avec des secrets externes à installer dans le childhurd une fois lancé. Les childhurds sont volatile, ce qiu signifie qu’à chaque démarrage, les secrets comme les clés hôtes SSH et la clé de signature de Guix sont recréés.
Si le répertoire /etc/childhurd n’existe pas, le
secret-service
qui tourne dans le Childhurd recevra une liste vide de
secrets.
Par défaut, le service rempli automatiquement /etc/childhurd avec les secrets non-volatiles suivants, à moins qu’ils existent déjà :
/etc/childhurd/etc/guix/acl /etc/childhurd/etc/guix/signing-key.pub /etc/childhurd/etc/guix/signing-key.sec /etc/childhurd/etc/ssh/authorized_keys.d/offloading /etc/childhurd/etc/ssh/ssh_host_ed25519_key /etc/childhurd/etc/ssh/ssh_host_ecdsa_key /etc/childhurd/etc/ssh/ssh_host_ed25519_key.pub /etc/childhurd/etc/ssh/ssh_host_ecdsa_key.pub
Remarquez que par défaut l’image de la VM est volatile, c.-à-d. qu’une
fois arrêtée le contenu est perdu. Si vous voulez une image avec état à la
place, remplacez les champs image
et options
pour enlever le
drapeau --snapshot
avec quelque chose de ce style-là :
(service hurd-vm-service-type
(hurd-vm-configuration
(image (const "/out/of/store/writable/hurd.img"))
(options '())))
Remarque : Ce service est considéré comme étant expérimental. Les options de configuration peuvent changer de manière non compatible, et tous les paramètres n’ont pas été testés. Si vous utilisez ce service, nous vous encourageons à partager votre expérience avec guix-devel@gnu.org.
Ganeti est un système de gestion de machines virtuelles. Il est conçu pour
faire tourner les machines virtuelles en continue sur une grappe de serveurs
même dans le cas d’une erreur matérielle, et pour rendre les tâches de
maintenance et de récupération faciles. Il consisste en plusieurs services
qui sont décrits plus loin dans cette section. En plus du service Ganeti,
vous aurez besoin du service OpenSSH (voir openssh-service-type
), et de mettre à jour le fichier
/etc/hosts (voir hosts-service-type
)
avec le nom de la grappe et l’adresse (ou utiliser un serveur DNS).
Tous les nœuds participant dans une grappe Ganeti devraient avec la même
configuration de Ganeti et /etc/hosts. voici un exemple de
configuration pour un nœud d’une grappe Ganeti qui prend en charge plusieurs
moteurs de stockage et installe les fournisseurs de systèmes
debbotstrap
et guix
:
(use-package-modules virtualization) (use-service-modules base ganeti networking ssh) (operating-system ;; … (host-name "node1") ;; Installe QEMU pour pouvoir utiliser les instances KVM, ainsi que LVM, DRBD et Ceph ;; pour utiliser les moteurs de stockage « plain », « drbd » et « rbd ». (packages (append (map specification->package '("qemu" "lvm2" "drbd-utils" "ceph" ;; Add the debootstrap and guix OS providers. "ganeti-instance-guix" "ganeti-instance-debootstrap")) %base-packages)) (services (append (list (service static-networking-service-type (list (static-networking (addresses (list (network-address (device "eth0") (value "192.168.1.201/24")))) (routes (list (network-route (destination "default") (gateway "192.168.1.254")))) (name-servers '("192.168.1.252" "192.168.1.253"))))) ;; Ganeti utilise SSH pour communiquer entre les nœuds. (service openssh-service-type (openssh-configuration (permit-root-login 'prohibit-password))) (simple-service 'ganeti-hosts-entries hosts-service-type (list (host "192.168.1.200" "ganeti.example.com") (host "192.168.1.201" "node1.example.com" '("node1")) (host "192.168.1.202" "node2.example.com" '("node2")))) (service ganeti-service-type (ganeti-configuration ;; cette liste spécifie les chemins du système de fichiers autorisés ;; pour le stockage des images de machines virtuelles. (file-storage-paths '("/srv/ganeti/file-storage")) ;; Cette variable configure une « variante » pour ;; Debootstrap et Guix qui fonctionne avec KVM. (os %default-ganeti-os)))) %base-services)))
Nous vous encourageons à lire le guide d’administration de Ganeti pour apprendre les diverse options de grappes et les opérations de base. Il y a aussi un billet de blog décrivant comment configurer et initialiser une petite grappe.
C’est le type de service qui inclus tous les service dont les nœuds Ganeti ont besoin.
Sa valeur est un objet ganeti-configurtaion
qui définie le paquet
pour utiliser les opérations en ligne de commande, ainsi que pour les divers
démons. Les chemins de stockage autorisés et les systèmes d’exploitation
invités disponibles sont aussi configurés à travers ce type de données.
Le service ganeti
prend les options de configuration suivante :
ganeti
(par défaut : ganeti
)Le paquet ganeti
à utiliser. Il sera installé sur le profil du
système et rendra gnt-cluster
, gnt-instance
, etc
disponibles. Remarquez que la valeur spécifiée ici n’affecte pas les autres
services auxquels se réfère le paquet ganeti
(voir plus bas).
noded-configuration
(par défaut : (ganeti-noded-configuration)
)confd-configuration
(par défaut : (ganeti-confd-configuration)
)wconfd-configuration
(par défaut : (ganeti-wconfd-configuration)
)luxid-configuration
(par défaut : (ganeti-luxid-configuration)
)rapi-configuration
(par défaut : (ganeti-rapi-configuration)
)kvmd-configuration
(par défaut : (ganeti-kvmd-configuration)
)mond-configuration
(par défaut : (ganeti-mond-configuration)
)metad-configuration
(par défaut : (ganeti-metad-configuration)
)watcher-configuration
(par défaut : (ganeti-watcher-configuration)
)cleaner-configuration
(par défaut : (ganeti-cleaner-configuration)
)Ces options contrôlent les divers démons et tâches cron distribués avec Ganeti. Les valeurs possibles sont détaillées plus bas. Pour changer un paramètre, vous devez utiliser le type de configuration pour ce service :
(service ganeti-service-type
(ganeti-configuration
(rapi-configuration
(ganeti-rapi-configuration
(interface "eth1"))))
(watcher-configuration
(ganeti-watcher-configuration
(rapi-ip "10.0.0.1"))))
file-storage-paths
(par défaut : '()
)Liste des répertoire autorisés pour le moteur de stockage de fichiers.
hooks
(par défaut : #f
)Lorsqu’une valeur est indiquée, elle doit être un objet simili-fichier contenant un répertoire avec des crochets d’exécution de grappe.
os
(par défaut : %default-ganeti-os
)Liste des enregistrements <ganeti-os>
.
En résumé ganeti-service-type
est un raccourci pour la déclaration de
chaque service individuel :
(service ganeti-noded-service-type) (service ganeti-confd-service-type) (service ganeti-wconfd-service-type) (service ganeti-luxid-service-type) (service ganeti-kvmd-service-type) (service ganeti-mond-service-type) (service ganeti-metad-service-type) (service ganeti-watcher-service-type) (service ganeti-cleaner-service-type)
Plus une extension de service pour etc-service-type
qui configure le
moteur de stockage de fichiers et les variantes de systèmes.
Ce type de données peut être passé au paramètre os
de
ganeti-configuration
. Il prend les paramètres suivants :
name
Le nom du fournisseur de système. Il est seulement utilisé pour spécifier où la configuration se trouve. Indiquer « debootstrap » créera /etc/ganeti/intance-debootstrap.
extension
(par défaut : #f
)L’extension de fichier pour les variantes de ce type de système. Par exemple .conf ou .scm. Elle sera ajoutée à la fin du nom de fichier si elle est indiquée.
variants
(par défaut : '()
)Il doit s’agir soit d’une liste d’objets ganeti-os-variant
pour cet
OS ou un objet « simili-fichier » (voir file-like objects)
représentant le répertoire des variantes.
Pour utiliser le fournisseur Guix OS avec les définitions des variantes dans un répertoire local au lieu de déclarer des variantes individuelles (voir guix-variants ci-dessous), vous pouvez utiliser :
(ganeti-os
(name "guix")
(variants (local-file "ganeti-guix-variants"
#:recursive? #true)))
Remarquez que vous devrez maintenir le fichier variants.list (voir
ganeti-os-interface(7)
) manuellement dans ce cas.
Type de données représentant une variante de système Ganeti. Il prend les paramètres suivants :
name
Le nom de cette variante.
configuration
Un fichier de configuration pour cette variante.
Cette variable contient les crochet pour configurer le réseau et le chargeur d’amorçage GRUB.
Cette variable contient une liste de paquets requis pour un invité complètement virtualisé.
Ce type de données crée des fichiers de configurations pour le fournisseur de système debootstrap.
hooks
(par défaut : %default-debootstrap-hooks
)Lorsque la valeur n’est pas #f
, cela doit être une G-expression qui
spécifie un répertoire avec les scripts qui seront lancés à l’installation
du système. Elle peut aussi être une liste de pairs de (nom,
simili-fichier)
. Par exemple :
`((99-hello-world . ,(plain-file "#!/bin/sh\necho Hello, World")))
Cela va créer un répertoire avec un exécutable nommé 99-hello-world
et le lancera à chaque fois que cette variante est installée. Si la valeur
est #f
, les crochets dans
/etc/ganeti/instance-debootstrap/hooks seront utilisés, s’ils
existent.
proxy
(par défaut : #f
)Serveur mandataire HTTP facultatif à utiliser.
mirror
(par défaut : #f
)Le miroir Debian. Habituellement quelque chose comme
http://ftp.no.debian.org/debian
. La valeur par défaut dépend de la
distribution.
arch
(par défaut : #f
)L’architecture pour dpkg. Indiquez armhf
pour debootstrap pour une
instnace ARMv7 sur un hôte AArch64. La valeur par défaut est l’architecture
système actuelle.
suite
(par défaut : "stable"
)Lorsqu’il est indiqué, ce paramètre doit être une distribution Debian comme
buster
ou focal
. Si la valeur est #f
, la valeur par
défaut du fournisseur de système est utilisée.
extra-pkgs
(par défaut : %default-debootstrap-extra-pkgs
)Liste des paquets supplémentaires qui seront installés par dpkg en plus du système minimal.
components
(par défaut : #f
)Lorsque la valeur est indiquée, doit être une liste de « composants » de
répertoires Debian. Par exemple '("main" "contrib")
.
generate-cache?
(par défaut : #t
)Indique s’il faut automatiquement mettre en cache l’archive debootstrap générée.
clean-cache
(par défaut : 14
)Supprime le cache après ce nombre de jours. Utilisez #f
pour ne
jamais vider le cache.
partition-style
(par défaut : 'msdos
)Le type de partition à créer. Lorsqu’il est indiqué, ce paramètre doit être
'msdos
, 'none
ou une chaine de caractères.
partition-alignment
(par défaut : 2048
)Alignement des partitions en nombre de secteur.
C’est une procédure auxiliaire qui crée un enregistrement
ganeti-os-variant
. Il prend deux paramètres . un nom et un objet
debootstrap-configuration
.
C’est une procédure auxiliaire qui crée un enregistrement ganeti-os
.
Elle prend une liste de variantes créé avec debootstrap-variant
.
C’est une procédure auxiliaire qui crée un enregistrement
ganeti-os-variant
à utiliser avec le fournisseur de système Guix. Il
prend un nom et une G-expression qui renvoie un objet simili-fichier
(voir file-like objects) contenant une configuration Guix
System.
C’est une procédure auxiliaire qui crée un enregistrement ganeti-os
.
Elle prend une liste de variantes produites par guix-variant
.
C’est une variable pratique pour que le fournisseur debootstrap fonctionne directement sans avoir à déclarer des variantes manuellement. Elle contient une seule variante debootrstap avec la configuration par défaut :
(list (debootstrap-variant
"default"
(debootstrap-configuration)))
C’est une variable pratique pour que le fournisseur Guix fonctionne directement sans configuration supplémentaire. Elle crée une machine virtuelle qui a un serveur SSH, une console série et autorise les clés SSH des hôtes Ganeti.
(list (guix-variant
"default"
(file-append ganeti-instance-guix
"/share/doc/ganeti-instance-guix/examples/dynamic.scm")))
Les utilisateur·rices peuvent implémenter la prise en charge des
fournisseurs de systèmes inconnus de Guix en étendant les enregistrement
ganeti-os
et ganeti-os-variant
comme il faut. Par exemple :
(ganeti-os
(name "custom")
(extension ".conf")
(variants
(list (ganeti-os-variant
(name "toto")
(configuration (plain-file "titi" "this is fine"))))))
Cela crée /etc/ganeti/instance-custom/variants/toto.conf qui pointe
vers un fichier dans le dépôt qui contient this is fine
. Cela crée
aussi /etc/ganeti/instance-custom/variants/variants.list qui contient
toto
.
Évidemment cela ne fonctionnera pas avec tous les fournisseurs d’OS disponibles. Si vous trouvez que cette interface est trop limitée, contactez-nous sur guix-devel@gnu.org.
Le reste de cette section documente les divers services inclus par
ganeti-service-type
.
ganeti-noded
est le démon responsable des fonctions spécifiques au
nœud dans le système Ganeti. La valeur de ce service doit être un objet
ganeti-noded-configuration
.
La configuration du service ganeti-noded
.
ganeti
(par défaut : ganeti
)Le paquet ganeti
à utiliser pour ce service.
port
(par défaut : 1811
)Port TCP sur lequel le démon de nœud écoute les requêtes réseaux.
address
(par défaut : "0.0.0.0"
)Adresse réseau sur laquelle le démon se lie. L’adresse par défaut signifie de se lier à toutes les adresse disponibles.
interface
(par défaut : #f
)Si une valeur est indiquée, elle doit être une interface réseau spécifique
(p. ex. eth0
) à laquelle le démon se liera.
max-clients
(par défaut : 20
)Cela indique une limite du nombre de connexions clientes simultanées que le démon pourra prendre en charge. Les connexions au delà de ce nombre sont acceptées, mais aucune réponse ne sera envoyée avant que suffisamment de connexions ne soient fermées.
ssl?
(par défaut : #t
)Indique s’il faut utiliser SSL/TLS pour chiffrer les communications
réseaux. Le certification est automatiquement intégré par la grappe et peut
être modifié avec gnt-cluster renew-crypto
.
ssl-key
(par défaut : "/var/lib/ganeti/server.pem")Cela peut être utilisé pour fournir une clé de chiffrement spécifique pour les communications TLS.
ssl-cert
(par défaut : "/var/lib/ganeti/server.pem")Cela peut être utilisé pour fournir un certification spécifique pour les communications TLS.
debug?
(par défaut : #f
)Lorsque la valeur est vraie, le démon effectue plus de journalisation pour le débogage. Remarque que cela laissera fuiter des détails de chiffrement dans les journaux, utilisez cette option avec prudence.
ganeti-confd
répond aux requêtes liées à la configuration de la
grappe Ganeti. Le but de ce démon est d’avoir une manière rapide et très
disponible de demander les valeurs de configuration de la grappe. Il est
automatiquement activé sur tous les candidats maitres. La valeur de
ce service doit être un objet ganeti-confd-configuration
.
La configuration du service ganeti-confd
.
ganeti
(par défaut : ganeti
)Le paquet ganeti
à utiliser pour ce service.
port
(par défaut : 1814
)Le port UDP sur lequel écouter les requêtes réseaux.
address
(par défaut : "0.0.0.0"
)L’adresse réseau sur laquelle le démon se liera.
debug?
(par défaut : #f
)Lorsque la valeur est vraie, le démon effectue des actions de journalisation supplémentaires pour le débogage.
ganeti-wconfd
est le démon qui fait autorité sur la configuration
de la grappe et est la seule entité qui peut y accepter des changements.
Tous les travaux qui ont besoin de modifier la configuration le feront en
envoyant les requêtes appropriées à ce démon. Il ne tourne que sur le
nœud maitre et sera automatiquement désactivé sur les autres nœuds.
La valeur de ce service est un objet ganeti-wconfd-configuration
.
La configuration du service ganeti-wconfd
.
ganeti
(par défaut : ganeti
)Le paquet ganeti
à utiliser pour ce service.
no-voting?
(par défaut : #f
)Le démon refusera de démarrer si la majorité des nœuds de la grappe ne sont
pas d’accord pour dire qu’il est le nœud maitre. Indiquez #t
pour le
démarre même si le quorum n’a pas été atteint (dangereux, utilisez avec
prudence).
debug?
(par défaut : #f
)Lorsque la valeur est vraie, le démon effectue des actions de journalisation supplémentaires pour le débogage.
ganeti-luxid
est un démon utilisé pour répondre aux requêtes liées
à la configuration et à l’état actuel d’une grappe Ganeti. En plus, c’est
le démon qui fait autorité pour la queue de travaux de Ganeti. les travaux
peuvent être soumis via ce démon et il les programme et les démarre.
Il prend un objet ganeti-luxid-configuration
.
La configuration du service ganeti-rapi
.
ganeti
(par défaut : ganeti
)Le paquet ganeti
à utiliser pour ce service.
no-voting?
(par défaut : #f
)Le démon refusera de démarrer s’il ne peut pas vérifier que la majorité des
nœuds de la grappe pensent qu’il est le nœud maitre. Indiquez #t
pour le démarre malgré tout (cela peut être dangereux).
debug?
(par défaut : #f
)Lorsque la valeur est vraie, le démon effectue des actions de journalisation supplémentaires pour le débogage.
ganeti-rapi
fournit une API à distance pour les grappes Ganeti.
Il est lancé sur le maitre et peut être utilisé pour effectuer des actions
programmées sur la grappe via un protocole de RPC basé sur JSON.
La plupart des opérations de requêtes sont permises sans authentification (à moins que require-authentification? ne soit indiqué), alors que les opérations en écriture requièrent une autorisation explicite via le fichier /var/lib/ganeti/rapi/users. Voir la documentation de l’API distante de Ganeti pour plus d’informations.
La valeur de ce service doit être un objet geneti-rapi-configuration
.
La configuration du service ganeti-rapi
.
ganeti
(par défaut : ganeti
)Le paquet ganeti
à utiliser pour ce service.
require-authentication?
(par défaut : #f
)Indique s’il faut demander une authentification même pour les opérations en lecture-seule.
port
(par défaut : 5080
)Le port TCP sur lequel écouter les requêtes de l’API.
address
(par défaut : "0.0.0.0"
)L’adresse réseau sur laquelle le service de liera. Par défaut il écoute sur toutes les adresses.
interface
(par défaut : #f
)Si une valeur est indiquée, elle doit spécifier une interface réseau
spécifique comme eth0
sur laquelle le démon se liera.
max-clients
(par défaut : 20
)Le nombre maximum de requêtes clientes simultanées à prendre en charge. Les connexions supplémentaires sont permises, mais aucune réponse ne sera envoyée tant qu’il n’y aura pas assez de connexions fermées.
ssl?
(par défaut : #t
)Indique s’il faut utiliser le chiffrement SSL/TLS sur le port RAPI.
ssl-key
(par défaut : "/var/lib/ganeti/server.pem")Cela peut être utilisé pour fournir une clé de chiffrement spécifique pour les communications TLS.
ssl-cert
(par défaut : "/var/lib/ganeti/server.pem")Cela peut être utilisé pour fournir un certification spécifique pour les communications TLS.
debug?
(par défaut : #f
)Lorsque la valeur est vraie, le démon effectue plus de journalisation pour le débogage. Remarque que cela laissera fuiter des détails de chiffrement dans les journaux, utilisez cette option avec prudence.
ganeti-kvmd
doit déterminer si une instance KVM donnée a été
éteinte par un administrateur ou un utilisateur. Normalement Ganeti
redémarre une instance qui a été arrêtée par Ganeti lui-même. Si l’option
de grappe user_shutdown
est vraie, ce démon vérifie la socket
QMP
fournie par QEMU et écoute les évènements d’extinction, et marque
l’instance USER down au lieu de ERROR down lorsqu’elle s’éteint
correctement par elle-même.
Il prend un objet ganeti-kvmd-configuration
.
ganeti
(par défaut : ganeti
)Le paquet ganeti
à utiliser pour ce service.
debug?
(par défaut : #f
)Lorsque la valeur est vraie, le démon effectue des actions de journalisation supplémentaires pour le débogage.
ganeti-mond
est un démon facultatif qui propose des
fonctionnalités de surveillance de Ganeti. Il est responsable des
collecteurs de données et de la publication des informations récupérées sur
une interface HTTP.
Il prend un objet ganeti-mond-configuration
.
ganeti
(par défaut : ganeti
)Le paquet ganeti
à utiliser pour ce service.
port
(par défaut : 1815
)Le port sur lequel le démon écoutera.
address
(par défaut : "0.0.0.0"
)L’adresse réseau sur laquelle le démon se liera. Par défaut, il se lie à toutes les interfaces disponibles.
debug?
(par défaut : #f
)Lorsque la valeur est vraie, le démon effectue des actions de journalisation supplémentaires pour le débogage.
ganeti-metad
est un démon facultatif qui peut être utilisé pour
fournir des informations sur la grappe aux instance ou aux scripts
d’installation de systèmes.
Il prend un objet ganeti-metad-configuration
.
ganeti
(par défaut : ganeti
)Le paquet ganeti
à utiliser pour ce service.
port
(par défaut : 80
)Le port sur lequel le démon écoutera.
address
(par défaut : #f
)Si la valeur est indiquée, le démon se liera à cette adresse uniquement. Si la valeur n’est pas indiquée, le comportement dépend de la configuration de la grappe.
debug?
(par défaut : #f
)Lorsque la valeur est vraie, le démon effectue des actions de journalisation supplémentaires pour le débogage.
ganeti-watcher
est un script conçu pour se lancer périodiquement
et s’assurer de la santé de la grappe. Il redémarrera automatiquement les
instances qui sont arrêtées sans le consentement de Ganeti, et réparera les
liens DRBD au cas où un nœud a redémarré. Il archive aussi les anciennes
tâche de la grappe et redémarre les démons Ganeti qui ne sont pas lancés.
Si le paramètres de grappe ensure_node_health
est indiqué, le gardien
éteindra aussi les instances et les périphériques DRBD si le nœud sur lequel
il est lancé est déclaré hors-ligne par un candidat maitre.
Il peut être mis en pause sur tous les nœuds avec gnt-cluster
watcher-pause
.
Le service prend un objet ganeti-watcher-configuration
.
ganeti
(par défaut : ganeti
)Le paquet ganeti
à utiliser pour ce service.
schedule
(par défaut : '(next-second-from (next-minute (range 0 60 5)))
)Indique quand lancer le script. Par défaut, toutes les cinq minutes.
rapi-ip
(par défaut : #f
)Cette option doit être spécifiée seulement si le démon RAPI est configuré pour utiliser une interface ou une adresse particulière. Par défaut l’adresse de grappe est utilisée.
job-age
(par défaut : (* 6 3600)
)Archive les tâches de grappe plus vieilles que cela, en secondes. Par
défaut c’est 6 heure. Cela permet de garder un gnt-job list
gérable.
verify-disks?
(par défaut : #t
)Si la valeur est #f
, le gardien n’essaiera pas de réparer les liens
DRBD cassés automatiquement. Les administrateur·rices devront utiliser
gnt-cluster verify-disks
manuellement à la place.
debug?
(par défaut : #f
)Lorsque la valeur est #t
, le script effectue des actions de
journalisation supplémentaires pour le débogage.
ganeti-cleaner
est un script conçu pour être lancé périodiquement
et supprimer les anciens fichiers de la grappe. Ce type de service contrôle
deux tâches cron : l’une est conçue pour le nœud maitre et purge de
manière permanente les ancienne tâches de la grappe, et l’autre est conçue
pour tous les nœuds et supprime les certificats X509, les clés et les
informations ganeti-watcher
périmées. Comme tous les services
Ganeti, on peut l’ajouter même sur les nœuds non-maitres car il se désactive
tout seul en cas de besoin.
Il prend un objet ganeti-cleaner-configuration
.
ganeti
(par défaut : ganeti
)Le paquet ganeti
à utiliser pour la commande gnt-cleaner
.
master-schedule
(par défaut : "45 1 * * *"
)La périodicité à laquelle lancer la tâche de nettoyage maitre. Par défaut c’est une fois par jour, à 01:45:00.
node-schedule
(par défaut : "45 2 * * *"
)La périodicité à laquelle lancer la tâche de nettoyage des nœuds. Par défaut une fois par jour, à 02:45:00.
Suivant: Services de jeu, Précédent: Services de virtualisation, Monter: Services [Table des matières][Index]
Le module (gnu services version-control)
fournit un service pour
permettre l’accès à distance à des dépôts Git locaux. Il y a trois options
: en utilisant git-daemon-service-type
qui fournit un accès aux
dépôts via le protocole non sécurisé git://
basé sur TCP, en étendant
le serveur web nginx
pour relayer les requêtes vers
git-http-backend
ou en fournissant une interface web avec
cgit-service-type
.
Type de service qui lance git daemon
, un serveur TCP simple pour
exposer des dépôts sur le protocole Git pour des accès anonymes.
La valeur de ce service est un enregistrement
<git-daemon-configuration>
, par défaut il permet l’accès en
lecture-seule aux dépôts exportés39 dans
/srv/git.
Type de données qui représente la configuration de
git-daemon-service-type
.
package
(par défaut : git
)Objet de paquet du système de contrôle de version distribué Git.
export-all?
(par défaut : #f
)Indique s’il faut permettre l’accès à tous les dépôts Git, même s’ils n’ont pas le fichier git-daemon-export-ok.
base-path
(par défaut : /srv/git)Indique s’il faut traduire toutes les requêtes de chemins relativement au
chemin actuel. Si vous lancez git daemon
avec (base-path
"/srv/git")
sur ‘example.com’, et que vous essayez ensuite de
récupérer ‘git://example.com/hello.git
’, le démon git
interprètera ce chemin comme étant /srv/git/hello.git
.
user-path
(par défaut : #f
)Indique s’il faut permettre la notation ~user
dans les requêtes.
Lorsque spécifié avec une chaine vide, les requêtes à
‘git://host/~alice/toto
’ sont des requêtes d’accès au dépôt
toto
dans le répertoire personnel de l’utilisateur alice
. Si
(user-path "chemin") est spécifié, la même requête est
interprétée comme accédant au répertoire chemin/foo dans le
répertoire personnel de l’utilisateur alice
.
listen
(par défaut : '()
)Indique s’il faut écouter sur des adresses IP ou des noms d’hôtes particuliers, par défaut tous.
port
(par défaut : #f
)Indique s’il faut écouter sur un port particulier, par défaut le 9418.
whitelist
(par défaut : '()
)Si la liste n’est pas vide, n’autoriser l’accès qu’aux dossiers spécifiés.
extra-options
(par défaut : '()
)Options supplémentaires qui seront passées à git
daemon
40.
Le protocole git://
ne permet pas l’authentification. Lorsque vous
récupérez un dépôt via git://
, vous ne pouvez pas savoir si les
données que vous recevez ont été modifiées ou si elles viennent bien de
l’hôte spécifié, et votre connexion pourrait être espionnée. Il est
préférable d’utiliser un protocole de transport authentifié et chiffré,
comme https
. Bien que Git vous permette de servir des dépôts avec un
serveur web peu sophistiqué basé sur les fichiers, il y a un protocole plus
rapide implémenté par le programme git-http-backend
. Ce programme
est le moteur des services web Git corrects. Il est conçu pour se trouver
derrière un mandataire FastCGI. Voir Services web pour plus
d’informations sur la manière de lancer le démon fcgiwrap
nécessaire.
Guix a un type de données de configuration séparé pour servir des dépôts Git par HTTP.
Type de données représentant la configuration d’un futur
git-http-service-type
; il peut actuellement être utilisé pour
configurer Nginx à travers git-http-nginx-location-configuration
.
package
(par défaut : git)Objet de paquet du système de contrôle de version distribué Git.
git-root
(par défaut : /srv/git)Répertoire contenant les dépôts Git à exposer au monde.
export-all?
(par défaut : #f
)Indique s’il faut exposer l’accès de tous les dépôts Git dans git-root, même s’ils n’ont pas le fichier git-daemon-export-ok.
uri-path
(par défaut : ‘/git/’)Préfixe du chemin pour l’accès Git. Avec le préfixe ‘/git/’ par
défaut, cela traduira ‘http://server/git/repo.git
’
en /srv/git/repo.git. Les requêtes dont les chemins d’URI ne
commencent pas par ce préfixe ne seront pas passées à cette instance de Git.
fcgiwrap-socket
(par défaut : 127.0.0.1:9000
)Le socket sur lequel le démon fcgiwrap
écoute. Voir Services web.
Il n’y a pas de git-http-service-type
, actuellement ; à la place vous
pouvez créer un nginx-location-configuration
à partir d’un
git-http-configuration
puis ajouter cela au serveur web.
Calcule un nginx-location-configuration
qui correspond à la
configuration http Git donnée. Voici un exemple de définition de service
nginx qui sert le répertoire /srv/git par défaut en HTTPS :
(service nginx-service-type
(nginx-configuration
(server-blocks
(list
(nginx-server-configuration
(listen '("443 ssl"))
(server-name "git.my-host.org")
(ssl-certificate
"/etc/certs/git.my-host.org/fullchain.pem")
(ssl-certificate-key
"/etc/certs/git.my-host.org/privkey.pem")
(locations
(list
(git-http-nginx-location-configuration
(git-http-configuration (uri-path "/"))))))))))
Ce exemple suppose que vous utilisez Let’s Encrypt pour récupérer votre
certificat TLS. Voir Services de certificats. Le service certbot
par
défaut redirigera tout le trafic HTTP de git.my-host.org
en HTTPS.
Vous devrez aussi ajouter un mandataire fcgiwrap
à vos services
systèmes. Voir Services web.
Cgit est une interface web pour des dépôts Git écrite en C.
L’exemple suivant configurera le service avec les valeurs par défaut. Par
défaut, on peut accéder à Cgit sur le port (http://localhost:80
).
(service cgit-service-type)
Le type file-object
désigne soit un objet simili-fichier
(voir file-like objects), soit une chaîne.
Les champs de cgit-configuration
disponibles sont :
cgit-configuration
:package package ¶Le paquet cgit.
cgit-configuration
:nginx-server-configuration-list nginx ¶Configuration Nginx.
cgit-configuration
:file-object about-filter ¶Spécifie une commande qui doit être invoquée pour formater le contenu des pages « à propos » (au plus haut niveau et pour chaque dépôt).
La valeur par défaut est ‘""’.
cgit-configuration
:string agefile ¶Spécifie un chemin, relativement à chaque dépôt, qui peut être utilisé pour spécifier la date et l’heure du plus récent commit du dépôt.
La valeur par défaut est ‘""’.
cgit-configuration
:file-object auth-filter ¶Spécifie une commande qui sera invoquée pour authentifier l’accès au dépôt.
La valeur par défaut est ‘""’.
cgit-configuration
:string branch-sort ¶Drapeau qui, lorsqu’il vaut ‘age’, active le trie par date dans la liste des branches, et le trie par nom lorsqu’il vaut ‘name’.
La valeur par défaut est ‘"name"’.
cgit-configuration
:string cache-root ¶Chemin utilisé pour stocker les entrées de cache de cgit.
La valeur par défaut est ‘"/var/cache/cgit"’.
cgit-configuration
:integer cache-static-ttl ¶Nombre qui spécifie le temps de vie, en minute, des versions en cache des pages du dépôt accédées par leur SHA-1.
La valeur par défaut est ‘-1’.
cgit-configuration
:integer cache-dynamic-ttl ¶Nombre qui spécifie le temps de vie, en minutes, des version en cache des pages du dépôt accédées sans leur SHA1.
La valeur par défaut est ‘5’.
cgit-configuration
:integer cache-repo-ttl ¶Nombre qui spécifie le temps de vie, en minute, des version en cache de la page de résumé du dépôt.
La valeur par défaut est ‘5’.
cgit-configuration
:integer cache-root-ttl ¶Nombre qui spécifie le temps de vie, en minutes, de la version en cache de la page d’index du dépôt.
La valeur par défaut est ‘5’.
cgit-configuration
:integer cache-scanrc-ttl ¶Nombre qui spécifie le temps de vie, en minutes, de la version en cache du résultat du scan d’un chemin dans le dépôt Git.
La valeur par défaut est ‘15’.
cgit-configuration
:integer cache-about-ttl ¶Nombre qui spécifie le temps de vie, en minutes, de la version en cache de la page « à propos » du dépôt.
La valeur par défaut est ‘15’.
cgit-configuration
:integer cache-snapshot-ttl ¶Nombre qui spécifie le temps de vie, en minutes, de la version en cache des archives.
La valeur par défaut est ‘5’.
cgit-configuration
:integer cache-size ¶Le nombre maximum d’entrées dans le cache de cgit. Lorsque la valeur est ‘0’, le cache est désactivé.
La valeur par défaut est ‘0’.
cgit-configuration
:boolean case-sensitive-sort? ¶Indique si le tri des éléments est sensible à la casse.
La valeur par défaut est ‘#t’.
cgit-configuration
:list clone-prefix ¶Liste des préfixes communs qui, lorsqu’ils sont combinés à l’URL du dépôt, génèrent des URL de clone valides pour le dépôt.
La valeur par défaut est ‘'()’.
cgit-configuration
:list clone-url ¶Liste des modèles clone-url
.
La valeur par défaut est ‘'()’.
cgit-configuration
:file-object commit-filter ¶Commande qui sera invoquée pour formater les messages de commit.
La valeur par défaut est ‘""’.
cgit-configuration
:string commit-sort ¶Drapeau qui, s’il vaut ‘date’, active le tri par date strict dans le messages de commit, et le tri topologique strict lorsqu’il vaut ‘topo’.
La valeur par défaut est ‘"git log"’.
cgit-configuration
:file-object css ¶URL qui spécifie le document css à inclure dans les pages cgit.
La valeur par défaut est ‘"/share/cgit/cgit.css"’.
cgit-configuration
:file-object email-filter ¶Spécifie une commande qui sera invoquée pour formater les noms et l’adresse de courriel des commiteurs, des auteurs et des taggueurs, représentés à plusieurs endroits dans l’interface cgit.
La valeur par défaut est ‘""’.
cgit-configuration
:boolean embedded? ¶Drapeau qui, s’il vaut ‘#t’, fera générer un fragment HTML à cgit qu’il sera possible d’inclure dans d’autres pages HTML.
La valeur par défaut est ‘#f’.
cgit-configuration
:boolean enable-commit-graph? ¶Drapeau qui, lorsqu’il vaut ‘#t’, fera afficher un historique en ASCII-art à gauche des messages de commit dans la page de log du dépôt.
La valeur par défaut est ‘#f’.
cgit-configuration
:boolean enable-filter-overrides? ¶Drapeau qui, lorsqu’il vaut ‘#t’, permet à tous les paramètres de filtrage d’être modifiés dans des fichiers cgitrc spécifiques au dépôt.
La valeur par défaut est ‘#f’.
cgit-configuration
:boolean enable-follow-links? ¶Drapeau qui, s’il vaut ‘#t’, permet aux utilisateurs de suivre un fichier dans la vue « log ».
La valeur par défaut est ‘#f’.
cgit-configuration
:boolean enable-http-clone? ¶Si la valeur est ‘#t’, cgit agira comme un point d’accès HTTP idiot pour les clones Git.
La valeur par défaut est ‘#t’.
cgit-configuration
:boolean enable-index-links? ¶Drapeau qui, s’il vaut ‘#t’, fera générer des liens « résumé », « commit » et « arborescence » supplémentaires poru chaque dépôt dans l’index des dépôts.
La valeur par défaut est ‘#f’.
cgit-configuration
:boolean enable-index-owner? ¶Drapeau qui, s’il vaut ‘#t’, fera afficher le propriétaire de chaque dépôt dans l’index des dépôts.
La valeur par défaut est ‘#t’.
cgit-configuration
:boolean enable-log-filecount? ¶Drapeau qui, s’il vaut ‘#t’, fera afficher à cgit le nombre de fichiers modifiés pour chaque commit sur la page de log du dépôt.
La valeur par défaut est ‘#f’.
cgit-configuration
:boolean enable-log-linecount? ¶Drapeau qui, s’il vaut ‘#t’, fera afficher à cgit le nombre de lignes ajoutées et enlevées pour chaque commit de la page de log du dépôt.
La valeur par défaut est ‘#f’.
cgit-configuration
:boolean enable-remote-branches? ¶Drapeau qui, s’il vaut ‘#t’, fera afficher les branches distantes dans les vues du résumé et des références.
La valeur par défaut est ‘#f’.
cgit-configuration
:boolean enable-subject-links? ¶Drapeau qui, s’il vaut ‘1’, fera utiliser à cgit le sujet du commit parent comme texte du lien lors de la génération des liens vers les commits parents dans la vue des commits.
La valeur par défaut est ‘#f’.
cgit-configuration
:boolean enable-html-serving? ¶Drapeau qui, s’il vaut ‘#t’, fera utiliser à cgit l esujet du commit parent comme texte du lien lors de la génération des liens vers le commit parent dans la vue des commits.
La valeur par défaut est ‘#f’.
cgit-configuration
:boolean enable-tree-linenumbers? ¶Drapeau qui, s’il vaut ‘#t’, fera générer à cgit des liens vers le numéro de ligne pour les blobs en texte brut affichés dans la vue de l’arborescence.
La valeur par défaut est ‘#t’.
cgit-configuration
:boolean enable-git-config? ¶Drapeau qui, s’il vaut ‘#t’, permettra à cgit d’utiliser la configuration Git pour spécifier des paramètres spécifiques au dépôt.
La valeur par défaut est ‘#f’.
cgit-configuration
:file-object favicon ¶URL utilisée comme lien vers un icône pour cgit.
La valeur par défaut est ‘"/favicon.ico"’.
Le contenu du fichier spécifié avec cette option sera inclus directement au bas de toutes les pages (c.-à-d. qu’il remplace le message « généré par … » générique).
La valeur par défaut est ‘""’.
cgit-configuration
:string head-include ¶Le contenu du fichier spécifié dans cette option sera inclus directement dans la section HEAD HTML de toutes les pages.
La valeur par défaut est ‘""’.
cgit-configuration
:string header ¶Le contenu du fichier spécifié avec cette option sera inclus directement au début de toutes les pages.
La valeur par défaut est ‘""’.
cgit-configuration
:file-object include ¶Nom d’un fichier de configuration à inclure avant que le reste du fichier de configuration actuel ne soit analysé.
La valeur par défaut est ‘""’.
cgit-configuration
:string index-header ¶Le contenu du fichier spécifié avec cette option sera inclus directement au dessus de l’index des dépôts.
La valeur par défaut est ‘""’.
cgit-configuration
:string index-info ¶Le contenu du fichier spécifié avec cette option sera inclus directement en dessous de l’en-tête sur la page d’index du dépôt.
La valeur par défaut est ‘""’.
cgit-configuration
:boolean local-time? ¶Drapeau qui, s’il vaut ‘#t’, fera afficher à cgit l’heure et la date de commit et de tag dans le fuseau horaire du serveur.
La valeur par défaut est ‘#f’.
cgit-configuration
:file-object logo ¶URL qui spécifie la source d’une image utilisé comme logo sur toutes les pages cgit.
La valeur par défaut est ‘"/share/cgit/cgit.png"’.
cgit-configuration
:string logo-link ¶URL chargée lors du clic sur l’image du logo de cgit.
La valeur par défaut est ‘""’.
cgit-configuration
:file-object owner-filter ¶Commande qui sera invoquée pour formater la colonne propriétaire sur la page principale.
La valeur par défaut est ‘""’.
cgit-configuration
:integer max-atom-items ¶Nombre d’éléments à afficher dans la vue des flux atom.
La valeur par défaut est ‘10’.
cgit-configuration
:integer max-commit-count ¶Nombre d’éléments à lister par page dans la vue « log ».
La valeur par défaut est ‘50’.
cgit-configuration
:integer max-message-length ¶Nombre caractères de messages de commit à afficher dans la vue « log ».
La valeur par défaut est ‘80’.
cgit-configuration
:integer max-repo-count ¶Spécifie le nombre d’éléments à lister par page sur la page de l’index des dépôts.
La valeur par défaut est ‘50’.
cgit-configuration
:integer max-repodesc-length ¶Spécifie le nombre maximum de caractères de description de dépôts à afficher sur la page d’index des dépôts.
La valeur par défaut est ‘80’.
cgit-configuration
:integer max-blob-size ¶Spécifie la taille maximale d’un blob pour lequel afficher du HTML en kilo-octets.
La valeur par défaut est ‘0’.
cgit-configuration
:string max-stats ¶Période de statistiques maximale. Les valeurs valides sont ‘week’, ‘month’, ‘quarter’ et ‘year’.
La valeur par défaut est ‘""’.
cgit-configuration
:mimetype-alist mimetype ¶Type mime pour l’extension de fichier spécifiée.
La valeur par défaut est ‘'((gif "image/gif") (html "text/html") (jpg "image/jpeg") (jpeg "image/jpeg") (pdf "application/pdf") (png "image/png") (svg "image/svg+xml"))’.
cgit-configuration
:file-object mimetype-file ¶Spécifie le fichier à utiliser pour la recherche automatique de type mime.
La valeur par défaut est ‘""’.
cgit-configuration
:string module-link ¶Texte qui sera utilisé comme chaîne de formatage pour un lien hypertexte lorsqu’un sous-module est affiché dans la liste du répertoire.
La valeur par défaut est ‘""’.
cgit-configuration
:boolean nocache? ¶Si la valeur est ‘#t’, le cache est désactivé.
La valeur par défaut est ‘#f’.
cgit-configuration
:boolean noplainemail? ¶Si la valeur est ‘#t’, l’affichage des adresse de courriel des auteurs sera désactivé.
La valeur par défaut est ‘#f’.
cgit-configuration
:boolean noheader? ¶Drapeau qui, s’il vaut ‘#t’, fera omettre à cgit l’en-tête standard sur toutes les pages.
La valeur par défaut est ‘#f’.
cgit-configuration
:project-list project-list ¶UNe liste de sous-répertoires dans repository-directory
, relativement
à lui, qui devrait être chargé comme des dépôts Git. Une liste vide
signifie que tous les sous-répertoires seront chargés.
La valeur par défaut est ‘'()’.
cgit-configuration
:file-object readme ¶Text which will be used as default repository-cgit-configuration
readme
.
La valeur par défaut est ‘""’.
cgit-configuration
:boolean remove-suffix? ¶Si la valeur est #t
et que repository-directory
est activé, si
un dépôt avec un suffixe de .git
est trouvé, ce suffixe sera supprimé
de l’URL et du nom.
La valeur par défaut est ‘#f’.
cgit-configuration
:integer renamelimit ¶Nombre maximum de fichiers à considérer lors de la détection des renommages.
La valeur par défaut est ‘-1’.
cgit-configuration
:string repository-sort ¶La manière dont les dépôt de chaque section sont rangés.
La valeur par défaut est ‘""’.
cgit-configuration
:robots-list robots ¶Texte utilisé comme contenu du méta-attribut robots
.
La valeur par défaut est ‘'("noindex" "nofollow")’.
cgit-configuration
:string root-desc ¶Texte affiché en dessous de l’en-tête de la page d’index des dépôts.
La valeur par défaut est ‘"a fast webinterface for the git dscm"’.
cgit-configuration
:string root-readme ¶Le contenu du fichier spécifié avec cette option sera inclus directement en dessous du lien « à propos » sur la page d’index du dépôt.
La valeur par défaut est ‘""’.
cgit-configuration
:string root-title ¶Texte affiché sur la page d’index des dépôts.
La valeur par défaut est ‘""’.
Si la valeur est ‘#t’ et que repository-directory est activé, repository-directory recherchera de manière récursive dans les répertoires dont le nom commence par un point. Sinon, repository-directory restera hors de ces répertoires, considérés comme « cachés ». Remarquez que cela ne s’applique pas au répertoire « .git » dans le dépôts non bruts.
La valeur par défaut est ‘#f’.
cgit-configuration
:list snapshots ¶Texte qui spécifie l’ensemble des formats d’archives par défaut pour lesquelles cgit générera un lien.
La valeur par défaut est ‘'()’.
cgit-configuration
:repository-directory repository-directory ¶Nom du répertoire à scanner pour trouver les dépôts (représente
scan-path
).
La valeur par défaut est ‘"/srv/git"’.
cgit-configuration
:string section ¶Le nom de la section de dépôts actuelle — tous les dépôts définis après ce point hériterons du nom de section actuel.
La valeur par défaut est ‘""’.
cgit-configuration
:string section-sort ¶Drapeau qui, s’il vaut ‘1’, triera les sections dans la liste des dépôts par nom.
La valeur par défaut est ‘""’.
cgit-configuration
:integer section-from-path ¶Un nombre qui, s’il est défini avant repository-directory, spécifier combien d’éléments de chemin de chaque chemin de dépôt utiliser comme nom de section par défaut.
La valeur par défaut est ‘0’.
cgit-configuration
:boolean side-by-side-diffs? ¶Si la valeur est ‘#t’, afficher des diffs côte à côte au lieu des unidiffs par défaut.
La valeur par défaut est ‘#f’.
cgit-configuration
:file-object source-filter ¶Spécifie une commande qui sera invoquée pour formater les blobs en texte brut dans la vue de l’arborescence.
La valeur par défaut est ‘""’.
cgit-configuration
:integer summary-branches ¶Spécifie le nombre de branches à afficher dans la vue « résumé » du dépôt.
La valeur par défaut est ‘10’.
cgit-configuration
:integer summary-log ¶Spécifie le nombre d’élément du journal à afficher dans la vue « résumé » du dépôt.
La valeur par défaut est ‘10’.
Spécifie le nombre de tags à afficher dans la vue « résumé » du dépôt.
La valeur par défaut est ‘10’.
cgit-configuration
:string strict-export ¶Nom de fichier qui, s’il est spécifié, doit être présent dans le dépôt pour que cgit accorde l’accès à ce dépôt.
La valeur par défaut est ‘""’.
cgit-configuration
:string virtual-root ¶URL qui, si elle est spécifiée, sera utilisée comme racine pour tous les liens cgit.
La valeur par défaut est ‘"/"’.
cgit-configuration
:repository-cgit-configuration-list repositories ¶A list of repository-cgit-configuration
records.
La valeur par défaut est ‘'()’.
Les champs de repository-cgit-configuration
disponibles sont :
repository-cgit-configuration
:repo-list snapshots ¶Un masque de formats d’archives pour ce dépôt pour lesquelles cgit générera
un lien, restreint par le paramètre snapshots
global.
La valeur par défaut est ‘'()’.
repository-cgit-configuration
:repo-file-object source-filter ¶Modifie le source-filter
par défaut.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-string url ¶URL relative utilisée pour accéder au dépôt.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-file-object about-filter ¶Modifie le paramètre about-filter
par défaut.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-string branch-sort ¶Drapeau qui, s’il vaut ‘age’, active le tri par date dans la liste des branches, et lorsqu’il vaut ‘name’, le tri par nom.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-list clone-url ¶Un liste d’URL qui peuvent être utilisées pour cloner ce dépôt.
La valeur par défaut est ‘'()’.
repository-cgit-configuration
:repo-file-object commit-filter ¶Modifie le paramètre commit-filter
par défaut.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-string commit-sort ¶Drapeau qui, s’il vaut ‘date’, active le tri par date strict dans le messages de commit, et le tri topologique strict lorsqu’il vaut ‘topo’.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-string defbranch ¶Le nom de la branche par défaut de ce dépôt. Si cette branche n’existe pas dans le dépôt, le premier nom de branche (trié) sera utilisé par défaut. Par défaut la branche pointée par HEAD, ou « master » s’il n’y a pas de HEAD convenable.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-string desc ¶La valeur à afficher comme description du dépôt.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-string homepage ¶La valeur à afficher comme page d’accueil du dépôt.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-file-object email-filter ¶Modifie le paramètre email-filter
par défaut.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:peut-être-booléen-repo enable-commit-graph? ¶Un drapeau qui peut être utilisé pour désactiver le paramètre
enable-commit-graph?
global.
La valeur par défaut est ‘disabled’.
repository-cgit-configuration
:peut-être-booléen-repo enable-log-filecount? ¶Un drapeau qui peut être utilisé pour désactiver le paramètre
enable-log-filecount?
global.
La valeur par défaut est ‘disabled’.
repository-cgit-configuration
:peut-être-booléen-repo enable-log-linecount? ¶Un drapeau qui peut être utilisé pour désactiver le paramètre
enable-log-linecount?
global.
La valeur par défaut est ‘disabled’.
repository-cgit-configuration
:peut-être-booléen-repo enable-remote-branches? ¶Drapeau qui, s’il vaut ‘#t’, fera afficher les branches distantes dans les vues du résumé et des références.
La valeur par défaut est ‘disabled’.
repository-cgit-configuration
:peut-être-booléen-repo enable-subject-links? ¶Un drapeau qui peut être utilisé pour modifier le paramètre
enable-subject-links?
global.
La valeur par défaut est ‘disabled’.
repository-cgit-configuration
:peut-être-booléen-repo enable-html-serving? ¶Un drapeau qui peut être utilisé pour modifier le paramètre
enable-html-serving?
global.
La valeur par défaut est ‘disabled’.
repository-cgit-configuration
:repo-boolean hide? ¶Drapeau qui, s’il vaut #t
, cache le dépôt de l’index des dépôts.
La valeur par défaut est ‘#f’.
repository-cgit-configuration
:repo-boolean ignore? ¶Drapeau qui, s’il vaut #t
, ignore le dépôt.
La valeur par défaut est ‘#f’.
repository-cgit-configuration
:repo-file-object logo ¶URL qui spécifie la source d’une image qui sera utilisée comme logo sur les pages de ce dépôt.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-string logo-link ¶URL chargée lors du clic sur l’image du logo de cgit.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-file-object owner-filter ¶Modifie le paramètre owner-filter
par défaut.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-string module-link ¶Texte qui sera utilisé comme chaîne de formatage pour un lien hypertexte lorsqu’un sous-module est affiché dans une liste de fichiers. Les arguments pour la chaîne de formatage sont le chemin et le SHA1 du commit du sous-module.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:module-link-path module-link-path ¶Texte qui sera utilisé comme chaîne de formatage lorsqu’un sous-module avec un chemin spécifié sera affiché dans une liste de fichiers.
La valeur par défaut est ‘'()’.
repository-cgit-configuration
:repo-string max-stats ¶Modifie la période de statistique maximale par défaut.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-string name ¶La valeur à afficher comme nom de dépôt.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-string owner ¶Une valeur utilisée pour identifier le propriétaire du dépôt.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-string path ¶Un chemin absolu vers le répertoire du dépôt.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-string readme ¶Un chemin (relatif au dépôt) qui spécifie un fichier à inclure directement comme page « À propos » pour ce dépôt.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-string section ¶Le nom de la section de dépôts actuelle — tous les dépôts définis après ce point hériterons du nom de section actuel.
La valeur par défaut est ‘""’.
repository-cgit-configuration
:repo-list extra-options ¶Options supplémentaires ajoutées à la fin du fichier cgitrc.
La valeur par défaut est ‘'()’.
cgit-configuration
:list extra-options ¶Options supplémentaires ajoutées à la fin du fichier cgitrc.
La valeur par défaut est ‘'()’.
Cependant, vous pourriez vouloir simplement récupérer un cgitrc
et
l’utiliser. Dans ce cas, vous pouvez passer un
opaque-cgit-configuration
comme enregistrement à
cgit-service-type
. Comme son nom l’indique, une configuration opaque
n’a pas de capacité de réflexion facile.
Les champs de opaque-cgit-configuration
disponibles sont :
opaque-cgit-configuration
:package cgit ¶Le paquet cgit.
opaque-cgit-configuration
:string string ¶Le contenu de cgitrc
, en tant que chaîne de caractère.
Par exemple, si votre cgitrc
est juste la chaîne vide, vous pouvez
instancier un service cgit ainsi :
(service cgit-service-type
(opaque-cgit-configuration
(cgitrc "")))
Gitolite est un outil pour héberger des dépôts Git sur un serveur central.
Gitolite peut gérer plusieurs dépôts et utilisateurs et supporte une configuration flexible des permissions pour les utilisateurs sur ces dépôts.
L’exemple suivant configure Gitolite en utilisant l’utilisateur git
par défaut et la clef SSH fournie.
(service gitolite-service-type
(gitolite-configuration
(admin-pubkey (plain-file
"yourname.pub"
"ssh-rsa AAAA... guix@example.com"))))
Gitolite est configuré via un dépôt d’administration spécial que vous pouvez
cloner. Par exemple, si vous hébergez Gitolite sur example.com
, vous
pouvez lancer la commande suivante pour cloner le dépôt d’administration.
git clone git@example.com:gitolite-admin
Lorsque le service Gitolite est activé, la clef admin-pubkey
fournie
sera insérée dans le répertoire keydir du dépôt gitolite-admin. Si
cela change le dépôt, un commit sera effectué avec le message « gitolite
setup by GNU Guix ».
Type de données représentant la configuration de
gitolite-service-type
.
package
(par défaut : gitolite)Le paquet Gitolite à utiliser. Il y a des dépendances facultatives à
Gitolite qui ne sont pas incluses dans le paquet par défaut comme Redis et
git-annex. Ces fonctionnalités peuvent devenir disponibles en utilisant la
procédure make-gitolite
dans le module (gnu packages
version-control)
pour produire une variante de Gitolite avec les
dépendances supplémentaires souhaitées.
Le code suivant renvoie un paquet dans lequel les programmes Redis et git-annex peuvent être invoqués par les scripts de Gitolite :
(use-modules (gnu packages databases) (gnu packages haskell-apps) (gnu packages version-control)) (make-gitolite (list redis git-annex))
user
(par défaut : git)Utilisateur pour utiliser Gitolite. Cela sera l’utilisateur à utiliser pour accéder à Gitolite par SSH.
group
(par défaut : git)Groupe à utiliser pour Gitolite.
home-directory
(par défaut : "/var/lib/gitolite")Répertoire dans lequel stocker la configuration et les dépôts de Gitolite.
rc-file
(par défaut : (gitolite-rc-file))Un objet « simili-fichier » (voir file-like objects) représentant la configuration de Gitolite.
admin-pubkey
(par défaut : #f)Un objet « simili-fichier » (voir file-like objects) utilisé pour paramétrer Gitolite. Il sera inséré dans le répertoire keydir dans le dépôt gitolite-admin.
Pour spécifier la clef SSH comme chaîne de caractère, utilisez la fonction
plain-file
.
(plain-file "yourname.pub" "ssh-rsa AAAA... guix@example.com")
Type de données représentant le fichier RC de Gitolite.
umask
(par défaut : #o0077
)Cela contrôle les permissions que Gitolite propose sur les dépôts et leur contenu.
Une valeur comme #o0027
donnera accès en lecture au groupe utilisé
par Gitolite (par défaut : git
). Cela est nécessaire lorsque vous
utilise Gitolite avec un logiciel comme cgit ou gitweb.
local-code
(par défaut : "$rc{GL_ADMIN_BASE}/local"
)Vous permet d’ajouter vos propres programmes non essentiels, voire d’écraser les programmes fournis par défaut avec vos propres programmes.
Fournissez le chemin COMPLET à cette variable. Par défaut, le répertoire appelé « local » dans votre clone gitolite est utilisé, ce qui permet de le versionner et de vous permettre de le modifier sans avoir à vous connecter au serveur.
unsafe-pattern
(par défaut : #f
)Une expression régulière en Perl qui correspond aux configurations non sures dans le fichier de configuration. Voir la documentation de Gitolite pour plus d’informations.
Lorsque la valeur n’est pas #f
, elle devrait être une chaîne
contenant une expression régulière en Perl, comme ‘"[`~#\$\&()|;<>]"’,
qui est la valeur par défaut utilisée par gitolite. Elle rejette les
caractères spéciaux dans la configuration qui pourraient être interprétés
par un shell, ce qui est utile lorsque vous partagez la charge
d’administration avec d’autres personnes qui n’ont pas accès à un shell sur
le serveur.
git-config-keys
(par défaut : ""
)Gitolite vous permet de modifier les configurations git avec le mot-clef ‘config’. Ce paramètre vous permet de contrôler les clefs de configuration acceptables.
roles
(par défaut : '(("READERS" . 1) ("WRITERS" . ))
)Indique les noms des rôles qui peuvent être utilisés par les utilisateurs avec la commande perms.
enable
(par défaut : '("help" "desc" "info" "perms" "writable" "ssh-authkeys" "git-config" "daemon" "gitweb")
)Ce paramètre contrôle les commandes et les fonctionnalités à activer dans Gitolite.
Gitile est une forge Git qui permet de visualiser le contenu de dépôts Git dans votre navigateur web.
Gitile fonctionne mieux en tandem avec Gitolite, et servira les dépôts publics de Gitolite par défaut. Le service devrait écouter uniquement sur un port local, et vous devriez configurer un serveur web pour servir les ressources statiques. Le service gitile fournit une manière pratique d’étendre le service Nginx pour cela (voir NGINX).
L’exemple suivant configurera Gitile pour servir les dépôts d’un emplacement personnalisé, avec quelques messages par défaut pour la page d’accueil et les pieds de page.
(service gitile-service-type
(gitile-configuration
(repositories "/srv/git")
(base-git-url "https://myweb.site/git")
(index-title "My git repositories")
(intro '((p "This is all my public work!")))
(footer '((p "This is the end")))
(nginx
(nginx-server-configuration
(ssl-certificate
"/etc/certs/myweb.site/fullchain.pem")
(ssl-certificate-key
"/etc/certs/myweb.site/privkey.pem")
(listen '("443 ssl http2" "[::]:443 ssl http2"))
(locations
(list
;; Allow for https anonymous fetch on /git/ urls.
(git-http-nginx-location-configuration
(git-http-configuration
(uri-path "/git/")
(git-root "/var/lib/gitolite/repositories")))))))))
En plus de l’enregistrement de configuration, vous devriez configurer vos dépôts git pour contenir certaines informations facultatives. Tout d’abord, vos dépôts publics doivent contenir le fichier magique git-daemon-export-ok qui permet à Git d’exporter le dépôt. Gitile utiliser la présence de ce fichier pour détecter les dépôts publics qu’il doit rendre accessibles. Pour cela, avec Gitolite par exemple, modifiez votre conf/gitolite.conf pour inclure ceci dans les dépôts que vous voulez rendre publics :
repo toto R = daemon
En plus, Gitile peut lire la configuration du dépôt pour afficher des informations supplémentaires sur les page du dépôt. Gitile utilise l’espace de nom gitweb pour sa configuration. Par exemple, vous pouvez utiliser cela dans votre conf/gitolite.conf :
repo toto R = daemon desc = Une description longue, éventuellement avec du <i>HTML</i>, qui se trouvera sur la page d'accueil config gitweb.name = Le projet Toto config gitweb.synopsis = Une description courte, affichée sur la page principale du projet
N’oubliez pas de commiter et de pousser les changement quand vous êtes satisfait. Vous pourrez avoir besoin de changer la configuration de gitolite pour permettre aux options précédentes d’être acceptées. Une manière de faire est d’ajouter la définition de service suivante :
(service gitolite-service-type
(gitolite-configuration
(admin-pubkey (local-file "key.pub"))
(rc-file
(gitolite-rc-file
(umask #o0027)
;; Permet d'indique n'importe quelle clé de configuration
(git-config-keys ".*")
;; Admet n'importe quel texte comme valeur de configuration valide
(unsafe-patt "^$")))))
Type de données représentant la configuration de gitile-service-type
.
package
(par défaut : gitile)Le paquet Gitile à utiliser.
host
(par défaut : "localhost"
)L’hôte sur lequel gitile écoute.
port
(par défaut : 8080
)Le port sur lequel gitile écoute.
database
(par défaut : "/var/lib/gitile/gitile-db.sql"
)L’emplacement de la base de données.
repositories
(par défaut : "/var/lib/gitolite/repositories"
)L’emplacement des dépôts. Notez que seuls les dépôts publics seront affichés par Gitile. Pour rendre un dépôt public, ajouter un fichier vide git-daemon-export-ok à la racine de ce dépôt.
base-git-url
L’URL git de base qui sera utilisée pour afficher les commandes de clonage.
index-title
(par défaut : "Index"
)La titre de la page pour la page d’index qui répertorie tous les dépôts disponibles.
intro
(par défaut : '()
)Le contenu de l’introduction, sous la forme d’une liste d’expressions sxml. C’est ce qui est affiché au-dessus de la liste des dépôts, sur la page d’index.
footer
(par défaut : '()
)Le contenu du pied-de-page, sous la forme d’une liste d’expressions sxml. Il apparaît sur chaque page servie par Gitile.
nginx
Un bloc de serveur nginx qui sera étendu et utilisé comme serveur mandataire inverse par Gitile pour servir ses pages, et comme serveur web normal pour servir ses ressources statiques.
Vous pouvez utiliser ce bloc pour ajouter d’autres URLs personnalisées à
votre domaine, comme une URL /git/
pour les clonages anonymes, ou
pour servir tout autre fichier que vous voudriez servir.
Suivant: Service PAM de montage, Précédent: Services de contrôle de version, Monter: Services [Table des matières][Index]
Le service joycond permet d’appairer des contrôleurs Nintendo joycon par Bluetooth (voir Services de bureaux pour paramétrer le Bluetooth).
Type de données représentant la configuration de joycond
.
package
(par défaut : joycond
)Le paquet joycond à utiliser.
Service type for the joycond service. It also extends the
udev-service-type
with the joycond
package (provided via the
joycond-configuration
configuration), so that joycond controllers can
be detected and used by an unprivileged user.
La Bataille pour Wesnoth est un jeu de stratégie en tour par tour dans un univers fantastique, avec plusieurs campagnes solo et des parties multijoueurs (en réseau et en local).
Type de service pour le service wesnothd. Sa valeur doit être un objet
wesnothd-configuration
. Pour lancer wesnothd avec la configuration
par défaut, instanciez-le ainsi :
Type de donées représentant la configuration de wesnothd
.
package
(par défaut : wesnoth-server
)Le paquet de serveur de wesnoth à utiliser.
port
(par défaut : 15000
)Le pour sur lequel lier le serveur.
Suivant: Services Guix, Précédent: Services de jeu, Monter: Services [Table des matières][Index]
Le module (gnu services pam-mount)
fournit un service qui permet de
monter des volumes à la connexion de l’utilisateur·rice. Il peut monter
n’importe quel format de volume pris en charge par le système.
Type de service pour la prise en charge de PAM Mount.
Type de données représentant la configuration de PAM Mount.
Il prend les paramètres suivants :
rules
Les règles de configuration utilisées pour générer /etc/security/pam_mount.conf.xml.
Les règles de configuration sont des éléments SXML (voir SXML dans GNU Guile Reference Manual), et les valeurs par défaut ne montent rien pour personne à la connexion :
`((debug (@ (enable "0"))) (mntoptions (@ (allow ,(string-join '("nosuid" "nodev" "loop" "encryption" "fsck" "nonempty" "allow_root" "allow_other") ",")))) (mntoptions (@ (require "nosuid,nodev"))) (logout (@ (wait "0") (hup "0") (term "no") (kill "no"))) (mkmountpoint (@ (enable "1") (remove "true"))))
Certains éléments de volume
doivent être ajoutés pour automatiquement
monter des volumes à la connexion. voici un exemple qui permet à
l’utilisatrice alice
de monter son répertoire HOME
chiffré et
permet à l’utilisateur bob
de monter la partition où il stocke ses
données :
(define pam-mount-rules `((debug (@ (enable "0"))) (volume (@ (user "alice") (fstype "crypt") (path "/dev/sda2") (mountpoint "/home/alice"))) (volume (@ (user "bob") (fstype "auto") (path "/dev/sdb3") (mountpoint "/home/bob/data") (options "defaults,autodefrag,compress"))) (mntoptions (@ (allow ,(string-join '("nosuid" "nodev" "loop" "encryption" "fsck" "nonempty" "allow_root" "allow_other") ",")))) (mntoptions (@ (require "nosuid,nodev"))) (logout (@ (wait "0") (hup "0") (term "no") (kill "no"))) (mkmountpoint (@ (enable "1") (remove "true"))))) (service pam-mount-service-type (pam-mount-configuration (rules pam-mount-rules)))
La liste complète des options disponibles se trouve sur la page de manuel de pam_mount.conf.
PAM mount volumes are automatically mounted at login by the PAM login
service according to a set of per-volume rules. Because they are mounted by
PAM the password entered during login may be used directly to mount
authenticated volumes, such as cifs
, using the same credentials.
These volumes will be added in addition to any volumes directly specified in
pam-mount-rules
.
Here is an example of a rule which will mount a remote CIFS share from //remote-server/share into a sub-directory of /shares named after the user logging in:
(simple-service 'pam-mount-remote-share pam-mount-volume-service-type
(list (pam-mount-volume
(secondary-group "users")
(file-system-type "cifs")
(server "remote-server")
(file-name "share")
(mount-point "/shares/%(USER)")
(options "nosuid,nodev,seal,cifsacl"))))
Configuration for a single volume to be mounted. Any fields not specified will be omitted from the run-time PAM configuration. See the man page for the default values when unspecified.
user-name
(type: maybe-string)Mount the volume for the given user.
user-id
(type: maybe-integer-or-range)Mount the volume for the user with this ID. This field may also be
specified as a pair of (start . end)
indicating a range of user IDs
for whom to mount the volume.
primary-group
(type: maybe-string)Mount the volume for users with this primary group name.
group-id
(type: maybe-integer-or-range)Mount the volume for the users with this primary group ID. This field may
also be specified as a cons cell of (start . end)
indicating a range
of group ids for whom to mount the volume.
secondary-group
(type: maybe-string)Mount the volume for users who are members of this group as either a primary or secondary group.
file-system-type
(type: maybe-string)The file system type for the volume being mounted (e.g., cifs
)
no-mount-as-root?
(type: maybe-boolean)Whether or not to mount the volume with root privileges. This is normally
disabled, but may be enabled for mounts of type fuse
, or other
user-level mounts.
server
(type: maybe-string)The name of the remote server to mount the volume from, when necessary.
file-name
(type: maybe-string)The location of the volume, either local or remote, depending on the
file-system-type
.
mount-point
(type: maybe-string)Where to mount the volume in the local file-system. This may be set to ~ to indicate the home directory of the user logging in. If this field is omitted then /etc/fstab is consulted for the mount destination.
options
(type: maybe-string)The options to be passed as-is to the underlying mount program.
ssh?
(type: maybe-boolean)Enable this option to pass the login password to SSH for use with mounts
involving SSH (e.g., sshfs
).
cipher
(type: maybe-string)Cryptsetup cipher name for the volume. To be used with the crypt
file-system-type
.
file-system-key-cipher
(type: maybe-string)Cipher name used by the target volume.
file-system-key-hash
(type: maybe-string)SSL hash name used by the target volume.
file-system-key-file-name
(type: maybe-string)File name of the file system key for the target volume.
Suivant: Services Linux, Précédent: Service PAM de montage, Monter: Services [Table des matières][Index]
The Build Farm Front-End assists with building Guix packages in bulk. It’s responsible for submitting builds and displaying the status of the build farm.
Service type for the Build Farm Front-End. Its value must be a
bffe-configuration
object.
Data type representing the configuration of the Build Farm Front-End.
package
(default: bffe
)The Build Farm Front-End package to use.
user
(default: "bffe"
)L’utilisateur qui lance le service.
group
(default: "bffe"
)Le groupe système qui lance le service.
arguments
A list of arguments to the Build Farm Front-End. These are passed to the
run-bffe-service
procedure when starting the service.
For example, the following value directs the Build Farm Front-End to submit
builds for derivations available from data.guix.gnu.org
to the Build
Coordinator instance assumed to be running on the same machine.
(list #:build (list (build-from-guix-data-service (data-service-url "https://data.guix.gnu.org") (build-coordinator-url "http://127.0.0.1:8746") (branches '("master")) (systems '("x86_64-linux" "i686-linux")) (systems-and-targets (map (lambda (target) (cons "x86_64-linux" target)) '("aarch64-linux-gnu" "i586-pc-gnu"))) (build-priority (const 0)))) #:web-server-args '(#:event-source "https://example.com" #:controller-args (#:title "example.com build farm")))
extra-environment-variables
(par défaut : ’())Extra environment variables to set via the shepherd service.
Le Guix Build Coordinator aide à distribuer la construction de dérivations entre machines sur lesquelles tourne un agent. Le démon de construction est toujours utilisé pour construire les dérivations, mais Guix Build Coordinator gère l’allocation des construction et des résultats.
Le coordinateur des constructions Guix consiste en un coordinateur, et un ou plus processus agents connectés. Le coordinateur gère les clients qui soumettent des constructions, et alloue les constructions aux agents. Les processus agents parlent au démon de construction pour effectuer les constructions, puis envoie les résultats au coordinateur.
Il y a un script pour lancer le composant du coordinateur de Guix Build Coordinator, mais le service Guix utilise un script Guile personnalisé à la place, pour fournir une meilleure intégration avec les G-expressions utilisées dans la configuration.
Le type de service pour Guix Build Coordinator. Sa valeur doit être un
guix-build-coordinator-configuration
.
Le type de données représentant la configuration de Guix Build Coordinator.
package
(par défaut : guix-build-coordinator
)Le paquet Guix Build Coordinator à utiliser.
user
(par défaut : "guix-build-coordinator"
)L’utilisateur qui lance le service.
group
(par défaut : "guix-build-coordinator"
)Le groupe système qui lance le service.
database-uri-string
(par défaut : "sqlite:///var/lib/guix-build-coordinator/guix_build_coordinator.db"
)L’URI à utiliser pour la base de données.
agent-communication-uri
(par défaut : "http://0.0.0.0:8745"
)L’URI décrivant comment écouter les requêtes des processus agents.
client-communication-uri
(par défaut : "http://127.0.0.1:8746"
)L’URI décrivant comme écouter les requêtes des clients. L’API cliente permet de soumettre des constructions et n’est pas actuellement authentifiée, donc faites attention lors de la configuration de cette valeur.
allocation-strategy
(par défaut : #~basic-build-allocation-strategy
)Une G-expression pour la stratégie d’allocation à utiliser. C’est une procédure qui prend le stockage de données en argument et rempli le plan d’allocation dans la base de données.
hooks
(par défaut : ’())Une liste d’association de crochets. Ils fournissent une manière d’exécuter du code arbitraire en fonction d’évènements, comme le traitement des résultats des constructions.
parallel-hooks
(par défaut : ’())Les crochets peuvent être configurés pour être lancés en parallèle. Ce paramètre est une liste d’association de crochets à lancer en parallèle, où la clé est le symbole pour le crochet et la valeur est le nombre de threads à lancer.
guile
(par défaut : guile-3.0-latest
)Le paquet Guile à utiliser pour lancer Guix Build Coordinator.
extra-environment-variables
(par défaut : ’())Extra environment variables to set via the shepherd service.
Le type de service pour un agent Guix Build Coordinator. Sa valeur doit
être un guix-build-coordinator-agent-configuration
.
Type de données représentant la configuration d’un agent Guix Build Coordinator.
package
(par défaut : guix-build-coordinator/agent-only
)Le paquet Guix Build Coordinator à utiliser.
user
(par défaut : "guix-build-coordinator-agent"
)L’utilisateur qui lance le service.
coordinator
(par défaut : "http://localhost:8745"
)L’URI à utiliser lors de la connexion au coordinateur.
authentification
Enregistrement décrivant comme cet agent devrait s’authentifier avec le coordinateur. Les types d’enregistrement possibles sont décrit plus bas.
systems
(par défaut : #f
)Les systèmes pour lesquels cet agent devrait récupérer les constructions. Le processus de l’agent utilisera le système actuel comme valeur par défaut.
max-parallel-builds
(default: #f
)Le nombre de constructions qui peuvent tourner simultanément.
max-parallel-uploads
(default: #f
)The number of uploads to perform in parallel.
max-allocated-builds
(par défaut : #f
)Le nombre maximum de constructions que cette agent peut allouer.
max-1min-load-average
(par défaut : #f
)Valeur moyenne de charge à vérifier avant de commencer de nouvelles construction. Si la valeur moyenne à une minute dépasse cette valeur, l’agent attendra avant de commencer de nouvelles constructions.
Cela sera non spécifié si la valeur est #f
, et l’agent utilisera le
nombre de cœurs rapportés par le système comme la moyenne de charge à 1
minute maximale.
derivation-substitute-urls
(par défaut : #f
)URL à partir desquelles essayer de récupérer les substituts pour les dérivations, si les dérivation ne sont pas déjà disponibles.
non-derivation-substitute-urls
(par défaut : #f
)URL à partir desquelles essayer de chercher les substituts pour les entrées des constructions, si les éléments du dépôt des entrées ne sont pas déjà disponibles.
extra-options
(par défaut : ’())Extra command line options for guix-build-coordinator-agent
.
Type de données représentant un moyen d’authentification avec un coordinateur pour les agents, via un UUID et un mot de passe.
uuid
L’UUID de l’agent. Il devrait être généré par le processus du coordinateur, stocké dans la base du coordinateur et utilisé par l’agent prévu.
password
Le mot de passe à utiliser lors de la connexion au coordinateur.
Type de données représentant un moyen d’authentification avec un coordinateur via un UUID et un mot de passe lu depuis un fichier.
uuid
L’UUID de l’agent. Il devrait être généré par le processus du coordinateur, stocké dans la base du coordinateur et utilisé par l’agent prévu.
password-file
Un fichier contenant le mot de passe à utiliser pour la connexion avec le coordinateur.
Type de données représentant un moyen d’authentification à un coordinateur via un jeton d’authentification dynamique et le nom de l’agent.
agent-name
Nom d’un agent, c’est utilisé pour le faire correspondre à une entrée existante dans la base de données s’il existe. Lorsqu’aucune entrée n’est trouvée, une nouvelle entrée est ajoutée automatiquement.
token
Jeton d’authentification dynamique, créé et stocké dans la base de données du coordinateur, et utilisé par l’agent pour s’authentifier.
Type de données représentant une méthode d’authentification à un coordinateur via un jeton d’authentification dynamique lu depuis un fichier et un nom d’agent.
agent-name
Nom d’un agent, c’est utilisé pour le faire correspondre à une entrée existante dans la base de données s’il existe. Lorsqu’aucune entrée n’est trouvée, une nouvelle entrée est ajoutée automatiquement.
token-file
Fichier contenant le jeton d’authentification dynamique, créé et stocké dans la base de données du coordinateur, et utilisé par l’agent pour s’authentifier.
Le Guix Data Service traite, stocke et fournit des données à propos de GNU Guix. Cela comprend des informations sur les paquets, les dérivations et les messages d’avertissement de formatage.
Les données sont stockées dans une base PostgreSQL, et sont disponibles à travers une interface web.
Le type de service pour le Guix Data Service. Sa valeur doit être un objet
guix-data-service-configuration
. Le service étend éventuellement le
service getmail, car la liste de diffusion guix-commits est utilisée pour
récupérer les changement dans le dépôt git de Guix.
Le type de données représentant la configuration du Guix Data Service.
package
(par défaut : guix-data-service
)Le paquet Guix Data Service à utiliser.
user
(par défaut : "guix-data-service"
)L’utilisateur qui lance le service.
group
(par défaut : "guix-data-service"
)Le groupe système qui lance le service.
port
(par défaut : 8765
)Le port sur lequel lier le service web.
host
(par défaut : "127.0.0.1"
)L’hôte sur lequel lier le service web.
getmail-idle-mailboxes
(par défaut : #f
)Si une valeur est indiquée, c’est la liste des boites de courriel que le service getmail récupère.
commits-getmail-retriever-configuration
(par défaut : #f
)Si la valeur est indiquée, c’est l’objet
getmail-retriever-configuration
avec lequel configurer getmail pour
récupérer les courriels à part de la liste de diffusion guix-commits.
extra-options
(par défaut : ’())Liste d’options supplémentaires de la ligne de commande pour
guix-data-service
.
extra-process-jobs-options
(par défaut : ’())Liste d’options supplémentaires de la ligne de commande pour
guix-data-service-process-jobs
.
The Guix Home service is a way to let Guix System deploy the home
environment of one or more users (voir Configuration du dossier personnel, for more on
Guix Home). That way, the system configuration embeds declarations of the
home environment of those users and can be used to deploy everything
consistently at once, saving users the need to run guix home
reconfigure
independently.
Service type for the Guix Home service. Its value must be a list of lists containing user and home environment pairs. The key of each pair is a string representing the user to deploy the configuration under and the value is a home-environment configuration.
(use-modules (gnu home)) (define my-home (home-environment …)) (operating-system (services (append (list (service guix-home-service-type `(("alice" ,my-home)))) %base-services)))
This service can be extended by other services to add additional home environments, as in this example:
(simple-service 'my-extra-home guix-home-service-type `(("bob" ,my-extra-home))))
Nar Herder est un utilitaire pour gérer une collection de nars.
Le type de service pour le Guix Data Service. Sa valeur doit être un objet
nar-herder-configuration
. Le service étend éventuellement le service
getmail, car la liste de diffusion guix-commits est utilisée pour récupérer
les changement dans le dépôt git de Guix.
Le type de données représentant la configuration du Guix Data Service.
package
(par défaut : nar-herder
)Le paquet Nar Herder à utiliser.
user
(par défaut : "nar-herder"
)L’utilisateur qui lance le service.
group
(par défaut : "nar-herder"
)Le groupe système qui lance le service.
port
(par défaut : 8734
)Le pour sur lequel lier le serveur.
host
(par défaut : "127.0.0.1"
)L’hôte sur lequel lier le serveur.
mirror
(par défaut : #f
)URL facultative de l’autre instance de Nar Herder qui doit être répliquée. Cela signifie que cette instance de Nar Herder téléchargera sa base de données et la gardera à jour.
database
(par défaut : "/var/lib/nar-herder/nar_herder.db"
)Emplacement de la base de données. Si cette instance de Nar Herder en réplique une autre, la base de données sera téléchargée si elle n’existe pas. Si cette instance de Nar Herder n’en réplique pas une autre, une base de données vide sera créée.
database-dump
(par défaut : "/var/lib/nar-herder/nar_herder_dump.db"
)Emplacement de la décharge de la base de données. Elle est crée et régulièrement mise à jour en prenant une copie de la base de données. C’est la version de la base de données qui est disponible au téléchargement.
storage
(par défaut : #f
)Emplacement facultatif dans lequel stocker les nars.
storage-limit
(par défaut : "none"
)Limite en octets pour les nars stockés dans l’emplacement de stockage. Cela peut valoir « none » pour qu’il n’y ait pas de limite.
Lorsque l’emplacement de stockage dépasse cette taille, les nars sont supprimés en fonction des critères de suppression des nars.
storage-nar-removal-criteria
(par défaut : '()
)Critères utilisés pour supprimer les nars de l’emplacement de stockage. Ils sont utilisés en plus de la limite de stockage.
Lorsque l’emplacement de stockage dépasse la limite de taille, les nars passeront aux critères de suppression et ceux qui correspondent aux critères seront supprimés. Cela continue jusqu’à ce que l’emplacement de stockage repasse en dessous de la limite de taille.
Chaque critère est spécifié par une chaine, puis un signe égal, puis une autre chaine. Actuellement, seul un critère est pris en charge, vérifier si un nar est stocké sur une autre instance de Nar Herder.
ttl
(par défaut : #f
)Produit des en-têtes HTTP Cache-Control
qui annoncent une durée de
vie (TTL) de ttl. ttl peut dénoter une durée : 5d
signifie 5 jours, 1m
signifie un mois, etc.
Cela permet au Guix de l’utilisateur ou de l’utilisatrice de garder les informations de substituts en cache pendant ttl.
new-ttl
(default: #f
)If specified, this will override the ttl
setting when used for the
Cache-Control
headers, but this value will be used when scheduling
the removal of nars.
Use this setting when the TTL is being reduced to avoid removing nars while clients still have cached narinfos.
negative-ttl
(par défaut : #f
)Produit de la même manière des en-têtes HTTP Cache-Control
pour
annoncer la durée de vie (TLL) d’une recherche négative — des entrées
du dépôt manquantes, pour lesquelles une erreur 404 est renvoyée. Par
défaut, aucun TTL négatif n’est annoncé.
log-level
(par défaut : 'DEBUG
)Niveau de journalisation à utiliser, spécifie un niveau de journalisation
comme 'INFO
pour arrêter de journaliser les requêtes individuelles.
cached-compressions
(default: '()
)Activate generating cached nars with different compression details from the stored nars. This is a list of nar-herder-cached-compression-configuration records.
min-uses
(default: 3
)When cached-compressions are enabled, generate cached nars when at least this number of requests are made for a nar.
workers
(default: 2
)Number of cached nars to generate at a time.
nar-source
(default: #f
)Location to fetch nars from when computing cached compressions. By default, the storage location will be used.
extra-environment-variables
(par défaut : '()
)Extra environment variables to set via the shepherd service.
Data type representing the cached compression configuration.
type
Type of compression to use, e.g. 'zstd
.
workers
(par défaut : #f
)Level of the compression to use.
directory
(default: #f
)Location to store the cached nars. If unspecified, they will be stored in /var/cache/nar-herder/nar/TYPE.
directory-max-size
(default: #f
)Maximum size in bytes of the directory.
unused-removal-duration
(default: #f
)If a cached nar isn’t used for unused-removal-duration
, it will be
scheduled for removal.
unused-removal-duration must denote a duration: 5d
means 5
days, 1m
means 1 month, and so on.
ttl
(par défaut : #f
)If specified this overrides the ttl
used for narinfos when this
cached compression is available.
new-ttl
(default: #f
)As with the new-ttl
option for nar-herder-configuration
, this
value will override the ttl
when used for narinfo requests.
Suivant: Services Hurd, Précédent: Services Guix, Monter: Services [Table des matières][Index]
Early OOM, aussi appelé Earlyoom, est un démon de gestion du remplissage mémoire (OOM) minimaliste qui se lance en espace utilisateur et fournit une alternative plus rapide et configurable que le gestionnaire du noyau. Il est utile pour éviter que le système ne cesse de répondre lorsqu’il n’a plus de mémoire.
Le type de service pour le service earlyoom
, le démon Early OOM.
Sa valeur doit être un objet earlyoom-configuration
, décrit plus
bas. Vous pouvez instancier le service avec sa configuration par défaut
avec :
La configuration pour earlyoom-service-type
.
earlyoom
(par défaut : earlyoom)Le paquet Earlyoom à utiliser.
minimum-available-memory
(par défaut : 10
)La limite de mémoire disponible minimum, en pourcentage.
minimum-free-swap
(par défaut : 10
)La limite d’espace d’échange libre minimum, en pourcentage.
prefer-regexp
(par défaut : #f
)Une expression régulière (une chaine) qui correspond aux noms des processus à tuer en priorité.
avoid-regexp
(par défaut : #f
)Une expression régulière (une chaine) des noms des processus qui ne doivent pas être tués.
memory-report-interval
(par défaut : 0
)L’intervalle en seconde d’affichage du rapport mémoire. Il est désactivé par défaut.
ignore-positive-oom-score-adj?
(par défaut : #f
)Un booléen indiquant si les ajustements positifs indiqués dans /proc/*/oom_score_adj doivent être ignorés.
show-debug-messages?
(par défaut : #f
)Un booléen indiquant si les messages de débogages doivent être affichés. Les journaux sont sauvegardés dans /var/log/earlyoom.log.
send-notification-command
(par défaut : #f
)On peut utiliser cette option pour fournir une commande personnalisée pour envoyer les notifications.
The command fstrim
can be used to discard (or trim) unused
blocks on a mounted file system.
Attention : Running
fstrim
frequently, or even usingmount -o discard
, might negatively affect the lifetime of poor-quality SSD devices. For most desktop and server systems a sufficient trimming frequency is once a week. Note that not all devices support a queued trim, so each trim command incurs a performance penalty on whatever else might be trying to use the disk at the time.
Type for a service that periodically runs fstrim
, whose value must
be an <fstrim-configuration>
object. The service can be instantiated
in its default configuration with:
Available fstrim-configuration
fields are:
package
(default: util-linux
) (type: file-like)The package providing the fstrim
command.
schedule
(default: "0 0 * * 0"
) (type: mcron-time)Schedule for launching fstrim
. This can be a procedure, a list or
a string. For additional information, see Job
specification dans the mcron manual. By default this is set to run weekly
on Sunday at 00:00.
listed-in
(default: '("/etc/fstab" "/proc/self/mountinfo")
) (type: maybe-list-of-strings)List of files in fstab or kernel mountinfo format. All missing or empty
files are silently ignored. The evaluation of the list stops after
the first non-empty file. File systems with X-fstrim.notrim
mount
option in fstab are skipped.
verbose?
(default: #t
) (type: boolean)Verbose execution.
quiet-unsupported?
(default: #t
) (type: boolean)Suppress error messages if trim operation (ioctl) is unsupported.
extra-arguments
(type: maybe-list-of-strings)Extra options to append to fstrim
(run ‘man fstrim’ for more
information).
Le service de chargement de modules du noyau vous permet de charger des
modules du noyau au démarrage. C’est particulièrement utile pour les
modules qui ne sont pas chargés automatiquement et qui doivent être chargés
manuellement, comme c’est le cas avec ddcci
.
Le type de service pour charger des modules du noyau au démarrage avec
modprobe
. Sa valeur doit être une liste de chaines de caractères
représentant les noms des modules. Par exemple pour charger les pilotes
fournis par ddcci-driver-linux
, en mode débogage en passant certains
paramètres au module, on peut faire :
(use-modules (gnu) (gnu services)) (use-package-modules linux) (use-service-modules linux) (define ddcci-config (plain-file "ddcci.conf" "options ddcci dyndbg delay=120")) (operating-system ... (services (cons* (service kernel-module-loader-service-type '("ddcci" "ddcci_backlight")) (simple-service 'ddcci-config etc-service-type (list `("modprobe.d/ddcci.conf" ,ddcci-config))) %base-services)) (kernel-loadable-modules (list ddcci-driver-linux)))
The Cachefilesd service starts a daemon that caches network file system data locally. It is especially useful for NFS and AFS shares, where it reduces latencies for repeated access when reading files.
The daemon can be configured as follows:
(service cachefilesd-service-type
(cachefilesd-configuration
(cache-directory "/var/cache/fscache")))
The service type for starting cachefilesd
. The value for this
service type is a cachefilesd-configuration
, whose only required
field is cache-directory.
Available cachefilesd-configuration
fields are:
cachefilesd
(default: cachefilesd
) (type: file-like)The cachefilesd package to use.
debug-output?
(default: #f
) (type: boolean)Print debugging output to stderr.
use-syslog?
(default: #t
) (type: boolean)Log to syslog facility instead of stdout.
scan?
(default: #t
) (type: boolean)Scan for cachable objects.
cache-directory
(type: maybe-string)Location of the cache directory.
cache-name
(default: "CacheFiles"
) (type: maybe-string)Name of cache (keep unique).
security-context
(type: maybe-string)SELinux security context.
pause-culling-for-block-percentage
(default: 7
) (type: maybe-non-negative-integer)Pause culling when available blocks exceed this percentage.
pause-culling-for-file-percentage
(default: 7
) (type: maybe-non-negative-integer)Pause culling when available files exceed this percentage.
resume-culling-for-block-percentage
(default: 5
) (type: maybe-non-negative-integer)Start culling when available blocks drop below this percentage.
resume-culling-for-file-percentage
(default: 5
) (type: maybe-non-negative-integer)Start culling when available files drop below this percentage.
pause-caching-for-block-percentage
(default: 1
) (type: maybe-non-negative-integer)Pause further allocations when available blocks drop below this percentage.
pause-caching-for-file-percentage
(default: 1
) (type: maybe-non-negative-integer)Pause further allocations when available files drop below this percentage.
log2-table-size
(default: 12
) (type: maybe-non-negative-integer)Size of tables holding cullable objects in logarithm of base 2.
cull?
(default: #t
) (type: boolean)Create free space by culling (consumes system load).
trace-function-entry-in-kernel-module?
(default: #f
) (type: boolean)Trace function entry in the kernel module (for debugging).
trace-function-exit-in-kernel-module?
(default: #f
) (type: boolean)Trace function exit in the kernel module (for debugging).
trace-internal-checkpoints-in-kernel-module?
(default: #f
) (type: boolean)Trace internal checkpoints in the kernel module (for debugging).
Le service Rasdaemon fournit un démon qui surveille les rapports RAS (Reliability, Availability, and Serviceability) de la plateforme dans les événements de trace du noyau Linux, et les envoie à syslogd.
La fiabilité, la disponibilité et la serviabilité est un concept utilisé sur les serveur conçu pour mesurer leur robustesse.
La fiabilité est la probabilité pour qu’un système produise les résultats attendus :
La disponibilité est la probabilité pour qu’un système soit opérationnel à un moment donné :
La serviabilité est la simplicité et la rapidité avec laquelle un système peut être réparé ou maintenu :
Entre autres mesures de surveillance, les plus courantes sont :
En surveillant le nombre de détection d’erreurs, il est possible d’identifier si la probabilité d’erreurs matérielles augmente, et dans ce cas, d’effectuer une maintenance préventive pour remplacecr un composant dégradé tant que les erreurs peuvent être corrigées.
Pour des informations détaillées sur les types d’événements d’erreur récupérés et comment les comprendre, voir le guide de l’administrateur du noyau sur https://www.kernel.org/doc/html/latest/admin-guide/ras.html.
Le type de service pour le service rasdaemon
. Il accepte un objet
rasdaemon-configuration
. Instantiez-le avec
chargera une configuration par défaut, qui surveille tous les événements et les enregistre avec syslogd.
Type de données représentant la configuration de rasdaemon
.
record?
(par défaut : #f
)Un booléen indiquant s’il faut enregistrer les événements dans une base de données SQLite. Cela donne un accès plus structuré aux informations contenues dans le fichier journal. L’emplacement de la base de données est codée en dur : /var/lib/rasdaemon/ras-mc_event.db.
Le service de périphérique Zram fournit un périphérique de swap compressé en mémoire système. La documentation du noyau Linux a plus d’information à propos de ces périphériques zram.
Ce service crée un périphérique de bloc zram, le formate en swap et active
l’espace d’échange. La valeur du service est un enregistrement
zram-device-configuration
.
C’est le type de données représentant la configuration du service zram-device.
size
(par défaut : "1G"
)C’est l’espace que vous voulez fournir à votre périphérique zram. Il
accepte une chaine et peut être un nombre d’octets ou utiliser un suffixe,
p. ex. : "512M"
ou "1024000"
.
compression-algorithm
(par défaut : 'lzo
)C’est l’algorithme de compression à utiliser. Il est difficile de lister
toutes les possibilités, mais les options habituelles prises en charge par
le noyau Linux Libre de Guix sont 'lzo
, 'lz4
et 'zstd
.
memory-limit
(par défaut : 0
)C’est la quantité de mémoire maximal que le périphérique zram peut
utiliser. le mettre à « 0 » désactive la limite. Bien qu’il soit
généralement accepté que la compression aura un ratio de 2 pour 1, il est
possible que des données non-comprimables soient écrites en espace d’échange
et c’est une méthode pour limiter la quantité de mémoire qui peut être
utilisée. Le paramètre accepte une chaine qui peut être un nombre d’octets
ou utiliser un suffixe, p. ex. "2G"
.
priority
(par défaut : #f
)C’est la priorité du périphérique d’échange créé à partir du périphérique zram. Voir Espace d’échange pour une description des priorités des espaces d’échange. Vous voudrez peut-être indiquer une priorité spécifique pour le périphérique zram, sinon il pourrait ne pas être utilisé du tout pour les raisons qui y sont décrites.
Suivant: Services divers, Précédent: Services Linux, Monter: Services [Table des matières][Index]
Ce service démarre le client VGA
sophistiqué en console sur le Hurd.
La valeur du service est un enregistrement
hurd-console-configuration
.
C’est le type de données représentant la configuration de hurd-console-service.
hurd
(par défaut : hurd)Le paquet Hurd à utiliser.
Ce service démarre un tty avec le programme getty
.
La valeur du service est un enregistrement hurd-getty-configuration
.
Ce type de données représente la configuration de hurd-getty-service.
hurd
(par défaut : hurd)Le paquet Hurd à utiliser.
tty
Le nom de la console sur laquelle tourne ce Getty, p. ex. "tty1"
.
baud-rate
(par défaut : 38400
)Un entier spécifiant le taux de Baud de ce tty.
Précédent: Services Hurd, Monter: Services [Table des matières][Index]
Le module (gnu services authentication)
fournit un service DBus pour
lire et identifier les empreintes digitales via un lecteur d’empreinte.
Le type de service pour fprintd
, qui fournit des capacités de
lecture d’empreinte.
Le module (gnu services sysctl)
fournit un service pour configurer
les paramètres du noyau au démarrage.
Le type de service pour sysctl
, qui modifie les paramètres du
noyau dans /proc/sys/. Pour activer le transfert d’IPv4, vous pouvez
l’instancier ainsi :
(service sysctl-service-type
(sysctl-configuration
(settings '(("net.ipv4.ip_forward" . "1")))))
Comme le service sysctl-service-type
fait partie des services par
défaut, %base-services
et %desktop-services
, vous pouvez
utiliser modify-services
pour changer sa configuration et ajouter les
paramètres du noyau que vous voulez (voir modify-services
).
(modify-services %base-services
(sysctl-service-type config =>
(sysctl-configuration
(settings (append '(("net.ipv4.ip_forward" . "1"))
%default-sysctl-settings)))))
Le type de données représentant la configuration de sysctl
.
sysctl
(par défaut : (file-append procps "/sbin/sysctl"
)L’exécutable sysctl
à utiliser.
settings
(par défaut : %default-sysctl-settings
)Une liste d’association spécifiant les paramètres du noyau et leur valeur.
Une liste d’association spécifiant les paramètres sysctl
par
défaut sur le système Guix.
Le module (gnu services security-token)
fournit le service suivant
qui lance pcscd
, le démon PC/SC Smart Card. pcscd
est
le démon pour pcsc-lite et MuscleCard. C’est un gestionnaire de ressource
qui coordonne les communications avec les lecteurs de smart cards, les smart
cards et les jetons cryptographiques connectés au système.
Le type de service pour le service pcscd
. Sa valeur doit être un
objet pcscd-configuration
. Pour lancer pcscd dans sa configuration
par défaut, instantiez-le avec :
Type de données représentant la configuration de pcscd
.
pcsc-lite
(par défaut : pcsc-lite
)Le paquet pcsc-lite qui fournit pcscd.
usb-drivers
(par défaut : (list ccid)
)Liste des paquets qui fournissent des pilotes USB à pcscd. Les pilotes doivent être dans pcsc/drivers dans le répertoire du dépôt du paquet.
Le module (gnu services lirc)
fournit le service suivant.
Type for a service that runs LIRC, a daemon that decodes infrared signals from remote controls.
The value for this service is a <lirc-configuration>
object.
Data type representing the configuration of lircd
.
lirc
(default: lirc
) (type: file-like)Package object for lirc
.
device
(default: #f
) (type: string)driver
(default: #f
) (type: string)config-file
(default: #f
) (type: string-or-file-like)TODO. See lircd
manual for details.
extra-options
(default: '()
) (type: list-of-string)Additional command-line options to pass to lircd
.
Le module (gnu services spice)
fournit le service suivant.
Type of the service that runs VDAGENT, a daemon that enables sharing the clipboard with a vm and setting the guest display resolution when the graphical console window resizes.
Data type representing the configuration of
spice-vdagent-service-type
.
spice-vdagent
(default: spice-vdagent
) (type: file-like)Package object for VDAGENT.
Le service inputattach vous permet d’utiliser des périphériques d’entrée comme les tablettes Wacom, les écrans tactiles ou les joysticks avec le serveur d’affichage Xorg.
Type d’un service qui lance inputattach
sur un appareil et envie
les événements qu’il reçoit.
device-type
(par défaut : "wacom"
)Le type du périphérique à gérer. Lancez inputattach --help
, du
paquet inputattach
, pour voir la liste des types de périphériques
supportés.
device
(par défaut : "/dev/ttyS0"
)Le fichier de périphérique pour s’y connecter.
baud-rate
(par défaut : #f
)Taux de Baud à utiliser pour la connexion série. Cela doit être un nombre
ou #f
.
log-file
(par défaut : #f
)Si la valeur est vraie, cela doit être le nom d’un fichier où enregistrer les messages.
Le module (gnu services dict)
fournit le service suivant :
C’est le type de service qui lance le démon dicod
, une
implémentation du serveur DICT (voir Dicod dans GNU Dico Manual).
Vous pouvez ajouter open localhost
à votre fichier ~/.dico
pour faire de localhost
le serveur par défaut du client
dico
(voir Initialization File dans GNU Dico Manual).
Remarque : This service is also available for Guix Home, where it runs directly with your user privileges (voir
home-dicod-service-type
).
Type de données représentant la configuration de dicod.
dico
(par défaut : dico)Objet de paquet du serveur de dictionnaire GNU Dico.
interfaces
(par défaut : ’("localhost"))C’est la liste des adresses IP et des ports et éventuellement des noms de
fichiers de socket sur lesquels écouter (voir listen
directive dans GNU Dico Manual).
handlers
(par défaut : ’())Liste des objets <dicod-handler>
qui définissent des gestionnaires
(des instances de modules).
databases
(par défaut : (list %dicod-database:gcide))Liste d’objets <dicod-database>
qui définissent des dictionnaires à
servir.
Type de données représentant un gestionnaire de dictionnaire (instance de module).
name
Nom du gestionnaire (instance de module).
module
(par défaut : #f)Nom du module dicod du gestionnaire (instance). Si la valeur est #f
,
le module a le même nom que le gestionnaire. (voir Modules dans GNU
Dico Manual).
options
Liste de chaînes ou de gexps représentant les arguments pour le gestionnaire de module
Type de données représentant une base de données de dictionnaire.
name
Nom de la base de données, qui sera utilisée dans les commande DICT.
handler
Nom du gestionnaire dicod (instance de module) utilisé par cette base de données (voir Handlers dans GNU Dico Manual).
complex?
(par défaut : #f)Indique si la configuration est pour une base de données complexe. La
configuration complexe a besoin d’un objet <dicod-handler>
correspondant, sinon inutile.
options
Liste de chaînes ou de gexps représentant les arguments pour la base de données (voir Databases dans GNU Dico Manual).
Un objet <dicod-database>
servant le dictionnaire international
collaboratif en anglais via le paquet gcide
.
Voici un exemple de configuration de dicod-service-type
.
(service dicod-service-type
(dicod-configuration
(handlers (list
(dicod-handler
(name "wordnet")
(module "wordnet")
(options
(list #~(string-append "wnhome=" #$wordnet))))))
(databases (list
(dicod-database
(name "wordnet")
(complex? #t)
(handler "wordnet"))
%dicod-database:gcide))))
Le module (gnu services docker)
fournit les services suivants.
This service type operates containerd containerd, a daemon responsible for overseeing the entire container lifecycle on its host system. This includes image handling, storage management, container execution, supervision, low-level storage operations, network connections, and more.
This is the data type representing the configuration of containerd.
containerd
(default: containerd
)The containerd daemon package to use.
debug?
(par défaut : #f
)Indique s’il faut activer la sortie de débogage.
environment-variables
(par défaut : '()
)List of environment variables to set for containerd
.
Cela doit être une liste de chaines où chaque chaine a pour forme ‘clé=valeur’ comme dans cet exemple :
(list "HTTP_PROXY=socks5://127.0.0.1:9150"
"HTTPS_PROXY=socks5://127.0.0.1:9150")
C’est le type du service qui lance Docker, un démon qui peut exécuter des lots applicatifs (aussi appelés « conteneurs ») dans des environnements isolés.
The containerd-service-type
service need to be added to a system
configuration, otherwise a message about not any service provides
containerd
will be displayed during guix system reconfigure
.
Le type de données qui représente la configuration de Docker et Containerd.
docker
(par défaut : docker
)Le paquet du démon Docker à utiliser.
docker-cli
(par défaut : docker-cli
)Le paquet du client Docker à utiliser.
containerd
(par défaut : containerd)This field is deprecated in favor of containerd-service-type
service.
proxy
(par défaut : docker-libnetwork-cmd-proxy)Le paquet du mandataire réseau en espace utilisateur de Docker à utiliser.
enable-proxy?
(par défaut : #t
)Indique s’il faut utiliser le mandataire réseau en espace utilisateur de Docker.
debug?
(par défaut : #f
)Indique s’il faut activer la sortie de débogage.
enable-iptables?
(par défaut : #t
)Indique s’il faut ajouter des règles iptables.
environment-variables
(par défaut : '()
)Liste de variables d’environnement à initialiser pour dockerd
.
Cela doit être une liste de chaines où chaque chaine a pour forme ‘clé=valeur’ comme dans cet exemple :
(list "LANGUAGE=eo:ca:eu"
"TMPDIR=/tmp/dockerd")
config-file
(type: maybe-file-like)JSON configuration file pass to dockerd
.
C’est le type de service qui vous permet de lancer Singularity, un outil similaire à Docker pour créer et lancer des lots applicatifs (aussi appelés « conteneurs »). la valeur de ce service est le paquet Singularity à utiliser.
Le service n’installe pas de démon : à la place, il installe des utilitaires
en setuid-root (voir Privileged Programs) pour que les utilisateurs non
privilégiés puisse invoquer singularity run
et les commandes
similaires.
Should you wish to manage your Docker containers with the same consistent interface you use for your other Shepherd services, oci-container-service-type is the tool to use: given an Open Container Initiative (OCI) container image, it will run it in a Shepherd service. One example where this is useful: it lets you run services that are available as Docker/OCI images but not yet packaged for Guix.
This is a thin wrapper around Docker’s CLI that executes OCI images backed processes as Shepherd Services.
(service oci-container-service-type
(list
(oci-container-configuration
(network "host")
(image
(oci-image
(repository "guile")
(tag "3")
(value (specifications->manifest '("guile")))
(pack-options '(#:symlinks (("/bin/guile" -> "bin/guile"))
#:max-layers 2))))
(entrypoint "/bin/guile")
(command
'("-c" "(display \"hello!\n\")")))
(oci-container-configuration
(image "prom/prometheus")
(ports
'(("9000" . "9000")
("9090" . "9090"))))
(oci-container-configuration
(image "grafana/grafana:10.0.1")
(network "host")
(volumes
'("/var/lib/grafana:/var/lib/grafana")))))
In this example three different Shepherd services are going to be added to
the system. Each oci-container-configuration
record translates to a
docker run
invocation and its fields directly map to options. You
can refer to the
upstream
documentation for the semantics of each value. If the images are not found,
they will be
pulled.
The services with (network "host")
are going to be attached to the
host network and are supposed to behave like native processes with regard to
networking.
Available oci-container-configuration
fields are:
user
(default: "oci-container"
) (type: string)The user under whose authority docker commands will be run.
group
(default: "docker"
) (type: string)The group under whose authority docker commands will be run.
command
(default: '()
) (type: list-of-strings)Overwrite the default command (CMD
) of the image.
entrypoint
(default: ""
) (type: string)Overwrite the default entrypoint (ENTRYPOINT
) of the image.
host-environment
(default: '()
) (type: list)Set environment variables in the host environment where docker run
is invoked. This is especially useful to pass secrets from the host to the
container without having them on the docker run
’s command line: by
setting the MYSQL_PASSWORD
on the host and by passing --env
MYSQL_PASSWORD
through the extra-arguments
field, it is possible to
securely set values in the container environment. This field’s value can be
a list of pairs or strings, even mixed:
(list '("LANGUAGE\" . "eo:ca:eu")
"JAVA_HOME=/opt/java")
Pair members can be strings, gexps or file-like objects. Strings are passed
directly to make-forkexec-constructor
.
environment
(default: '()
) (type: list)Set environment variables. This can be a list of pairs or strings, even mixed:
(list '("LANGUAGE" . "eo:ca:eu")
"JAVA_HOME=/opt/java")
Pair members can be strings, gexps or file-like objects. Strings are passed directly to the Docker CLI. You can refer to the upstream documentation for semantics.
image
(type: string-or-oci-image)The image used to build the container. It can be a string or an
oci-image
record. Strings are resolved by the Docker Engine, and
follow the usual format myregistry.local:5000/testing/test-image:tag
.
provision
(default: ""
) (type: string)Set the name of the provisioned Shepherd service.
requirement
(default: '()
) (type: list-of-symbols)Set additional Shepherd services dependencies to the provisioned Shepherd service.
log-file
(type: maybe-string)When log-file
is set, it names the file to which the service’s
standard output and standard error are redirected. log-file
is
created if it does not exist, otherwise it is appended to.
auto-start?
(default: #t
) (type: boolean)Whether this service should be started automatically by the Shepherd. If it
is #f
, the service has to be started manually with herd
start
.
respawn?
(default: #f
) (type: boolean)Whether to have Shepherd restart the service when it stops, for instance when the underlying process dies.
shepherd-actions
(default: '()
) (type: list-of-symbols)This is a list of shepherd-action
records defining actions supported
by the service.
network
(default: ""
) (type: string)Set a Docker network for the spawned container.
ports
(default: '()
) (type: list)Set the port or port ranges to expose from the spawned container. This can be a list of pairs or strings, even mixed:
(list '("8080" . "80")
"10443:443")
Pair members can be strings, gexps or file-like objects. Strings are passed directly to the Docker CLI. You can refer to the upstream documentation for semantics.
volumes
(default: '()
) (type: list)Set volume mappings for the spawned container. This can be a list of pairs or strings, even mixed:
(list '("/root/data/grafana" . "/var/lib/grafana")
"/gnu/store:/gnu/store")
Pair members can be strings, gexps or file-like objects. Strings are passed directly to the Docker CLI. You can refer to the upstream documentation for semantics.
container-user
(default: ""
) (type: string)Set the current user inside the spawned container. You can refer to the upstream documentation for semantics.
workdir
(default: ""
) (type: string)Set the current working directory for the spawned Shepherd service. You can refer to the upstream documentation for semantics.
extra-arguments
(default: '()
) (type: list)A list of strings, gexps or file-like objects that will be directly passed
to the docker run
invocation.
Available oci-image
fields are:
repository
(type: string)A string like myregistry.local:5000/testing/test-image
that names the
OCI image.
tag
(default: "latest"
) (type: string)A string representing the OCI image tag. Defaults to latest
.
value
(type: oci-lowerable-image)A manifest
or operating-system
record that will be lowered
into an OCI compatible tarball. Otherwise this field’s value can be a gexp
or a file-like object that evaluates to an OCI compatible tarball.
pack-options
(default: '()
) (type: list)An optional set of keyword arguments that will be passed to the
docker-image
procedure from guix scripts pack
. They can be
used to replicate guix pack
behavior:
(oci-image
(repository "guile")
(tag "3")
(value
(specifications->manifest '("guile")))
(pack-options '(#:symlinks (("/bin/guile" -> "bin/guile"))
#:max-layers 2)))
If the value
field is an operating-system
record, this field’s
value will be ignored.
system
(default: ""
) (type: string)Attempt to build for a given system, e.g. "i686-linux"
target
(default: ""
) (type: string)Attempt to cross-build for a given triple, e.g. "aarch64-linux-gnu"
grafts?
(default: #f
) (type: boolean)Whether to allow grafting or not in the pack build.
Le module (gnu services auditd)
fournit le service suivant.
C’est le type du service qui lance auditd, un démon qui suit les informations de sécurité de votre système.
Exemples de ce qui peut être suivi :
auditctl
du paquet audit
peut être utilisé pour ajouter ou
supprimer des évènements à suivre (jusqu’au prochain redémarrage). Pour
suivre les évènements de manière permanente, ajoutez des arguments à la
commande auditctl dans un fichier nommé audit.rules
dans le
répertoire de configuration (voir plus bas). aureport
du paquet
audit
peut être utilisé pour visualiser un rapport de tous les
évènements enregistrés. le démon d’audit enregistre par défaut dans le
fichier /var/log/audit.log.
Le type de données qui représente la configuration de auditd.
audit
(par défaut : audit
)Le paquet audit à utiliser.
configuration-directory
(par défaut : %default-auditd-configuration-directory
)Le répertoire contenant le fichier de configuration du paquet audit, qui
doit être nommé auditd.conf
, et éventuellement des règles d’audit à
instancier au démarrage.
Le module (gnu services science)
fournit le service suivant.
C’est le type de service utilisé pour lancer une appli web créée avec
r-shiny
. Ce service initialise la variable d’environnement
R_LIBS_USER
et lance le script fournit pour appeler runApp
.
Le type de données qui représente la configuration de rshiny.
package
(par défaut : r-shiny
)Le paquet à utiliser.
binary
(par défaut : "rshiny"
)Le nom du binaire ou du script shell situé dans package/bin/
à lancer
au démarrage du service.
La manière habituelle de créer ce fichier est :
… (let* ((out (assoc-ref %outputs "out")) (targetdir (string-append out "/share/" ,name)) (app (string-append out "/bin/" ,name)) (Rbin (search-input-file %build-inputs "/bin/Rscript"))) ;; … (mkdir-p (string-append out "/bin")) (call-with-output-file app (lambda (port) (format port "#!~a library(shiny) setwd(\"~a\") runApp(launch.browser=0, port=4202)~%\n" Rbin targetdir))))
Le module (gnu services nix)
fournit le service suivant.
C’est le type du service qui lance le démon de construction du gestionnaire de paquets Nix. Voici un exemple qui montre comment l’utiliser :
(use-modules (gnu)) (use-service-modules nix) (use-package-modules package-management) (operating-system ;; … (packages (append (list nix) %base-packages)) (services (append (list (service nix-service-type)) %base-services)))
Après guix system reconfigure
, configurez Nix pour votre
utilisateur :
$ nix-channel --add https://nixos.org/channels/nixpkgs-unstable $ nix-channel --update
$ sudo mkdir -p /nix/var/nix/profiles/per-user/$USER $ sudo chown $USER:root /nix/var/nix/profiles/per-user/$USER
$ ln -s "/nix/var/nix/profiles/per-user/$USER/profile" ~/.nix-profile $ source /run/current-system/profile/etc/profile.d/nix.sh
Ce type de données représente la configuration du démon Nix.
nix
(par défaut : nix
)Le paquet Nix à utiliser.
sandbox
(par défaut : #t
)Spécifie si les constructions sont effectuées dans un bac à sable par défaut.
build-directory
(par défaut : "/tmp"
)Le répertoire où les répertoires de construction sont stockés pendant les constructions. Il est utile de le modifier par exemple si l’emplacement par défaut n’a pas assez d’espace pour contenir l’arborescence de construction de gros paquets.
Cela fonctionne de la même manière que la variable d’environnement
TPMDIR
pour guix-daemon
. TPMDIR
, pour plus d’information.
build-sandbox-items
(par défaut : '()
)C’est une liste de chaines de caractères ou d’objets ajoutés au champ
build-sandbox-items
du fichier de configuration.
extra-config
(par défaut : '()
)C’est une liste de chaînes de caractères ou d’objets ajoutés au fichier de configuration. Elle est utile pour ajouter du texte supplémentaire directement dans le fichier de configuration.
extra-options
(par défaut : '()
)Options supplémentaires de la ligne de commande pour
nix-service-type
.
fail2ban
scanne les fichiers
journaux (p. ex. /var/log/apache/error_log
) et bannit les
adresses IP qui montrent des signes de malhonnêteté — des échecs de
connexion répétés, des tentatives d’utiliser des exploits, etc.
Le type de service fail2ban-service-type
est fournit par le module
(gnu services security)
.
Ce type de service lance le démon fail2ban
. Il peut être configuré de
plusieurs façon qui sont :
Les paramètres de base du service Fail2Ban peut être configurés via sa
configuration fail2ban
, qui est documentée ci-dessous.
La fonction fail2ban-jail-service
peut être utilisée pour ajouter de
nouvelles prisons Fail2Ban.
Les développeurs de services peuvent étendre le type de service
fail2ban-service-type
lui-même avec le mécanisme d’extension habituel
des services.
C’est le type de service qui lance le démon fail2ban
. Voici un
exemple de configuration de base explicite :
(append
(list
(service fail2ban-service-type
(fail2ban-configuration
(extra-jails
(list
(fail2ban-jail-configuration
(name "sshd")
(enabled? #t))))))
;; Il n'y a pas de dépendance implicite à un service SSH,
;; donc il faut en fournir un.
(service openssh-service-type))
%base-services)
Étend svc-type, un objet <service-type>
avec jail, un
objet fail2ban-jail-configuration
.
Par exemple :
(append
(list
(service
;; La procédure « fail2ban-jail-service » peut étendre n'importe quel type de service
;; avec une prison fail2ban. Cela supprime la nécessité d'étendre les services explicitement
;; avec le fail2ban-service-type.
(fail2ban-jail-service
openssh-service-type
(fail2ban-jail-configuration
(name "sshd")
(enabled? #t)))
(openssh-configuration ...))))
Ci-dessous se trouve la référence des différents enregistrement de
configuration jail-service-type
.
Les champs de fail2ban-configuration
disponibles sont :
fail2ban
(par défaut : fail2ban
) (type : paquet)Le paquet fail2ban
à utiliser. Il est utilisé à la fois pour les
binaires et pour la configuration de base par défaut qui doit être étendue
avec des objets <fail2ban-jail-configuration>
.
run-directory
(par défaut : "/var/run/fail2ban"
) (type : chaine)Le répertoire d’état pour le démon fail2ban
.
jails
(par défaut : '()
) (type : liste-de-fail2ban-jail-configurations)Instances de <fail2ban-jail-configuration>
collectées par les
extensions.
extra-jails
(par défaut : '()
) (type : liste-de-fail2ban-jail-configurations)Instances de <fail2ban-jail-configuration>
fournies explicitement.
extra-content
(par défaut : '()
) (type : text-config)Contenu brut supplémentaire à ajouter à la fin du fichier jail.local, à fournir sous forme d’une liste de simili-fichiers.
Les champs de fail2ban-ignore-cache-configuration
disponibles sont :
key
(type : chaine)Clé de cache.
max-count
(type : entier)Taille du cache.
max-time
(type : entier)Durée du cache.
Les champs de fail2ban-jail-action-configuration
disponibles sont :
name
(type : string)Nom de l’action.
arguments
(par défaut : '()
) (type : liste-d’arguments)Arguments de l’action.
Les champs de fail2ban-jail-configuration
disponibles sont :
name
(type : string)Nom requis de cette configuration de prison.
enabled?
(par défaut : #t
) (type : booléen)Spécifie si cette prison est activée.
backend
(type : peut-être-symbole)Le moteur à utiliser pour détecter les changements dans log-path
. La
valeur par défaut est ’auto. Pour consulter les valeurs par défaut de la
configuration de prison, consultez le fichier /etc/fail2ban/jail.conf
du paquet fail2ban
.
max-retry
(type : peut-être-entier)Le nombre d’échecs avant qu’un hôte ne soit banni (p. ex. (max-retry
5)
).
max-matches
(type : peut-être-entier)Le nombre de correspondances stockées dans le ticket (accessible avec
l’étiquette <matches>
) dans l’action.
find-time
(type : peut-être-chaine)La fenêtre pendant laquelle le compte de tentative maximale doit être
atteint pour qu’une adresse IP soit bannie. Un hôte est banni s’il a généré
max-retry
pendant les dernières find-time
secondes (p. ex.
»find-time "10m")
). Elle peut être fournie en seconde ou avec le «
format temporel abrégé » de Fail2ban, décrit dans man 5 jail.conf
.
ban-time
(type : peut-être-chaine)La durée, en secondes ou au format temporel abrégé, qu’un bannissement doit
durer (p. ex. (ban-time "10m")
).
ban-time-increment?
(type : peut-être-booléen)Indique s’il faut considérer les bannissements passés pour calculer un incrément du temps de bannissement par défaut d’une adresse IP particulière.
ban-time-factor
(type : peut-être-chaine)Le coefficient à utiliser pour calculer un temps de bannissement exponentiel.
ban-time-formula
(type : peut-être-chaine)C’est la formule utilisée pour calculer la prochaine valeur d’une durée de bannissement.
ban-time-multipliers
(type : peut-être-chaine)Utilisé pour calculer la prochaine valeur de la durée du bannissement au lieu de la formule.
ban-time-max-time
(type : peut-être-chaine)Le nombre maximum de secondes qu’un bannissement peut durer.
ban-time-rnd-time
(type : peut-être-chaine)Le nombre maximum de secondes maximum qu’un bannissement à durée aléatoire peut durer. C’est utile pour arrêter les robots « intelligents » qui calculent le moment exacte où une adresse IP peut être dé-bannie.
ban-time-overall-jails?
(type : peut-être-booléen)Lorsque la valeur est vraie, elle spécifie que la recherche d’une adresse IP dans la base de donnée doit se faire dans toutes les prisons. Sinon, seule la prison actuelle pour l’adresse IP bannie est prise en compte.
ignore-self?
(type : peut-être-booléen)Ne jamais bannir l’adresse IP de la machine locale.
ignore-ip
(par défaut : '()
) (type : liste-de-chaines)Une liste d’adresse IP, de masques CIDR ou d’hôtes DNS à
ignorer. fail2ban
ne bannira par un hôte qui correspond à une adresse
de cette liste.
ignore-cache
(type : peut-être-fail2ban-ignore-cache-configuration)fournit des paramètres de cache pour ignorer les vérifications d’échecs.
filter
(type : peut-fail2ban-jail-filter-configuration)Le filtre à utiliser par la prison, spécifiée par un objet
<fail2ban-jail-filter-configuration>
. Par défaut, les prisons ont un
nom qui correspond au nom de leur filtre.
log-time-zone
(type : peut-être-chaine)Le fuseau horaire par défaut pour les lignes de journaux qui n’en indiquent pas.
log-encoding
(type : peut-être-symbole)L’encodage des journaux traités par la prison. Les valeurs possibles sont :
'ascii
, 'utf-8
et 'auto
.
log-path
(par défaut : '()
) (type : liste-de-chaines)Le nom de fichier des journaux à surveiller.
action
(par défaut : '()
) (type : liste-de-fail2ban-jail-action)Une liste de <fail2ban-jail-action-configuration>
.
extra-content
(par défaut : '()
) (type : text-config)Contenu supplémentaire pour la configuration de la prison, à fournir sous la forme d’une liste de simili-fichiers.
Les champs de fail2ban-jail-filter-configuration
disponibles sont :
name
(type : string)Filtre à utiliser.
mode
(type : peut-être-chaine)Mode de filtrage.
The (gnu services backup)
module offers services for backing up file
system trees. For now, it provides the restic-backup-service-type
.
With restic-backup-service-type
, you can periodically back up
directories and files with Restic, which
supports end-to-end encryption and deduplication. Consider the following
configuration:
(use-service-modules backup …) ;for 'restic-backup-service-type' (use-package-modules sync …) ;for 'rclone' (operating-system ;; … (packages (append (list rclone) ;for use by restic %base-packages)) (services (list (service restic-backup-service-type (restic-backup-configuration (jobs (list (restic-backup-job (name "remote-ftp") (repository "rclone:remote-ftp:backup/restic") (password-file "/root/.restic") ;; Every day at 23. (schedule "0 23 * * *") (files '("/root/.restic" "/root/.config/rclone" "/etc/ssh/ssh_host_rsa_key" "/etc/ssh/ssh_host_rsa_key.pub" "/etc/guix/signing-key.pub" "/etc/guix/signing-key.sec"))))))))))
Each restic-backup-job
translates to an mcron job which sets the
RESTIC_PASSWORD
environment variable by reading the first line of
password-file
and runs restic backup
, creating backups
using rclone of all the files listed in the files
field.
The restic-backup-service-type
installs as well restic-guix
to
the system profile, a restic
utility wrapper that allows for easier
interaction with the Guix configured backup jobs. For example the following
could be used to instantaneusly trigger a backup for the above shown
configuration, without waiting for the scheduled job:
restic-guix backup remote-ftp
Available restic-backup-configuration
fields are:
jobs
(default: '()
) (type: list-of-restic-backup-jobs)The list of backup jobs for the current system.
Available restic-backup-job
fields are:
restic
(default: restic
) (type: package)The restic package to be used for the current job.
user
(default: "root"
) (type: string)The user used for running the current job.
repository
(type: string)The restic repository target of this job.
name
(type : string)A string denoting a name for this job.
password-file
(type: string)Name of the password file, readable by the configured user
, that will
be used to set the RESTIC_PASSWORD
environment variable for the
current job.
schedule
(type: gexp-or-string)A string or a gexp that will be passed as time specification in the mcron job specification (voir mcron job specifications dans GNU mcron).
files
(default: '()
) (type: list-of-lowerables)The list of files or directories to be backed up. It must be a list of values that can be lowered to strings.
verbose?
(default: #f
) (type: boolean)Whether to enable verbose output for the current backup job.
extra-flags
(default: '()
) (type: list-of-lowerables)A list of values that are lowered to strings. These will be passed as
command-line arguments to the current job restic backup
invokation.
The (gnu services upnp)
module offers services related to
UPnP (Universal Plug and Play) and DLNA (Digital Living
Network Alliance), networking protocols that can be used for media streaming
and device interoperability within a local network. For now, this module
provides the readymedia-service-type
.
ReadyMedia (formerly
known as MiniDLNA) is a DLNA/UPnP-AV media server. The project’s daemon,
minidlnad
, can serve media files (audio, pictures, and video) to
DLNA/UPnP-AV clients available on the network.
readymedia-service-type
is a Guix service that wraps around
ReadyMedia’s minidlnad
.
Consider the following configuration:
(use-service-modules upnp …) (operating-system … (services (list (service readymedia-service-type (readymedia-configuration (media-directories (list (readymedia-media-directory (path "/media/audio") (types '(A))) (readymedia-media-directory (path "/media/video") (types '(V))) (readymedia-media-directory (path "/media/misc")))) (extra-config '(("notify_interval" . "60"))))) …)))
This sets up the ReadyMedia daemon to serve files from the media folders
specified in media-directories
. The media-directories
field
is mandatory. All other fields (such as network ports and the server name)
come with a predefined default and can be omitted.
Available readymedia-configuration
fields are:
readymedia
(default: readymedia
) (type: package)The ReadyMedia package to be used for the service.
friendly-name
(default: #f
) (type: maybe-string)A custom name that will be displayed on connected clients.
media-directories
(type: list)The list of media folders to serve content from. Each item is a
readymedia-media-directory
.
cache-directory
(default: "/var/cache/readymedia"
) (type: string)A folder for ReadyMedia’s cache files. If not existing already, the folder will be created as part of the service activation and the ReadyMedia user will be assigned ownership.
log-directory
(default: "/var/log/readymedia"
) (type: string)A folder for ReadyMedia’s log files. If not existing already, the folder will be created as part of the service activation and the ReadyMedia user will be assigned ownership.
port
(default: #f
) (type: maybe-integer)A custom port that the service will be listening on.
extra-config
(default: '()
) (type: alist)An association list of further options, as accepted by ReadyMedia.
A media-directories
entry includes a folder path
and,
optionally, the types
of media files included within the folder.
path
(type: string)The media folder location.
types
(default: '()
) (type: list)A list indicating the types of file included in the media folder. Valid
values are combinations of individual media types, i.e. symbol A
for
audio, P
for pictures, V
for video. An empty list means that
no type is specified.
Suivant: Certificats X.509, Précédent: Services, Monter: Configuration du système [Table des matières][Index]
Certains programmes doivent être lancés avec des privilèges élevés même
lorsqu’ils sont lancés par un utilisateur non privilégié. Un exemple
notoire est le programme passwd
, que les utilisateurs peuvent
appeler pour modifier leur mot de passe et qui doit accéder à
/etc/passwd et /etc/shadow — ce qui est normalement réservé à
root, pour des raisons de sécurité évidentes. Pour contourner cela,
passwd
devrait être setuid-root, ce qui signifie qu’il sera
toujours lancé avec les privilèges root (voir How Change Persona dans The GNU C Library Reference Manual, pour plus d’informations sur le
mécanisme setuid).
The store itself cannot contain privileged programs: that would be a security issue since any user on the system can write derivations that populate the store (voir Le dépôt). Thus, a different mechanism is used: instead of directly granting permissions to files that are in the store, we let the system administrator declare which programs should be entrusted with these additional privileges.
Le champ privileged-programs
d’une déclaration
operating-system
contient une liste de <privileged-program>
qui dénotent les noms des programmes qui auront le bit setuid ou setgid
(voir Utiliser le système de configuration). Par exemple, le programme
mount.nfs
, qui fait partie du paquet nfs-utils, avec le bit setuid
root, peut être désigné comme ceci :
(privileged-program
(program (file-append nfs-utils "/sbin/mount.nfs"))
(setuid? #t))
Ensuite, pour rendre mount.nfs
setuid sur votre système, ajoutez
l’exemple précédent à votre déclaration de système d’exploitation en
l’ajoutant aux %default-privileged-programs
de cette façon :
(operating-system
;; Certains champs omis...
(privileged-programs
(append (list (privileged-program
(program (file-append nfs-utils "/sbin/mount.nfs"))
(setuid? #t))
%default-privileged-programs)))
This data type represents a program with special privileges, such as setuid
program
A file-like object to which all given privileges should apply.
setuid?
(par défaut : #f
)Indique s’il faut activer le bit setuid.
setgid?
(par défaut : #f
)Indique s’il faut active le bit setgid.
user
(par défaut : 0
)L’UID (entier) ou le nom d’utilisateur (chaîne) du propriétaire du programme, root par défaut.
group
(par défaut : 0
)Le GID (entier) ou le nom du groupe (chaîne) pour le groupe propriétaire du programme, root par défaut.
capabilities
(default: #f
)A string representing the program’s POSIX capabilities, as described by the
cap_to_text(3)
man page from the libcap package, or #f
to make
no changes.
A default set of privileged programs is defined by the
%default-privileged-programs
variable of the (gnu system)
module.
A list of <privileged-program>
denoting common programs with elevated
privileges.
La liste inclus des commandes comme passwd
, ping
,
su
et sudo
.
Under the hood, the actual privileged programs are created in the /run/privileged/bin directory at system activation time. The files in this directory refer to the “real” binaries, which are in the store.
Suivant: Name Service Switch, Précédent: Privileged Programs, Monter: Configuration du système [Table des matières][Index]
Les serveurs web disponibles par HTTPS (c’est-à-dire HTTP sur le mécanisme de la couche de transport sécurisée, TLS) envoient aux clients un certificat X.509 que les clients peuvent utiliser pour authentifier le serveur. Pour cela, les clients vérifient que le certificat du serveur est signé par une autorité de certification (AC ou CA). Mais pour vérifier la signature de la CA, les clients doivent d’abord avoir récupéré le certificat de la CA.
Les navigateurs web comme GNU IceCat incluent leur propre liste de certificats, pour qu’ils puissent vérifier les signatures des CA directement.
Cependant, la plupart des autres programmes qui peuvent parler HTTPS —
wget
, git
, w3m
, etc — doivent savoir où
trouver les certificats des CA.
For users of Guix System, this is done by adding a package that provides
certificates to the packages
field of the operating-system
declaration (voir Référence de operating-system
). Guix includes one such
package, nss-certs
, which is a set of CA certificates provided as
part of Mozilla’s Network Security Services.
This package is part of %base-packages
, so there is no need to
explicitly add it. The /etc/ssl/certs directory, which is where most
applications and libraries look for certificates by default, points to the
certificates installed globally.
Les utilisateurs non privilégiés, dont les utilisateurs de Guix sur une
distro externe, peuvent aussi installer leur propre paquet de certificats
dans leur profil. Un certain nombre de variables d’environnement doivent
être définies pour que les applications et les bibliothèques puissent les
trouver. En particulier, la bibliothèque OpenSSL prend en compte les
variables SSL_CERT_DIR
et SSL_CERT_FILE
. Certaines applications
ajoutent leurs propres variables, par exemple le système de contrôle de
version Git prend en compte le lot de certificats pointé par la variable
d’environnement GIT_SSL_CAINFO
. Ainsi, vous lanceriez quelque chose
comme ceci :
guix install nss-certs export SSL_CERT_DIR="$HOME/.guix-profile/etc/ssl/certs" export SSL_CERT_FILE="$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt" export GIT_SSL_CAINFO="$SSL_CERT_FILE"
Un autre exemple serait R, qui a besoin que la variable d’environnement
CURL_CA_BUNDLE
pointe sur le lot de certificats, donc vous lanceriez
quelque chose comme ceci :
guix install nss-certs export CURL_CA_BUNDLE="$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt"
Pour d’autres applications vous pourriez avoir besoin de chercher la variable d’environnement requise dans leur documentation.
Suivant: Disque de RAM initial, Précédent: Certificats X.509, Monter: Configuration du système [Table des matières][Index]
Le module (gnu system nss)
fournit des liaisons pour le fichier de
configuration du name service switch ou NSS de la libc
(voir NSS Configuration File dans The GNU C Library Reference
Manual). En résumé, NSS est un mécanisme qui permet à la libc d’être
étendue avec de nouvelles méthodes de résolution de « noms » dans les bases
de données du système, comme les noms d’hôtes, les noms des services, les
comptes utilisateurs et bien plus (voir System
Databases and Name Service Switch dans The GNU C Library Reference
Manual).
La configuration de NSS spécifie, pour chaque base de données du système,
quelle méthode de résolution utiliser, et comment les diverses méthodes sont
enchaînées — par exemple, sous certaines circonstances, NSS devrait essayer
la méthode suivante de la liste. La configuration de NSS est donnée dans le
champ name-service-switch
de la déclaration operating-system
(voir name-service-switch
).
Par exemple, la déclaration ci-dessous configure NSS pour utiliser le
moteur
nss-mdns
, qui supporte la résolution de nom d’hôte sur le DNS
multicast (mDNS) pour les noms d’hôtes terminant par .local
:
(name-service-switch
(hosts (list %files ; d'abord, vérifier /etc/hosts
;; Si ce qui précède n'a pas fonctionné, essayer
;; avec « mdns_minimal ».
(name-service
(name "mdns_minimal")
;; « mdns_minimal » fait autorité pour
;; « .local ». Lorsqu'il renvoie « pas trouvé »,
;; inutile d'essayer la méthode suivante.
(reaction (lookup-specification
(not-found => return))))
;; Puis revenir sur DNS.
(name-service
(name "dns"))
;; Enfin, essayer avec « mdns complet ».
(name-service
(name "mdns")))))
Ne vous inquiétez pas : la variable %mdns-host-lookup-nss
(voir plus
bas) contient cette configuration, donc vous n’avez pas besoin de tout taper
si vous voulez simplement que la résolution de nom en .local
fonctionne.
Remarquez que dans ce cas, en plus de mettre en place le
name-service-switch
de la déclaration operating-system
, vous
devez aussi utiliser avahi-service-type
(voir avahi-service
), ou %desktop-services
qui l’inclut
(voir Services de bureaux). Cela rend nss-mdns
accessible au démon
de cache du service de nom (voir nscd-service
).
Pour votre confort, les variables suivantes contiennent des configurations NSS typiques.
C’est la configuration NSS par défaut, un objet name-service-switch
.
C’est la configuration NSS avec le support de la résolution de noms sur DNS
multicast (mDNS) pour les noms d’hôtes en .local
.
La référence pour la configuration de NSS est donnée ci-dessous. C’est une
correspondance directe avec le format de fichier de la bibliothèque C, donc
référez-vous au manuel de la bibliothèque C pour plus d’informations
(voir NSS Configuration File dans The GNU C Library Reference
Manual). Comparé au format de fichier de configuration de NSS, cette
configuration a l’avantage non seulement d’ajouter ces bonnes vieilles
parenthèses, mais aussi des vérifications statiques ; vous saurez s’il y a
des erreurs de syntaxe et des coquilles dès que vous lancerez guix
system
.
C’est le type de données représentant la configuration de NSS. Chaque champ ci-dessous représente l’un des système de bases de données supportés.
aliases
ethers
group
gshadow
hosts
initgroups
netgroup
networks
password
public-key
rpc
services
shadow
Les bases de données du système gérées par NSS. Chaque champ doit être une
liste d’objets <name-service>
(voir plus bas).
C’est le type de données représentant un service de noms et l’action de résolution associée.
name
Une chaîne dénotant le service de nom (voir Services in the NSS configuration dans The GNU C Library Reference Manual).
Remarquez que les services de dnoms listés ici doivent être visibles à
nscd. Cela se fait en passant la liste des paquets fournissant les services
de noms à l’argument #:name-services
de nscd-service
(voir nscd-service
).
reaction
Une action spécifiée par la macro lookup-specification
(voir Actions in the NSS configuration dans The GNU C Library
Reference Manual). Par exemple :
Suivant: Configuration du chargeur d’amorçage, Précédent: Name Service Switch, Monter: Configuration du système [Table des matières][Index]
Pour le démarrage, on passe au noyau Linux-Libre un disque de RAM initial ou initrd. Un initrd contient un système de fichier racine temporaire ainsi qu’un script d’initialisation. Ce dernier est responsable du montage du vrai système de fichier racine et du chargement des modules du noyau qui peuvent être nécessaires à cette tâche.
Le champ initrd-modules
d’une déclaration operating-system
vous permet de spécifier les modules du noyau Linux-Libre qui doivent être
disponibles dans l’initrd. En particulier, c’est là où vous devez lister
les modules requis pour effectivement piloter le disque dur où se trouve la
partition racine — bien que la valeur par défaut de initrd-modules
couvre la plupart des cas. Par exemple, en supposant que vous ayez besoin
du module megaraid_sas
en plus des modules par défaut pour accéder à
votre système de fichiers racine, vous écririez :
(operating-system
;; …
(initrd-modules (cons "megaraid_sas" %base-initrd-modules)))
C’est la liste des modules du noyau inclus dans l’initrd par défaut.
En plus, si vous avez besoin de paramétrages plus bas niveau, le champ
initrd
d’une déclaration operating-system
vous permet de
spécifier quel initrd vous voudriez utiliser. Le module (gnu system
linux-initrd)
fournit trois manières de construire un initrd : la procédure
base-initrd
de haut niveau et les procédures raw-initrd
et
expression->initrd
de bas niveau.
La procédure base-initrd
est conçue pour couvrir la plupart des
usages courants. Par exemple, si vous voulez ajouter des modules du noyau à
charger au démarrage, vous pouvez définir le champ initrd
de votre
déclaration de système d’exploitation ainsi :
(initrd (lambda (file-systems . rest)
;; Crée un initrd standard mais paramètre le réseau
;; avec les paramètres que QEMU attend par défaut.
(apply base-initrd file-systems
#:qemu-networking? #t
rest)))
La procédure base-initrd
gère aussi les cas d’utilisation courants
qui concernent l’utilisation du système comme client QEMU, ou comme un
système « live » avec un système de fichier racine volatile.
La procédure base-initrd
est construite à partir de la procédure
raw-initrd
. Contrairement à base-initrd
, raw-initrd
ne
fait rien à haut-niveau, comme essayer de deviner les modules du noyau et
les paquets qui devraient être inclus dans l’initrd. Un exemple
d’utilisation de raw-initrd
serait si un utilisateur a une
configuration personnalisée du noyau Linux et que les modules du noyau
inclus par défaut par base-initrd
ne sont pas disponibles.
Le disque de RAM initial produit par base-initrd
ou raw-initrd
prend en compte plusieurs options passées par la ligne de commande du noyau
Linux (c’est-à-dire les arguments passés via la commande linux
de
GRUB ou l’option -append
de QEMU), notamment :
gnu.load=boot
Dit au disque de RAM initial de charger boot, un fichier contenant un programme Scheme, une fois qu’il a monté le système de fichier racine.
Guix utilise cette option pour donner le contrôle à un programme de démarrage qui lance les programmes d’activation de services puis démarre le GNU Shepherd, le système d’initialisation.
root=root
Monte root comme système de fichier racine. root peut être un
nom de périphérique comme /dev/sda1
, une étiquette de système de
fichiers ou un UUID de système de fichiers. Lorsque ce n’est pas spécifié,
le nom de périphérique du système de fichier racine de la déclaration de
système d’exploitation est utilisé.
rootfstype=type
Indique le type du système de fichiers racine. Il remplace le champ
type
du système de fichiers racine spécifié dans la déclaration
operating-system
, s’il existe.
rootflags=options
Indique les options de montage du système de fichiers racine. Elles
remplacent le champ options
du système de fichiers racine spécifié
dans la déclaration operating-system
s’il existe.
fsck.mode=mode
Contrôle s’il faut vérifier ou pas le système de fichier root avant de
le monter. mode peut valoir skip
(ne jamais vérifier),
force
(toujours vérifier), ou auto
pour respecter le réglage
check?
de l’objet <file-system>
pour la racine (voir Systèmes de fichiers) et n’exécuter une analyse complète que si le système de fichier
n’a pas été éteint proprement.
auto
est la valeur par défaut si cette option n’est pas renseignée ou
si mode n’a pas l’une des valeurs ci-dessus.
fsck.repair=niveau
Le niveau de réparation à effectuer automatiquement si des erreurs sont
détectées dans le système de fichier root. level prend les
valeurs no
(ne pas écrire du tout sur root si possible),
yes
(réparer autant que possible), ou preen
pour réparer les
problèmes considérés réparables automatiquement sans risque.
preen
est la valeur par défaut si cette option n’est pas renseignée
ou si level n’est pas l’une des valeurs ci-dessus.
gnu.system=système
S’assure que /run/booted-system et /run/current-system pointent vers system.
modprobe.blacklist=modules…
¶Dit au disque de RAM initial ainsi qu’à la commande modprobe
(du
paquet kmod) de refuser de charger modules. modules doit être
une liste de noms de modules séparés par des virgules — p. ex.
usbkbd,9pnet
.
gnu.repl
Démarre une boucle lecture-évaluation-affichage (REPL) depuis le disque de RAM initial avant qu’il n’essaye de charger les modules du noyau et de monter le système de fichiers racine. Notre équipe commerciale appelle cela boot-to-Guile. Le Schemeur en vous va adorer. Voir Using Guile Interactively dans GNU Guile Reference Manual, pour plus d’information sur le REPL de Guile.
Maintenant que vous connaissez toutes les fonctionnalités des disques de RAM
initiaux produits par base-initrd
et raw-initrd
, voici comment
l’utiliser le personnalisé plus avant.
Renvoie une dérivation qui construit un initrd. file-systems est une
liste de systèmes de fichiers à monter par l’initrd, éventuellement en plus
du système de fichier racine spécifié sur la ligne de commande du noyau via
root. linux-modules est une liste de modules du noyau à
charger au démarrage. mapped-devices est une liste de correspondances
de périphériques à réaliser avant que les file-systems ne soient
montés (voir Périphériques mappés). helper-packages est une liste de
paquets à copier dans l’initrd. Elle peut inclure e2fsck/static
ou
d’autres paquets requis par l’initrd pour vérifier le système de fichiers
racine.
Lorsque la valeur est vraie, keyboard-layout est un enregistrement
<keyboard-layout>
dénotant la disposition du clavier désirée pour la
console. Cela est effectuée avant que les mapped-devices ne soient
créés et avant que les file-systems ne soient montés, de sorte que, si
l’utilisateur au besoin de saisir une phrase de passe ou d’utiliser le REPL,
cela arrive avec la disposition du clavier voulue.
Lorsque qemu-networking? est vrai, paramètre le réseau avec les paramètres QEMU standards. Lorsque virtio? est vrai, charge des modules supplémentaires pour que l’initrd puisse être utilisé comme client QEMU avec les pilotes I/O para-virtualisés.
Lorsque volatile-root? est vrai, le système de fichier racine est inscriptible mais tous les changements seront perdus.
Renvoie un objet simili-fichier contenant un initrd générique, avec les modules du noyau de linux. file-systems est une liste de systèmes de fichiers à monter par l’initrd, éventuellement en plus du système de fichiers racine spécifié sur la ligne de commande du noyau via root. mapped-devices est une liste de correspondances de périphériques à réaliser avant de monter les file-systems.
Lorsque la valeur est vraie, keyboard-layout est un enregistrement
<keyboard-layout>
dénotant la disposition du clavier désirée pour la
console. Cela est effectuée avant que les mapped-devices ne soient
créés et avant que les file-systems ne soient montés, de sorte que, si
l’utilisateur au besoin de saisir une phrase de passe ou d’utiliser le REPL,
cela arrive avec la disposition du clavier voulue.
qemu-networking? et volatile-root? se comportent comme pour
raw-initrd
.
L’initrd est automatiquement remplie avec tous les modules du noyau requis pour file-systems et pour les options données. On peut lister des modules supplémentaires dans linux-modules. Ils seront ajoutés à l’initrd et chargés au démarrage dans l’ordre dans lequel ils apparaissent.
Inutile de le dire, les initrds que nous produisons et utilisons incluent
une version de Guile liée statiquement, et le programme d’initialisation est
un programme Guile. Cela donne beaucoup de flexibilité. La procédure
expression->initrd
construit un tel initrd, étant donné le programme
à lancer dans cet initrd.
Renvoie un objet simili-fichier contenant un initrd Linux (une archive cpio compressée avec gzip) contenant guile et qui évalue exp, une G-expression, au démarrage. Toutes les dérivations référencées par exp sont automatiquement copiées dans l’initrd.
Suivant: Invoquer guix system
, Précédent: Disque de RAM initial, Monter: Configuration du système [Table des matières][Index]
Le système d’exploitation supporte plusieurs chargeurs d’amorçage. La
configuration du chargeur d’amorçage se fait avec la déclaration
bootloader-configuration
. Tous les champs de cette structure sont
indépendants du chargeur d’amorçage sauf un, bootloader
qui indique
le chargeur d’amorçage à configurer et à installer.
Certains chargeurs d’amorçage ne prennent pas en compte tous les champs de
bootloader-configuration
. Par exemple, le chargeur d’amorçage
extlinux ne supporte pas les thèmes et ignore donc le champ theme
.
Le type d’une déclaration de configuration de chargeur d’amorçage.
bootloader
¶Le chargeur d’amorçage à utiliser, en tant qu’objet bootloader
. Pour
l’instant grub-bootloader
, grub-efi-bootloader
,
grub-efi-removable-bootloader
, gru-efi-netboot-bootloader
,
grub-efi-netboot-removable-bootloader
, extlinux-bootloader
et
u-boot-bootloader
sont pris en charge.
Les chargeurs d’amorçage disponibles sont décrits dans les modules
(gnu bootloader …)
. En particulier, (gnu bootloader
u-boot)
contient des définitions de chargeurs d’amorçage pour une large
gamme de systèmes ARM et AArch, à l’aide du
chargeur d’amorçage U-Boot.
grub-bootloader
vous permet de démarrer en particulier sur des
machines Intel en mode BIOS « legacy ».
grub-efi-bootloader
permet de démarrer sur un système moderne qui
utilise l’UEFI (Unified Extensible Firmware Interface). C’est ce que
vous devriez utiliser si l’image d’installation contient un répertoire
/sys/firmware/efi lorsque vous démarrez dessus sur votre machine.
grub-efi-removable-bootloader
vous permet de démarrer votre système à
partir d’un média amovible en écrivant le fichier GRUB à l’emplacement
spécifié par UEFI /EFI/BOOT/BOOTX64.efi du répertoire de démarrage,
typiquement /boot/efi. C’est aussi utile pour certains micrologiciels
UEFI qui « oublient » la configuration de leur stockage non-volatile. Comme
pour grub-efi-bootloader
, cela peut aussi être utilisé si le
répertoire /sys/firmware/efi est disponible.
Remarque : Cela remplacera le fichier GRUB des autres systèmes d’exploitation qui placent aussi un fichier GRUB dans l’emplacement spécifié par UEFI. Cela les rends impossible à démarrer.
grub-efi-netboot-bootloader
vous permet de démarrer votre système via
le réseau avec TFTP. En plus d’un système de fichier racine NFS, cela vous
permet de démarrer un système Guix sans disque.
L’installation de ggrub-efi-netboot-bootloader
génère le contenu du
répertoire racine TFTP sur targets
(voir targets
) sous le répertoire efi/Guix, qui sera servi par un
serveur TFTP. Vous pouvez maintenant monter les répertoires du serveur TFTP
directement sur targets
pour déplacer les fichiers requis vers le
serveur TFTP automatiquement pendant l’installation.
Si vous voulez aussi utiliser un système de fichier racine NFS (en fait si
vous montez le dépôt depuis un partage NFS), alors le serveur TFTP doit
aussi servir le fichier /boot/grub/grub.cfg et d’autres fichiers à
partir du dépôt (comme l’image de fond de GRUB, le noyau
(voir kernel
) et l’initrd
(voir initrd
)). Tous ces fichiers du
dépôt seront accessibles pour GRUB à travers TFTP avec leurs chemins
normaux, par exemple
tftp://tftp-server/gnu/store/…-initrd/initrd.cpio.gz.
Deux liens symboliques sont créés pour rendre cela possible. Pour chaque
cible du champ targets
, le premier lien est
‘target’/efi/Guix/boot/grub/grub.cfg pointant vers
../../../boot/grub/grub.cfg, où ‘target’ peut être
/boot. Dans ce cas le lien ne quitte pas le répertoire racine du
serveur TFTP. Le second lien est ‘target’/gnu/store qui pointe
vers ../gnu/store. Ce lien est en dehors du répertoire racine du
serveur TFTP.
L’hypothèse derrière tout ceci est que vous avez un serveur NFS qui exporte
le système de fichiers racine de votre système Guix, et en plus, un serveur
TFTP qui exporte vos répertoires targets
— habituellement
/boot uniquement — à partir du même système de fichiers racine que
votre système Guix. Dans ce cas les liens symboliques vont fonctionner.
Pour d’autres cas vous devrez programmer votre propre installateur de
chargeur d’amorçage qui rende les fichiers nécessaires du dépôt disponibles
à travers TFTP, par exemple en les copiant vers la racine du répertoire de
TFTP pour vos targets
.
Il est important de remarquer que les liens symboliques pointant hors du répertoire racine de TFTP peuvent ne pas être permis par dans configuration de votre serveur TFTP. De plus le lien vers le dépôt expose la totalité de celui-ci à travers TFTP. Ces deux points sont à prendre en compte pour les aspects de sécurité. Nous vous conseillons de désactiver tout accès TFTP en écriture !
Remarquez que ce chargeur d’amorçage ne modifiera pas le « gestionnaire de démarrage UEFI » du système.
En dehors de grub-efi-netboot-bootloader
, des serveurs TFTP et NFS
déjà mentionnés, vous pouvez utiliser un serveur DHCP correctement configuré
pour permettre le démarrage réseau. Pour cela nous ne pouvons que vous
recommander de regarder les instructions sur PXE (Preboot eXecution
Environment).
Si une partition système EFI (ESP) ou une partition similaire avec un
système de fichiers FAT est montée dans targets
, alors le liens
symboliques ne peuvent pas être créés. Dans ce cas tout sera préparé pour le
démarrage à partir du stockage local, de la même manière que
grub-efi-bootloader
, à la différence que tous les binaires GRUB sont
copiés dans targets
, ce qui est nécessaire pour démarrer depuis le
réseau.
grub-efi-netboot-removable-bootloader
est identique à
grub-efi-netboot-bootloader
en dehors du fait que le sous-répertoire
efi/boot sera utilisé au lieu de efi/Guix pour se conformer
aux spécifications UEFI pour les média amovibles.
Remarque : Cela remplacera le fichier GRUB des autres systèmes d’exploitation qui placent aussi un fichier GRUB dans l’emplacement spécifié par UEFI. Cela les rends impossible à démarrer.
targets
C’est une liste de chaînes qui dénotent les cibles sur lesquelles installer le chargeur d’amorçage.
L’interprétation des cibles dépend du chargeur d’amorçage en question. Pour
grub-bootloader
par exemple, cela devrait être le nom des
périphériques compris par la commande installer
du chargeur
d’amorçage, comme /dev/sda
ou (hd0)
(voir Invoking
grub-install dans GNU GRUB Manual). Pour grub-efi-bootloader
et
grub-efi-removable-bootloader
, cela devrait être les points de
montage des systèmes de fichiers EFI, typiquement /boot/efi. Pour
grub-efi-netboot-bootloader
, targets
doit contenir les points
de montage correspondant aux répertoires racines de TFTP sur votre serveur
TFTP.
menu-entries
(par défaut : '()
)Une liste éventuellement vide d’objets menu-entry
(voir plus bas),
dénotant les entrées qui doivent apparaître dans le menu du chargeur
d’amorçage, en plus de l’entrée pour le système actuel et l’entrée pointant
vers les générations précédentes.
default-entry
(par défaut : 0
)L’index de l’entrée du menu de démarrage par défaut. L’index 0 correspond au système actuel.
timeout
(par défaut : 5
)Le nombre de secondes à attendre une entrée clavier avant de démarrer. Indiquez 0 pour démarre immédiatement, et -1 pour attendre indéfiniment.
keyboard-layout
(par défaut : #f
)Si c’est #f
, le menu du chargeur d’amorçage (s’il y en a un) utilise
la disposition du clavier par défaut, normalement pour l’anglais américain
(« qwerty »).
Sinon, cela doit être un objet keyboard-layout
(voir Disposition du clavier).
Remarque : Cette option est actuellement ignorée par les chargeurs d’amorçage autre que
grub
etgrub-efi
.
theme
(par défaut : #f)L’objet de thème du chargeur d’amorçage décrivant le thème utilisé. Si aucun thème n’est fournit, certains chargeurs d’amorçage peuvent utiliser un thème par défaut, c’est le cas de GRUB.
terminal-outputs
(par défaut : '(gfxterm)
)Les terminaux de sortie utilisés par le menu de démarrage du chargeur
d’amorçage, en tant que liste de symboles. GRUB accepte les valeurs
console
, serial
, serial_{0-3}
, gfxterm
,
vga_text
, mda_text
, morse
et pkmodem
. Ce champ
correspond à la variable GRUB GRUB_TERMINAL_OUTPUT
(voir Simple
configuration dans GNU GRUB manual).
terminal-inputs
(par défaut : '()
)Les terminaux d’entrée utilisés par le menu de démarrage du chargeur
d’amorçage, en tant que liste de symboles. Pour GRUB, la valeur par défaut
est le terminal natif de la plate-forme déterminé à l’exécution. GRUB
accepte les valeurs console
, serial
, serial_{0-3}
,
at_keyboard
et usb_keyboard
. Ce champ correspond à la
variable GRUB GRUB_TERMINAL_INPUT
(voir Simple configuration dans GNU GRUB manual).
serial-unit
(par défaut : #f
)L’unitié série utilisée par le chargeur d’amorçage, en tant qu’entier entre 0 et 3. Pour GRUB, il est choisi à l’exécution ; actuellement GRUB choisi 0, ce qui correspond à COM1 (voir Serial terminal dans GNU GRUB manual).
serial-speed
(par défaut : #f
)La vitesse de l’interface série, en tant qu’entier. Pour GRUB, la valeur par défaut est choisie à l’exécution ; actuellement GRUB choisi 9600 bps (voir Serial terminal dans GNU GRUB manual).
device-tree-support?
(par défaut : #t
)Indique s’il faut prendre en charge le chargement des fichiers device tree de Linux.
Cette option est activée par défaut. Dans certains cas qui impliquent le
chargeur d’amorçage u-boot
, où l’arborescence de l’appareil est déjà
chargée en RAM, il peut être pratique de désactiver cette option en
indiquant #f
.
extra-initrd
(default: #f
)File name of an additional initrd to load during the boot. It may or may not point to a file in the store, but the main use case is for out-of-store files containing secrets.
In order to be able to provide decryption keys for the LUKS device, they need to be available in the initial ram disk. However they cannot be stored inside the usual initrd, since it is stored in the store and being a world-readable (as files in the store are) is not a desired property for a initrd containing decryption keys. You can therefore use this field to instruct GRUB to also load a manually created initrd not stored in the store.
For any use case not involving secrets, you should use regular initrd
(voir initrd
) instead.
Suitable image can be created for example like this:
echo /key-file.bin | cpio -oH newc >/key-file.cpio chmod 0000 /key-file.cpio
After it is created, you can use it in this manner:
;; Operating system with encrypted boot partition (operating-system ... (bootloader (bootloader-configuration (bootloader grub-efi-bootloader) (targets '("/boot/efi")) ;; Load the initrd with a key file (extra-initrd "/key-file.cpio"))) (mapped-devices (list (mapped-device (source (uuid "12345678-1234-1234-1234-123456789abc")) (target "my-root") (type (luks-device-mapping-with-options ;; And use it to unlock the root device #:key-file "/key-file.bin"))))))
Be careful when using this option, since pointing to a file that is not readable by the grub while booting will cause the boot to fail and require a manual edit of the initrd line in the grub menu.
Currently only supported by GRUB.
Si vous voulez lister des entrées du menu de démarrage supplémentaires via
le champ menu-entries
ci-dessus, vous devrez les créer avec la forme
menu-entry
. Par exemple, imaginons que vous souhaitiez pouvoir
démarrer sur une autre distro (c’est difficile à concevoir !), vous pourriez
alors définir une entrée du menu comme ceci :
(menu-entry
(label "L'autre distro")
(linux "/boot/old/vmlinux-2.6.32")
(linux-arguments '("root=/dev/sda2"))
(initrd "/boot/old/initrd"))
Les détails suivent.
Le type d’une entrée dans le menu du chargeur d’amorçage.
label
L’étiquette à montrer dans le menu — p. ex. "GNU"
.
linux
(par défaut : #f
)L’image du noyau Linux à démarrer, par exemple :
(file-append linux-libre "/bzImage")
Pour GRUB, il est aussi possible de spécifier un périphérique explicitement dans le chemin de fichier avec la convention de nommage de GRUB (voir Naming convention dans GNU GRUB manual), par exemple :
"(hd0,msdos1)/boot/vmlinuz"
Si le périphérique est spécifié explicitement comme au-dessus, le champ
device
est complètement ignoré.
linux-arguments
(par défaut : '()
)La liste des arguments de la ligne de commande du noyau supplémentaires —
p. ex. '("console=ttyS0")
.
initrd
(par défaut : #f
)Une G-expression ou une chaîne dénotant le nom de fichier du disque de RAM initial à utiliser (voir G-Expressions).
device
(par défaut : #f
)Le périphérique où le noyau et l’initrd se trouvent — c.-à-d. pour GRUB, l’option root de cette entrée de menu (voir root dans GNU GRUB manual).
Cela peut être une étiquette de système de fichiers (une chaîne), un UUID de
système de fichiers (un vecteur d’octets, voir Systèmes de fichiers) ou
#f
, auquel cas le chargeur d’amorçage recherchera le périphérique
contenant le fichier spécifié par le champ linux
(voir search dans GNU GRUB manual). Cela ne doit pas être un nom de
périphérique donné par l’OS comme /dev/sda1.
multiboot-kernel
(par défaut : #f
)Le noyau à démarrer en mode Multiboot (voir multiboot dans GNU GRUB manual). Lorsque ce champ est spécifié, une entrée de menu Multiboot est générée. Par exemple :
(file-append mach "/boot/gnumach")
multiboot-arguments
(par défaut : '()
)Liste d’arguments de la ligne de commande supplémentaires pour le multiboot-kernel.
For example, when running in QEMU it can be useful to use a text-based console (use options --nographic --serial mon:stdio):
'("console=com0")
To use the new and still experimental
rumpdisk
user-level disk driver instead of GNU Mach’s in-kernel IDE driver, set
kernel-arguments
to:
'("noide")
Of course, these options can be combined:
'("console=com0" "noide")
multiboot-modules
(par défaut : '()
)Liste de commandes pour charger les modules Multiboot. Par exemple :
(list (list (file-append hurd "/hurd/ext2fs.static") "ext2fs"
…)
(list (file-append libc "/lib/ld.so.1") "exec"
…))
chain-loader
(par défaut : #f
)Une chaine qui peut être acceptée par la directive chainloader
de
grub
. Cela n’a aucun effet si le champ linux
ou
multiboot-kernel
est renseigné. Voici un exemple de chargement chainé
d’un autre système GNU/Linux.
(bootloader
(bootloader-configuration
;; …
(menu-entries
(list
(menu-entry
(label "GNU/Linux")
(device (uuid "1C31-A17C" 'fat))
(chain-loader "/EFI/GNULinux/grubx64.efi"))))))
Pour l’instant seul GRUB prend en charge les thèmes. On crée un thème GRUB
avec la forme grub-theme
, qui n’est pas encore complètement
documentée.
Type de données représentant la configuration du thème GRUB.
gfxmode
(par défaut : '("auto")
)Le gfxmode
de GRUB à utiliser (une liste de chaines de résolution
d’écran, voir gfxmode dans GNU GRUB manual).
Renvoie le thème par défaut de GRUB utilisé par le système d’exploitation si
aucun champ theme
n’est spécifié dans l’enregistrement
bootloader-configuration
.
Il contient une image de fond sympathique avec les logos de GNU et de Guix.
Par exemple, pour changer la résolution par défaut, vous pouvez utiliser quelque chose comme
(bootloader
(bootloader-configuration
;; …
(theme (grub-theme
(inherit (grub-theme))
(gfxmode '("1024x786x32" "auto"))))))
Suivant: Invoquer guix deploy
, Précédent: Configuration du chargeur d’amorçage, Monter: Configuration du système [Table des matières][Index]
guix system
Une fois que vous avez écrit une déclaration de système d’exploitation comme
nous l’avons vu dans les sections précédentes, elle peut être instanciée
avec la commande guix system
. Voici le résumé de la commande :
guix system options… action file
file doit être le nom d’un fichier contenant une déclaration
operating-system
. action spécifie comment le système
d’exploitation est instancié. Actuellement les valeurs suivantes sont
supportées :
search
Affiche les définitions des types de services disponibles qui correspondent aux expressions régulières données, triées par pertinence :
$ guix system search console name: console-fonts location: gnu/services/base.scm:806:2 extends: shepherd-root description: Install the given fonts on the specified ttys (fonts are per + virtual console on GNU/Linux). The value of this service is a list of + tty/font pairs. The font can be the name of a font provided by the `kbd' + package or any valid argument to `setfont', as in this example: + + '(("tty1" . "LatGrkCyr-8x16") + ("tty2" . (file-append + font-tamzen + "/share/kbd/consolefonts/TamzenForPowerline10x20.psf")) + ("tty3" . (file-append + font-terminus + "/share/consolefonts/ter-132n"))) ; for HDPI relevance: 9 name: mingetty location: gnu/services/base.scm:1190:2 extends: shepherd-root description: Provide console login using the `mingetty' program. relevance: 2 name: login location: gnu/services/base.scm:860:2 extends: pam description: Provide a console log-in service as specified by its + configuration value, a `login-configuration' object. relevance: 2 …
Comme pour guix package --search
, le résultat est écrit au format
recutils
, ce qui rend facile le filtrage de la sortie (voir GNU recutils databases dans GNU recutils manual).
edit
Modifier ou visualiser la définition d’un type de service donné.
Par exemple, la commande plus bas ouvre votre éditeur, spécifié par la
variable d’environnement EDITOR
, sur la définition du type de service
openssh
:
guix system edit openssh
reconfigure
Construit le système d’exploitation décrit dans file, l’active et passe dessus41.
Remarque : Il est grandement recommandé de lancer
guix pull
une fois avant de lancerguix system reconfigure
pour la première fois (voir Invoquerguix pull
). Sans cela, vous verriez une version plus ancienne de Guix une foisreconfigure
terminé.
This effects all the configuration specified in file: user accounts,
system services, global package list, privileged programs, etc. The command
starts system services specified in file that are not currently
running; if a service is currently running this command will arrange for it
to be upgraded the next time it is stopped (e.g. by herd stop X
or
herd restart X
).
Cette commande crée une nouvelle génération dont le numéro est un de plus
que la génération actuelle (rapportée par guix system
list-generations
). Si cette génération existe déjà, elle sera réécrite.
Ce comportement correspond à celui de guix package
(voir Invoquer guix package
).
Elle ajoute aussi une entrée de menu du chargeur d’amorçage pour la nouvelle configuration, à moins que --no-bootloader ne soit passé. Pour GRUB, elle déplace les entrées pour les anciennes configurations dans un sous-menu, ce qui vous permet de choisir une ancienne génération au démarrage si vous en avez besoin.
À la fin, le nouveau système d’exploitation est déployé dans /run/current-system. Ce répertoire contient les métadonnées de provenance : la liste des canaux utilisés (voir Canaux) et fichier lui-même, s’il est disponible. Vous pouvez les voir avec :
guix system describe
Cette information est utile si vous voulez plus tard inspecter comment une génération particulière a été construite. En fait, en supposant que file est auto-contenu, vous pouvez reconstruire la génération n de votre système d’exploitation avec :
guix time-machine \ -C /var/guix/profiles/system-n-link/channels.scm -- \ system reconfigure \ /var/guix/profiles/system-n-link/configuration.scm
Vous pouvez considérer cela comme une sorte de contrôle de version intégré !
Votre système n’est pas seulement un artéfact binaire : il contient
ses propres sources. Voir provenance-service-type
, pour plus d’informations sur le suivi de
provenance.
Par défaut, reconfigure
vous empêche de faire revenir en
arrière votre système, ce qui pourrait (ré)introduire des vulnérabilités de
sécurité et cause des problèmes avec les services « avec état » comme les
systèmes de gestion de bases de données. Vous pouvez contrôler ce
comportement en passant --allow-downgrades.
switch-generation
¶Passe à une génération existante du système. Cette action change automatiquement le profil système vers la génération spécifiée. Elle réarrange aussi les entrées existantes du menu du chargeur d’amorçage du système. Elle fait de l’entrée du menu pour la génération spécifiée l’entrée par défaut et déplace les entrées pour les autres générations dans un sous-menu, si cela est pris en charge par le chargeur d’amorçage utilisé. Lors du prochain démarrage du système, la génération du système spécifiée sera utilisée.
Le chargeur d’amorçage lui-même n’est pas réinstallé avec cette commande. Ainsi, le chargeur d’amorçage est utilisé avec un fichier de configuration plus à jour.
La génération cible peut être spécifiée explicitement par son numéro de génération. Par exemple, l’invocation suivante passerait à la génération 7 du système :
guix system switch-generation 7
La génération cible peut aussi être spécifiée relativement à la génération
actuelle avec la forme +N
ou -N
, où +3
signifie « trois
générations après la génération actuelle » et -1
signifie « une
génération précédent la génération actuelle ». Lorsque vous spécifiez un
nombre négatif comme -1
, il doit être précédé de --
pour
éviter qu’il ne soit compris comme une option. Par exemple :
guix system switch-generation -- -1
Actuellement, l’effet de l’invocation de cette action est uniquement
de passer au profil du système vers une autre génération existante et de
réarranger le menu du chargeur d’amorçage. Pour vraiment commencer à
utiliser la génération spécifiée, vous devez redémarrer après avoir lancé
cette action. Dans le futur, elle sera corrigée pour faire la même chose
que reconfigure
, comme réactiver et désactiver les services.
Cette action échouera si la génération spécifiée n’existe pas.
roll-back
¶Passe à la génération précédente du système. Au prochain démarrage, la
génération précédente sera utilisée. C’est le contraire de
reconfigure
, et c’est exactement comme invoquer
switch-generation
avec pour argument -1
.
Actuellement, comme pour switch-generation
, vous devez redémarrer
après avoir lancé cette action pour vraiment démarrer sur la génération
précédente du système.
delete-generations
¶Supprimer des générations du système, ce qui les rend disponibles pour le
ramasse-miettes (voir Invoquer guix gc
, pour des informations sur la
manière de lancer le « ramasse-miettes »).
Cela fonctionne comme pour ‘guix package --delete-generations’
(voir --delete-generations
). Avec aucun
argument, toutes les générations du système sauf la génération actuelle sont
supprimées :
guix system delete-generations
Vous pouvez aussi choisir les générations que vous voulez supprimer. L’exemple plus bas supprime toutes les génération du système plus vieilles que deux mois :
guix system delete-generations 2m
Lancer cette commande réinstalle automatiquement le chargeur d’amorçage avec une liste à jour d’entrées de menu — p. ex. le sous-menu « anciennes générations » dans GRUB ne liste plus les générations qui ont été supprimées.
build
Construit la dérivation du système d’exploitation, ce qui comprend tous les fichiers de configuration et les programmes requis pour démarrer et lancer le système. Cette action n’installe rien.
init
Rempli le répertoire donné avec tous les fichiers nécessaires à lancer le système d’exploitation spécifié dans file. C’est utile pour la première installation de Guix System. Par exemple :
guix system init my-os-config.scm /mnt
copie tous les éléments du dépôt requis par la configuration spécifiée dans my-os-config.scm dans /mnt. Cela comprend les fichiers de configuration, les paquets, etc. Elle crée aussi d’autres fichiers essentiels requis pour que le système fonctionne correctement — p. ex. les répertoires /etc, /var et /run et le fichier /bin/sh.
Cette commande installe aussi le chargeur d’amorçage sur les cibles spécifiées dans my-os-config, à moins que l’option --no-bootloader ne soit passée.
vm
¶Construit une machine virtuelle (VM) qui contient le système d’exploitation déclaré dans file et renvoie un script pour lancer cette VM.
Remarque : Les actions
vm
et les autres plus bas peuvent utiliser la prise en charge KVM du noyau Linux-libre. Plus spécifiquement, si la machine prend en charge la virtualisation matérielle, le module noyau KVM correspondant devrait être chargé, et le nœud de périphérique /dev/kvm devrait exister et être lisible et inscriptible pour l’utilisateur et pour les utilisateurs de construction du démon (voir Réglages de l’environnement de construction).
Les arguments passés au script sont passés à QEMU comme dans l’exemple ci-dessous, qui active le réseau et demande 1 Go de RAM pour la machine émulée :
$ /gnu/store/…-run-vm.sh -m 1024 -smp 2 -nic user,model=virtio-net-pci
Il est possible de combiner les deux étapes en une :
$ $(guix system vm my-config.scm) -m 1024 -smp 2 -nic user,model=virtio-net-pci
La VM partage sont dépôt avec le système hôte.
Par défaut, le système de fichiers racine de la VM sera monté de manière
volatile ; l’option --persistent peut être fournie pour le rendre
persistent à la place. Dans ce cas, le fichier d’image disque VM sera copiée
à partir du dépôt vers le répertoire TMPDIR
pour le rendre
inscriptible.
Vous pouvez partager des fichiers supplémentaires entre l’hôte et la VM avec les options en ligne de commande --share et --expose : la première spécifie un répertoire à partager avec accès en écriture, tandis que le deuxième fournit un accès en lecture-seule au répertoire partagé.
L’exemple ci-dessous crée une VM dans laquelle le répertoire personnel de l’utilisateur est accessible en lecture-seule, et où le répertoire /exchange est une correspondance en lecture-écriture à $HOME/tmp sur l’hôte :
guix system vm my-config.scm \ --expose=$HOME --share=$HOME/tmp=/exchange
Sur GNU/Linux, le comportement par défaut consiste à démarrer directement sur le noyau ; cela a l’avantage de n’avoir besoin que d’une toute petite image disque puisque le dépôt de l’hôte peut ensuite être monté.
L’option --full-boot force une séquence de démarrage complète, en commençant par le chargeur d’amorçage. Cela requiert plus d’espace disque puisqu’une image racine contenant au moins le noyau, l’initrd et les fichiers de données du chargeur d’amorçage doit être créé.
On peut utiliser l’option --image-size pour spécifier la taille de l’image.
The --no-graphic option will instruct guix system
to
spawn a headless VM that will use the invoking tty for IO. Among other
things, this enables copy-pasting, and scrollback. Use the ctrl-a
prefix to issue QEMU commands; e.g. ctrl-a h prints a help,
ctrl-a x quits the VM, and ctrl-a c switches between the QEMU
monitor and the VM.
image
¶The image
command can produce various image types. The image type
can be selected using the --image-type option. It defaults to
mbr-hybrid-raw
. When its value is iso9660
, the
--label option can be used to specify a volume ID with
image
. By default, the root file system of a disk image is mounted
non-volatile; the --volatile option can be provided to make it
volatile instead. When using image
, the bootloader installed on the
generated image is taken from the provided operating-system
definition. The following example demonstrates how to generate an image
that uses the grub-efi-bootloader
bootloader and boot it with QEMU:
image=$(guix system image --image-type=qcow2 \ gnu/system/examples/lightweight-desktop.tmpl) cp $image /tmp/my-image.qcow2 chmod +w /tmp/my-image.qcow2 qemu-system-x86_64 -enable-kvm -hda /tmp/my-image.qcow2 -m 1000 \ -bios $(guix build ovmf-x86-64)/share/firmware/ovmf_x64.bin
When using the mbr-hybrid-raw
image type, a raw disk image is
produced; it can be copied as is to a USB stick, for instance. Assuming
/dev/sdc
is the device corresponding to a USB stick, one can copy the
image to it using the following command:
# dd if=$(guix system image my-os.scm) of=/dev/sdc status=progress
La commande --list-image-types
liste tous les types d’images
disponibles.
Lorsque vous utilisez le type d’image qcow2
, l’image renvoyée est au
format qcow2, que l’émulateur QEMU peut utiliser efficacement.
Voir Exécuter Guix sur une machine virtuelle, pour plus d’information sur la manière de
lancer l’image dans une machine virtuelle. Le chargeur d’amorçage
grub-bootloader
est toujours utilisé quelque soit celui déclaré dans
le fichier operating-system
passé en argument. Cela facilite
l’utilisation de QEMU, qui utilise le BIOS SeaBIOS par défaut, et s’attend à
un chargeur d’amorçage installé dans le Master Boot Record (MBR).
En utilisant le type d’image docker
, on produit une image Docker.
Guix construit l’image de zéro, et non à partir d’une image Docker de base
pré-existante. En conséquence, elle contient exactly ce que vous
avez défini dans le fichier de configuration du système. Vous pouvez
ensuite charger l’image et lancer un conteneur Docker avec des commande
comme :
image_id="$(docker load < guix-system-docker-image.tar.gz)" container_id="$(docker create $image_id)" docker start $container_id
Cette commande démarre un nouveau conteneur Docker à partir de l’image
spécifiée. Il démarrera le système Guix de la manière habituelle, ce qui
signifie qu’il démarrera tous les services que vous avez définis dans la
configuration du système d’exploitation. Vous pouvez obtenir un shell
interactif dans le conteneur en utilisant docker exec
:
docker exec -ti $container_id /run/current-system/profile/bin/bash --login
En fonction de ce que vous lancez dans le conteneur Docker, il peut être
nécessaire de donner des permissions supplémentaires au conteneur. Par
exemple, si vous voulez construire des paquets avec Guix dans le conteneur
Docker, vous devriez passer --privileged à docker create
.
Enfin, l’option --network s’applique à guix system
docker-image
: elle produit une image où le réseau est partagé avec l’hôte,
et donc sans services comme nscd ou NetworkManager.
conteneur
Renvoie un script qui lance le système d’exploitation déclaré dans file dans un conteneur. Les conteneurs sont un ensemble de mécanismes d’isolation légers fournis par le noyau Linux-libre. Les conteneurs sont substantiellement moins gourmands en ressources que les machines virtuelles complètes car le noyau, les objets partagés et d’autres ressources peuvent être partagés avec le système hôte ; cela signifie aussi une isolation moins complète.
Actuellement, le script doit être lancé en root pour pouvoir supporter plus d’un utilisateur et d’un groupe. Le conteneur partage son dépôt avec le système hôte.
Comme avec l’action vm
(voir guix system vm), des systèmes de
fichiers supplémentaires peuvent être partagés entre l’hôte et le conteneur
avec les options --share et --expose :
guix system container my-config.scm \ --expose=$HOME --share=$HOME/tmp=/exchange
Les options --share et --expose peuvent aussi être passées au script généré pour effectuer un montage lié de répertoires supplémentaires dans le conteneur.
Remarque : Cette option requiert Linux-libre ou supérieur.
options peut contenir n’importe quelle option commune de construction (voir Options de construction communes). En plus, options peut contenir l’une de ces options :
Considère le système d’exploitation en lequel s’évalue expr. C’est une alternative à la spécification d’un fichier qui s’évalue en un système d’exploitation. C’est utilisé pour générer l’installateur du système Guix (voir Construire l’image d’installation).
Essaye de construire pour system au lieu du type du système hôte.
Cela fonction comme pour guix build
(voir Invoquer guix build
).
Effectuer une compilation croisée pour triplet qui doit être un
triplet GNU valide, comme ""aarch64-linux-gnu""
(voir GNU configuration triplets dans Autoconf).
Renvoie le nom du fichier de dérivation du système d’exploitation donné sans rien construire.
Comme nous en avons parlé précédemment, guix system init
et
guix system reconfigure
enregistrent toujours les informations de
provenance via un service dédié (voir provenance-service-type
). Cependant, d’autres commande ne le font
pas par défaut. Si vous voulez, disons, créer une image de machine
virtuelle contenant les informations de provenance, vous pouvez lancer :
guix system image -t qcow2 --save-provenance config.scm
De cette façon, l’image qui en résulte va effectivement « intégrer sa propre source » sous la forme de méta-données dans /run/current-system. Avec cette information, on peut reconstruire l’image pour s’assurer qu’elle contient vraiment ce qu’elle prétend contenir ; ou on peut utiliser ça pour dériver une variante de l’image.
Pour l’action image
, crée une image du type donné.
When this option is omitted, guix system
uses the
mbr-hybrid-raw
image type.
--image-type=iso9660 produit une image ISO-9660, qu’il est possible de graver sur un CD ou un DVD.
Pour l’action image
, crée une image de la taille donnée size.
size peut être un nombre d’octets ou contenir un suffixe d’unité
(voir size specifications dans GNU Coreutils).
Lorsque cette option est omise, guix system
calcule une estimation
de la taille de l’image en fonction de la taille du système déclaré dans
file.
Pour l’action container
, permet aux conteneurs d’accéder au réseau de
l’hôte, c’est-à-dire, ne crée pas d’espace de nom réseau.
Fait de fichier un lien symbolique vers le résultat, et l’enregistre en tant que racine du ramasse-miettes.
Passe les vérifications de sécurité avant l’installation.
Par défaut, guix system init
et guix system reconfigure
effectuent des vérifications de sécurité : ils s’assurent que les systèmes
de fichiers qui apparaissent dans la déclaration operating-system
existent vraiment (voir Systèmes de fichiers) et que les modules de noyau Linux
qui peuvent être requis au démarrage sont listés dans initrd-modules
(voir Disque de RAM initial). Passer cette option saute ces vérifications
complètement.
Dit à guix system reconfigure
de permettre le retour en arrière du
système.
Par défaut, reconfigure
vous empêche de faire revenir votre
système en arrière. Il fait cela en comparant les informations de
provenance de votre système (décrites par guix system describe
)
avec celles de la commande guix
(décrites par guix
describe
). Si les commits de guix
ne descendent pas de ceux
utilisés pour votre système, guix system reconfigure
renvoie une
erreur. Passer --allow-downgrades vous permet de passer ces tests.
Remarque : Assurez-vous de comprendre les implications de sa sécurité avant d’utiliser --allow-downgrades.
Applique strategy lorsqu’une erreur arrive lors de la lecture de file. strategy peut être l’une des valeurs suivantes :
nothing-special
Rapporte l’erreur de manière concise et quitte. C’est la stratégie par défaut.
backtrace
Pareil, mais affiche aussi une trace de débogage.
debug
Rapporte l’erreur et entre dans le débogueur Guile. À partir de là, vous
pouvez lancer des commandes comme ,bt
pour obtenir une trace de
débogage, ,locals
pour afficher les valeurs des variables locales et
plus généralement inspecter l’état du programme. Voir Debug Commands dans GNU Guile Reference Manual, pour une liste de commandes de débogage
disponibles.
Une fois que vous avez construit, re-configuré et re-re-configuré votre installation Guix, vous pourriez trouver utile de lister les générations du système disponibles sur le disque — et que vous pouvez choisir dans le menu du chargeur d’amorçage :
describe
Décrit la génération du système lancé : son nom de fichier, son noyau et chargeur d’amorçage utilisé, etc, ainsi que les informations de provenance si elles sont disponibles.
le drapeau --list-intalled
est disponible, avec la même syntaxe que
celui utilisé dans guix package --list-installed
(voir Invoquer guix package
). Lorsque le drapeau est utilisé, la description incluera une
liste des paquets qui sont actuellement installés dans le profil du système,
avec un filtre facultatif sur une expression régulière.
Remarque : La génération du système en cours — référencé par /run/current-system — n’est pas nécessairement la génération actuelle du système — référencée par /var/guix/profiles/system : elles sont différentes si par exemple, vous choisissez dans le menu du chargeur d’amorçage de démarrer une ancienne génération.
Elles peuvent aussi être différentes de la génération du système démarrée — référencée par /run/booted-system — par exemple parce que vous avez reconfiguré le système entre temps.
list-generations
Affiche un résumé de chaque génération du système d’exploitation disponible
sur le disque, dans un format lisible pour un humain. C’est similaire à
l’option --list-generations de guix package
(voir Invoquer guix package
).
Éventuellement, on peut spécifier un motif, avec la même syntaxe utilisée
pour guix package --list-generations
, pour restreindre la liste
des générations affichées. Par exemple, la commande suivante affiche les
générations de moins de 10 jours :
$ guix system list-generations 10d
Le drapeau --list-installed
peut aussi être spécifié, avec la même
syntaxe que celle utilisée dans guix package
--list-installed
. Cela peut être utile si vous essayez de déterminer si un
paquet a été ajouté au système.
La commande guix system
a même plus à proposer ! Les
sous-commandes suivantes vous permettent de visualiser comme vos services
systèmes sont liés les uns aux autres :
extension-graph
Émettre vers la sortie standard le graphe d’extension de service du
système d’exploitation défini dans file (voir Composition de services,
pour plus d’informations sur les extensions de service). Par défaut, le
format de sortie est le format Dot/Graphviz, mais vous pouvez choisir un
autre format avec --graph-backend, comme avec guix graph
(voir --backend) :
La commande :
$ guix system extension-graph file | xdot -
montre les relations d’extension entre les services.
Remarque : Le programme
dot
est fournit par le paquetgraphviz
.
shepherd-graph
Affiche le graphe de dépendance des services shepherd du système d’exploitation défini dans file sur la sortie standard. Voir Services Shepherd, pour plus d’informations et un exemple de graphe.
Encore une fois, le format de sortie par défaut est Dot/Graphviz, mais vous pouvez passer --graph-backend pour en choisir un autre.
Suivant: Exécuter Guix sur une machine virtuelle, Précédent: Invoquer guix system
, Monter: Configuration du système [Table des matières][Index]
guix deploy
Nous avons déjà vu les déclarations de operating-system
utilisées
pour gérer la configuration d’une machine localement. Supposez que vous
ayez besoin de configurer plusieurs machines — peut-être que vous gérez un
service web comprenant plusieurs serveurs. guix deploy
vous
permet d’utiliser les mêmes déclarations de systèmes d’exploitation pour
gérer plusieurs hôtes distants en même temps dans le même « déploiement »
logique.
Remarque : La fonctionnalité décrite dans cette section est toujours en cours de développement et est sujette à changement. Contactez-nous sur guix-devel@gnu.org !
guix deploy fichier
Une telle invocation déploiera les machines en lesquelles le code de fichier s’évalue. Par exemple, fichier peut contenir une définition comme celle-ci :
;; Ceci est le déploiement Guix d'un système « minimal » sans ;; serveur d'affichage X11, vers une machine dont le démon SSH ;; écoute sur localhost:2222. Une configuration comme celle-ci ;; est appropriée pour les machines virtuelles dont les ports sont relayés ;; vers l'interface de bouclage de l'hôte. (use-service-modules networking ssh) (use-package-modules bootloaders) (define %system (operating-system (host-name "gnu-deployed") (timezone "Etc/UTC") (bootloader (bootloader-configuration (bootloader grub-bootloader) (target '("/dev/vda")) (terminal-outputs '(console)))) (file-systems (cons (file-system (mount-point "/") (device "/dev/vda1") (type "ext4")) %base-file-systems)) (services (append (list (service dhcp-client-service-type) (service openssh-service-type (openssh-configuration (permit-root-login #t) (allow-empty-passwords? #t)))) %base-services)))) (list (machine (operating-system %system) (environment managed-host-environment-type) (configuration (machine-ssh-configuration (host-name "localhost") (system "x86_64-linux") (user "alice") (identity "./id_rsa") (port 2222)))))
Le fichier devrait s’évaluer en une liste d’objets machine. Cet
exemple, lors du déploiement, créera une nouvelle génération sur le système
distant en réalisant la déclaration operating-system
%system
.
environment
et configuration
spécifient comme la machine
devrait être provisionnée — c.-à-d. comment les ressources sont créées
et gérées. L’exemple ci-dessus ne crée aucune ressource, car un
'managed-host
est une machine qui fait déjà tourner le système Guix
et est disponible sur le réseau. Cela est un cas particulièrement simple ;
un déploiement plus complexe pourrait impliquer, par exemple, le démarrage
de machines virtuels chez un fournisseur de serveurs privés virtuels (VPS).
Dans ce cas, une type d’environnement différent devrait être utilisé.
Prenez note que vous devez d’abord générer une paire de clés sur la machine
coordinatrice pour permettre au démon d’exporter les archives signées des
fichiers du dépôt (voir Invoquer guix archive
), bien que cette étape soit
automatique sur Guix System :
# guix archive --generate-key
Chaque machine cible doit autoriser la clé de la machine maître afin qu’elle accepte les objets de stockage qu’elle reçoit du coordinateur :
# guix archive --authorize < coordinator-public-key.txt
user
, dans cet exemple, spécifie le nom du compte utilisateur à
utiliser pour se connecter lors du déploiement. Sa valeur par défaut est
root
, mais la connexion SSH en root peut être interdite dans certains
cas. Pour contourner cela, guix deploy
peut se connecter en tant
qu’utilisateur non-privilégié et utiliser sudo
pour récupérer les
privilèges. Cela ne fonctionnera que si sudo
est actuellement
installé sur la machine distante et peut être invoqué de manière non
interactive par user
. C’est-à-dire que la ligne sudoers
permettant à user
d’utiliser sudo
doit contenir l’attribut
NOPASSWD
. Cela peut se faire avec le bout de configuration du
système d’exploitation suivant :
(use-modules ... (gnu system)) ;pour %sudoers-specification (define %user "username") (operating-system ... (sudoers-file (plain-file "sudoers" (string-append (plain-file-content %sudoers-specification) (format #f "~a ALL = NOPASSWD: ALL~%" %user)))))
Pour plus d’informations sur le format du fichier sudoers, consultez
man sudoers
.
Une fois que vous avez déployé un système sur un ensemble de machines, vous
trouverez utile de lancer une commande sur chacune. Les options
--execute ou -x vous le permet. L’exemple ci-dessous lance
uname -a
sur toutes les machines listées dans le fichier de
déploiement :
guix deploy fichier -x -- uname -a
Ce que vous devrez souvent faire après un déploiement est de redémarrer les services spécifiques sur toutes les machines, ce qui peut se faire de cette manière :
guix deploy file -x -- herd restart service
La commande guix deploy -x
renvoie zéro si et seulement si la
commande réussi sur toutes les machines.
Voici les types de données que vous devrez connaitre pour écrire un fichier de déploiement.
C’est le type de données représentant une seule machine dans un déploiement Guix hétérogène.
operating-system
L’objet de la configuration du système d’exploitation à déployer.
environment
Un environment-type
décrit comment la machine est provisionnée.
configuration
(par défaut : #f
)Un objet décrivant la configuration de l’environnement de la machine. Si
l’objet environment
a une configuration par défaut, vous pouvez
utiliser #f
. Si vous utilisez #f
mais que l’environnement n’a
pas de configuration par défaut, une erreur sera renvoyée.
C’est le type de données représentant les paramètres du client SSH pour une
machine qui a pour environment
managed-host-environment-type
.
host-name
build-locally?
(par défaut : #t
)Si la valeur est fausse, les dérivations du système seront construites sur la machine qui est déployée.
system
Le type de système décrivant l’architecture de la machine déployée
pour—par exemple, "x86_64-linux"
.
authorize?
(par défaut : #t
)Si la valeur est vraie, la clé de signature du coordinateur sera ajoutée au porteclé des ACL de la machine distante.
port
(par défaut : 22
)user
(par défaut : "root"
)identity
(par défaut : #f
)Si spécifié, le chemin d’accès à la clé privée SSH à utiliser pour s’authentifier auprès de l’hôte distant.
host-key
(par défaut : #f
)Cela devrait être la clé de l’hôte SSH de la machine, qui ressemble à cela :
ssh-ed25519 AAAAC3Nz… root@example.org
Quand host-key
est #f
, le serveur est authentifié avec le
fichier ~/.ssh/known_hosts, exactement comme le ferait le client
ssh
OpenSSH.
allow-downgrades?
(par défaut : #f
)Autoriser ou non d’éventuels déclassements.
Comme guix sysetm reconfigure
, guix deploy
compare les
commits du canal actuellement déployé sur l’hôte distant (renvoyé par
guix system describe
) à ceux utilisés (renvoyés par guix
describe
) pour déterminer si les commits actuellement utilisés descendent
de ceux déployés. Lorsque ce n’est pas le cas et que
allow-downgrades?
est faux, cela lève une erreur. Cela permet de
s’assurer que vous ne déployez pas accidentellement une version plus
ancienne version les machines distantes.
safety-checks?
(par défaut : #t
)Indique s’il faut lancer des « vérifications de cohérence » avant le
déploiement. Cela comprend la vérification que les périphériques et les
systèmes de fichiers référencés dans la configuration du système
d’exploitation existent vraiment sur la machine cible, et la vérification
que les modules Linux nécessaires à l’accès aux périphériques de stockage au
démarrage se trouvent dans le champ initrd-modules
du système
d’exploitation.
Ces vérification s’assurent que vous ne déployez pas par inadvertance un système qui ne pourra pas démarrer. Soyez prudent avant de les désactiver !
C’est le type de données décrivant le Droplet qui devrait être créé pour une
machine avec un environment
valant
digital-ocean-environment-type
.
ssh-key
Le chemin vers la clé SSH privée à utiliser pour s’authentifier avec l’hôte distant. Dans le futur, le champ pourrait ne plus exister.
tags
Une liste « d’attributs » qui identifient la machine de manière unique. Il faut faire attention à ce que deux machine du déploiement n’aient pas le même ensemble d’attributs.
region
Le nom d’une région de Digital Ocean, comme "nyc3"
.
taille
Le nom d’une taille de Digital Ocean, comme "s-1vcpu-1gb"
enable-ipv6?
Indique s’il faut créer une IPv6 pour le droplet.
Suivant: Définir des services, Précédent: Invoquer guix deploy
, Monter: Configuration du système [Table des matières][Index]
Pour exécuter Guix dans une machine virtuelle (VM), on peut soit utiliser
l’image de VM Guix pré-construite sur
‘https://ftp.gnu.org/gnu/guix/guix-system-vm-image-b2bd56f.x86_64-linux.qcow2
’
. Cette image est une image compressée au format QCOW. Vous devrez la
passer à un émulateur comme QEMU (voir plus bas
pour des détails).
Cette image démarre l’environnement graphique Xfce et contient certains
outils couramment utilisés. Vous pouvez installer plus de logiciels sur
l’image en lançant guix package
dans un terminal (voir Invoquer guix package
). Vous pouvez aussi reconfigurer le système à partir de son
fichier de configuration initiale disponible dans
/run/current-system/configuration.scm (voir Utiliser le système de configuration).
Au lieu d’utiliser cette image pré-construite, on peut construire sa propre
image avec guix system image
(voir Invoquer guix system
).
Si vous construisez votre propre image, vous devez la copier en dehors du
dépôt (voir Le dépôt) et vous donner la permission d’écrire sur la copie
avant de pouvoir l’utiliser. Lorsque vous invoquez QEMU, vous devez choisir
un émulateur système correspondant à votre plate-forme matérielle. Voici
une invocation minimale de QEMU qui démarrera le résultat de guix
system image -t qcow2
sur un matériel x8_64 :
$ qemu-system-x86_64 \ -nic user,model=virtio-net-pci \ -enable-kvm -m 2048 \ -device virtio-blk,drive=myhd \ -drive if=none,file=guix-system-vm-image-b2bd56f.x86_64-linux.qcow2,id=myhd
Voici la signification de ces options :
qemu-system-x86_64
Cela spécifie la plate-forme matérielle à émuler. Elle doit correspondre à l’hôte.
-nic user,model=virtio-net-pci
Active la pile réseau en mode utilisateur non privilégié. Le système invité
peut accéder à l’hôte mais pas l’inverse. C’est la manière la plus simple
de mettre le système en ligne. model
spécifie le périphérique réseau
à émuler : virtio-net-pci
est un périphérique spécial conçu pour les
systèmes d’exploitation virtualisés et recommandés dans la plupart des cas.
En supposant que votre plateforme matérielle est x86_64, vous pouvez
récupérer une liste des modèles d’interfaces réseaux en lançant
qemu-system-x86_64 -nic model=help
.
-enable-kvm
Si votre système a des extensions de virtualisation matérielle, activer le support des machines virtuelles de Linux (KVM) accélérera les choses.
-m 2048
RAM disponible sur l’OS émulé, en mébioctets. La valeur par défaut est 128 Mo, ce qui peut ne pas suffire pour certaines opérations.
-device virtio-blk,drive=myhd
Crée un lecteur virtio-blk
nommé « myhd ». virtio-blk
est un
mécanisme de « paravirtualisation » pour les périphériques blocs qui permet
à QEMU d’avoir de meilleures performances que s’il émulait un disque
complet. Voir la documentation de QEMU et KVM pour plus d’info.
-drive if=none,file=/tmp/qemu-image,id=myhd
Utilise notre image QCOW, le fichier guix-system-vm-image-b2bd56f.x86_64-linux.qcow2, comme stockage pour le lecteur « myhd ».
Le script run-vm.sh
par défaut renvoyé par une invocation de
guix system vm
n’ajoute pas le drapeau -nic user
par
défaut. Pour avoir accès au réseau dans la vm, ajoutez le
(dhcp-client-service)
à votre définition et démarrez la VM avec
$(guix system vm config.scm) -nic user
. Un problème important
avec -nic user
pour le réseau, est que ping
ne
fonctionnera pas, car il utilise le protocole ICMP. Vous devrez utiliser
une autre commande pour vérifier la connectivité réseau, par exemple
guix download
.
Pour activer SSH dans une VM vous devez ajouter un serveur SSH comme
opennssh-service-type
à votre VM (voir openssh-service-type
). En plus vous devez transférer le port 22,
par défaut, à l’hôte. Vous pouvez faire cela avec
$(guix system vm config.scm) -nic user,model=virtio-net-pci,hostfwd=tcp::10022-:22
Pour vous connecter à la VM vous pouvez lancer
ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 10022 localhost
Le -p
donne le port auquel vous voulez vous connecter à
ssh
, -o UserKnownHostsFile=/dev/null
évite que
ssh
ne se plaigne à chaque fois que vous modifiez le fichier
config.scm
et -o StrictHostKeyChecking=no
évite que vous
n’ayez à autoriser une connexion à un hôte inconnu à chaque fois que vous
vous connectez.
Remarque : Si le ‘hostfwd’ d’exemple ci-dessus ne marche pas chez vous (ex : si votre client SSH reste bloqué en attente de connexion vers le port lié de votre VM), assurez-vous que votre VM Guix System prend bien en charge le réseau, en utilisant par exemple le type de service
dhcp-client-service-type
.
virt-viewer
avec SpiceAlternativement au client graphique qemu
par défaut vous pouvez
utiliser remote-viewer
du paquet virt-viewer
. Pour vous
connecter, passez le drapeau -spice port=5930,disable-ticketing
à
qemu
. Voir les sections précédentes pour plus d’informations sur
comment faire cela.
Spice a aussi de chouettes fonctionnalités comme le partage de votre
presse-papier avec la VM. Pour activer cela vous devrez aussi passer les
drapeaux suivants à qemu
:
-device virtio-serial-pci,id=virtio-serial0,max_ports=16,bus=pci.0,addr=0x5 -chardev spicevmc,name=vdagent,id=vdagent -device virtserialport,nr=1,bus=virtio-serial0.0,chardev=vdagent,\ name=com.redhat.spice.0
Vous devrez également ajouter le (spice-vdagent-service)
à la
définition de votre système (voir Spice service).
Précédent: Exécuter Guix sur une machine virtuelle, Monter: Configuration du système [Table des matières][Index]
Les sections précédentes montrent les services disponibles et comment on
peut les combiner dans une déclaration operating-system
. Mais, déjà,
comment les définir ? Et qu’est-ce qu’un service au fait ?
Suivant: Types service et services, Monter: Définir des services [Table des matières][Index]
Ici nous définissons un service comme étant, assez largement, quelque
chose qui étend la fonctionnalité d’un système d’exploitation. Souvent un
service est un processus — un démon — démarré lorsque le système
démarre : un serveur ssh, un serveur web, le démon de construction de Guix,
etc. Parfois un service est un démon dont l’exécution peut être déclenchée
par un autre démon — p. ex. un serveur FTP démarré par inetd
ou un service D-Bus activé par dbus-daemon
. Parfois, un service
ne correspond pas à un démon. Par exemple, le service « de comptes »
récupère la liste des comptes utilisateurs et s’assure qu’ils existent bien
lorsque le système est lancé ; le service « udev » récupère les règles de
gestion des périphériques et les rend disponible au démon eudev ; le service
/etc rempli le répertoire /etc du système.
Les services de Guix sont connectés par des extensions. Par exemple,
le service ssh étend le Shepherd — le système d’initialisation de
GuixSD, qui tourne en tant que PID 1 — en lui donnant les lignes de
commande pour démarrer et arrêter le démon ssh (voir lsh-service
) ; le service UPower étend le service D-Bus en lui
passant sa spécification .service et étend le service udev en lui
passant des règles de gestion de périphériques (voir upower-service
) ; le démon Guix étend le Shepherd en lui passant les
lignes de commande pour démarrer et arrêter le démon et étend le service de
comptes en lui passant une liste des comptes utilisateurs de constructions
requis (voir Services de base).
En définitive, les services et leurs relation « d’extensions » forment un graphe orienté acyclique (DAG). Si nous représentons les services comme des boîtes et les extensions comme des flèches, un système typique pourrait fournir quelque chose comme cela :
En bas, on voit le service système qui produit le répertoire contenant
tout et lançant et démarrant le système, renvoyé par la commande
guix system build
. Voir Référence de service, pour apprendre les
autres types de services montrés ici. Voir the
guix system extension-graph
command, pour plus d’informations sur
la manière de générer cette représentation pour une définition de système
d’exploitation particulière.
Techniquement, on peut définir des types de services pour exprimer ces relations. Il peut y avoir n’importe quel quantité de services d’un type donné sur le système — par exemple, un système sur lequel tournent deux instances du serveur ssh de GNU (lsh) a deux instance de lsh-service-type, avec des paramètres différents.
La section suivante décrit l’interface de programmation des types de services et des services.
Suivant: Référence de service, Précédent: Composition de services, Monter: Définir des services [Table des matières][Index]
Un type de service est un nœud dans le DAG décrit plus haut.
Commençons avec un exemple simple, le type de service pour le démon de
construction de Guix (voir Invoquer guix-daemon
) :
(define guix-service-type
(service-type
(name 'guix)
(extensions
(list (service-extension shepherd-root-service-type guix-shepherd-service)
(service-extension account-service-type guix-accounts)
(service-extension activation-service-type guix-activation)))
(default-value (guix-configuration))))
Il définit trois choses :
Chaque type de service a au moins une extension de service. La seule exception est le type de service boot, qui est le service ultime.
Dans cet exemple, guix-service-type étend trois services :
shepherd-root-service-type
La procédure guix-shepherd-service définit comment le service du
Shepherd est étendu. En fait, elle renvoie un objet
<shepherd-service>
qui définit comment guix-daemon
est
démarré et stoppé (voir Services Shepherd).
account-service-type
Cette extension pour ce service est calculée par guix-accounts, qui
renvoie une liste d’objets user-group
et user-account
représentant les comptes des utilisateurs de construction (voir Invoquer guix-daemon
).
activation-service-type
Ici, guix-activation est une procédure qui renvoie une gexp, qui est un bout de code qui s’exécute au moment de l’activation — p. ex. lorsque le service est démarré.
Un service de ce type est instancié de cette manière :
(service guix-service-type
(guix-configuration
(build-accounts 5)
(extra-options '("--gc-keep-derivations"))))
Le deuxième argument de la forme service
est une valeur représentant
les paramètres de cet instance spécifique du service.
Voir guix-configuration
, pour plus
d’informations sur le type de données guix-configuration
. Lorsque la
valeur est omise, la valeur par défaut spécifiée par
guix-service-type
est utilisée :
guix-service-type est très simple car il étend d’autres services mais ne peut pas être étendu.
Le type de service pour un service extensible ressemble à ceci :
(define udev-service-type
(service-type (name 'udev)
(extensions
(list (service-extension shepherd-root-service-type
udev-shepherd-service)))
(compose concatenate) ;concaténer la liste des règles
(extend (lambda (config rules)
(udev-configuration
(inherit config)
(rules (append (udev-configuration-rules config)
rules)))))))
C’est le type de service pour le le démon de gestion des périphériques eudev. Comparé à l’exemple précédent, en plus d’une extension de shepherd-root-service-type, on trouve deux nouveaux champs :
compose
C’est la procédure pour composer la liste des extensions de services de ce type.
Les services peuvent étendre le service udev en lui passant des listes de règles ; on compose ces extensions simplement en les concaténant.
extend
Cette procédure définie comme la valeur du service est étendue avec la composition des extensions.
Les extensions Udev sont composés en une liste de règles, mais la valeur du
service udev est elle-même un enregistrement <udev-configuration>
.
Donc ici, nous étendons cet enregistrement en ajoutant la liste des règle
contribuées à la liste des règles qu’il contient déjà.
description
C’est une chaîne donnant un aperçu du type de service. Elle peut contenir
du balisage Texinfo (voir Overview dans GNU Texinfo). La commande
guix system search
permet de rechercher dans ces chaînes et de les
afficher (voir Invoquer guix system
).
Il ne peut y avoir qu’une instance d’un type de service extensible comme
udev-service-type. S’il y en avait plus, les spécification
service-extension
seraient ambiguës.
Toujours ici ? La section suivante fournit une référence de l’interface de programmation des services.
Suivant: Services Shepherd, Précédent: Types service et services, Monter: Définir des services [Table des matières][Index]
Nous avons vu un résumé des types de services (voir Types service et services). Cette section fournit une référence sur la manière de manipuler
les services et les types de services. Cette interface est fournie par le
module (gnu services)
.
Renvoie un nouveau service de type type, un objet
<service-type>
(voir plus bas). valuepeut être n’importe quel
objet ; il représente les paramètres de cette instance particulière de
service.
Lorsque value est omise, la valeur par défaut spécifiée par type est utilisée ; si type ne spécifie pas de valeur par défaut, une erreur est levée.
Par exemple ceci :
est équivalent à ceci :
Dans les deux cas le résultat est une instance de
openssh-service-type
avec la configuration par défaut.
Renvoie vrai si obj est un service.
Renvoie le type de service — c.-à-d. un objet <service-type>
.
Renvoie la valeur associée à service. Elle représente ses paramètres.
Voici un exemple de la manière dont un service est créé et manipulé :
(define s (service nginx-service-type (nginx-configuration (nginx nginx) (log-directory log-directory) (run-directory run-directory) (file config-file)))) (service? s) ⇒ #t (eq? (service-kind s) nginx-service-type) ⇒ #t
La forme modify-services
fournit une manière pratique de modifier les
paramètres de certains services d’une liste comme %base-services
(voir %base-services
). Elle s’évalue en une liste
de services. Bien sûr, vous pouvez toujours utiliser les combinateurs de
liste standards comme map
et fold
pour cela (voir List Library dans GNU Guile Reference Manual) ; modify-services
fournit simplement une manière plus concise pour ce besoin commun.
Modifie les services listés dans services en fonction des clauses données. Chaque clause à la forme :
(type variable => body)
où type est un type de service — p. ex. guix-service-type
—
et variable est un identifiant lié dans body aux paramètres du
service — p. ex. une instance de guix-configuration
— du service
original de ce type.
La variable body devrait s’évaluer en de nouveaux paramètres de
service, qui seront utilisés pour configurer le nouveau service. Ce nouveau
service remplacera l’original dans la liste qui en résulte. Comme les
paramètres d’un service sont créés avec define-record-type*
, vous
pouvez écrire un body court qui s’évalue en de nouveaux paramètres
pour le services en utilisant inherit
, fourni par
define-record-type*
.
Les clauses peuvent aussi avoir les formes suivantes :
(delete type)
Cette clause supprime tous les services du type donné de services.
Voir Utiliser le système de configuration pour des exemples d’utilisation.
Suit l’interface de programmation des types de services. Vous devrez la
connaître pour écrire de nouvelles définitions de services, mais pas
forcément lorsque vous cherchez des manières simples de personnaliser votre
déclaration operating-system
.
C’est la représentation d’un type de service (voir Types service et services).
name
C’est un symbole, utilisé seulement pour simplifier l’inspection et le débogage.
extensions
Une liste non-vide d’objets <service-extension>
(voir plus bas).
compose
(par défaut : #f
)S’il s’agit de #f
, le type de service dénote des services qui ne
peuvent pas être étendus — c.-à-d. qui ne reçoivent pas de « valeurs »
d’autres services.
Sinon, ce doit être une procédure à un argument. La procédure est appelée
par fold-services
et on lui passe une liste de valeurs collectées par
les extensions. Elle peut renvoyer n’importe quelle valeur simple.
extend
(par défaut : #f
)Si la valeur est #f
, les services de ce type ne peuvent pas être
étendus.
Sinon, il doit s’agir ’une procédure à deux arguments : fold-services
l’appelle et lui passe la valeur initiale du service comme premier argument
et le résultat de l’application de compose
sur les valeurs
d’extension en second argument. Elle doit renvoyer une valeur qui est une
valeur de paramètre valide pour l’instance du service.
description
C’est une chaine, éventuellement avec de la syntaxe Texinfo, décrivant une
quelques phrases ce que le service fait. Cette chaine permet aux
utilisateurs de trouver le service à travers guix system search
(voir Invoquer guix system
).
default-value
(par défaut : &no-default-value
)La valeur par défaut associée aux instances de ce type de service. Cela
permet d’utiliser la forme service
sans son second argument :
(service type)
Le service renvoyé dans ce cas a la valeur par défaut spécifiée par type.
Voir Types service et services, pour des exemples.
compute doit être une procédure à un argument : fold-services
l’appelle et lui passe la valeur associée au service qui fournit cette
extension ; elle doit renvoyer une valeur valide pour le service cible.
Renvoie vrai si obj est une extension de service.
Parfois, vous voudrez simplement étendre un service existant. Cela implique
de créer un nouveau type de service et de spécifier l’extension qui vous
intéresse, ce qui peut être assez verbeux ; la procédure
simple-service
fournit un raccourci pour ce cas.
Renvoie un service qui étend target avec value. Cela fonctionne en créant un type de service singleton name, dont le service renvoyé est une instance.
Par exemple, cela étend mcron (voir Exécution de tâches planifiées) avec une tâche supplémentaire :
(simple-service 'my-mcron-job mcron-service-type
#~(job '(next-hour (3)) "guix gc -F 2G"))
Au cœur de l’abstraction des services se cache la procédure
fold-services
, responsable de la « compilation » d’une liste de
services en un répertoire unique qui contient tout ce qui est nécessaire au
démarrage et à l’exécution du système — le répertoire indiqué par la
commande guix system build
(voir Invoquer guix system
). En
soit, elle propage les extensions des services le long du graphe des
services, en mettant à jour chaque paramètre des nœuds sur son chemin,
jusqu’à atteindre le nœud racine.
Replie services en propageant leurs extensions jusqu’à la racine de type target-type ; renvoie le service racine ajusté de cette manière.
Enfin, le module (gnu services)
définie aussi divers types de
services essentiels, dont certains sont listés ci-dessous.
C’est la racine du graphe des services. Il produit le répertoire du système
renvoyé par la commande guix system build
.
Le type du service « boot », qui produit le script de démarrage. Le script de démarrage est ce que le disque de RAM initial lance au démarrage.
Le type du service /etc. Ce service est utilisé pour créer des fichiers dans /etc et peut être étendu en lui passant des tuples nom/fichier comme ceci :
(list `("issue" ,(plain-file "issue" "Bienvenue !\n")))
Dans cet exemple, l’effet serait d’ajouter un fichier /etc/issue pointant vers le fichier donné.
Type for the “privileged-program service”. This service collects lists of executable file names, passed as gexps, and adds them to the set of privileged programs on the system (voir Privileged Programs).
De type du service qui rempli le profil du système — c.-à-d. les programmes dans /run/current-system/profile. Les autres services peuvent l’étendre en lui passant des listes de paquets à ajouter au profil du système.
C’est le type de service qui enregistre les métadonnées de provenance dans le système lui-même. Il crée plusieurs fichiers dans /run/current-system :
C’est un « fichier de canaux » qui peut être passé à guix pull -C
ou guix time-machine -C
, et qui décrit les canaux utilisés pour
construire le système, si cette information était disponible
(voir Canaux).
C’est le fichier qui était passé en argument à ce service
provenance-service-type
. Par défaut, guix system
reconfigure
passe automatiquement le fichier de configuration du système
qu’il a reçu en argument de la ligne de commande.
Cela contient la même information que les deux autres fichiers mais dans un format plus facile à traiter automatiquement.
En général, ces deux informations (les canaux et le fichier de configuration) sont suffisants pour reproduire le système d’exploitation « depuis les sources ».
Limites : Cette information est nécessaire pour reconstruire votre système d’exploitation, mais elle n’est pas suffisante. En particulier, configuration.scm lui-même n’est pas suffisant s’il n’est pas auto-contenu — s’il référence des modules Guile externes ou des fichiers supplémentaires. Si vous voulez que configuration.scm soit auto-contenu, nous vous recommandons de faire en sorte que les modules et les fichiers auxquels il fait référence se trouvent dans un canal.
De plus, les métadonnées de provenance sont « silencieuses » dans le sens où elles ne changent pas les bits contenus dans votre système, en dehors des bits des métadonnées elles-mêmes. Deux configuration de système différents ou des ensembles de canaux différents peuvent créer le même système, bit-à-bit, mais lorsque
provenance-service-type
est utilisé ces deux systèmes auront des métadonnées différentes et donc des noms de fichiers dans le dépôt différents, ce qui rend la comparaison plus difficile.
Ce service est automatiquement ajouté à la configuration de votre système
d’exploitation quand vous utilisez guix system reconfigure
,
guix system init
et guix deploy
.
Type du service qui récolte les listes de paquets contenant les modules chargeables par le noyau, et les ajoute à l’ensemble des modules chargeables par le noyau.
Ce type de service est conçu pour être étendu par d’autres types de services, comme ceci :
(simple-service 'installing-module
linux-loadable-module-service-type
(list module-to-install-1
module-to-install-2))
Ce service ne charge pas les modules au démarrage, il ne fait que les ajouter au profil du noyau pour qu’ils puissent être chargés par d’autres moyens.
Suivant: Configurations complexes, Précédent: Référence de service, Monter: Définir des services [Table des matières][Index]
Le module (gnu services shepherd)
fournit une manière de définir les
services gérés par le GNU Shepherd, qui est le système d’initialisation
— le premier processus démarré lorsque le système démarre, aussi connu comme
étant le PID 1 (voir Introduction dans The GNU Shepherd
Manual).
Les services dans le Shepherd peuvent dépendre les uns des autres. Par exemple, le démon SSH peut avoir besoin d’être démarré après le démon syslog, qui à son tour doit être démarré après le montage des systèmes de fichiers. Le système d’exploitation simple déclaré précédemment (voir Utiliser le système de configuration) crée un graphe de service comme ceci :
Vous pouvez générer un tel graphe pour n’importe quelle définition de
système d’exploitation avec la commande guix system shepherd-graph
(voir guix system shepherd-graph
).
La variable %shepherd-root-service est un objet de service
représentant le PID 1, de type shepherd-root-service-type ; il
peut être étendu en lui passant des listes d’objets
<shepherd-service>
.
Le type de données représentant un service géré par le Shepherd.
provision
C’est une liste de symboles dénotant ce que le service fournit.
Ce sont les noms qui peuvent être passés à herd start
,
herd status
et les commandes similaires (voir Invoking herd dans The GNU Shepherd Manual). Voir Defining Services dans The GNU Shepherd Manual, pour plus de détails.
requirement
(par défaut : '()
)Liste de symboles dénotant les services du Shepherd dont celui-ci dépend.
one-shot?
(par défaut : #f
)Indique si ce service est ponctuel. Les services ponctuels s’arrêtent
immédiatement à la fin de leur action start
. Voir Slots of
services dans The GNU Shepherd Manual, pour plus d’infos.
respawn?
(par défaut : #t
)Indique s’il faut redémarrer le service lorsqu’il s’arrête, par exemple si le processus sous-jacent meurt.
respawn-limit
(default: #f
)Set a limit on how many times and how frequently a service may be restarted by Shepherd before it is disabled. Voir Defining Services dans The GNU Shepherd Manual, for details.
respawn-delay
(default: #f
)When true, this is the delay in seconds before restarting a failed service.
start
(default: #~(const #t)
)stop
(par défaut : #~(const #f)
)Les champs start
et stop
se réfèrent à la capacité du Shepherd
de démarrer et d’arrêter des processus (voir Service De- and
Constructors dans The GNU Shepherd Manual). Ils sont donnés comme
des G-expressions qui sont étendues dans le fichier de configuration du
Shepherd (voir G-Expressions).
actions
(par défaut : '()
) ¶C’est une liste d’objets shepherd-action
(voir plus bas) définissant
des actions supportées par le service, en plus des actions
start
et stop
standards. Les actions listées ici sont
disponibles en tant que sous-commande de herd
:
herd action service [arguments…]
free-form
(default: #f
)When set, this field replaces the start
, stop
, and
actions
fields. It is meant to be used when the service definition
comes from some other source, typically the service collection provided by
the Shepherd proper (voir Service Collection dans The GNU Shepherd
Manual).
For example, the snippet below defines a service for the Shepherd’s built-in REPL (read-eval-print loop) service (voir REPL Service dans The GNU Shepherd Manual):
(shepherd-service
(provision '(repl))
(modules '((shepherd service repl)))
(free-form #~(repl-service)))
In this case, the service object is returned by the repl-service
procedure of the Shepherd, so all the free-form
G-expression does is
call that procedure. Note that the provision
field must be
consistent with the actual service provision.
auto-start?
(par défaut : #t
)Indique si ce service doit être démarré automatiquement par le Shepherd. Si
la valeur est #f
, le service doit être démarré manuellement avec
herd start
.
documentation
Une chaîne de documentation, montrée lorsqu’on lance :
herd doc service-name
où service-name est l’un des symboles dans provision (voir Invoking herd dans The GNU Shepherd Manual).
modules
(par défaut : %default-modules
)C’est la liste des modules qui doivent être dans le contexte lorsque
start
et stop
sont évalués.
L’exemple ci-dessous défini un service Shepherd qui lance syslogd
,
le démon de journalisation du système des utilitaires réseau de GNU
(voir syslogd
dans GNU Inetutils) :
(let ((config (plain-file "syslogd.conf" "…"))) (shepherd-service (documentation "Run the syslog daemon (syslogd).") (provision '(syslogd)) (requirement '(user-processes)) (start #~(make-forkexec-constructor (list #$(file-append inetutils "/libexec/syslogd") "--rcfile" #$config) #:pid-file "/var/run/syslog.pid")) (stop #~(make-kill-destructor))))
Les éléments clés de cet exemple sont les champs start
et stop
: ce sont des bouts de code échelonné qui utilisent la procédure
make-forkexec-constructor
fournie par le Shepherd et son dual,
make-kill-destructor
(voir Service De- and Constructors dans The GNU Shepherd Manual). Le champ start
fera créer un
syslogd
au shepherd
avec les options données. Remarquez
que nous passons config
après --rcfile, qui est un fichier
de configuration déclaré plus haut (le contenu de ce fichier a été omis). De
même, le champ stop
décrit comment ce service sera arrêté. Dans ce
cas, il est arrêté par l’appel système kill
sur son PID. Le code est
échelonné par des G-expressions : #~
échelonne le code, tandis que
#$
« descend » vers le code hôte (voir G-Expressions).
C’est le type de données qui définie des actions supplémentaires implémentées par un service Shepherd (voir au-dessus).
name
Symbole nommant l’action.
documentation
C’est une chaîne de documentation pour l’action. Elle peut être consultée avec :
herd doc service action action
procedure
Cela devrait être une gexp qui s’évalue en une procédure à au moins un argument, la « valeur de lancement » du service (voir Slots of services dans The GNU Shepherd Manual).
L’exemple suivant définie une action nommée dire-bonjour
qui salue
amicalement l’utilisateur :
(shepherd-action
(name 'dire-bonjour)
(documentation "Dit salut !")
(procedure #~(lambda (running . args)
(format #t "Salut, l'ami ! arguments : ~s\n"
args)
#t)))
En supposant que cette action est ajoutée dans le service example
,
vous pouvez écrire :
# herd dire-bonjour example Salut, l'ami ! arguments : () # herd dire-bonjour example a b c Salut, l'ami ! arguments : ("a" "b" "c")
Comme vous pouvez le voir, c’est une manière assez sophistiquée de dire bonjour. Voir Defining Services dans The GNU Shepherd Manual, pour plus d’informations sur les actions.
Renvoie une action configuration
pour afficher file, qui
devrait être le nom du fichier de configuration du service.
Il peut être utile d’équiper les services avec cette action. Par exemple, le
service pour le routeur anonyme Tor (voir tor-service-type
) est défini globalement de cette façon :
(let ((torrc (plain-file "torrc" …)))
(shepherd-service
(provision '(tor))
(requirement '(user-processes loopback syslogd))
(start #~(make-forkexec-constructor
(list #$(file-append tor "/bin/tor") "-f" #$torrc)
#:user "tor" #:group "tor"))
(stop #~(make-kill-destructor))
(actions (list (shepherd-configuration-action torrc)))
(documentation "Run the Tor anonymous network overlay.")))
Grâce à cette action, la personne administrant le système peut inspecter le
fichier de configuration passé à tor
avec cette commande shell :
cat $(herd configuration tor)
Cela peut être pratique pour déboguer !
Le type de service pour le « service racine » du Shepherd — c.-à-d. le PID 1.
C’est le type de service que les extensions ciblent lorsqu’elles veulent
créer un service shepherd (voir Types service et services, pour un
exemple). Chaque extension doit passer une liste de
<shepherd-service>
. Sa valeur doit être un
shepherd-configuration
, décrit plus bas.
Ce type de données représente la configuration du Shepherd.
shepherd (par défaut : shepherd
)
Le paquet Shepherd à utiliser.
services (par défaut : '()
)
Une liste de <shepherd-service>
à démarrer. Vous devriez probablement
utiliser le mécanisme d’extensions des services à la place (voir Services Shepherd).
L’exemple suivant spécifie le paquet Shepherd pour le système d’exploitation :
(operating-system
;; ...
(services (append (list openssh-service-type))
;; ...
%desktop-services)
;; ...
;; Utiliser notre propre paquet Shepherd.
(essential-services
(modify-services (operating-system-default-essential-services
this-operating-system)
(shepherd-root-service-type config => (shepherd-configuration
(inherit config)
(shepherd my-shepherd))))))
Ce service représente le PID 1.
Précédent: Services Shepherd, Monter: Définir des services [Table des matières][Index]
Certains programmes peuvent avoir des fichiers ou des formats de
configuration complexes, et pour rendre plus simple la création de liaisons
Scheme pour ces fichiers de configuration, vous pouvez utiliser les fonction
auxiliaires définies dans le modules (gnu services configuration)
.
The main utility is the define-configuration
macro, a helper used to
define a Scheme record type (voir Record Overview dans GNU Guile
Reference Manual). The fields from this Scheme record can be serialized
using serializers, which are procedures that take some kind of Scheme
value and translates them into another Scheme value or G-Expressions.
Crée un type d’enregistrement nommé nom
qui contient les champs
qui se trouvent dans les clauses.
A clause has the following form:
(field-name type-decl documentation option* …)
nom-du-champ est un identifiant qui dénote le nom du champ dans l’enregistrement généré.
type-decl is either type
for fields that require a value
to be set or (type default-value)
otherwise.
type est le type de valeur correspondant à nom-du-champ ; comme
Guile n’est pas typé, une procédure de prédicat — type?
—
sera appelée avec la valeur correspondant au champ pour s’assurer que la
valeur est du type correct. Cela signifie que si type est
package
, alors une procédure nommée package?
sera appliquée
sur la valeur pour s’assurer que c’est bien un objet <package>
.
valeur-par-défaut est la valeur par défaut correspondant au champ ; si aucune n’est spécifiée, l’utilisateur ou l’utilisatrice doit fournir une valeur à la création d’un objet de ce type d’enregistrement.
documentation est une chaine formatée avec la syntaxe de Texinfo qui fournit une description de ce que ce champ de configuration signifie.
option* is one of the following subclauses:
empty-serializer
Exclude this field from serialization.
(serializer serializer)
serializer is the name of a procedure which takes two arguments, the
first is the name of the field, and the second is the value corresponding to
the field. The procedure should return a string or G-Expressions that
represents the content that will be serialized to the configuration file.
If none is specified, a procedure of the name serialize-type
will be used.
An example of a simple serializer procedure:
(define (serialize-boolean field-name value)
(let ((value (if value "true" "false")))
#~(string-append '#$field-name " = " #$value)))
(sanitizer sanitizer)
sanitizer is a procedure which takes one argument, a user-supplied value, and returns a “sanitized” value for the field. If no sanitizer is specified, a default sanitizer is used, which raises an error if the value is not of type type.
An example of a sanitizer for a field that accepts both strings and symbols looks like this:
(define (sanitize-foo value)
(cond ((string? value) value)
((symbol? value) (symbol->string value))
(else (error "bad value"))))
Dans certains cas plusieurs enregistrements de configuration différents
peuvent être définis dans le même fichier, mais leurs sérialiseurs pour le
même type peuvent devoir être différents, à cause de formats de
configuration différents. Par exemple, la procédure serialize-boolean
pour le service Getmail doit être différente de celle pour le service
Transmission. Pour faciliter cette situation, on peut spécifier un préfixe
pour sérialiseur en utilisant le littéral prefix
dans la forme
define-configuration
. Cela signifie qu’on n’a pas à spécifier
manuellement un sérialiseur personnalisé pour chaque champ.
(define (toto-serialize-string field-name value) …) (define (titi-serialize-string field-name value) …) (define-configuration foo-configuration (label string "The name of label.") (prefix foo-)) (define-configuration bar-configuration (ip-address string "The IPv4 address for this device.") (prefix bar-))
Cependant, dans certains cas vous ne voudrez pas sérialiser les valeurs de
l’enregistrement. Pour cela, vous pouvez utiliser le littéral
no-serialization
. Il y a aussi la macro
define-configuration/no-serialization
qui est un raccourci.
Parfois un champ ne devrait pas être sérialisé si l’utilisateur ou
l’utilisatrice de spécifie par de valeur. Pour cela, vous pouvez utiliser la
macro define-maybe
pour définir un « type peut-être » ; si la valeur
d’un type peut-être n’est pas spécifiée, ou est indiquée à
%unset-value
, elle n’est pas sérialisée.
Lorsque vous définissez un « type peut-être », le sérialiseur correspondant
au type normal sera utilisé par défaut. Par exemple, un champ de type
maybe-string
sera sérialisé avec la procédure serialize-string
par défaut, vous pouvez évidemment changer cela en spécifiant une procédure
de sérialisation personnalisée. De la même manière, le type de la valeur
doit être une chaine, ou la valeur doit rester non spécifiée.
(define-maybe string) (define (serialize-string field-name value) …) (define-configuration tata-configuration (name ;; Si c'est une chaine, la procédure « serialize-string » sera utilisée ;; pour sérialiser la chaine. Sinon ce champ n'est pas sérialisé maybe-string "Le nom de ce module."))
Comme avec define-configuration
, on peut indiquer un préfixe pour le
nom de sérialiseur en utilisant le littéral prefix
.
(define-maybe integer (prefix tata-)) (define (tata-serialize-integer field-name value) …)
Il y a aussi le littéral no-serialization
, qui s’il est utilisé
indique qu’aucun sérialiseur ne sera défini pour le « type peut-être »,
indépendamment de si la valeur est indiquée ou
non. define-maybe/no-serialization
est un raccourci pour spécifier le
littéral no-serialization
.
(define-maybe/no-serialization symbol) (define-configuration/no-serialization test-configuration (mode maybe-symbol "Docstring."))
Prédicat pour vérifier si l’utilisateur ou l’utilisatrice a spécifié la valeur d’un champ peut-être.
Renvoie une G-expression qui contient les valeurs correspondant aux
champs de configuration, un enregistrement qui a été généré par
define-configuration
. La G-expression peut ensuite être sérialisée
vers le disque en utilisant par exemple mixed-text-file
.
Une fois que vous avez défini un enregistrement de configuration, vous voudrez aussi sans doute le documenter pour que d’autres personnes sachent comment l’utiliser. Pour vous aider, il y a deux procédure qui sont documentées plus bas.
Génère un fragment Texinfo à partir de docstrings dans documentation,
une liste de (étiquette champs sous-documentation
…)
. étiquette devrait être un symbole et devrait être le nom de
l’enregistrement de configuration. champs devrait être une liste de
tous les champs disponibles pour l’enregistrement de configuration.
sub-documentation is a (field-name
configuration-name)
tuple. field-name is the name of the field
which takes another configuration record as its value, and
configuration-name is the name of that configuration record. The same
value may be used for multiple field-names, in case a field accepts
different types of configurations.
sous-documentation n’est requis que s’il y a des enregistrements de
configuration imbriqués. Par exemple, l’enregistrement
getmail-configuration
(voir Services de courriels) accepte un
enregistrement getmail-configuration-file
dans l’un de ses champs
rcfile
, donc la documentation de getmail-configuration-file
est imbriquée dans getmail-configuration
.
(generate-documentation
`((getmail-configuration ,getmail-configuration-fields
(rcfile getmail-configuration-file))
…)
'getmail-configuration)
nom-de-documentation devrait être un symbole et devrait être le nom de l’enregistrement de configuration.
Prend configuration-symbol, le symbole correspondant au nom utilisé
pour définir un enregistrement de configuration avec
define-configuration
, et affiche la documentation Texinfo pour ses
champs. Cette procédure est utile s’il n’y a pas d’enregistrement de
configuration imbriqué car elle n’affiche que la documentation des champs de
plus haut niveau.
Actuellement, il n’y a pas de manière automatique de générer la
documentation pour les enregistrements de configuration et les ajouter au
manuel. Au lieu de cela, chaque fois que vous faites un changement dans les
docstrings d’un enregistrement de configuration, vous devez appeler
manuellement generate-documentation
ou
configuration->documentation
et coller la sortie dans le fichier
doc/guix.texi.
Ci-dessous se trouve un exemple d’un type d’enregistrement créé avec
define-configuration
et compagnie.
(use-modules (gnu services) (guix gexp) (gnu services configuration) (srfi srfi-26) (srfi srfi-1)) ;; Transforme les noms de champs, qui sont des symboles Scheme, en chaines (define (uglify-field-name field-name) (let ((str (symbol->string field-name))) ;; field? -> is-field (if (string-suffix? "?" str) (string-append "is-" (string-drop-right str 1)) str))) (define (serialize-string field-name value) #~(string-append #$(uglify-field-name field-name) " = " #$value "\n")) (define (serialize-integer field-name value) (serialize-string field-name (number->string value))) (define (serialize-boolean field-name value) (serialize-string field-name (if value "true" "false"))) (define (serialize-contact-name field-name value) #~(string-append "\n[" #$value "]\n")) (define (list-of-contact-configurations? lst) (every contact-configuration? lst)) (define (serialize-list-of-contact-configurations field-name value) #~(string-append #$@(map (cut serialize-configuration <> contact-configuration-fields) value))) (define (serialize-contacts-list-configuration configuration) (mixed-text-file "contactrc" #~(string-append "[Owner]\n" #$(serialize-configuration configuration contacts-list-configuration-fields)))) (define-maybe integer) (define-maybe string) (define-configuration contact-configuration (name string "The name of the contact." serialize-contact-name) (phone-number maybe-integer "The person's phone number.") (email maybe-string "The person's email address.") (married? boolean "Whether the person is married.")) (define-configuration contacts-list-configuration (name (string) "Le nom du propriétaire de cette liste de contacts.") (email (string) "L'adresse de courriel du propriétaire.") (contacts (list-of-contact-configurations '()) "Une liste d'enregistrements @code{contact-configuration} qui contiennent des informations sur tous vos contacts."))
Une configuration de liste de contacts pourrait alors être créée de cette manière :
(define my-contacts
(contacts-list-configuration
(name "Alice")
(email "alice@example.org")
(contacts
(list (contact-configuration
(name "Bob")
(phone-number 1234)
(email "bob@gnu.org")
(married? #f))
(contact-configuration
(name "Charlie")
(phone-number 0000)
(married? #t))))))
Après la sérialisation de la configuration sur le disque, le fichier qui en résulte ressemble à ceci :
[owner] name = Alice email = alice@example.org [Bob] phone-number = 1234 email = bob@gnu.org is-married = false [Charlie] phone-number = 0 is-married = true
Suivant: Configuration du dossier personnel, Précédent: Configuration du système, Monter: GNU Guix [Table des matières][Index]
Le système Guix permet de redémarrer sur une génération précédente si la dernière ne fonctionne pas, ce qui le rend assez robuste contre les défaillances irréversibles. Cette fonctionnalité dépend du bon fonctionnement de GRUB cependant, ce qui signifie que si pour quelque raison que ce soit, votre installation de GRUB est corrompue pendant une reconfiguration du système, vous pourriez ne pas pouvoir facilement démarrer une génération précédente. Une technique qui peut être utilisée dans ce cas est de chrooter dans votre système endommagé et de le reconfigurer à partir de là. Cette technique est expliquée plus bas.
Cette section explique comment chrooter sur un système Guix déjà installé dans le but de le reconfigurer, par exemple pour corriger une installation défaillante de GRUB. Le processus est semblable à la manière de faire pour les autres systèmes GNU/Linux, mais il y a quelques particularités du système Guix comme le démon et les profils qui le rend utile à décrire ici.
mount /dev/sda2 /mnt
mount --rbind /proc /mnt/proc mount --rbind /sys /mnt/sys mount --rbind /dev /mnt/dev
Si votre système est basé sur EFI, vous devez aussi monter la partition ESP. En supposant qu’elle est sur /dev/sda1, vous pouvez le faire avec :
mount /dev/sda1 /mnt/boot/efi
chroot /mnt /bin/sh
source /var/guix/profiles/system/profile/etc/profile source /home/utilisateur/.guix-profile/etc/profile
Pour vous assurer que vous travaillez avec la révision de Guix que vous utiliseriez en tant qu’utilisateur normal, sourcez aussi votre profil actuel de Guix :
source /home/utilisateur/.config/guix/current/etc/profile
guix-daemon
minimal en tâche de fond :
guix-daemon --build-users-group=guixbuild --disable-chroot &
guix system reconfigure votre-config.scm
Suivant: Documentation, Précédent: Corriger les problèmes du système, Monter: GNU Guix [Table des matières][Index]
Guix prend en charge la configuration déclarative des environnement
personnels en utilisant le mécanisme de configuration décrit au chapitre
précédent (voir Définir des services), mais pour les paquets et les fichiers
de configuration des utilisateurs et utilisatrices. Cela fonctionne aussi
bien sur le système Guix que sur les distributions externes et vous permet
de déclarer tous les paquets et services qui devraient être installés et
configurés. Une fois que vous avez écrit un fichier contenant un
enregistrement home-environment
, cette configuration peut être
instanciée par un utilisateur ou une utilisatrice non privilégié·e
avec la commande guix home
(voir Invoquer guix home
).
Votre environnement personnel consiste en général de trois parties : les
logiciels, la configuration et l’état. Dans les distributions populaires,
les logiciels sont habituellement installés au niveau du système, mais avec
GNU Guix, la plupart des paquets peuvent être installés indépendamment par
chaque utilisateur et utilisatrice sans nécessiter de privilèges root, et
font donc partie de votre environnement personnel. Les paquets seuls
ne sont généralement pas très utiles car ils nécessitent de la configuration
supplémentaire, typiquement dans des fichiers de configuration dans
XDG_CONFIG_HOME
(~/.config par défaut) ou d’autres
répertoires. Tout le reste peut être considéré comme faisant partie de
l’état, comme les fichiers multimédia, les bases de données des applications
et les journaux.
Utiliser Guix pour gérer votre environnement personnel apporte de nombreux avantages :
guix home reconfigure
, une nouvelle génération de
l’environnement personnel sera créée. Cela signifie que vous pouvez revenir
à une génération précédente de votre environnement personnel et que vous
n’avez pas à craindre de casser votre configuration.
rsync
pour synchroniser vos données entre vos
hôtes. Cette fonctionnalité est cependant toujours expérimentale.
guix home
Suivant: Configurer le shell, Monter: Configuration du dossier personnel [Table des matières][Index]
L’environnement personnel est configuré en fournissant une déclaration
home-environment
dans un fichier qui peut être passé à la commande
guix home
(voir Invoquer guix home
). Le plus facile pour
commencer est de générer une configuration initiale avec guix home
import
:
guix home import ~/src/guix-config
La commande guix home import
lit certains « dot files » comme
~/.bashrc qui se trouvent dans votre dossier personnel et les copie
dans le dossier donné, ~/src/guix-config dans notre exemple. Il lit
aussi le contenu de votre profil, ~/.guix-profile, et, en fonction de
cela, il rempli ~/src/guix-config/home-configuration.scm avec une
configuration du dossier personnel qui ressemble à votre configuration
actuelle.
Une configuration simple peut inclure par exemple Bash et une configuration textuelle personnalisée, comme dans l’exemple ci-dessous. N’ayez pas peur de déclarer des parties de votre environnement personnel qui correspondent à des fichiers de configuration existants : avant d’installer les fichiers de configuration, Guix Home créera une sauvegarde des fichiers existants à un emplacement distinct de votre dossier personnel.
Remarque : Il est fortement recommandé de gérer votre shell avec Guix Home, car il s’assurera que tous les scripts nécessaires seront sourcés par le fichier de configuration du shell. Sinon, vous devrez le faire manuellement. (voir Configurer le shell).
(use-modules (gnu home) (gnu home services) (gnu home services shells) (gnu services) (gnu packages admin) (guix gexp)) (home-environment (packages (list htop)) (services (list (service home-bash-service-type (home-bash-configuration (guix-defaults? #t) (bash-profile (list (plain-file "bash-profile" "\ export HISTFILE=$XDG_CACHE_HOME/.bash_history"))))) (simple-service 'test-config home-xdg-configuration-files-service-type (list `("test.conf" ,(plain-file "tmp-file.txt" "the content of ~/.config/test.conf")))))))
Le champ packages
devrait être évident, il installera la liste des
paquets dans votre profil. Le champ le plus important est services
,
qui contient une liste de services personnels, qui sont les blocs de
base d’un environnement personnel.
Il n’y a pas de démon (en tout cas pas nécessairement) lié à un service personnel, un service personnel est seulement un élément qui est utilisé pour déclarer une partie de l’environnement personnel et en étendre d’autres parties. Le mécanisme d’extension présenté dans le chapitre précédent (voir Définir des services) ne doit pas être confondu avec les services Shepherd (voir Services Shepherd). L’utilisation de ce mécanisme d’extension et de code Scheme autour vous donne la liberté de déclarer votre propre environnement personnel, hautement personnalisé.
Une fois que la configuration a l’air bonne, vous pouvez d’abord la tester dans un « conteneur » jetable :
guix home container config.scm
La commande ci-dessus démarre un shell où votre environnement personnel est lancé. Le shell tourne dans un conteneur, ce qui signifie qu’il est isolé du reste du système, donc c’est un bon moyen d’essayer votre configuration — vous pouvez vérifier s’il manque des bouts de configuration ou si elle ne se comporte pas correctement, si les démons sont démarrés, etc. Une fois que vous quittez ce shell, vous retournez à l’invite de commande de votre shell de départ « dans le monde réel ».
Une fois que votre configuration correspond à vos besoins, vous pouvez reconfigurer votre dossier personnel en exécutant :
guix home reconfigure config.scm
Cette commande « construit » votre environnement personnel et crée un lien ~/.guix-home qui pointe dessus. Et voilà !
Remarque : Assurez-vous que votre système d’exploitation a elogind, systemd ou un mécanisme similaire pour créer les répertoires XDG à l’exécution et défini la variable
XDG_RUNTIME_DIR
. Autrement, le script on-first-login ne sera pas exécuté et les processus comme le Shepherd utilisateur et ses descendants ne démarreront pas.
If you’re using Guix System, you can embed your home configuration in your
system configuration such that guix system reconfigure
will deploy
both the system and your home at once! Voir guix-home-service-type
, for how to do that.
Suivant: Services du dossier personnel, Précédent: Déclarer l’environnement personnel, Monter: Configuration du dossier personnel [Table des matières][Index]
Vous pouvez sauter cette section sans problème si votre shell ou vos shells sont gérés par Guix Home. Sinon, lisez-la avec attention.
Il y a quelques scripts qui doivent être évalués par un shell de connexion
pour activer l’environnement personnel. Les fichiers de démarrage du shell
lus par les shells de connexion ont souvent le suffixe profile
. Pour
plus d’information sur les shells de connexion, voir Invoking Bash dans The GNU Bash Reference Manual et voir Bash Startup Files dans The GNU Bash Reference Manual.
Le premier script qui a besoin d’être sourcé est setup-environment,
qui initialise toutes les variables d’environnement nécessaires (dont les
variables que vous avez déclarées) et le second est on-first-login,
qui démarre Shepherd pour l’utilisateur actuel et effectue les action
déclarées par les autres services personnels qui étendent
home-run-on-first-login-service-type
.
Guix Home créera toujours ~/.profile, qui contient les lignes suivantes :
HOME_ENVIRONMENT=$HOME/.guix-home . $HOME_ENVIRONMENT/setup-environment $HOME_ENVIRONMENT/on-first-login
Cela fait activer l’environnement personnel sur les shell POSIX. Cependant, dans la plupart des cas ce fichier ne sera pas lu par les shells les plus modernes, parce qu’ils sont lancés en mode non POSIX par défaut et qu’ils ont leur propre fichiers de démarrage *profile. Par exemple Bash préfèrera ~/.bash_profile s’il existe et n’utilisera ~/.profile que s’il n’existe pas. Zsh (sans option supplémentaire) ignorera ~/.profile même si ~/.zprofile n’existe pas.
Pour que votre shell respecte ~/.profile, ajoutez . ~/.profile
ou source ~/.profile
au fichier de démarrage pour le shell de
connexion. Dans le cas d eBash, c’est ~/.bash_profile, et dans le cas
de Zsh, c’est ~/.zprofile.
Remarque : Cette étape n’est requise que si votre shell n’est pas géré par Guix HOME. Sinon, tout sera déjà fait automatiquement.
Suivant: Invoquer guix home
, Précédent: Configurer le shell, Monter: Configuration du dossier personnel [Table des matières][Index]
Un service personnel ne correspond pas forcément à un démon géré par
le Shepherd (voir Jump Start dans The GNU Shepherd Manual), dans
la plupart des cas ce n’est pas le cas. C’est un simple bloc de construction
de l’environnement personnel, souvent déclaré comme une ensemble de paquets
à installer dans le profil de l’environnement personnel, un ensemble de
fichiers de configuration vers lesquels créer des liens symboliques dans
XDG_CONFIG_HOME
(~/.config par défaut) et des variables
d’environnement à initialiser dans un shell de connexion.
Il y a un mécanisme d’extension de services (voir Composition de services)
qui permet aux services personnels d’étendre les autres services personnels
et d’utiliser leurs fonctionnalités ; par exemple : déclarer des tâches
mcron (voir GNU Mcron) en étendant Exécution de tâches planifiées personnelles ; déclarer des démons en étendant Gérer les démons personnels ;
ajouter des commandes qui seront invoquées par Bash en étendant home-bash-service-type
.
Une bonne manière de découvrir les services personnels disponibles est
d’utiliser la commande guix home search
(voir Invoquer guix home
). Après avoir trouvé les services personnels requis, ajoutez son
module avec la forme use-modules
(voir Using Guile
Modules dans The GNU Guile Reference Manual), ou la directive
#:use-modules
(voir Creating Guile Modules dans The GNU Guile Reference Manual) et déclarez un service personnels avec la
fonction service
, ou étendez un type de service en déclarant un
nouveau service avec la procédure simple-service
de (gnu
services)
.
Suivant: Shells, Monter: Services du dossier personnel [Table des matières][Index]
There are a few essential home services defined in (gnu home
services)
, they are mostly for internal use and are required to build a
home environment, but some of them will be useful for the end user.
Le service de ce type sera instancié par chaque environnement personnel automatiquement par défaut, il n’y a pas besoin de le définir, mais vous voudrez peut-être l’étendre avec une liste de paires pour initialiser certaines variables d’environnement.
(list ("ENV_VAR1" . "valeur1")
("ENV_VAR2" . "valeur2"))
Le plus simple pour étendre un type de service, sans définir un nouveau type
de service est d’utiliser la fonction simple-service
de (gnu
services)
.
(simple-service 'un-service-de-variables-utiles
home-environment-variables-service-type
`(("LESSHISTFILE" . "$XDG_CACHE_HOME/.lesshst")
("SHELL" . ,(file-append zsh "/bin/zsh"))
("USELESS_VAR" . #f)
("_JAVA_AWT_WM_NONREPARENTING" . #t)
("LITERAL_VALUE" . ,(literal-string "${abc}"))))
Si vous incluez un tel service dans votre définition d’environnement personnel, il ajoutera le contenu suivant au script setup-environment (qui doit être sourcé par le shell de connexion) :
export LESSHISTFILE="$XDG_CACHE_HOME/.lesshst" export SHELL="/gnu/store/2hsg15n644f0glrcbkb1kqknmmqdar03-zsh-5.8/bin/zsh" export _JAVA_AWT_WM_NONREPARENTING export LITERAL_VALUE='${abc}'
Remarquez que literal-string
ci-dessus nous permet de déclarer qu’une
valeur doit être interprétée comme une chaine littérale, c’est-à-dire
que les « caractères spéciaux » comme le symbole dollar ne seront pas
interprétés par le shell.
Remarque : Assurez-vous que le module
(gnu packages shells)
est importé avecuse-modules
ou d’une autre façon ; cet espace de nom contient la définition du paquetzsh
, utilisé dans l’exemple précédent.
La liste d’association (voir Association Lists dans le manuel de référence de Guile) est une structure de données
contenant des paires de clé-valeurs. Pour
home-environment-variables-service-type
la clé est toujours une
chaine, la valeur peut être une chaine, une gexp s’évaluant en une chaine
(voir G-Expressions), un objet simili-fichier (voir file-like object) ou un booléen. Pour les gexps, la variable sera
initialisée à la valeur de la gexp ; pour les objets simili-fichiers, elle
sera initialisée au chemin du fichier dans le dépôt (voir Le dépôt) ;
pour #t
, la variable sera exportée sans valeur et pour #f
, la
variable sera omise.
Le service de ce type sera instancié par chaque environnement personnel automatiquement, il n’y a pas besoin de le définir, mais vous pouvez l’étendre avec une liste de paquets si vous voulez installer des paquets supplémentaires dans votre profil. D’autres services, qui ont besoin de rendre certains programmes disponible à l’utilisateur ou l’utilisatrice étendront aussi ce type de service.
La valeur d’extension est simplement une liste de paquets :
(list htop vim emacs)
Vous pouvez utiliser la même approche avec simple-service
(voir simple-service) que pour
home-environment-variables-service-type
. Assurez-vous que les
modules contenant les paquets spécifiés sont importés avec
use-modules
. Pour trouver un paquet ou des informations à propos de
son module utilisez guix search
voir Invoquer guix package
). Autrement, vous pouvez utiliser specification->package
pour récupérer l’enregistrement de paquet à partir d’une chaine sans
importer le module correspondant.
Il y a quelques autres services essentiels, mais vous n’avez pas besoin de les étendre.
La racine du graphe des services personnels, elle génère un dossier qui sera plus tard lié à partir de ~/.guix-home, il contient les configurations, le profil avec les binaires et les bibliothèques et certains scripts nécessaires pour tout faire fonctionner ensemble.
Le service de ce type génère un script Guile qui devrait être lancé par le
shell de connexion. Il n’est exécuté que si le fichier spécial dans
XDG_RUNTIME_DIR
n’a pas été créé, ce qui évite les exécutions
supplémentaires de ce script si plusieurs shells de connexion sont ouverts.
Il peut être étendu avec une gexp. Cependant, pour démarrer une application
automatiquement, vous ne devriez pas utiliser ce service, dans la
plupart des cas il vaut mieux étendre home-shepherd-service-type
avec
un service Shepherd (voir Services Shepherd), ou en étendant le fichier
de démarrage de shell avec la commande requise en utilisant le type de
service approprié.
Le service de ce type permet de spécifier une liste de fichiers, qui iront dans ~/.guix-home/files. Ce répertoire contient généralement des fichiers de configuration (pour être plus précis, il contient des liens symboliques vers des fichiers de /gnu/store) qui devraient être placés dans $XDG_CONFIG_DIR ou dans de rares cas dans $HOME. Il accepte des valeurs d’extension de cette forme :
`((".sway/config" ,sway-file-like-object) (".tmux.conf" ,(local-file "./tmux.conf")))
Chaque liste imbriquée contient deux valeurs : un sous-répertoire et un
objet simili-fichier. Après la construction d’un environnement personnel
~/.guix-home/files contiendra le contenu approprié et tous les
répertoires imbriqués seront créés en fonction. Cependant, ces fichiers
n’iront nul part ailleurs à moins qu’un autre service s’en occupe. Par
défaut un service home-symlink-manager-service-type
, qui crée les
liens symboliques nécessaires vers les fichiers de ~/.guix-home/files
et sauvegarde les fichiers existants en conflit et d’autres choses, fait
partie des services personnels essentiels (activés par défaut), mais il est
possible d’utiliser des services alternatifs pour implémenter des cas
d’usage plus avancés comme un dossier personnel en
lecture-seule. Expérimentez et partagez vos trouvailles.
It is often the case that Guix Home users already have a setup for versioning their user configuration files (also known as dot files) in a single directory, and some way of automatically deploy changes to their user home.
The home-dotfiles-service-type
from (gnu home services
dotfiles)
is designed to ease the way into using Guix Home for this kind of
users, allowing them to point the service to their dotfiles directory
without migrating them to Guix native configurations.
Please keep in mind that it is advisable to keep your dotfiles directories under version control, for example in the same repository where you’d track your Guix Home configuration.
There are two supported dotfiles directory layouts, for now. The
'plain
layout, which is structured as follows:
~$ tree -a ./dotfiles/ dotfiles/ ├── .gitconfig ├── .gnupg │ ├── gpg-agent.conf │ └── gpg.conf ├── .guile ├── .config │ ├── guix │ │ └── channels.scm │ └── nixpkgs │ └── config.nix ├── .nix-channels ├── .tmux.conf └── .vimrc
This tree structure is installed as is to the home directory upon
guix home reconfigure
.
The 'stow
layout, which must follow the layout suggested by
GNU Stow presents an additional
application specific directory layer, just like:
~$ tree -a ./dotfiles/ dotfiles/ ├── git │ └── .gitconfig ├── gpg │ └── .gnupg │ ├── gpg-agent.conf │ └── gpg.conf ├── guile │ └── .guile ├── guix │ └── .config │ └── guix │ └── channels.scm ├── nix │ ├── .config │ │ └── nixpkgs │ │ └── config.nix │ └── .nix-channels ├── tmux │ └── .tmux.conf └── vim └── .vimrc 13 directories, 10 files
For an informal specification please refer to the Stow manual (voir Introduction). This tree structure is installed following GNU Stow’s
logic to the home directory upon guix home reconfigure
.
A suitable configuration with a 'plain
layout could be:
(home-environment
;; …
(services
(service home-dotfiles-service-type
(home-dotfiles-configuration
(directories '("./dotfiles"))))))
The expected home directory state would then be:
. ├── .config │ ├── guix │ │ └── channels.scm │ └── nixpkgs │ └── config.nix ├── .gitconfig ├── .gnupg │ ├── gpg-agent.conf │ └── gpg.conf ├── .guile ├── .nix-channels ├── .tmux.conf └── .vimrc
Return a service which is very similiar to home-files-service-type
(and actually extends it), but designed to ease the way into using Guix Home
for users that already track their dotfiles under some kind of version
control. This service allows users to point Guix Home to their dotfiles
directory and have their files automatically provisioned to their home
directory, without migrating all of their dotfiles to Guix native
configurations.
Available home-dotfiles-configuration
fields are:
source-directory
(default: (current-source-directory)
) (type: string)The path where dotfile directories are resolved. By default dotfile
directories are resolved relative the source location where
home-dotfiles-configuration
appears.
layout
(default: 'plain
) (type: symbol)The intended layout of the specified directory
. It can be either
'stow
or 'plain
.
directories
(default: '()
) (type: list-of-strings)The list of dotfiles directories where home-dotfiles-service-type
will look for application dotfiles.
packages
(type: maybe-list-of-strings)The names of a subset of the GNU Stow package layer directories. When
provided the home-dotfiles-service-type
will only provision dotfiles
from this subset of applications. This field will be ignored if
layout
is set to 'plain
.
excluded
(default: '(".*~" ".*\\.swp" "\\.git" "\\.gitignore")
) (type: list-of-strings)The list of file patterns home-dotfiles-service-type
will exclude
while visiting each one of the directories
.
Le service est très semblable au service home-files-service-type
(et
l’étend en fait), mais il est utilisé pour définir des fichiers qui iront
dans ~/.guix-home/files/.config, et qui seront liés symboliquement
dans $XDG_CONFIG_DIR par home-symlink-manager-service-type
(par exemple) à l’activation. Il accepte des valeurs d’extension dans ce
format :
`(("sway/config" ,sway-file-like-object) ;; -> ~/.guix-home/files/.config/sway/config ;; -> $XDG_CONFIG_DIR/sway/config (par symlink-manager) ("tmux/tmux.conf" ,(local-file "./tmux.conf")))
Le service de ce type génère un script guile qui est lancé à chaque
invocation de guix home reconfigure
ou n’importe quelle autre
action qui active l’environnement personnel.
Le service de ce type génère un script guile qui sera exécuté à l’activation de l’environnement personnel, et effectuera les actions suivantes :
home-files-service-type
,
home-xdg-configuration-files-service-type
et éventuellement
d’autres), prend les fichiers du sous-répertoire files/.config/ et
place des liens symboliques correspondant dans XDG_CONFIG_DIR
. Par
exemple le lien symbolique pour files/.config/sway/config se
retrouvera dans $XDG_CONFIG_DIR/sway/config. Le reste des fichiers de
files/ en dehors du sous-répertoire files/.config/ seront
traités un peu différemment : un lien symbolique sera créé dans
$HOME. files/.un-programme/config se retrouvera dans
$HOME/.un-programme/config.
symlink-manager fait partie des services personnels essentiels et est activé et utilisé par défaut.
Suivant: Exécution de tâches planifiées personnelles, Précédent: Services personnels essentiels, Monter: Services du dossier personnel [Table des matières][Index]
Les shells jouent un rôle important dans le processus d’initialisation de l’environnement, et vous pouvez les configurer manuellement comme décrit dans la section Configurer le shell, mais il est recommandé d’utiliser les services personnels listés plus bas. C’est à la fois plus facile et plus fiable.
Chaque environnement personnel instancie
home-shell-profile-service-type
, qui crée un fichier de démarrage
~/.profile pour tous les shell POSIX. Ce fichier content toutes les
étapes nécessaires à l’initialisation de l’environnement, mais de nombreux
shells modernes comme Bash ou Zsh préfèrent leur propres fichiers de
démarrage, c’est pourquoi les services personnels correspondants
(home-bash-service-type
et home-zsh-service-type
) s’assurent
que ~/.profile est sourcé par ~/.bash_profile et
~/.zprofile, respectivement.
Les champs de home-shell-profile-configuration
disponibles sont :
profile
(par défaut : '()
) (type : text-config)home-shell-profile
est instancié automatiquement par
home-environment
, NE créez PAS ce service manuellement, il ne peut
qu’être étendu. profile
est une liste d’objets simili-fichiers, qui
iront dans ~/.profile. Par défaut ~/.profile contient le code
d’initialisation, qui doit être évalué par le shell de connexion pour rendre
le profil de l’environnement personnel disponible, mais vous pouvez ajouter
d’autres commandes au fichier si c’est vraiment nécessaire. Dans la plupart
des cas les personnalisations devraient aller dans les fichiers de
configuration de votre shell. Étendez le service home-shell-profile qui si
vous savez vraiment ce que vous faites.
Les champs de home-bash-configuration
disponibles sont :
package
(par défaut : bash
) (type : paquet)Le paquet Bash à utiliser.
guix-defaults?
(par défaut : #t
) (type : booléen)Ajoute des instructions par défaut correctes comme la lecture de
/etc/bashrc et la coloration de la sortie de ls
au début du
fichier .bashrc.
environment-variables
(par défaut : '()
) (type : liste d’association)Liste d’association de variables d’environnement à initialiser dans la
session Bash. Les règles de home-environment-variables-service-type
s’appliquent ici (voir Services personnels essentiels). Le contenu de ce champ
sera ajouté après le contenu du champ bash-profile
.
aliases
(par défaut : '()
) (type : liste d’association)Liste d’association d’alias à initialiser pour la session Bash. Les alias
seront définis après le contenu du champ bashrc
dans le fichier
.bashrc. Les alias seront automatiquement encadrés de guillemets,
pour que ceci :
'(("ls" . "ls -alF"))
devienne
alias ls="ls -alF"
bash-profile
(par défaut : '()
) (type : text-config)Liste d’objets simili-fichiers qui seront ajoutés à .bash_profile. C’est utilisé pour exécuter des commandes au démarrage d’un shell de connexion (dans la plupart des cas le shell qui démarre sur un tty après la connexion). .bash_login ne sera jamais lu parce que .bash_profile est toujours présent.
bashrc
(par défaut : '()
) (type : text-config)Liste d’objets simili-fichiers qui seront ajoutés à .bashrc. C’est
utilisé pour exécuter des commandes au lancement d’un shell interactif (le
shell utilisé de manière interactive, démarré en tapant bash
ou par
votre application de terminal ou tout autre programme).
bash-logout
(par défaut : '()
) (type : text-config)Liste d’objets simili-fichiers qui seront ajoutés à .bash_logout. C’est utilisé pour exécuter des commandes à la sortie d’un shell de connexion. Il ne sera pas lu dans certains cas (si le shell termine en utilisant exec sur un autre processus par exemple).
Vous pouvez étendre le service Bash en utilisant un enregistrement de
configuration home-bash-extension
, dont les champs correspondent à
ceux de home-bash-configuration
(voir home-bash-configuration). Le
contenu des extensions seront ajoutées à la fin des fichiers de
configuration Bash correspondants (voir Bash Startup Files dans le
manuel de référence de Bash.
Par exemple, voici comment définir un service qui étend le service Bash de
sorte que ~/.bash_profile définisse une variable d’environnement
supplémentaire, PS1
:
(define bash-fancy-prompt-service
(simple-service 'bash-fancy-prompt
home-bash-service-type
(home-bash-extension
(environment-variables
'(("PS1" . "\\u \\wλ "))))))
Vous ajouterez ensuite bash-fancy-prompt-service
à la liste dans le
champ services
de votre home-environment
. Voici la
documentation de référence pour home-bash-extension
.
Les champs de home-bash-extension
disponibles sont :
environment-variables
(par défaut : '()
) (type : liste d’association)Variables d’environnement supplémentaires à définir. Elles seront combinées aux variables d’environnement des autres extensions et du service de base pour former un bloc cohérent de variables d’environnement.
aliases
(par défaut : '()
) (type : liste d’association)Alias supplémentaires à définir. Ils seront combinés aux alias des autres extensions et du service de base.
bash-profile
(par défaut : '()
) (type : text-config)Blocs de texte supplémentaires à ajouter à .bash_profile, qui seront combinés avec les blocs de texte des autres extensions et du service de base.
bashrc
(par défaut : '()
) (type : text-config)Blocs de texte supplémentaires à ajouter à .bashrc, qui seront combinés avec les blocs de texte des autres extensions et du service de base.
bash-logout
(par défaut : '()
) (type : text-config)Blocs de texte supplémentaires à ajouter à .bash_logout, qui seront combinés avec les blocs de texte des autres extensions et du service de base.
Les champs de home-zsh-configuration
disponibles sont :
package
(par défaut : zsh
) (type : paquet)Le paquet Zsh à utiliser.
xdg-flavor?
(par défaut : #t
) (type : booléen)Place tous les fichiers de configuration dans
$XDG_CONFIG_HOME/zsh. Cela fait initialiser ZDOTDIR
à
$XDG_CONFIG_HOME/zsh dans ~/.zshenv. Le processus de démarrage
du shell continuera avec $XDG_CONFIG_HOME/zsh/.zshenv.
environment-variables
(par défaut : '()
) (type : liste d’association)Une liste d’association de variables d’environnement à initialiser dans la session Zsh.
zshenv
(par défaut : '()
) (type : text-config)Liste d’objets simili-fichiers qui seront ajoutés à .zshenv. C’est
utilisé pour initialiser les variables d’environnement du shell. Elle ne
doit pas contenir de commande qui suppose la présence d’un tty ou qui
produise une sortie. Cela sera toujours lu, et toujours avant tout autre
fichiers dans ZDOTDIR
.
zprofile
(par défaut : '()
) (type : text-config)Liste d’objets simili-fichiers qui seront ajoutés à .zprofile. C’est utilisé pour exécuter des commandes au démarrage d’un shell de connexion (dans la plupart des cas le shell démarré sur un tty après la connexion). Elle sera lue avant .zlogin.
zshrc
(par défaut : '()
) (type : text-config)Liste d’objets simili-fichiers qui seront ajoutés à .zshrc. C’est
utilisé pour exécuter des commandes au démarrage d’un shell interactif (le
shell utilisé de manière interactive démarré en tapant zsh
ou par
votre application de terminal ou toute autre application).
zlogin
(par défaut : '()
) (type : text-config)Liste d’objets simili-fichiers qui seront ajoutés à .zlogin. C’est utilisé pour exécuter des commandes à la fin du processus de démarrage du shell de connexion.
zlogout
(par défaut : '()
) (type : text-config)Liste d’objets simili-fichiers qui seront ajoutés à .zlogout. C’est utilisé pour exécuter des commandes à la sortie d’un shell de connexion. Elle ne sera pas lue dans certains cas (si le shell termine après avoir utilisé exec sur un autre processus par exemple).
The GNU Readline
package includes Emacs and vi editing modes, with the ability to customize
the configuration with settings in the ~/.inputrc file. With the
gnu home services shells
module, you can setup your readline
configuration in a predictable manner, as shown below. For more information
about configuring an ~/.inputrc file, voir Readline Init File dans GNU Readline.
This is the service to setup various .inputrc configurations. The settings in .inputrc are read by all programs which are linked with GNU Readline.
Voici un exemple de service et sa configuration que vous pouvez ajouter au
champ services
de votre home-environment
:
(service home-inputrc-service-type
(home-inputrc-configuration
(key-bindings
`(("Control-l" . "clear-screen")))
(variables
`(("bell-style" . "visible")
("colored-completion-prefix" . #t)
("editing-mode" . "vi")
("show-mode-in-prompt" . #t)))
(conditional-constructs
`(("$if mode=vi" .
,(home-inputrc-configuration
(variables
`(("colored-stats" . #t)
("enable-bracketed-paste" . #t)))))
("$else" .
,(home-inputrc-configuration
(variables
`(("show-all-if-ambiguous" . #t)))))
("endif" . #t)
("$include" . "/etc/inputrc")
("$include" . ,(file-append
(specification->package "readline")
"/etc/inputrc"))))))
The example above starts with a combination of key-bindings
and
variables
. The conditional-constructs
show how it is possible
to add conditionals and includes. In the example above colored-stats
is only enabled if the editing mode is vi
style, and it also reads
any additional configuration located in /etc/inputrc or in
/gnu/store/…-readline/etc/inputrc.
The value associated with a home-inputrc-service-type
instance must
be a home-inputrc-configuration
record, as described below.
Available home-inputrc-configuration
fields are:
key-bindings
(default: '()
) (type: alist)Association list of readline key bindings to be added to the ~/.inputrc file.
'((\"Control-l\" . \"clear-screen\"))
devienne
Control-l: clear-screen
variables
(default: '()
) (type: alist)Association list of readline variables to set.
'((\"bell-style\" . \"visible\") (\"colored-completion-prefix\" . #t))
devienne
set bell-style visible set colored-completion-prefix on
conditional-constructs
(default: '()
) (type: alist)Association list of conditionals to add to the initialization file. This
includes $if
, else
, endif
and
include
and they receive a value of another
home-inputrc-configuration
.
(conditional-constructs
`((\"$if mode=vi\" .
,(home-inputrc-configuration
(variables
`((\"show-mode-in-prompt\" . #t)))))
(\"$else\" .
,(home-inputrc-configuration
(key-bindings
`((\"Control-l\" . \"clear-screen\")))))
(\"$endif\" . #t)))
devienne
$if mode=vi set show-mode-in-prompt on $else Control-l: clear-screen $endif
extra-content
(default: ""
) (type: text-config)Extra content appended as-is to the configuration file. Run man
readline
for more information about all the configuration options.
Suivant: Services personnels de gestion de l’énergie, Précédent: Shells, Monter: Services du dossier personnel [Table des matières][Index]
Le module (gnu home services mcron)
fournit une interface pour
GNU mcron, un démon qui lance des tâches planifiées (voir GNU mcron). Les informations sur le mcron du système
s’appliquent ici aussi (voir Exécution de tâches planifiées), la seule
différence pour les services personnels et qu’ils doivent être déclarés dans
un enregistrement home-environment
au lieu d’un enregistrement
operating-system
.
C’est le type du service personnel mcron
, dont la valeur est un objet
home-mcron-configuration
. Il permet de gérer des tâches planifiées.
Ce type de service peut être la cible d’une extension de service qui fournit des spécifications de tâches supplémentaires (voir Composition de services). En d’autres termes, il est possible de définir des services qui fournissent des tâches mcron à lancer.
Les champs de home-mcron-configuration
disponibles sont :
mcron
(par défaut : mcron
) (type : simili-fichier)Le paquet mcron à utiliser.
jobs
(par défaut : '()
) (type : liste-de-gexps)C’est la liste des gexps (voir G-Expressions), où chaque gexp correspond à une spécification de tâche de mcron (voir mcron job specifications dans GNU mcron).
log?
(par défaut : #t
) (type : booléen)Journalise les messages sur la sortie standard.
log-format
(par défaut : "~1@*~a ~a: ~a~%"
) (type : chaine)Chaine de format (ice-9 format)
pour les message de journaux. La
valeur par défaut produit des messages de type « ‘pid name:
message’ » (voir Invoking dans GNU mcron). Chaque message est aussi préfixé par un horodatage
par le GNU Shepherd.
Suivant: Gérer les démons personnels, Précédent: Exécution de tâches planifiées personnelles, Monter: Services du dossier personnel [Table des matières][Index]
Le module (gnu home services pm)
fournit des services personnels pour
la gestion de la batterie.
Service pour batsignal
, un programme un surveille le niveau de
batterie et vous averti à travers des notifications du bureau lorsque la
batterie est presque vide. Vous pouvez aussi configurer une commande à
lancer lorsque le niveau de batterie descend en dessous d’un seuil «
dangereux ». Ce service est configuré avec l’enregistrement
home-batsignal-configuration
.
Type données qui représente la configuration de batsignal.
warning-level
(par défaut : 15
)Le niveau de batterie auquel envoyer un message d’avertissement.
warning-message
(par défaut : #f
)Le message à envoyer dans une notification lorsque le niveau de batterie
atteint le warning-level
. Indiquer #f
utilise le message par
défaut.
critical-level
(par défaut : 5
)Le niveau de batterie auquel envoyer un message critique.
critical-message
(par défaut : #f
)Le message à envoyer dans une notification lorsque le niveau de batterie
atteint le critical-level
. Indiquer #f
utilise le message par
défaut.
danger-level
(par défaut : 2
)Le niveau de batterie auquel lancer la danger-command
.
danger-command
(par défaut : #f
)La commande à lancer lorsque le niveau de batterie atteint le
danger-level
. Indiquer #f
désactive complètement l’exécution
de la commande.
full-level
(par défaut : #f
)Le niveau de batterie auquel envoyer le message de plein. Indiquer #f
désactive l’envoie du message de plein.
full-message
(par défaut : #f
)Le message à envoyer dans une notification lorsque le niveau de batterie
atteint le full-level
. Indiquer #f
utiliser le message par
défaut.
batteries
(par défaut : '()
)Les batteries à surveiller. Indiquer '()
essaye de trouver les
batteries automatiquement.
poll-delay
(par défaut : 60
)Le temps d’attente en secondes avant de revérifier la batterie.
icon
(par défaut : #f
)Un objet simili-fichier à utiliser comme icône pour les notifications de la
batterie. Indiquer #f
désactive complètement l’icône de notification.
notifications?
(par défaut : #t
)S’il faut envoyer des notifications.
notifications-expire?
(par défaut : #f
)Indique si les notifications envoyées expirent après un certain temps.
notification-command
(par défaut : #f
)Commande à utiliser pour envoyer les messages. Indiquer #f
envoie une
notification à travers libnotify
.
ignore-missing?
(par défaut : #f
)Indique s’il faut ignorer les erreurs de batterie manquante.
Suivant: Shell sécurisé, Précédent: Services personnels de gestion de l’énergie, Monter: Services du dossier personnel [Table des matières][Index]
Le module (gnu home services shepherd)
prend en charge la définition
de services Shepherd par utilisateur (voir Introduction dans le
manuel de GNU Shepherd). Vous pouvez étendre
home-shepherd-service-type
avec de nouveaux services ; Guix Home se
chargera ensuite de démarrer le démon shepherd
pour vous à la
connexion, ce qui démarrera ensuite les services que vous avez demandés.
Le type de service pour le shepherd en espace utilisateur, qui vous permet de gérer les processus longs ou les tâches uniques. Le shepherd personnel n’est pas un processus d’init (PID 1), mais presque toutes les information décrites dans Services Shepherd sont applicables ici aussi.
C’est le type de service que les extensions ciblent lorsqu’elles veulent
créer un service shepherd (voir Types service et services, pour un
exemple). Chaque extension doit passer une liste de
<shepherd-service>
. Sa valeur doit être un
home-shepherd-configuration
, décrit plus bas.
Ce type de données représente la configuration du Shepherd.
shepherd (par défaut : shepherd
)
Le paquet Shepherd à utiliser.
auto-start? (par défaut : #t
)
Indique s’il faut lancer le Shepherd à la première connexion.
daemonize? (default: #t
)
Whether or not to run Shepherd in the background.
silent? (default: #t
)
When true, the shepherd
process does not write anything to
standard output when started automatically.
services (par défaut : '()
)
Une liste de <shepherd-service>
à démarrer. Vous devriez probablement
utiliser le mécanisme d’extensions des services à la place (voir Services Shepherd).
Suivant: GNU Privacy Guard, Précédent: Gérer les démons personnels, Monter: Services du dossier personnel [Table des matières][Index]
Le paquet OpenSSH contient un client, la
commande ssh
, qui vous permet de vous connecter à des machines
distantes avec le protocole SSH (shell sécurisé). Avec le module
(gnu home services ssh)
, vous pouvez configurer OpenSSH pour qu’il
fonctionne de manière prédictible, presque indépendamment de l’état de la
machine locale. Pour cela, vous devez instancier
home-openssh-service-type
dans votre configuration personnelle, comme
expliqué plus bas.
C’est le type de service pour configurer le client OpenSSH. Il a les fonctionnalités suivantes :
ssh
connaisse les hôtes auxquels vous vous connectez
régulièrement et leurs paramètres associés ;
sshd
, peut accepter pour se connecter à ce
compte utilisateur ;
Voici un exemple de service et sa configuration que vous pouvez ajouter au
champ services
de votre home-environment
:
(service home-openssh-service-type
(home-openssh-configuration
(hosts
(list (openssh-host (name "ci.guix.gnu.org")
(user "charlie"))
(openssh-host (name "chbouib")
(host-name "chbouib.example.org")
(user "supercharlie")
(port 10022))))
(authorized-keys (list (local-file "alice.pub")))))
L’exemple au-dessus liste deux hôtes et leurs paramètres. Par exemple,
lancer ssh chbouib
se connectera automatiquement à
chbouib.example.org
sur le port 10022, en se connectant en tant que
‘supercharlie’. En plus, il marque la clé publique dans
alice.pub comme autorisée pour les connexions entrantes.
La valeur associée à une instance de home-openssh-service-type
doit
être un enregistrement home-openssh-configuration
, décrit ci-dessous.
C’est le type de données représentant la configuration du client et du serveur OpenSSH dans l’environnement personnel. Il possède les champs suivants :
hosts
(par défaut : '()
)Une liste d’enregistrements openssh-host
qui spécifient les noms
d’hôte et les paramètres de connexion associés (voir plus bas). Cet liste
d’hôtes va dans ~/.ssh/config, que ssh
lit au démarrage.
known-hosts
(par défaut : *unspecified*
)Cela doit être soit :
*unspecified*
, auquel cas home-openssh-service-type
laisse à
ssh
et à l’utilisateur le soit de maintenir la liste des hôtes
connus dans ~/.ssh/known_hosts, ou
Le fichier ~/.ssh/known_hosts contient une liste de paires de nom
d’hôte et de clé d’hôte qui permet à ssh
d’authentifier les hôtes
auxquels vous vous connectez et de détecter de potentielles attaques par
usurpation. Par défaut, ssh
la met à jour sur la base du principe
TOFU, confiance à la première utilisation, ce qui signifie qu’il
enregistre la clé d’hôte dans ce fichier la première fois que vous vous
connectez. Ce comportement est préservé si known-hosts
est indiqué à
*unspecified*
.
Si vous fournissez à la place une liste de clés d’hôtes dès le départ dans
le champ known-hosts
, votre configuration devient auto-contenue et
sans état : elle peut être répliquée ailleurs ou à un autre moment. Préparer
cette liste peut être plutôt compliqué cependant, c’est pourquoi
*unspecified*
reste la valeur par défaut.
authorized-keys
(par défaut : #false
)The default #false
value means: Leave any
~/.ssh/authorized_keys file alone. Otherwise, this must be a list of
file-like objects, each of which containing an SSH public key that should be
authorized to connect to this machine.
Concrètement, ces fichiers sont concaténés et rendus disponibles dans
~/.ssh/authorized_keys. Si un serveur OpenSSH, sshd
, est
lancé sur cette machine, alors il peut prendre ce fichier en compte :
c’est ce que sshd
fait par défaut, mais soyez conscient qu’il peut
aussi être configuré pour l’ignorer.
add-keys-to-agent
(default: no
)This string specifies whether keys should be automatically added to a
running ssh-agent. If this option is set to yes
and a key is loaded
from a file, the key and its passphrase are added to the agent with the
default lifetime, as if by ssh-add
. If this option is set to
ask
, ssh
will require confirmation. If this option is set to
confirm
, each use of the key must be confirmed. If this option is
set to no
, no keys are added to the agent. Alternately, this option
may be specified as a time interval to specify the key’s lifetime in
ssh-agent
, after which it will automatically be removed. The
argument must be no
, yes
, confirm
(optionally followed
by a time interval), ask
or a time interval.
Les champs de openssh-host
disponibles sont :
name
(type : string)Name of this host declaration. A openssh-host
must define only
name
or match-criteria
. Use host-name \"*\"
for
top-level options.
host-name
(type : peut-être-chaine)Nom d’hôte — p. ex. "toto.exemple.org"
ou "192.168.1.2"
.
match-criteria
(type: maybe-match-criteria)When specified, this string denotes the set of hosts to which the entry
applies, superseding the host-name
field. Its first element must be
all or one of ssh-match-keywords
. The rest of the elements are
arguments for the keyword, or other criteria. A openssh-host
must
define only name
or match-criteria
. Other host configuration
options will apply to all hosts matching match-criteria
.
address-family
(type: maybe-address-family)Address family to use when connecting to this host: one of AF_INET
(for IPv4 only), AF_INET6
(for IPv6 only). Additionally, the field
can be left unset to allow any address family.
identity-file
(type : peut-être-chaine)Le fichier d’identité à utiliser — p. ex.
"/home/charlie/.ssh/id_ed25519"
.
port
(type : peut-être-entier-naturel)Numéro de port TCP sur lequel se connecter.
user
(type : peut-être-chaine)Le nom d’utilisateur sur la machine distante.
forward-x11?
(type: maybe-boolean)Indique s’il faut relayer les connexions clientes distantes vers l’affichage graphique X11 local.
forward-x11-trusted?
(type: maybe-boolean)Indique si les client X11 distants ont l’accès complet à l’affichage graphique X11 original.
forward-agent?
(type: maybe-boolean)Indique si l’agent d’authentification (s’il y en a un) est relayé vers la machine distante.
compression?
(type: maybe-boolean)Indique s’il faut compresser les données en transit.
proxy
(type: maybe-proxy-command-or-jump-list)The command to use to connect to the server or a list of SSH hosts to jump
through before connecting to the server. The field may be set to either a
proxy-command
or a list of proxy-jump
records.
As an example, a proxy-command
to connect via an HTTP proxy at
192.0.2.0 would be constructed with: (proxy-command "nc -X connect -x
192.0.2.0:8080 %h %p")
.
Available proxy-jump
fields are:
user
(type : peut-être-chaine)Le nom d’utilisateur sur la machine distante.
host-name
(type: string)Host name—e.g., foo.example.org
or 192.168.1.2
.
port
(type : peut-être-entier-naturel)Numéro de port TCP sur lequel se connecter.
host-key-algorithms
(type : peut-être-liste-de-chaine)La liste des algorithmes de clé hôtes acceptées — p. ex.
'("ssh-ed25519")
.
accepted-key-types
(type : peut-être-liste-de-chaine)La liste des types de clés publiques utilisatrices acceptées.
extra-content
(par défaut : ""
) (type : raw-configuration-string)Contenu supplémentaire ajouté tel-quel à la fin de ce block Host
dans
~/.ssh/config.
The parcimonie
service runs a daemon that slowly refreshes a GnuPG
public key from a keyserver. It refreshes one key at a time; between every
key update parcimonie sleeps a random amount of time, long enough for the
previously used Tor circuit to expire. This process is meant to make it
hard for an attacker to correlate the multiple key update.
As an example, here is how you would configure parcimonie
to refresh
the keys in your GnuPG keyring, as well as those keyrings created by Guix,
such as when running guix import
:
(service home-parcimonie-service-type
(home-parcimonie-configuration
(refresh-guix-keyrings? #t)))
This assumes that the Tor anonymous routing daemon is already running on
your system. On Guix System, this can be achieved by setting up
tor-service-type
(voir tor-service-type
).
The service reference is given below.
This is the service type for parcimonie
(Parcimonie’s web
site). Its value must be a home-parcimonie-configuration
, as shown
below.
Available home-parcimonie-configuration
fields are:
parcimonie
(default: parcimonie
) (type: file-like)The parcimonie package to use.
verbose?
(default: #f
) (type: boolean)Whether to have more verbose logging from the service.
gnupg-already-torified?
(default: #f
) (type: boolean)Whether GnuPG is already configured to pass all traffic through Tor.
refresh-guix-keyrings?
(default: #f
) (type: boolean)Guix creates a few keyrings in the $XDG_CONFIG_DIR, such as when
running guix import
(voir Invoquer guix import
). Setting this to
#t
will also refresh any keyrings which Guix has created.
extra-content
(default: #f
) (type: raw-configuration-string)Raw content to add to the parcimonie command.
The OpenSSH package includes a daemon, the
ssh-agent
command, that manages keys to connect to remote machines
using the SSH (secure shell) protocol. With the (gnu home
services ssh)
service, you can configure the OpenSSH ssh-agent to run upon
login. Voir home-gpg-agent-service-type
, for an
alternative to OpenSSH’s ssh-agent
.
Voici un exemple de service et sa configuration que vous pouvez ajouter au
champ services
de votre home-environment
:
(service home-ssh-agent-service-type
(home-ssh-agent-configuration
(extra-options '("-t" "1h30m"))))
This is the type of the ssh-agent
home service, whose value is a
home-ssh-agent-configuration
object.
Available home-ssh-agent-configuration
fields are:
openssh
(default: openssh
) (type: file-like)Le paquet OpenSSH à utiliser.
socket-directory
(default: XDG_RUNTIME_DIR
/ssh-agent"
) (type: gexp)The directory to write the ssh-agent’s socket file.
extra-options
(par défaut : '()
)Extra options will be passed to ssh-agent
, please run man
ssh-agent
for more information.
Suivant: Services personnels pour ordinateur de bureau, Précédent: Shell sécurisé, Monter: Services du dossier personnel [Table des matières][Index]
The (gnu home services gnupg)
module provides services that help you
set up the GNU Privacy Guard, also known as GnuPG or GPG, in your home
environment.
The gpg-agent
service configures and sets up GPG’s agent, the program
that is responsible for managing OpenPGP private keys and, optionally,
OpenSSH (secure shell) private keys (voir Invoking GPG-AGENT dans Using the GNU Privacy Guard).
As an example, here is how you would configure gpg-agent
with SSH
support such that it uses the Emacs-based Pinentry interface when prompting
for a passphrase:
(service home-gpg-agent-service-type
(home-gpg-agent-configuration
(pinentry-program
(file-append pinentry-emacs "/bin/pinentry-emacs"))
(ssh-support? #t)))
The service reference is given below.
This is the service type for gpg-agent
(voir Invoking
GPG-AGENT dans Using the GNU Privacy Guard). Its value must be a
home-gpg-agent-configuration
, as shown below.
Available home-gpg-agent-configuration
fields are:
gnupg
(default: gnupg
) (type: file-like)The GnuPG package to use.
pinentry-program
(type: file-like)Pinentry program to use. Pinentry is a small user interface that
gpg-agent
delegates to anytime it needs user input for a
passphrase or PIN (personal identification number) (voir Using the PIN-Entry).
ssh-support?
(default: #f
) (type: boolean)Whether to enable SSH (secure shell) support. When true,
gpg-agent
acts as a drop-in replacement for OpenSSH’s
ssh-agent
program, taking care of OpenSSH secret keys and
directing passphrase requests to the chosen Pinentry program.
default-cache-ttl
(default: 600
) (type: integer)Time a cache entry is valid, in seconds.
max-cache-ttl
(default: 7200
) (type: integer)Maximum time a cache entry is valid, in seconds. After this time a cache entry will be expired even if it has been accessed recently.
default-cache-ttl-ssh
(default: 1800
) (type: integer)Time a cache entry for SSH keys is valid, in seconds.
max-cache-ttl-ssh
(default: 7200
) (type: integer)Maximum time a cache entry for SSH keys is valid, in seconds.
extra-content
(par défaut : ""
) (type : raw-configuration-string)Raw content to add to the end of ~/.gnupg/gpg-agent.conf.
Suivant: Services personnels Guix, Précédent: GNU Privacy Guard, Monter: Services du dossier personnel [Table des matières][Index]
Le module (gnu home services desktop)
fournit des services que vous
trouverez pratique sur un système « de bureau » possédant un environnement
utilisateur graphique comme Xorg.
This is the service type representing the X Window graphical display server (also referred to as “X11”).
X Window is necessarily started by a system service; on Guix System,
starting it is the responsibility of gdm-service-type
and similar
services (voir Système de fenêtrage X). At the level of Guix Home, as an unprivileged
user, we cannot start X Window; all we can do is check whether it is
running. This is what this service does.
As a user, you probably don’t need to worry or explicitly instantiate
home-x11-service-type
. Services that require an X Window graphical
display, such as home-redshift-service-type
below, instantiate it and
depend on its corresponding x11-display
Shepherd service
(voir Gérer les démons personnels).
When X Window is running, the x11-display
Shepherd service starts and
sets the DISPLAY
environment variable of the shepherd
process, using its original value if it was already set; otherwise, it fails
to start.
The service can also be forced to use a given value for DISPLAY
, like
so:
herd start x11-display :3
In the example above, x11-display
is instructed to set DISPLAY
to :3
.
Il s’agit du type de service pour Redshift, un programme qui ajuste la température des couleurs de
l’affichage suivant l’heure de la journée. Sa valeur associée doit être un
home-redshift-configuration
comme indiqué ci-dessous.
Une configuration typique, où nous spécifions la latitude et la longitude manuellement, ressemblerait à ceci :
(service home-redshift-service-type (home-redshift-configuration (location-provider 'manual) (latitude 35.81) ;hémisphère nord (longitude -0.80))) ;ouest de Greenwich
Les champs de home-redshift-configuration
disponibles sont :
redshift
(par défaut : redshift
) (type : simili-fichier)Le paquet Redshift à utiliser.
location-provider
(par défaut : geoclue2
) (type : symbol)Fournisseur de géolocalisation — 'manual
ou 'geoclue2
. Dans
le premier cas, vous devez aussi spécifier les champs latitude
et
longitude
pour que Redshift puisse déterminer les heures de jour et
de nuit là où vous vous trouve. Dans le deuxième cas, le service système
Geoclue doit être lancé ; Redshift lui demandera les informations de
localisation.
adjustment-method
(par défaut : randr
) (type : symbol)Méthode d’ajustement des couleurs.
daytime-temperature
(par défaut : 6500
) (type : integer)Température des couleurs pour le jour (en kelvins).
nighttime-temperature
(par défaut : 4500
) (type : entier)Température des couleurs pour la nuit (en kelvins).
daytime-brightness
(type : peut-être-nombre-inexact)Luminosité de l’écran en journée, entre 0.1 et 1.0, ou non spécifiée.
nighttime-brightness
(type : peut-être-nombre-inexact)Luminosité de l’écran la nuit, entre 0.1 et 1.0, ou non spécifiée.
latitude
(type : peut-être-nombre-inexact)Latitude, lorsque location-provider
est 'manual
.
longitude
(type : peut-être-nombre-inexact)Longitude, lorsque location-provider
est 'manual
.
dawn-time
(type : peut-être-chaine)Heure personnalisée de transition entre la nuit et le jour le matin — au
format "HH:MM"
. Lorsque la valeur est spécifiée, l’élévation du
soleil n’est pas utilisée pour déterminer le cycle jour-nuit.
dusk-time
(type : peut-être-chaine)De même, heure personnalisée pour la transition entre le jour et la nuit en soirée.
extra-content
(par défaut : ""
) (type : raw-configuration-string)Contenu supplémentaire ajouté tel quel à la fin du fichier de configuration
de Redshift. Lancez man redshift
pour plus d’informations sur le
format du fichier de configuration.
C’est le type de service pour lancer un D-Bus spécifique à la session, pour les applications non privilégiées qui nécessitent que D-Bus soit lancé.
L’enregistrement de configuration pour home-dbus-service-type
.
dbus
(par défaut : dbus
)Le paquet qui fournit la commande /bin/dbus-daemon
.
This is the service type for Unclutter, a program that runs on the
background of an X11 session and detects when the X pointer hasn’t moved for
a specified idle timeout, after which it hides the cursor so that you can
focus on the text underneath. Its associated value must be a
home-unclutter-configuration
record, as shown below.
A typical configuration, where we manually specify the idle timeout (in seconds), might look like this:
(service home-unclutter-service-type
(home-unclutter-configuration
(idle-timeout 2)))
The configuration record for home-unclutter-service-type
.
unclutter
(default: unclutter
) (type: file-like)Unclutter package to use.
idle-timeout
(default: 5
) (type: integer)A timeout in seconds after which to hide cursor.
This is the service type for the
xmodmap utility to
modify keymaps and pointer button mappings under the Xorg display server.
Its associated value must be a home-xmodmap-configuration
record, as
shown below.
The key-map
field takes a list of objects, each of which is either a
statement (a string) or an assignment (a pair of strings). As
an example, the snippet below swaps around the Caps_Lock and the
Control_L keys, by first removing the keysyms (on the right-hand side)
from the corresponding modifier maps (on the left-hand side), re-assigning
them by swapping each other out, and finally adding back the keysyms to the
modifier maps.
(service home-xmodmap-service-type
(home-xmodmap-configuration
(key-map '(("remove Lock" . "Caps_Lock")
("remove Control" . "Control_L")
("keysym Control_L" . "Caps_Lock")
("keysym Caps_Lock" . "Control_L")
("add Lock" . "Caps_Lock")
("add Control" . "Control_L")))))
The configuration record for home-xmodmap-service-type
. Its
available fields are:
xmodmap
(default: xmodmap
) (type: file-like)The xmodmap
package to use.
key-map
(default: '()
) (type: list)The list of expressions to be read by xmodmap
on service startup.
Add startx
to the home profile putting it onto PATH
.
The value for this service is a <xorg-configuration>
object which is
passed to the xorg-start-command-xinit
procedure producing the
startx
used. Default value is (xorg-configuration)
.
Suivant: Services personnels pour les polices, Précédent: Services personnels pour ordinateur de bureau, Monter: Services du dossier personnel [Table des matières][Index]
Le module (gnu home services guix)
fournit des services pour la
configuration de Guix de l’utilisateur ou utilisatrice.
C’est le type de service qui gère $XDG_CONFIG_HOME/guix/channels.scm,
le fichier qui contrôle les canaux reçus par guix pull
(voir Canaux). Sa valeur associée est une liste d’enregistrements
channel
, définis dans le module (guix channels)
.
En général il vaut mieux étendre ce service que de le configurer
directement, car sa valeur par défaut est le canal guix par défaut défini
par %default-channels
. Si vous configurez ce service directement,
assurez-vous d’inclure un canal guix. Voir Spécifier des canaux supplémentaires
et Utiliser un canal Guix personnalisé pour plus de détails.
Une extension typique pour ajouter un canal ressemblerait à ceci :
(simple-service 'variant-packages-service
home-channels-service-type
(list
(channel
(name 'variant-packages)
(url "https://example.org/variant-packages.git"))))
Suivant: Services de son personnels, Précédent: Services personnels Guix, Monter: Services du dossier personnel [Table des matières][Index]
Le module (gnu home services fontutils)
fournit des services pour la
configuration personnelle de Fontconfig. La bibliothèque
Fontconfig est
utilisée par de nombreuses applications pour accéder aux polices du système.
This is the service type for generating configurations for Fontconfig. Its
associated value is a list of either strings (or gexps) pointing to fonts
locations, or SXML (voir SXML dans GNU Guile Reference Manual)
fragments to be converted into XML and put inside the main fontconfig
node.
En général il vaut mieux étendre ce service que de le configurer directement, car sa valeur par défaut est le chemin d’installation des polices du profile personnel (~/.guix-home/profile/share/fonts). Si vous configurez ce service directement, assurez-vous d’inclure ce répertoire.
Here’s how you’d extend it to include fonts installed with the Nix package manager, and to prefer your favourite monospace font:
(simple-service 'additional-fonts-service
home-fontconfig-service-type
(list "~/.nix-profile/share/fonts"
'(alias
(family "monospace")
(prefer
(family "Liberation Mono")))))
Suivant: Mail Home Services, Précédent: Services personnels pour les polices, Monter: Services du dossier personnel [Table des matières][Index]
The (gnu home services sound)
module provides services related to
sound support.
The following services dynamically reconfigure the
PulseAudio sound server: they let you toggle
broadcast of audio output over the network using the RTP (real-time
transport protocol) and, correspondingly, playback of sound received over
RTP. Once home-pulseaudio-rtp-sink-service-type
is among your home
services, you can start broadcasting audio output by running this command:
herd start pulseaudio-rtp-sink
You can then run a PulseAudio-capable mixer, such as pavucontrol
or
pulsemixer
(both from the same-named package) to control which audio
stream(s) should be sent to the RTP “sink”.
By default, audio is broadcasted to a multicast address: any device on the LAN (local area network) receives it and may play it. Using multicast in this way puts a lot of pressure on the network and degrades its performance, so you may instead prefer sending to specifically one device. The first way to do that is by specifying the IP address of the target device when starting the service:
herd start pulseaudio-rtp-sink 192.168.1.42
The other option is to specify this IP address as the one to use by default in your home environment configuration:
(service home-pulseaudio-rtp-sink-service-type
"192.168.1.42")
On the device where you intend to receive and play the RTP stream, you can
use home-pulseaudio-rtp-source-service-type
, like so:
This will then let you start the receiving module for PulseAudio:
herd start pulseaudio-rtp-source
Again, by default it will listen on the multicast address. If, instead, you’d like it to listen for direct incoming connections, you can do that by running:
(service home-pulseaudio-rtp-source-service-type
"0.0.0.0")
The reference of these services is given below.
This is the type of the service to send, respectively receive, audio streams over RTP (real-time transport protocol).
The value associated with this service is the IP address (a string) where
to send, respectively receive, the audio stream. By default, audio is
sent/received on multicast address %pulseaudio-rtp-multicast-address
.
This service defines one Shepherd service: pulseaudio-rtp-sink
,
respectively pulseaudio-rtp-source
. The service is not started by
default, so you have to explicitly start it when you want to turn it on, as
in this example:
herd start pulseaudio-rtp-sink
Stopping the Shepherd service turns off broadcasting.
This is the multicast address used by default by the two services above.
PipeWire provides a low-latency, graph-based audio and video processing service. In addition to its native protocol, it can also be used as a replacement for both JACK and PulseAudio.
While PipeWire provides the media processing and API, it does not, directly,
know about devices such as sound cards, nor how you might want to connect
applications, hardware, and media processing filters. Instead, PipeWire
relies on a session manager to specify all these relationships. While
you may use any session manager you wish, for most people the
WirePlumber
session manager, a reference implementation provided by the PipeWire project
itself, suffices, and that is the one home-pipewire-service-type
uses.
PipeWire can be used as a replacement for PulseAudio by setting
enable-pulseaudio?
to #t
in
home-pipewire-configuration
, so that existing PulseAudio clients may
use it without any further configuration.
In addition, JACK clients may connect to PipeWire by using the
pw-jack
program, which comes with PipeWire. Simply prefix the
command with pw-jack
when you run it, and audio data should go
through PipeWire:
pw-jack mpv -ao=jack sound-file.wav
For more information on PulseAudio emulation, see https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-PulseAudio, for JACK, see https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-JACK.
As PipeWire does not use dbus
to start its services on demand (as
PulseAudio does), home-pipewire-service-type
uses Shepherd to start
services when logged in, provisioning the pipewire
,
wireplumber
, and, if configured, pipewire-pulseaudio
services. Voir Gérer les démons personnels.
This provides the service definition for pipewire
, which will run
on login. Its value is a home-pipewire-configuration
object.
To start the service, add it to the service
field of your
home-environment
, such as:
Available home-pipewire-configuration
fields are:
pipewire
(default: pipewire
) (type: file-like)The PipeWire package to use.
wireplumber
(default: wireplumber
) (type: file-like)The WirePlumber package to use.
enable-pulseaudio?
(default: #t
) (type: boolean)When true, enable PipeWire’s PulseAudio emulation support, allowing PulseAudio clients to use PipeWire transparently.
Suivant: Messaging Home Services, Précédent: Services de son personnels, Monter: Services du dossier personnel [Table des matières][Index]
The (gnu home services mail)
module provides services that help you
set up the tools to work with emails in your home environment.
MSMTP is a SMTP (Simple Mail Transfer Protocol) client. It sends mail to a predefined SMTP server that takes care of proper delivery.
The service reference is given below.
This is the service type for msmtp
. Its value must be a
home-msmtp-configuration
, as shown below. It provides the
~/.config/msmtp/config file.
As an example, here is how you would configure msmtp
for a single
account:
(service home-msmtp-service-type
(home-msmtp-configuration
(accounts
(list
(msmtp-account
(name "alice")
(configuration
(msmtp-configuration
(host "mail.example.org")
(port 587)
(user "alice")
(password-eval "pass Mail/alice"))))))))
Available home-msmtp-configuration
fields are:
defaults
(type: msmtp-configuration)The configuration that will be set as default for all accounts.
accounts
(default: '()
) (type: list-of-msmtp-accounts)A list of msmtp-account
records which contain information about all
your accounts.
default-account
(type: maybe-string)Set the default account.
extra-content
(default: ""
) (type: string)Extra content appended as-is to the configuration file. Run man
msmtp
for more information about the configuration file format.
Available msmtp-account
fields are:
name
(type : string)The unique name of the account.
configuration
(type: msmtp-configuration)The configuration for this given account.
Available msmtp-configuration
fields are:
auth?
(type: maybe-boolean)Enable or disable authentication.
tls?
(type: maybe-boolean)Enable or disable TLS (also known as SSL) for secured connections.
tls-starttls?
(type: maybe-boolean)Choose the TLS variant: start TLS from within the session (‘on’, default), or tunnel the session through TLS (‘off’).
tls-trust-file
(type: maybe-string)Activate server certificate verification using a list of trusted Certification Authorities (CAs).
log-file
(type: maybe-string)Enable logging to the specified file. An empty argument disables logging. The file name ‘-’ directs the log information to standard output.
host
(type: maybe-string)The SMTP server to send the mail to.
port
(type: maybe-integer)The port that the SMTP server listens on. The default is 25 ("smtp"), unless TLS without STARTTLS is used, in which case it is 465 ("smtps").
user
(type : peut-être-chaine)Set the user name for authentication.
from
(type: maybe-string)Set the envelope-from address.
password-eval
(type: maybe-string)Set the password for authentication to the output (stdout) of the command cmd.
extra-content
(default: ""
) (type: string)Extra content appended as-is to the configuration block. Run man
msmtp
for more information about the configuration file format.
Suivant: Media Home Services, Précédent: Mail Home Services, Monter: Services du dossier personnel [Table des matières][Index]
The ZNC bouncer can be run as a daemon to manage your
IRC presence. With the (gnu home services messaging)
service, you
can configure ZNC to run upon login.
You will have to provide a ~/.znc/configs/znc.conf separately.
Voici un exemple de service et sa configuration que vous pouvez ajouter au
champ services
de votre home-environment
:
This is the type of the ZNC home service, whose value is a
home-znc-configuration
object.
Available home-znc-configuration
fields are:
znc
(default: znc
) (type: file-like)The ZNC package to use.
extra-options
(par défaut : '()
)Extra options will be passed to znc
, please run man znc
for more information.
Suivant: Sway window manager, Précédent: Messaging Home Services, Monter: Services du dossier personnel [Table des matières][Index]
The Kodi media center can be run as a daemon on a
media server. With the (gnu home services kodi)
service, you can
configure Kodi to run upon login.
Voici un exemple de service et sa configuration que vous pouvez ajouter au
champ services
de votre home-environment
:
(service home-kodi-service-type
(home-kodi-configuration
(extra-options '("--settings="<settings-file>"))))
This is the type of the Kodi home service, whose value is a
home-kodi-configuration
object.
Available home-kodi-configuration
fields are:
kodi
(default: kodi
) (type: file-like)The Kodi package to use.
extra-options
(par défaut : '()
)Extra options will be passed to kodi
, please run man
kodi
for more information.
Suivant: Networking Home Services, Précédent: Media Home Services, Monter: Services du dossier personnel [Table des matières][Index]
Le module (gnu home services sway)
fournit
home-sway-service-type
, un service personnel permettant de configurer
le gestionnaire de fenêtre Sway pour
Wayland de manière déclarative.
Voici un exemple de service et sa configuration que vous pouvez ajouter au
champ services
de votre home-environment
:
(service home-sway-service-type
(sway-configuration
(gestures
'((swipe:3:down . "move to scratchpad")
(swipe:3:up . "scratchpad show")))
(outputs
(list (sway-output
(identifier '*)
(background (file-append sway
"\
/share/backgrounds/sway/Sway_Wallpaper_Blue_1920x1080.png")))))))
L’exemple ci-dessus décrit une configuration Sway dans laquelle
sway
package;
Remarque : This home service only sets up the configuration file and profile packages for Sway. It does not start Sway in any way. If you want to do so, you might be interested in using
greetd-wlgreet-sway-session
instead.The procedure
sway-configuration->file
defined below can be used to provide the value for the optionalsway-configuration
field ofgreetd-wlgreet-sway-session
.
This procedure takes one argument config
, which must be a
sway-configuration
record (defined below), and returns a file-like
object representing the serialized configuration.
This is a home service type to set up Sway. It takes care of:
This configuration record describes the Sway configuration (see sway(5)). Available fields are:
variables
(default: %sway-default-variables
)The value of this field is an association list in which keys are symbols and values are either strings, G-expressions or file-like objects (voir G-Expressions).
Example:
(variables `((mod . "Mod4") ; string
(term ; file-append
. ,(file-append foot "/bin/foot"))
(Term ; G-expression
. ,#~(string-append #$foot "/bin/foot"))))
Remarque : Default keybindings assume the existence of variables named
$mod
,$left
,$right
,$up
and$down
. If you choose not to define these variables, make sure to remove keybindings referring to them.
keybindings
(default: %sway-default-keybindings
)This field describes keybindings for the default mode. The value is an association list: keys are symbols and values are either strings or G-expressions.
The following snippet launches the terminal when pressing $mod+t and
$mod+Shift+t (assuming that a variable $term
is defined):
`(($mod+t . ,#~(string-append "exec " #$foot "/bin/foot")) ($mod+Shift+t . "exec $term"))
gestures
(default: %sway-default-gestures
)Similar to the previous field, but for finger-gestures.
The following snippet allows to navigate through workspaces by swiping right and left with three fingers:
'((swipe:3:right . "workspace next_on_output") (swipe:3:left . "workspace prev_on_output"))
packages
(default: %sway-default-packages
)This field describes a list of packages to add to the user profile. At the
moment, the default value only adds sway
to the profile.
inputs
(par défaut : '()
)List of sway-input
configuration records (described below).
outputs
(default: '()
)List of sway-output
configuration records (described below).
bar
(optional sway-bar
record)Optional sway-bar
record (described below) to configure a Sway bar.
modes
(default: %sway-default-modes
)List of sway-mode
records (described below) to add modes to the Sway
configuration. The default value %sway-default-modes
adds the
“resize” mode of the default Sway configuration (as described below).
startup+reload-programs
(default: '()
)Programs to execute at startup time and after every configuration reload. The value of this field is a list of strings, G-expressions or file-like objects (voir G-Expressions).
startup-programs
(default: %sway-default-execs
)Programs to execute at startup time. As above, values of this field are a list of strings, G-expressions or file-like objects.
The default value, %sway-default-execs
, executes swayidle
in
order to lock the screen after 5 minutes of inactivity (displaying a
background distributed with Sway) and turn the screen off after 10 minutes
of inactivity.
extra-content
(default: '()
)Lines to add to the configuration file. The value of this field is a list of strings or G-expressions.
sway-input
records describe input blocks (see sway-input(5)). For example, the following snippet makes all
keyboards use a French layout, in which capslock has been remapped to
ctrl:
(sway-input (identifier "type:keyboard")
(layout
(keyboard-layout "fr" #:options '("ctrl:nocaps"))))
Available fields for sway-input
configuration records are:
identifier
(default: '*
)Identifier of the input. The field accepts symbols and strings. If the
identifier
is a symbol, it is inserted as is; if it is a string, it
will be quoted in the configuration file.
layout
(optional <keyboard-layout>
record)Keyboard specific option. Field specifying the layout to use for the
input. The value must be a <keyboard-layout>
record (voir Disposition du clavier).
Remarque :
(gnu home services sway)
does not re-export thekeyboard-layout
procedure.
disable-while-typing
(optional boolean)If #t
(resp. #f
) enables (resp. disables) the “disable
while typing” option for this input.
disable-while-trackpointing
(optional boolean)If #t
(resp. #f
), enables (resp. disables) the “disable
while track-pointing” option for this input.
tap
(optional boolean)Enables or disables the “tap” option, which allows clicking by tapping on a touchpad.
extra-content
(default: '()
)Lines to add to the input block. The value of this field must a list whose elements are either strings or G-expressions.
sway-output
records describe Sway outputs (see sway-output(5)). Available fields are:
identifier
(default: '*
)Identifier of the monitor. The field accepts symbols and strings. If the
identifier
is a symbol, it is inserted as is; if it is a string, it
will be quoted in the configuration file.
resolution
(optional string)This string defines the resolution of the monitor.
position
(optional)The (optional) value of this field must be a point
. Example:
(position
(point (x 1920)
(y 0)))
background
(optional)The value of this field describes what wallpaper to use on this output. The field accepts the following types of values:
stretch
, fill
,
fit
, center
and tile
.
If the second element is not specified (i.e. when the value is not a
pair), the fill
mode will be used.
Remarque : In order to use an SVG file, you must have
librsvg
in your profile (e.g. by adding it in thepackages
field ofsway-configuration
).
extra-content
(default: '()
)List defining additional lines to add to the output configuration block. Elements of the list must be either strings or G-expressions.
border
Color of the border.
background
Color of the background.
text
Color of the text.
background
(optional string)Background color of the bar.
statusline
(optional string)Text color of the status line.
focused-background
(optional string)Background color of the bar on the currently focused monitor.
focused-statusline
(optional string)Text color of the statusline on the currently focused monitor.
focused-workspace
(optional sway-border-color
)Color scheme for focused workspaces.
active-workspace
(optional sway-border-color
)Color scheme for active workspaces.
inactive-workspace
(optional sway-border-color
)Color scheme for inactive workspaces.
urgent-workspace
(optional sway-border-color
)Color scheme for workspaces containing “urgent windows”.
binding-mode
(optional sway-border-color
)Color scheme for the binding mode indicator.
Describes the Sway bar (see sway-bar(5)).
identifier
(default: 'bar0
)Identifier of the bar. The value must be a symbol.
position
(optional)Specify the position of the bar. Accepted values are 'top
or
'bottom
.
hidden-state
(optional)Specify the appearance of the bar when it is hidden. Accepted values are
'hide
or 'show
.
binding-mode-indicator
(optional)Boolean enabling or disabling the binding mode indicator.
colors
(optional)An optional sway-color
configuration record.
status-command
(optional)This field accept strings, G-expressions and executable file-like values. The default value is a command (string) that prints the date and time every second.
Each line printed on stdout
by this command (or script) will be
displayed on the status area of the bar.
Below are a few examples using:
"while date +'%Y-%m-%d %X'; do sleep 1; done"
,
#~(string-append "while " #$coreutils "/bin/date" " +'%Y-%m-%d %X'; do sleep 1; done")
(program-file
"sway-bar-status"
#~(begin
(use-modules (ice-9 format)
(srfi srfi-19))
(let loop ()
(let* ((date (date->string
(current-date)
"~d/~m/~Y (~a) • ~H:~M:~S")))
(format #t "~a~%~!" date)
(sleep 1)
(loop)))))
mouse-bindings
(default: '()
)This field accepts an associative list. Keys are integers describing mouse events. Values can either be strings or G-expressions.
The module (gnu home services sway)
exports constants
%ev-code-mouse-left
, %ev-code-mouse-right
and
%ev-code-mouse-scroll-click
whose values are integers corresponding
to left, right and scroll click respectively. For example, with
(mouse-bindings `((,%ev-code-mouse-left . "exec $term")))
, left
clicks in the status bar open the terminal (assuming that the variable
$term
is bound to a terminal).
Describes a Sway mode (see sway(5)). For example, the following snippet defines the resize mode of the default Sway configuration:
(sway-mode (mode-name "resize") (keybindings '(($left . "resize shrink width 10px") ($right . "resize grow width 10px") ($down . "resize grow height 10px") ($up . "resize shrink height 10px") (Left . "resize shrink width 10px") (Right . "resize grow width 10px") (Down . "resize grow height 10px") (Up . "resize shrink height 10px") (Return . "mode \"default\"") (Escape . "mode \"default\""))))
mode-name
(default: "default"
)Name of the mode. This field accepts strings.
keybindings
(default: '()
)This field describes keybindings. The value is an association list: keys are symbols and values are either strings or G-expressions, as above.
mouse-bindings
(default: '()
)Ditto, but keys are mouse events (integers). Constants
%ev-code-mouse-*
described above can be used as helpers to define
mouse bindings.
Suivant: Miscellaneous Home Services, Précédent: Sway window manager, Monter: Services du dossier personnel [Table des matières][Index]
This section lists services somewhat networking-related that you may use with Guix Home.
The (gnu home services syncthing)
module provides a service to set up
the https://syncthing.net continuous file backup service.
This is the service type for the syncthing
daemon; it is the Home
counterpart of the syncthing-service-type
system service
(voir syncthing-service-type
). The value for
this service type is a syncthing-configuration
.
Here is how you would set it up with the default configuration:
For a custom configuration, wrap you syncthing-configuration
in
for-home
, as in this example:
(service home-syncthing-service-type
(for-home
(syncthing-configuration (logflags 5))))
For details about syncthing-configuration
, check out the
documentation of the system service (voir syncthing-service-type
).
Précédent: Networking Home Services, Monter: Services du dossier personnel [Table des matières][Index]
This section lists Home services that lack a better place.
The (gnu home services music)
module provides the following service:
Beets is a music file and metadata manager that can
be used via its command-line interface, beet
. Beets requires a
YAML configuration file and this Guix Home service is to create such file.
The service can be used as follows:
(service home-beets-service-type
(home-beets-configuration (directory "/home/alice/music")))
Additional options can be specified via the service wild-card field
extra-options
:
(service home-beets-service-type
(home-beets-configuration
(directory "/home/alice/music")
(extra-options '("
import:
move: yes"))))
The (gnu home services dict)
module provides the following service:
C’est le type de service qui lance le démon dicod
, une
implémentation du serveur DICT (voir Dicod dans GNU Dico Manual).
Vous pouvez ajouter open localhost
à votre fichier ~/.dico
pour faire de localhost
le serveur par défaut du client
dico
(voir Initialization File dans GNU Dico Manual).
This service is a direct mapping of the dicod-service-type
system
service (voir Dictionary Service). You can use
it like this:
You may specify a custom configuration by providing a
dicod-configuration
record, exactly like for
dicod-service-type
, but wrapping it in for-home
:
(service home-dicod-service-type
(for-home
(dicod-configuration …)))
Précédent: Services du dossier personnel, Monter: Configuration du dossier personnel [Table des matières][Index]
guix home
Une fois que vous avez écrit une déclaration d’environnement personnel
(voir Déclarer l’environnement personnel), elle peut être
instanciée avec la commande guix home
. Voici le résumé de
la commande :
guix home options… action file
file doit être le nom d’un fichier contenant une déclaration
home-environment
. action spécifie comment l’environnement
personnel est instancié, mais il y a quelques actions supplémentaires qui ne
l’instancient pas. Actuellement les valeurs suivantes sont prises en charge
:
search
Affiche les définitions des types de services personnels disponibles qui correspondent aux expressions régulières données, triées par pertinence :
$ guix home search shell name: home-shell-profile location: gnu/home/services/shells.scm:100:2 extends: home-files description: Create `~/.profile', which is used for environment initialization of POSIX compliant login shells. + This service type can be extended with a list of file-like objects. relevance: 6 name: home-fish location: gnu/home/services/shells.scm:640:2 extends: home-files home-profile description: Install and configure Fish, the friendly interactive shell. relevance: 3 name: home-zsh location: gnu/home/services/shells.scm:290:2 extends: home-files home-profile description: Install and configure Zsh. relevance: 1 name: home-bash location: gnu/home/services/shells.scm:508:2 extends: home-files home-profile description: Install and configure GNU Bash. relevance: 1 …
Comme pour guix search
, le résultat est écrit au format
recutils
, ce qui rend facile le filtrage de la sortie (voir GNU recutils databases dans GNU recutils manual).
conteneur
Démarre un shell dans un environnement isolé — un conteneur — contenant votre dossier personnel spécifié par file.
Par exemple, voici comment vous pouvez démarrer un shell interactif dans un conteneur avec votre dossier personnel :
guix home container config.scm
C’est un conteneur jetable où vous pouvez gaiement jouer avec vos fichiers ; les changements effectués dans le conteneur et tous les processus qui y sont démarrés disparaissent aussitôt que vous sortez de ce shell.
Comme pour guix shell
, plusieurs options contrôlent ce conteneur :
Active le réseau dans le conteneur (il est désactivé par défaut).
Comme pour guix shell
, rend le répertoire source du système
hôte disponible en tant que target dans le conteneur — en
lecture-seule si vous utilisez --expose, et inscriptible si vous
utilisez --share (voir --expose et
--share).
En plus, vous pouvez lancer une commande dans ce conteneur, au lieu de démarrer un shell interactif. Par exemple, voici comment vérifier que les service Shepherd sont démarrés dans un conteneur personnel jetable :
guix home container config.scm -- herd status
La commande à lancer dans le conteneur doit être indiquée après --
(double tirets).
edit
Modifier ou visualiser la définition des types de services personnels donnés.
Par exemple, la commande plus bas ouvre votre éditeur, spécifié par la
variable d’environnement EDITOR
, sur la définition du type de service
home-mcron
:
guix home edit home-mcron
reconfigure
Construit l’environnement personnel décrit dans file et y bascule. Le
basculement signifie que le script d’activation sera évalué et (dans le
scénario de base) les liens symboliques vers les fichiers de configuration
générés dans la déclaration home-environment
seront créés dans
~. Si un fichier avec le même chemin existe dans le répertoire
personnel il sera déplacé vers
~/horodatage-guix-home-legacy-confis-backup, où
horodatage est l’epoch UNIX actuelle.
Remarque : Il est grandement recommandé de lancer
guix pull
une fois avant de lancerguix home reconfigure
pour la première fois (voir Invoquerguix pull
).
Cela met en application toute la configuration spécifiée dans file.
La commande démarre les services Shepherd spécifiés dans file qui ne
sont pas actuellement lancés ; si un service est actuellement exécuté cette
commande s’arrange pour qu’il soit mis à jour la prochaine fois qu’il est
stoppé (p. ex par herd stop service
ou herd restart
service
).
Cette commande crée une nouvelle génération dont le numéro est un de plus
que la génération actuelle (rapportée par guix home
list-generations
). Si cette génération existe déjà, elle sera réécrite.
Ce comportement correspond à celui de guix package
(voir Invoquer guix package
).
À la fin, le nouveau dossier personel est déployé dans ~/.guix-home. Ce répertoire contient les métadonnées de provenance : la liste des canaux utilisés (voir Canaux) et le fichier lui-même, s’il est disponible. Vous pouvez voir les informations de provenance avec :
guix home describe
Cette information est utile si vous voulez plus tard inspecter comment une génération particulière a été construite. En fait, en supposant que file est auto-contenu, vous pouvez reconstruire la génération n de votre environnement personnel avec :
guix time-machine \ -C /var/guix/profiles/per-user/USER/guix-home-n-link/channels.scm -- \ home reconfigure \ /var/guix/profiles/per-user/USER/guix-home-n-link/configuration.scm
Vous pouvez considérer cela comme une sorte de contrôle de version intégré ! Votre dossier personnel n’est pas seulement un artefact binaire : il contient ses propres sources.
Remarque : If you’re using Guix System,
guix-home-service-type
, on how to embed your home configuration in your system configuration such thatguix system reconfigure
deploys both your system and your home.
switch-generation
¶Bascule à une génération du dossier personnel existante. Cette action bascule de manière atomique à la génération du dossier personnel spécifiée.
La génération cible peut être spécifiée explicitement par son numéro de génération. Par exemple, l’invocation suivante passerait à la génération 7 du dossier personnel :
guix home switch-generation 7
La génération cible peut aussi être spécifiée relativement à la génération
actuelle avec la forme +N
ou -N
, où +3
signifie « trois
générations après la génération actuelle » et -1
signifie « une
génération précédent la génération actuelle ». Lorsque vous spécifiez un
nombre négatif comme -1
, il doit être précédé de --
pour
éviter qu’il ne soit compris comme une option. Par exemple :
guix home switch-generation -- -1
Cette action échouera si la génération spécifiée n’existe pas.
roll-back
¶Passe à la génération précédente du dossier personnel. C’est le contraire
de reconfigure
, et c’est exactement comme invoquer
switch-generation
avec pour argument -1
.
delete-generations
¶Supprimer des générations du dossier personnel, ce qui les rend disponibles
pour le ramasse-miettes (voir Invoquer guix gc
, pour des informations sur
la manière de lancer le « ramasse-miettes »).
Cela fonctionne comme pour ‘guix package --delete-generations’
(voir --delete-generations
). Avec aucun
argument, toutes les générations du dossier personnel sauf la génération
actuelle sont supprimées :
guix home delete-generations
Vous pouvez aussi choisir les générations que vous voulez supprimer. L’exemple plus bas supprime toutes les génération du dossier personnel plus vieilles que deux mois :
guix home delete-generations 2m
build
Construit la dérivation de l’environnement personnel, ce qui comprend tous les fichiers de configuration et les programmes requis. Cette action n’installe rien.
describe
Décrit la génération du dossier personnel actuel : son nom de fichier, ainsi que les informations de provenance si elles sont disponibles.
Pour afficher les paquets installés dans le profil de la génération actuelle
du dossier personnel, le drapeau --list-intalled
est proposé, avec la
même syntaxe que celle utilisée pour guix package --list-installed
(voir Invoquer guix package
). Par exemple, la commande suivante affiche
un tableau de tous les paquets avec « emacs » dans leur nom qui sont
installés dans la génération actuelle du profil du dossier personnel :
guix home describe --list-installed=emacs
list-generations
Affiche un résumé de chaque génération de l’environnement personnel
disponible sur le disque, dans un format lisible pour un humain. C’est
similaire à l’option --list-generations de guix package
(voir Invoquer guix package
).
Éventuellement, on peut spécifier un motif, avec la même syntaxe utilisée
pour guix package --list-generations
, pour restreindre la liste
des générations affichées. Par exemple, la commande suivante affiche les
générations de moins de 10 jours :
guix home list-generations 10d
Le drapeau --list-installed
peut aussi être spécifié, avec la même
syntaxe que celle utilisée dans guix home describe
. Cela peut être
utile si vous essayez de déterminer si un paquet a été ajouté au profil
personnel.
import
Génère un environnement personnel à partir des paquets du profil par défaut et des fichiers de configuration qui se trouvent dans votre répertoire personnel. Les fichiers de configuration sont copiés vers le répertoire donné, et un fichier home-configuration.scm sera rempli avec l’environnement personnel. Remarquez que les services personnels existants ne sont pas tous pris en charge (voir Services du dossier personnel).
$ guix home import ~/guix-config guix home: « /home/alice/guix-config » rempli avec tous les fichiers de configuration du dossier personnel
Et plus encore ! guix home
fournit aussi les sous-commandes
suivantes pour visualiser la manière dont les services de votre
environnement personnel sont liés les uns aux autres :
extension-graph
Émettre vers la sortie standard le graphe d’extension de service de
l’environnement personnel défini dans file (voir Composition de services, pour plus d’informations sur les extensions de service). Par
défaut, le format de sortie est le format Dot/Graphviz, mais vous pouvez
choisir un autre format avec --graph-backend, comme avec
guix graph
(voir --backend) :
La commande :
guix home extension-graph file | xdot -
montre les relations d’extension entre les services.
shepherd-graph
Affiche le graphe de dépendance des services shepherd de l’environnement personnel défini dans file sur la sortie standard. Voir Services Shepherd, pour plus d’informations et un exemple de graphe.
Encore une fois, le format de sortie par défaut est Dot/Graphviz, mais vous pouvez passer --graph-backend pour en choisir un autre.
options peut contenir n’importe quelle option commune de construction (voir Options de construction communes). En plus, options peut contenir l’une de ces options :
Considère l’environnement personnel en lequel s’évalue expr. C’est une alternative à la spécification d’un fichier qui s’évalue en un environnement personnel.
Dit à guix home reconfigure
de permettre le retour en arrière du
système.
Comme pour guix system
, guix home reconfigure
, par
défaut, vous empêche de faire revenir votre dossier personnel à une révision
plus vieille ou non liée par rapport aux révisions des canaux utilisés pour
le déployer — cette information est affichée par guix home
describe
. Avec --allow-downgrades, vous pouvez outrepasser cette
vérification, au risque de faire revenir votre dossier personnel en arrière
— faites attention !
Suivant: Plateformes, Précédent: Configuration du dossier personnel, Monter: GNU Guix [Table des matières][Index]
Dans la plupart des cas les paquets installés avec Guix ont une
documentation. Il y a deux formats de documentation principaux : « Info »,
un format hypertexte navigable utilisé par les logiciels GNU et les « pages
de manuel » (ou « pages de man »), le format de documentation linéaire
traditionnel chez Unix. Les manuels Info sont disponibles via la commande
info
ou avec Emacs, et les pages de man sont accessibles via la
commande man
.
Vous pouvez chercher de la documentation pour les logiciels installés sur votre système par mot-clef. Par exemple, la commande suivante recherche des informations sur « TLS » dans les manuels Info :
$ info -k TLS "(emacs)Network Security" -- STARTTLS "(emacs)Network Security" -- TLS "(gnutls)Core TLS API" -- gnutls_certificate_set_verify_flags "(gnutls)Core TLS API" -- gnutls_certificate_set_verify_function …
La commande ci-dessous recherche le même mot-clé dans les pages de manuel42 :
$ man -k TLS SSL (7) - OpenSSL SSL/TLS library certtool (1) - GnuTLS certificate tool …
Ces recherches sont purement locales à votre ordinateur donc vous savez que la documentation trouvée correspond à ce qui est effectivement installé, vous pouvez y accéder hors ligne et votre vie privée est préservée.
Une fois que vous avez ces résultats, vous pouvez visualiser la documentation appropriée avec, disons :
$ info "(gnutls)Core TLS API"
ou :
$ man certtool
Les manuels Info contiennent des sections et des indexs ainsi que des
hyperliens comme ce qu’on trouve sur les pages Web. Le lecteur
info
(voir Info reader dans Stand-alone GNU Info)
et sa contre-partie dans Emacs (voir Misc Help dans The GNU Emacs
Manual) fournissent des raccourcis claviers intuitifs pour naviguer dans
les manuels Voir Getting Started dans Info: An Introduction pour
trouver une introduction sur la navigation dans info.
Suivant: Créer des images systèmes, Précédent: Documentation, Monter: GNU Guix [Table des matières][Index]
Les paquets et les systèmes construit par Guix sont conçus, comme la plupart
des programmes informatiques, pour tourner sur un CPU avec un jeu
d’instructions spécifique, et sous un système d’exploitation
particulier. Ces programmes ciblent le plus souvent aussi un noyau et une
bibliothèque système particulière. Ces contraintes sont reflétées par Guix
dans les enregistrements platform
.
Suivant: Plateformes prises en charge, Monter: Plateformes [Table des matières][Index]
platform
Le type de données platform
décrit une plateforme : un
ISA (jeu d’instructions architectural (en anglais instruction
set architecture)) combiné avec un système d’exploitation et éventuellement
des paramètres systèmes supplémentaires comme l’ABI (interface
binaire applicative (en anglais application binary interface)).
C’est le type de donnée représentant une plateforme.
target
Ce champ spécifie le triplet GNU de la plateforme en une chaine (voir GNU configuration triplets dans Autoconf).
system
Cette chaine est le type de système connu par Guix et passé, par exemple, à l’option --system de la plupart des commandes.
Elle a le plus souvent la forme "cpu-noyau"
, où cpu
est le CPU cible et noyau est le noyau du système d’exploitation
cible.
Elle peut être par exemple "aarch64-linux"
ou
"armhf-linux"
. Vous rencontrerez ces types de systèmes en effectuant
des constructions natives (voir Constructions natives).
linux-architecture
(par défaut : #false
)Cette chaine facultative n’est pertinente que si le noyau est Linux. Dans ce
cas, elle correspond à la variable ARCH utilisée lors de la construction de
Linux, "mips"
par exemple.
rust-target
(default: #false
)This optional string field is used to determine which rust target is best
supported by this platform. For example, the base level system targeted by
armhf-linux
system is closest to
armv7-unknown-linux-gnueabihf
.
glibc-dynamic-linker
Ce champ est le nom de l’éditeur des liens dynamique de la bibliothèque C de
GNU pour le système correspondant, en une chaine. Elle peut être
"/lib/ld-linux-armhf.so.3"
.
Précédent: Référence de platform
, Monter: Plateformes [Table des matières][Index]
Les modules (guix platforms …)
exportent les variables
suivantes, chacune d’entre elle étant liée à un enregistrement
platform
.
Une plateforme ciblant un CPU ARM v7 tournant sous GNU/Linux.
Une plateforme ciblant un CPU ARM v8 tournant sous GNU/Linux.
Une plateforme ciblant un CPU MIPS petit-boutiste 64-bits tournant sous GNU/Linux.
Une plateforme ciblant un CPU PowerPC grand-boutiste 32-bits tournant sous GNU/Linux.
Une plateforme ciblant un CPU PowerPC petit-boutiste 64-bits tournant sous GNU/Linux.
Une plateforme ciblant un CPU RISC-V 64-bits tournant sous GNU/Linux.
Une plateforme ciblant un CPU x86 tournant sous GNU/Linux.
Une plateforme ciblant un CPU x86 64-bits tournant sous GNU/Linux.
Platform targeting x86 64-bit CPU running GNU/Linux with the run-time using the X32 ABI.
Une plateforme ciblant un CPU x86 tournant sous Windows, avec la prise en charge à l’exécution de MinGW.
Une plateforme ciblant un CPU x86 64-bits tournant sous Windows, avec la prise en charge à l’exécution de MinGW.
Une plateforme ciblant un CPU x86 tournant sous GNU/Hurd (aussi appelé « GNU »).
Platform targeting AVR CPUs without an operating system, with run-time support from AVR Libc.
Platform targeting OpenRISC 1000 CPU without an operating system and without a C standard library.
Platform targeting Xtensa CPU used in the Qualcomm Atheros AR7010 and AR9271 USB 802.11n NICs (Network Interface Controllers).
Suivant: Installer les fichiers de débogage, Précédent: Plateformes, Monter: GNU Guix [Table des matières][Index]
Lorsque vient le moment d’installer Guix System pour la première fois sur
une nouvelle machine, vous pouvez globalement procéder de trois manières
différentes. La première manière est d’utiliser un système d’exploitation
existant sur une machine pour lancer la commande guix system init
(voir Invoquer guix system
). La seconde consiste à produire une image
d’installation (voir Construire l’image d’installation). C’est un système
amorçable dont le rôle est de lancer guix system init
. Enfin, la
troisième possibilité est de produire une image qui est une instanciation
directe du système que vous voulez exécuter. Cette image peut ensuite être
copiée sur un périphérique amorçable comme un périphérique USB ou une carte
mémoire. La machine cible démarrerait alors directement dessus, sans aucune
procédure d’installation.
The guix system image
command is able to turn an operating system
definition into a bootable image. This command supports different image
types, such as mbr-hybrid-raw
, iso9660
and docker
. Any
modern x86_64
machine will probably be able to boot from an
iso9660
image. However, there are a few machines out there that
require specific image types. Those machines, in general using ARM
processors, may expect specific partitions at specific offsets.
Ce chapitre explique comment définir des images systèmes personnalisées et comment les transformer en images amorçables.
Suivant: Instancier une image, Monter: Créer des images systèmes [Table des matières][Index]
image
L’enregistrement image
, décrit juste après, vous permet de définir
une image système amorçable personnalisée.
C’est le type de donnée représentant une image système.
name
(par défaut : #false
)Le nom de l’image en tant que symbole, 'my-iso9660
par exemple. Le
nom est facultatif et vaut #false
par défaut.
format
Le format d’image en tant que symbole. Les formats suivants sont pris en charge :
disk-image
, une image disque brute composée d’une ou plusieurs
partitions.
compressed-qcow2
, une image qcow2 compressée composée
d’une ou plusieurs partitions.
docker
, une image Docker.
iso9660
, une image ISO-9660.
tarball
, une archive d’image en tar.gz.
wsl2
, une image WSL2.
platform
(par défaut : #false
)L’enregistrement platform
que l’image cible (voir Plateformes), par
exemple aarch64-linux
. Par défaut, ce champ est à #false
et
l’image ciblera la plateforme de l’hôte.
size
(par défaut : 'guess
)La taille de l’image en octets ou 'guess
. Le symbole 'guess
,
qui est utilisé par défaut, signifie que la taille de l’image sera inférée à
partir de son contenu.
operating-system
L’enregistrement operating-system
à instancier dans l’image.
partition-table-type
(par défaut : 'mbr
)Le type de table des partitions de l’image en tant que symbole. Les valeurs
possibles sont 'mbr
et 'gbt
. La valeur par défaut est
'mbr
.
partitions
(par défaut : '()
)Les partitions de l’image en tant que liste d’enregistrements
partition
(voir Référence de partition
).
compression?
(par défaut : #true
)Indique si le contenu de l’image doit être compressé, en tant que
booléen. Sa valeur par défaut est #true
et ne s’applique qu’aux
formats d’image 'iso9660
.
volatil-root?
(par défaut : #true
)Indique si la partition racine de l’image devrait être volatile, en tant que booléen.
Cela se fait en utilisant un système de fichiers en RAM (overlayfs) monté
sur la partition racine par l’initrd. Sa valeur par défaut est
#true
. Lorsque la valeur est #false
, la partition racine de
l’image est montée en lecture-écriture par l’initrd.
shared-store?
(par défaut : #false
)Indique si le dépôt de l’image devrait être partagé avec le système hôte, en
tant que booléen. Cela peut être utile si vous créez des images dédiées à
des machines virtuelles. Lorsque la valeur est #false
, ce qui est la
valeur par défaut, la clôture du operating-system
de l’image est
copiée dans l’image. Sinon, lorsque la valeur est #true
, le dépôt de
l’hôte est censé être disponible au démarrage avec un montage 9p
par
exemple.
shared-network?
(par défaut : #false
)Indique s’il faut utiliser les interfaces réseaux de l’hôte dans l’image, en
tant que booléen. C’est utilisé uniquement pour le format d’image
'docker
. Sa valeur par défaut est #false
.
substitutable?
(par défaut : #true
)Indique si la dérivation de l’image devrait être substituable, en tant que
booléen. Sa valeur par défaut est #true
.
Monter: Référence de image
[Table des matières][Index]
partition
L’enregistrement image
peut contenir des partitions.
C’est le type de donnée représentant une partition d’image.
size
(par défaut : 'guess
)La taille de la partition en octets ou 'guess
. Le symbole
'guess
, qui est la valeur par défaut, signifie que la taille de la
partition sera inférée en fonction de son contenu.
offset
(par défaut : 0
)La position du début de la partition en octets, relativement au début de
l’image ou de la fin de la partition précédente. Sa valeur par défaut est
0
ce qui signifie qu’aucun décalage n’est appliqué.
file-system
(par défaut : "ext4"
)The partition file system as a string, defaulting to "ext4"
.
The supported values are "vfat"
, "fat16"
, "fat32"
,
"btrfs"
, and "ext4"
.
"vfat"
, "fat16"
, and "fat32"
partitions without the
'esp
flag are by default LBA compatible.
file-system-options
(par défaut : '()
)The partition file system creation options that should be passed to the
partition creation tool, as a list of strings. This is only supported when
creating "vfat"
, "fat16"
, "fat32"
or "ext4"
partitions.
Voir la section "extended-options"
dans la page de manuel de l’outil
"mke2fs"
pour une référence plus complète.
label
L’étiquette de la partition en tant que chaine obligatoire, par exemple
"ma-racine"
.
uuid
(par défaut : #false
)L’UUID de la partition en tant qu’enregistrement uuid
(voir Systèmes de fichiers). Sa valeur par défaut est #false
, ce qui signifie que
l’outil de création de partition attribuera un UUID aléatoire à la
partition.
flags
(par défaut : '()
)Les drapeaux de la partition en tant que liste de symboles. Les valeurs
possibles sont 'boot
et 'esp
. Le drapeau 'boot
devrait
être indiqué si vous voulez démarrer sur cette partition. Exactement une
partition devrait avoir ce drapeau, typiquement la partition racine. Le
drapeau 'esp
identifie une partition système pour UEFI.
initializer
(par défaut : #false
)La procédure d’initialisation de la partition en tant que gexp. Cette
procédure est appelée pour remplir la partition. Si aucune procédure n’est
passée, la procédure initialize-root-partition
du module (gnu
build image)
sera utilisée.
Suivant: référence de image-type, Précédent: Référence de image
, Monter: Créer des images systèmes [Table des matières][Index]
Imaginons que vous vouliez créer une image MBR avec trois partitions distinctes :
%simple-os
.
Vous écririez ensuite la définition d’image suivante dans un fichier
mon-image.scm
par exemple.
(use-modules (gnu) (gnu image) (gnu tests) (gnu system image) (guix gexp)) (define Mio (expt 2 20)) (image (format 'disk-image) (operating-system %simple-os) (partitions (list (partition (size (* 40 Mio)) (offset (* 1024 1024)) (label "GNU-ESP") (file-system "vfat") (flags '(esp)) (initializer (gexp initialize-efi-partition))) (partition (size (* 50 Mio)) (label "DATA") (file-system "ext4") (initializer #~(lambda* (root . rest) (mkdir root) (call-with-output-file (string-append root "/data") (lambda (port) (format port "my-data")))))) (partition (size 'guess) (label root-label) (file-system "ext4") (flags '(boot)) (initializer (gexp initialize-root-partition))))))
Remarquez que la première et la troisième partition utilisent les procédure
d’initialisation par défaut, respectivement initialize-efi-partition et
initialize-root-partition. Initialize-efi-partition installe un chargeur EFI
GRUB qui charge le chargeur d’amorçage GRUB situé sur la partition
racine. Initialize-root-partition instancie un système complet défini par le
système d’exploitation %simple-os
.
Vous pouvez maintenant lancer :
guix system image mon-image.scm
pour instancier la définition de l’image
. Cela produit une image
disque qui a la structure attendue :
$ parted $(guix system image mon-image.scm) print … Model: (file) Disk /gnu/store/yhylv1bp5b2ypb97pd3bbhz6jk5nbhxw-disk-image: 1714MB Sector size (logical/physical): 512B/512B Partition Table: msdos Disk Flags: Number Start End Size Type File system Flags 1 1049kB 43.0MB 41.9MB primary fat16 esp 2 43.0MB 95.4MB 52.4MB primary ext4 3 95.4MB 1714MB 1619MB primary ext4 boot
La taille de la partition boot
a été inférée à 1619 Mo
pour
qu’elle soit assez grande pour héberger le système d’exploitation
%simple-os
.
Vous pouvez aussi utiliser les définitions d’enregistrements image
existantes et hériter d’elles pour simplifier la définition de
l’image
. Le module (gnu system image)
fournit les variables de
définition d’image
suivantes.
An MBR disk-image composed of a single ROOT partition. The ROOT partition starts at a 1 MiB offset so that the bootloader can install itself in the post-MBR gap.
An MBR disk-image composed of two partitions: a 64 bits ESP partition and a
ROOT boot partition. The ESP partition starts at a 1 MiB offset so
that a BIOS compatible bootloader can install itself in the post-MBR gap.
The image can be used by x86_64
and i686
machines supporting
only legacy BIOS booting. The ESP partition ensures that it can also be
used by newer machines relying on UEFI booting, hence the hybrid
denomination.
A GPT disk-image composed of two partitions: a 64 bits ESP partition and a
ROOT boot partition. This image can be used on most x86_64
and
i686
machines, supporting BIOS or UEFI booting.
Comme efi-disk-image
mais avec une partition EFI 32 bits.
Une image ISO-9660 composée d’une seule partition amorçable. Cette image
peut être utilisée sur la plupart des machine x86_64
et i686
.
Une image Docker qui peut être utilisée pour démarrer un conteneur Docker.
En utilisant efi-disk-image
nous pouvons simplifier notre précédente
déclaration d’image
de cette manière :
(use-modules (gnu) (gnu image) (gnu tests) (gnu system image) (guix gexp) (ice-9 match)) (define Mio (expt 2 20)) (define data (partition (size (* 50 Mio)) (label "DATA") (file-system "ext4") (initializer #~(lambda* (root . rest) (mkdir root) (call-with-output-file (string-append root "/data") (lambda (port) (format port "my-data"))))))) (image (inherit efi-disk-image) (operating-system %simple-os) (partitions (match (image-partitions efi-disk-image) ((esp root) (list esp data root)))))
Cela donnera exactement la même instanciation d’image
mas la
déclaration de l’image
est plus simple.
Suivant: Modules des images, Précédent: Instancier une image, Monter: Créer des images systèmes [Table des matières][Index]
La commande guix system image
peut, comme nous l’avons vu plus
haut, prendre un fichier contenant une déclaration d’image
comme
argument et produire une image disque à partir de celui-ci. Cette même
commande peut aussi gérer un fichier contenant une déclaration
operating-system
comme argument. Dans ce cas, comment un
operating-system
est-il transformé en une image ?
C’est là que l’enregistrement image-type
intervient. Cet
enregistrement définit comment transformer un enregistrement
operating-system
en un enregistrement image
.
C’est le type de donnée représentant un type d’image.
name
Le nom du type d’image, en tant que symbole obligatoire, par exemple
'efi32-raw
.
constructor
Le constructeur du type d’image, en tant que procédure obligatoire qui prend
un enregistrement operating-system
comme argument et renvoie un
enregistrement image
.
Il y a plusieurs enregistrements image-type
fournis par les modules
(gnu system image)
et (gnu system images …)
.
Build an image based on the mbr-disk-image
image.
Build an image based on the mbr-hybrid-disk-image
image.
Construit une image basée sur l’image efi-disk-image
.
Construit une image basée sur l’image efi32-disk-image
.
Build an image based on the mbr-disk-image
image but with the
compressed-qcow2
image format.
Construit une image compressée basée sur l’image iso9660-image
.
Construit une image basée sur l’image iso9660-image
mais avec le
champ compression?
à #false
.
Construit une image basée sur limage docker-image
.
Construit une image MBR avec une seule partition commençant à l’adresse
1024 Kio
. C’est utile pour laisser la place pour installer un
chargeur d’amorçage dans l’intervalle post-MBR.
Construit une image qui cible la machine Pinebook Pro. L’image MBR contient
une seule partition commençant à l’adresse 9 Mio
. Le chargeur
d’amorçage u-boot-pinebook-pro-rk3399-bootloader
sera installé dans
l’intervalle.
Construit une image qui cible la machine Rock64. L’image MBR contient une
seule partition commençant à l’adresse 16 Mio
. Le chargeur d’amorçage
u-boot-rock64-rk3328-bootloader
sera installé dans l’intervalle.
Construit une image qui cible la machine Novena. Elle a les mêmes
caractéristiques que raw-with-offset-image-type
.
Construit une image qui cible la machine Pine64. Elle a les mêmes
caractéristiques que raw-with-offset-image-type
.
Construit une image qui cible une machine i386
qui exécute le noyau
Hurd. L’image MBR contient une seule partition ext2 avec des drapeaux
file-system-options
spécifiques.
Construit une image similaire à celle construit par hurd-image-type
mais avec le format
'compressed-qcow2
.
Construit une image pour le WSL2 (sous-système Linux de Windows 2). Elle peut être importée en exécutant :
wsl --import Guix ./guix ./wsl2-image.tar.gz wsl -d Guix
So, if we get back to the guix system image
command taking an
operating-system
declaration as argument. By default, the
mbr-raw-image-type
is used to turn the provided
operating-system
into an actual bootable image.
Pour utiliser un image-type
différent, vous pouvez utiliser l’option
--image-type
. L’option --list-image-types
listera tous les
types d’images pris en charge. C’est une liste textuelle de toutes les
variables image-type
décrites plus haut (voir Invoquer guix system
).
Précédent: référence de image-type, Monter: Créer des images systèmes [Table des matières][Index]
Prenons l’exemple du Pine64, une machine ARM. Pour pouvoir produire une image ciblant cette carte, nous avons besoin des éléments suivants :
operating-system
contenant au moins
un noyau approprié (linux-libre-arm64-generic
) et un chargeur
d’amorçage (u-boot-pine64-lts-bootloader
) pour le Pine64.
image-type
fournissant une manière de
transformer l’enregistrement operating-system
en un enregistrement
image
approprié pour le Pine64.
image
qui peut être instanciée avec
la commande guix system image
.
Le module (gnu system images pine64)
fournit tous ces éléments :
pine64-barebones-os
, pine64-image-type
et
pine64-barebones-raw-image
, respectivement.
Le module renvoie pine64-barebones-raw-image
pour pouvoir exécuter :
guix system image gnu/system/images/pine64.scm
Maintenant, grâce à l’enregistrement pine64-image-type
qui déclare
l’image-type
'pine64-raw
, on peut aussi préparer un fichier
my-pine.scm
avec le contenu suivant :
(use-modules (gnu system images pine64)) (operating-system (inherit pine64-barebones-os) (timezone "Europe/Athens"))
pour personnaliser le pine64-barebones-os
, puis lancer :
$ guix system image --image-type=pine64-raw my-pine.scm
Remarquez qu’il y a d’autres modules dans le répertoire
gnu/system/images
qui ciblent les machines Novena
,
Pine64
, PinebookPro
et Rock64
.
Suivant: Utiliser TeX et LaTeX, Précédent: Créer des images systèmes, Monter: GNU Guix [Table des matières][Index]
Les binaires des programmes, produits par les compilateurs GCC par exemple, sont typiquement écrits au format ELF, avec une section contenant des informations de débogage. Les informations de débogage sont ce qui permet au débogueur, GDB, de relier le code binaire et le code source ; elles sont requises pour déboguer un programme compilé dans de bonnes conditions.
Ce chapitre explique comme utiliser les information de débogages séparées quand un paquet ne les fournit pas, et comme reconstruire un paquet avec les informations de débogage manquantes.
Suivant: Reconstruire les informations de débogage, Monter: Installer les fichiers de débogage [Table des matières][Index]
Le problème avec les informations de débogage est qu’elles prennent pas mal de place sur le disque. Par exemple, les informations de débogage de la bibliothèque C de GNU prend plus de 60 Mo. Ainsi, en tant qu’utilisateur, garder toutes les informations de débogage de tous les programmes installés n’est souvent pas une possibilité. Cependant, l’économie d’espace ne devrait pas empêcher le débogage — en particulier, dans le système GNU, qui devrait faciliter pour ses utilisateurs l’exercice de leurs libertés (voir Distribution GNU).
Heureusement, les utilitaires binaires de GNU (Binutils) et GDB fournissent un mécanisme qui permet aux utilisateurs d’avoir le meilleur des deux mondes : les informations de débogage peuvent être nettoyées des binaires et stockées dans des fichiers séparés. GDB peut ensuite charger les informations de débogage depuis ces fichiers, lorsqu’elles sont disponibles (voir Separate Debug Files dans Debugging with GDB).
La distribution GNU se sert de cela pour stocker les informations de
débogage dans le sous-répertoire lib/debug
d’une sortie séparée du
paquet appelée sans grande imagination debug
(voir Des paquets avec plusieurs résultats). Les utilisateurs peuvent choisir d’installer la sortie
debug
d’un paquet lorsqu’ils en ont besoin. Par exemple, la commande
suivante installe les informations de débogage pour la bibliothèque C de GNU
et pour GNU Guile :
guix install glibc:debug guile:debug
On doit ensuite dire à GDB de chercher les fichiers de débogage dans le
profil de l’utilisateur, en remplissant la variable
debug-file-directory
(vous pourriez aussi l’instancier depuis le
fichier ~/.gdbinit, voir Startup dans Debugging with GDB) :
(gdb) set debug-file-directory ~/.guix-profile/lib/debug
À partir de là, GDB récuperera les informations de débogage des fichiers .debug sous ~/.guix-profile/lib/debug.
Voici un script GDB alternatif qui est utile pour travailler avec d’autres profils. Il s’appuie sur l’intégration Guile facultative dans GDB. Ce bout de code est inclus par défaut sur le système Guix dans le fichier ~/.gdbinit.
guile (use-modules (gdb)) (execute (string-append "set debug-file-directory " (or (getenv "GDB_DEBUG_FILE_DIRECTORY") "~/.guix-profile/lib/debug"))) end
EN plus, vous voudrez sans doute que GDB puisse montrer le code source
débogué. Pour cela, vous devrez désarchiver le code source du paquet qui
vous intéresse (obtenu via guix build --source
, voir Invoquer guix build
) et pointer GDB vers ce répertoire des sources avec la commande
directory
(voir directory
dans Debugging with
GDB).
Le mécanisme de sortie debug
dans Guix est implémenté par le
gnu-build-system
(voir Systèmes de construction). Actuellement, ce n’est pas
obligatoire — les informations de débogage sont disponibles uniquement si
les définitions déclarent explicitement une sortie debug
. Cela
pourrait être modifié tout en permettant aux paquets de s’en passer dans le
futur si nos serveurs de construction peuvent tenir la charge. Pour
vérifier si un paquet a une sortie debug
, utilisez guix
package --list-available
(voir Invoquer guix package
).
Continuez à lire pour apprendre comment gérer les paquets qui n’ont pas de
sortie debug
.
Précédent: Informations de débogage séparées, Monter: Installer les fichiers de débogage [Table des matières][Index]
Comme nous l’avons montré, certains paquets, mais pas tous, fournissent des
informations de débogage dans une sortie debug
. Que faire lorsque
les informations de débogage sont manquantes ? L’option
--with-debug-info fournit une solution à cela : il vous permet de
reconstruire les paquets pour lesquels les informations de débogages sont
manquantes — et seulement ceux-là — et les greffe sur les applications
que vous déboguez. Ainsi, bien que ce ne soit pas aussi rapide qu’installer
la sortie debug
, ça demande relativement peu de choses.
Illustrons cela. Supposons que vous rencontriez un bogue dans Inkscape et
que vous souhaitiez voir ce qui se passe dans GLib, une bibliothèque assez
loin dans le graphe de dépendances. Il se trouve que GLib n’a pas de sortie
debug
et la trace de débogage de GDB est toute triste :
(gdb) bt #0 0x00007ffff5f92190 in g_getenv () from /gnu/store/…-glib-2.62.6/lib/libglib-2.0.so.0 #1 0x00007ffff608a7d6 in gobject_init_ctor () from /gnu/store/…-glib-2.62.6/lib/libgobject-2.0.so.0 #2 0x00007ffff7fe275a in call_init (l=<optimized out>, argc=argc@entry=1, argv=argv@entry=0x7fffffffcfd8, env=env@entry=0x7fffffffcfe8) at dl-init.c:72 #3 0x00007ffff7fe2866 in call_init (env=0x7fffffffcfe8, argv=0x7fffffffcfd8, argc=1, l=<optimized out>) at dl-init.c:118
Pour corriger cela, vous installez Inkscape lié à une variante de GLib qui contient les informations de débogage :
guix install inkscape --with-debug-info=glib
Cette fois-ci, le débogage a bien plus d’informations :
$ gdb --args sh -c 'exec inkscape' … (gdb) b g_getenv Function "g_getenv" not defined. Make breakpoint pending on future shared library load? (y or [n]) y Breakpoint 1 (g_getenv) pending. (gdb) r Starting program: /gnu/store/…-profile/bin/sh -c exec\ inkscape … (gdb) bt #0 g_getenv (variable=variable@entry=0x7ffff60c7a2e "GOBJECT_DEBUG") at ../glib-2.62.6/glib/genviron.c:252 #1 0x00007ffff608a7d6 in gobject_init () at ../glib-2.62.6/gobject/gtype.c:4380 #2 gobject_init_ctor () at ../glib-2.62.6/gobject/gtype.c:4493 #3 0x00007ffff7fe275a in call_init (l=<optimized out>, argc=argc@entry=3, argv=argv@entry=0x7fffffffd088, env=env@entry=0x7fffffffd0a8) at dl-init.c:72 …
Bien mieux !
Remarquez qu’il y a des paquets pour lesquels --with-debug-info n’a pas l’effet désiré. Voir --with-debug-info, pour plus d’informations.
Suivant: Mises à jour de sécurité, Précédent: Installer les fichiers de débogage, Monter: GNU Guix [Table des matières][Index]
Guix provides packages for the TeX, LaTeX, ConTeXt, LuaTeX, and related typesetting systems, taken from the TeX Live distribution. However, because TeX Live is so huge and because finding one’s way in this maze is tricky, so this section provides some guidance on how to deploy the relevant packages to compile TeX and LaTeX documents.
TeX Live currently comes in two mutually exclusive flavors in Guix:
texlive
package: it comes with every single
TeX Live package (roughly 4,200), but it is huge—more than 4 GiB
for a single package!
So to insist, these two flavors cannot be combined43. If in the modular setting your document
does not compile, the solution is not to add the monolithic texlive
package, but to add the set of missing packages from the modular
distribution.
Building a coherent system that provides all the essential tools and, at the same time, satisfies all of its internal dependencies can be a difficult task. It is therefore recommended to start with sets of packages, called collections, and schemes, the name for collections of collections. The following command lists available schemes and collections (voir Invoking guix package):
guix search texlive-\(scheme\|collection\) | recsel -p name,description
If needed, you may then complete your system with individual packages, particularly when they belong to a large collection you’re not otherwise interested in.
For instance, the following manifest is a reasonable, yet frugal starting point for a French LaTeX user:
(specifications->manifest
'("rubber"
"texlive-scheme-basic"
"texlive-collection-latexrecommended"
"texlive-collection-fontsrecommended"
"texlive-babel-french"
;; From "latexextra" collection.
"texlive-tabularray"
;; From "binextra" collection.
"texlive-texdoc"))
If you come across a document that does not compile in such a basic setting,
the main difficulty is finding the missing packages. In this case,
pdflatex
and similar commands tend to fail with obscure error
messages along the lines of:
doc.tex: File `tikz.sty' not found. doc.tex:7: Emergency stop.
ou, pour une police manquante :
kpathsea: Running mktexmf phvr7t ! I can't find file `phvr7t'.
How do you determine what the missing package is? In the first case, you will find the answer by running:
$ guix search texlive tikz name: texlive-pgf version: 59745 …
Dans le second cas, guix search
ne renvoie rien. À la place, vous
pouvez chercher dans la base de données des paquets TeX Live avec la
commande tlmgh
:
$ tlmgr info phvr7t tlmgr: cannot find package phvr7t, searching for other matches: Packages containing `phvr7t' in their title/description: Packages containing files matching `phvr7t': helvetic: texmf-dist/fonts/tfm/adobe/helvetic/phvr7t.tfm texmf-dist/fonts/tfm/adobe/helvetic/phvr7tn.tfm texmf-dist/fonts/vf/adobe/helvetic/phvr7t.vf texmf-dist/fonts/vf/adobe/helvetic/phvr7tn.vf tex4ht: texmf-dist/tex4ht/ht-fonts/alias/adobe/helvetic/phvr7t.htf
The file is available in the TeX Live helvetic
package, which is
known in Guix as texlive-helvetic
. Quite a ride, but you found it!
Suivant: Bootstrapping, Précédent: Utiliser TeX et LaTeX, Monter: GNU Guix [Table des matières][Index]
Parfois, des vulnérabilités importantes sont découvertes dans les paquets
logiciels et doivent être corrigées. Les développeur·euses de Guix essayent
de suivre les vulnérabilités connues et d’appliquer des correctifs aussi
vite que possible dans la branche master
de Guix (nous n’avons pas
encore de branche « stable » contenant seulement des mises à jour de
sécurité). L’outil guix lint
aide à trouver les versions
vulnérables des paquets logiciels dans la distribution :
$ guix lint -c cve gnu/packages/base.scm:652:2 : glibc@2.21 : probablement vulnérable à CVE-2015-1781, CVE-2015-7547 gnu/packages/gcc.scm:334:2 : gcc@4.9.3 : probablement vulnérable à CVE-2015-5276 gnu/packages/image.scm:312:2 : openjpeg@2.1.0 : probablement vulnérable à CVE-2016-1923, CVE-2016-1924 …
Voir Invoquer guix lint
, pour plus d’informations.
Guix suit une discipline de gestion de paquets fonctionnelle (voir Introduction), ce qui implique que lorsqu’un paquet change, tous les paquets qui en dépendent doivent être reconstruits. Cela peut grandement ralentir le déploiement de corrections dans les paquets du cœur comme libc ou bash comme presque toute la distribution aurait besoin d’être reconstruite. Cela aide d’utiliser des binaires pré-construits (voir Substituts), mais le déploiement peut toujours prendre plus de temps de souhaité.
Pour corriger cela, Guix implémente les greffes, un mécanisme qui permet un déploiement rapide des mises à jour de sécurité critiques sans le coût associé à une reconstruction complète de la distribution. L’idée est de reconstruire uniquement le paquet qui doit être corrigé puis de le « greffer » sur les paquets qui sont explicitement installés par l’utilisateur et qui se référaient avant au paquet d’origine. Le coût d’une greffe est typiquement très bas, et plusieurs ordres de grandeurs moins élevé que de reconstruire tout la chaîne de dépendance.
Par exemple, supposons qu’une mise à jour de sécurité doive être appliquée à
Bash. Les développeurs de Guix fourniront une définition de paquet pour le
Bash « corrigé », disons bash-fixed, de la manière habituelle
(voir Définition des paquets). Ensuite, la définition originale du paquet est
augmentée avec un champ replacement
qui pointe vers le paquet
contenant la correction :
(define bash
(package
(name "bash")
;; …
(replacement bash-fixed)))
À partir de maintenant, tout paquet dépendant directement ou indirectement
de Bash — rapporté par guix gc --requisites
(voir Invoquer guix gc
) — installé est automatiquement « réécrit » pour se référer à
bash-fixed au lieu de bash. Ce processus de greffe prend du
temps en proportion de la taille du paquet, typiquement moins d’une minute
pour un paquet de taille « moyenne » sur une machine récente. La greffe est
récursive : lorsqu’une dépendance indirecte a besoin d’être greffée, la
greffe se « propage » jusqu’au paquet que l’utilisateur installe.
Actuellement la longueur du nom et la version de la greffe et du paquet
qu’il remplace (bash-fixed et bash dans l’exemple ci-dessus)
doivent être identiques. Cette restriction vient surtout du fait que la
greffe fonctionne en corrigeant les fichiers, dont des fichiers binaires,
directement. D’autres restrictions peuvent apparaître : par exemple, si
vous ajoutez une greffe à un paquet fournissant une bibliothèque partagée,
la bibliothèque partagée originale et son remplacement doivent avoir le même
SONAME
et être compatibles au niveau binaire.
L’option en ligne de commande --no-grafts vous permet d’éviter les greffes (voir --no-grafts). Donc la commande :
guix build bash --no-grafts
renvoie le nom de fichier dans les dépôt du Bash original, alors que :
guix build bash
renvoie le nom de fichier du Bash « corrigé » de remplacement. Cela vous permet de distinguer les deux variantes de Bash.
Pour vérifier à quel Bash votre profil se réfère, vous pouvez lancer
(voir Invoquer guix gc
) :
guix gc -R $(readlink -f ~/.guix-profile) | grep bash
… et comparer les noms de fichiers que vous obtenez avec ceux du dessus. De la même manière pour une génération du système Guix :
guix gc -R $(guix system build my-config.scm) | grep bash
Enfin, pour vérifier quelles processus Bash lancés vous utilisez, vous
pouvez utiliser la commande lsof
:
lsof | grep /gnu/store/.*bash
Suivant: Porter vers une nouvelle plateforme, Précédent: Mises à jour de sécurité, Monter: GNU Guix [Table des matières][Index]
Dans notre contexte, le bootstrap se réfère à la manière dont la distribution est construite « à partir de rien ». Rappelez-vous que l’environnement de construction d’une dérivation ne contient rien d’autre que les entrées déclarées (voir Introduction). Donc il y a un problème évident de poule et d’œuf : comment le premier paquet est-il construit ? Comment le premier compilateur est-il construit ?
Il est tentant de penser que seuls les bidouilleurs les plus enthousiastes se soucient de cette question. Cependant, bien que la réponse à cette question soit technique par nature, ses implications sont très vastes. La manière dont une distribution est amorcée définie l’étendue de ce que nous, individuellement et collectivement en tant qu’utilisateurs, utilisatrices, bidouilleuses et bidouilleurs, pouvons faire confiance aux logiciels que nous lançons. C’est une préoccupation centrale du point de vue de la sécurité et de liberté des utilisateurs.
Le système GNU est surtout fait de code C, avec la libc en son cœur. Le
système de construction GNU lui-même suppose la disponibilité d’un shell
Bourne et d’outils en ligne de commande fournis par GNU Coreutils, Awk,
Findutils, sed et grep. En plus, les programmes de construction — les
programmes qui exécutent ./configure
, make
etc — sont écrits
en Guile Scheme (voir Dérivations). En conséquence, pour pouvoir
construire quoi que ce soit, de zéro, Guix a besoin de binaire
pré-construits de Guile, GCC, Binutils, la libc et des autres paquets
mentionnés plus haut — les binaires de bootstrap.
Ces binaires de bootstrap sont pris comme des acquis, bien qu’on puisse les recréer (ça arrive plus tard) si besoin (voir Se préparer à utiliser les binaires de bootstrap).
Suivant: Se préparer à utiliser les binaires de bootstrap, Monter: Bootstrapping [Table des matières][Index]
Guix — comme les autres distributions GNU/Linux — est traditionnellement bootstrappé à partir d’un ensemble de binaires de boostrap : Bourne shell, des outils en ligne de commande fournis par GNU Coreutils, Awk, Findutils, « sed » et « grep » et Guile, GCC, Binutils et la bibliothèque C de NU (voir Bootstrapping). Habituellement, ces binaires de bootstrap sont « pris pour acquis ».
Prendre les binaires de bootstrap pour acquis signifie que nous les considérons comme des « sources » corrects et de confiance pour la construction d’un système complet. Là se trouve le problème : la taille de ces binaires de bootstrap est d’environ 250 Mo (voir Bootstrappable Builds dans GNU Mes). Auditer ou même inspecter ces binaires est presque impossible.
For i686-linux
and x86_64-linux
, Guix now features a
full-source bootstrap. This bootstrap is rooted in hex0-seed
from the Stage0 package.
The hex0 program is minimalist assembler: it reads space-separated
hexadecimal digits (nibbles) from a file, possibly including comments, and
emits on standard output the bytes corresponding to those hexadecimal
numbers. The source code of this initial hex0 program is a file called
hex0_x86.hex0
and is written in the hex0
language.
Hex0 is self-hosting, which means that it can build itself:
./hex0-seed hex0_x86.hex0 hex0
Hex0 it is the ASCII-equivalent of the binary program and can be produced by doing something much like:
sed 's/[;#].*$//g' hex0_x86.hex0 | xxd -r -p > hex0 chmod +x hex0
It is because of this ASCII-binary equivalence that we can bless this initial 357-byte binary as source, and hence ‘full-source bootstrap”.
The bootstrap then continues: hex0
builds hex1
and then on to
M0
, hex2
, M1
, mescc-tools
and finally
M2-Planet
. Then, using mescc-tools
, M2-Planet
we build
Mes (voir GNU Mes Reference Manual dans GNU Mes, a Scheme
interpreter and C compiler in Scheme). From here on starts the more
traditional C
-based bootstrap of the GNU System.
Another step that Guix has taken is to replace the shell and all its utilities with implementations in Guile Scheme, the Scheme-only bootstrap. Gash (voir Gash dans The Gash manual) is a POSIX-compatible shell that replaces Bash, and it comes with Gash Utils which has minimalist replacements for Awk, the GNU Core Utilities, Grep, Gzip, Sed, and Tar.
Construire le Système GNU à partir des sources est actuellement seulement
possible en ajoutant certains paquets GNU historiques en tant qu’étapes
intermédiaires44. Tandis que Gash et Gash Utils
avancent, et que les paquets GNU deviennent de nouveau plus bootstrappables
(p. ex. les nouvelles versions de GNU Sed proposeront de nouveau des
archives gzip, en alternative à la compression xz
difficile à
boostrapper), on espère pouvoir réduire de nouveau cet ensemble de paquets
supplémentaires.
Le graphe ci-dessous montre le graphe de dépendance résultant pour
gcc-core-mesboot
, le compilateur de bootstrap utilisé pour le
bootstrap traditionnel du reste du système Guix.
Work is ongoing to bring these bootstraps to the arm-linux
and
aarch64-linux
architectures and to the Hurd.
Si vous êtes intéressé·e, rejoignez-nous sur ‘#bootstrappable’ sur le réseau IRC Libera.Chat ou discutez-en sur bug-mes@gnu.org ou gash-devel@nongnu.org.
Précédent: The Full-Source Bootstrap, Monter: Bootstrapping [Table des matières][Index]
La figure ci-dessus montre le tout début du graphe de dépendances de la
distribution, correspondant aux définitions des paquets du module (gnu
packages bootstrap)
. Une figure similaire peut être générée avec
guix graph
(voir Invoque guix graph
), de cette manière :
guix graph -t derivation \ -e '(@@ (gnu packages bootstrap) %bootstrap-gcc)' \ | dot -Tps > gcc.ps
ou, pour le bootstrap avec les sources binaires plus réduites
guix graph -t derivation \ -e '(@@ (gnu packages bootstrap) %bootstrap-mes)' \ | dot -Tps > mes.ps
À ce niveau de détails, les choses sont légèrement complexes. Tout d’abord,
Guile lui-même consiste en an exécutable ELF, avec plusieurs fichiers Scheme
sources et compilés qui sont chargés dynamiquement quand il est exécuté.
Cela est stocké dans l’archive guile-2.0.7.tar.xz montrée dans ce
graphe. Cette archive fait parti de la distribution « source » de Guix, et
est insérée dans le dépôt avec add-to-store
(voir Le dépôt).
Mais comment écrire une dérivation qui décompresse cette archive et l’ajoute
au dépôt ? Pour résoudre ce problème, la dérivation
guile-bootstrap-2.0.drv
— la première qui est construite — utilise
bash
comme constructeur, qui lance build-bootstrap-guile.sh
,
qui à son tour appelle tar
pour décompresser l’archive. Ainsi,
bash, tar, xz et mkdir sont des binaires liés
statiquement, qui font aussi partie de la distribution source de Guix, dont
le seul but est de permettre à l’archive de Guile d’être décompressée.
Une fois que guile-bootstrap-2.0.drv
est construit, nous avons un
Guile fonctionnel qui peut être utilisé pour exécuter les programmes de
construction suivants. Sa première tâche consiste à télécharger les
archives contenant les autres binaires pré-construits — c’est ce que la
dérivation .tar.xz.drv
accomplit. Les modules Guix comme
ftp-client.scm
sont utilisés pour cela. Les dérivations
module-import.drv
importent ces modules dans un répertoire dans le
dépôt, en utilisant la disposition d’origine. Les dérivations
module-import-compiled.drv
compilent ces modules, et les écrivent
dans un répertoire de sortie avec le bon agencement. Cela correspond à
l’argument #:modules
de build-expression->derivation
(voir Dérivations).
Enfin, les diverses archives sont décompressées par les dérivations
gcc-bootstrap-0.drv
, glibc-bootstrap-0.drv
, ou
bootstrap-mes-0.drv
et bootstrap-mescc-tools-0.drv
, à ce
stade, nous avons une chaîne d’outils C qui fonctionne.
Le bootstrap est complet lorsque nous avons une chaîne d’outils complète qui
ne dépend pas des outils de bootstrap pré-construits dont on vient de
parler. Ce pré-requis d’indépendance est vérifié en s’assurant que les
fichiers de la chaîne d’outil finale ne contiennent pas de référence vers
les répertoires /gnu/store des entrées de bootstrap. Le processus
qui mène à cette chaîne d’outils « finale » est décrit par les définitions
de paquets qui se trouvent dans le module (gnu packages
commencement)
.
La commande guix graph
nous permet de « dézoomer » comparé au
graphe précédent, en regardant au niveau des objets de paquets plutôt que
des dérivations individuelles — rappelez-vous qu’un paquet peut se traduire
en plusieurs dérivations, typiquement une dérivation pour télécharger ses
sources, une pour les modules Guile dont il a besoin et une pour
effectivement compiler le paquet depuis les sources. La commande :
guix graph -t bag \ -e '(@@ (gnu packages commencement) glibc-final-with-bootstrap-bash)' | dot -Tps > t.ps
produit le graphe de dépendances qui mène à la bibliothèque C « finale »45, représentée ci-dessous.
Le premier outil construit avec les binaires de bootstrap est GNU Make
— appelé make-boot0
ci-dessus — qui est un prérequis de tous les
paquets suivants . Ensuite, Findutils et Diffutils sont construits.
Ensuite vient la première passe de Binutils et GCC, construits comme des
pseudo outils croisés — c.-à-d. dont --target est égal à
--host
. Ils sont utilisés pour construire la libc. Grâce à cette
astuce de compilation croisée, cette libc est garantie de ne contenir aucune
référence à la chaîne d’outils initiale.
À partir de là, les Bintulis finaux et GCC (non visibles ci-dessus) sont
construits. GCC utilise ld
du Binutils final et lie les programme
avec la libc qui vient d’être construite. Cette chaîne d’outils est
utilisée pour construire les autres paquets utilisés par Guix et par le
système de construction de GNU : Guile, Bash, Coreutils, etc.
Et voilà ! À partir de là nous avons l’ensemble complet des outils auxquels
s’attend le système de construction GNU. Ils sont dans la variable
%final-inputs
du module (gnu packages commencement)
et sont
implicitement utilisés par tous les paquets qui utilisent le
gnu-build-system
(voir gnu-build-system
).
Comme la chaîne d’outils finale ne dépend pas des binaires de bootstrap, ils
ont rarement besoin d’être mis à jour. Cependant, il est utile d’avoir une
manière de faire cela automatiquement, dans le cas d’une mise à jour et
c’est ce que le module (gnu packages make-bootstrap)
fournit.
La commande suivante construit les archives contenant les binaires bootstrap (Binutils, GCC, glibc, pour le bootstrap traditionnel et les linux-libre-headers, bootstrap-mescc-tools, bootstrap-mes pour le bootstrap Reduced Binary Seed, et Guile, et une archive contenant un mélange de Coreutils et d’autres outils de base de la ligne de commande) :
guix build bootstrap-tarballs
Les archives générées sont celles qui devraient être référencées dans le
module (gnu packages bootstrap)
au début de cette section.
Vous êtes toujours là ? Alors peut-être que maintenant vous vous demandez, quand est-ce qu’on atteint un point fixe ? C’est une question intéressante ! La réponse est inconnue, mais si vous voulez enquêter plus profondément (et que vous avez les ressources en puissance de calcul et en capacité de stockage pour cela), dites-le nous.
Nos binaires de bootstrap incluent actuellement GCC, GNU Libc, Guile, etc. C’est beaucoup de code binaire ! Pourquoi est-ce un problème ? C’est un problème parce que ces gros morceaux de code binaire sont en pratique impossibles à auditer, ce qui fait qu’il est difficile d’établir quel code source les a produit. Chaque binaire non vérifiable nous rend également vulnérables aux portes dérobées des compilateurs, comme le décrit Ken Thompson dans le document Reflections on Trusting Trust de 1984.
Cela est rendu moins inquiétant par le fait que les binaires de bootstrap ont été générés par une révision antérieure de Guix. Cependant, il leur manque le niveau de transparence que l’on obtient avec le reste des paquets du graphe de dépendance, où Guix nous donne toujours une correspondance source-binaire. Ainsi, notre but est de réduire l’ensemble des binaires de bootstrap au minimum.
Le site web Bootstrappable.org liste les projets en cours à ce sujet. L’un d’entre eux parle de remplacer le GCC de bootstrap par une série d’assembleurs, d’interpréteurs et de compilateurs d’une complexité croissante, qui pourraient être construits à partir des sources à partir d’un assembleur simple et auditable. Votre aide est (bien sûr !) la bienvenue.
Our first major achievement is the replacement of GCC, the GNU C Library and Binutils by MesCC-Tools (a simple hex linker and macro assembler) and Mes (voir GNU Mes Reference Manual dans GNU Mes, a Scheme interpreter and C compiler in Scheme). Neither MesCC-Tools nor Mes can be fully bootstrapped yet and thus we inject them as binary seeds. We call this the Reduced Binary Seed bootstrap, as it has halved the size of our bootstrap binaries! Also, it has eliminated the C compiler binary; i686-linux and x86_64-linux Guix packages are now bootstrapped without any binary C compiler.
Le travail continue pour rendre MesCC-Tools et Mes complètement bootstrappables et nous cherchons aussi comment remplacer tout autre binaire de bootstrap. votre aide est la bienvenue !
Suivant: Contribuer, Précédent: Bootstrapping, Monter: GNU Guix [Table des matières][Index]
Comme nous en avons discuté plus haut, la distribution GNU est
auto-contenue, et cela est possible en se basant sur des « binaires de
bootstrap » pré-construits (voir Bootstrapping). Ces binaires sont
spécifiques au noyau de système d’exploitation, à l’architecture CPU et à
l’interface applicative binaire (ABI). Ainsi, pour porter la distribution
sur une plateforme qui n’est pas encore supportée, on doit construire ces
binaires de bootstrap et mettre à jour le module (gnu packages
bootstrap)
pour les utiliser sur cette plateforme.
Heureusement, Guix peut effectuer une compilation croisée de ces binaires de bootstrap. Lorsque tout va bien, et en supposant que la chaîne d’outils GNU supporte la plateforme cible, cela peut être aussi simple que de lancer une commande comme ceci :
guix build --target=armv5tel-linux-gnueabi bootstrap-tarballs
Pour que cela fonctionne, vous devez d’abord enregistrer une nouvelle
plateforme définie dans le module (guix platform)
. Une plateforme
connecte un triplet GNU (voir GNU
configuration triplets dans Autoconf), l’équivalent du système
en notation Nix, le nom du glibc-dynamic-linker et le nom de
l’architecture Linux correspondante si applicable (voir Plateformes)..
Une fois que les archives de bootstrap sont construites, le module
(gnu packages bootstrap)
doit être mis à jour pour se référer à ces
binaires sur la plateforme cible. C’est à dire que les hashs et les URL des
archives de bootstrap pour la nouvelle plateforme doivent être ajoutés avec
ceux des plateformes actuellement supportées. L’archive de bootstrap de
Guile est traitée séparément : elle doit être disponible localement, et
gnu/local.mk a une règle pour la télécharger pour les architectures
supportées ; vous devez également ajouter une règle pour la nouvelle
plateforme.
En pratique, il peut y avoir des complications. Déjà, il se peut que le
triplet GNU étendu qui spécifie l’ABI (comme le suffixe eabi
ci-dessus) ne soit pas reconnu par tous les outils GNU. Typiquement, la
glibc en reconnait certains, alors que GCC utilise un drapeau de
configuration --with-abi supplémentaire (voir gcc.scm
pour
trouver des exemples où ce cas est géré). Ensuite, certains des paquets
requis pourraient échouer à se construire pour cette plateforme. Enfin, les
binaires générés pourraient être cassé pour une raison ou une autre.
Suivant: Remerciements, Précédent: Porter vers une nouvelle plateforme, Monter: GNU Guix [Table des matières][Index]
Ce projet est un effort coopératif et nous avons besoin de votre aide pour
le faire grandir ! Contactez-nous sur guix-devel@gnu.org et
#guix
sur le réseau IRC Libera Chat. Nous accueillons les idées, les
rapports de bogues, les correctifs et tout ce qui pourrait aider le projet.
Nous apprécions particulièrement toute aide sur la création de paquets
(voir Consignes d’empaquetage).
Nous souhaitons fournir un environnement chaleureux, amical et sans harcèlement pour que tout le monde puisse contribuer au mieux de ses capacités. Pour cela notre projet a une « Convention de contribution » adaptée de http://contributor-covenant.org/. Vous pouvez trouver une version locale dans le fichier CODE-OF-CONDUCT dans l’arborescence des sources.
Les contributeur·rices n’ont pas besoin d’utiliser leur nom légal dans leurs correctifs et leurs communications en ligne ; elles et ils peuvent utiliser n’importe quel nom ou pseudonyme de leur choix.
Suivant: Construire depuis Git, Monter: Contribuer [Table des matières][Index]
You can easily hack on Guix itself using Guix and Git, which we use for version control (voir Construire depuis Git).
But when packaging Guix for foreign distros or when bootstrapping on systems without Guix, and if you decide to not just trust and install our readily made binary (voir Installation binaire), you can download a release version of our reproducible source tarball and read on.
Cette section dresse la liste des prérequis pour la construction de Guix depuis les sources. La procédure de construction pour Guix est la même que pour les autres logiciels GNU, et n’est pas expliquée ici. Regardez les fichiers README et INSTALL dans l’arborescence des sources de Guix pour plus de détails.
GNU Guix est disponible au téléchargement depuis son site web sur http://www.gnu.org/software/guix/.
GNU Guix dépend des paquets suivants :
Les dépendances suivantes sont facultatives :
guix copy
(voir Invoquer guix copy
) dépend de
Guile-SSH, version
0.13.0 ou ultérieure.
guix publish
et pour les
substituts (voir Invoquer guix publish
).
crate
(voir Invoquer guix import
).
go
(voir Invoquer guix import
) et pour certains
programmes de mise à jour .(voir Invoquer guix refresh
).
guix-daemon
peut l’utiliser pour compresser les journaux de
construction.
Sauf si --disable-daemon a été passé à configure
, les
paquets suivants sont également nécessaires :
Suivant: Lancer la suite de tests, Précédent: Prérequis, Monter: Contribuer [Table des matières][Index]
Si vous souhaitez travailler sur Guix lui-même, il est recommandé d’utiliser la dernière version du dépôt Git :
git clone https://git.savannah.gnu.org/git/guix.git
Comment vous assurer que vous avez obtenu une copie authentique du dépôt ?
Pour cela, exécutez guix git authenticate
, en lui transmettant le
commit et l’empreinte OpenPGP de l’canal introduction (voir Invoquer guix git authenticate
) :
git fetch origin keyring:keyring guix git authenticate 9edb3f66fd807b096b48283debdcddccfea34bad \ "BBB0 2DDF 2CEA F6A8 0D1D E643 A2A0 6DF2 A33A 54FA"
Cette commande se termine avec le code de sortie zéro en cas de succès ; elle affiche un message d’erreur et quitte avec un code non zéro dans le cas contraire.
Comme vous pouvez le voir, il y a un problème de poule et d’œuf : il faut d’abord avoir installé Guix. En général, vous installez Guix System (voir Installation du système) ou Guix sur une autre distribution (voir Installation binaire) ; dans les deux cas, vous vérifiez la signature OpenPGP sur le support d’installation. Cela "amorce" la chaîne de confiance.
La manière la plus simple de configurer un environnement de développement pour Guix est, bien sûr, d’utiliser Guix ! La commande suivante démarre un nouveau shell où toutes les dépendances et les variables d’environnements appropriées sont configurés pour travailler sur Guix :
guix shell -D guix -CPW
or even, from within a Git worktree for Guix:
guix shell -CPW
If -C (short for --container) is not supported on your
system, try --pure
instead of -CPW. Voir Invoquer guix shell
, for more information on that command.
Si vous ne pouvez pas utiliser Guix pour la construction de Guix depuis un extrait, les paquets suivants sont requis en plus de ceux mentionnés dans les instructions d’installation (voir Prérequis).
Avec Guix, vous pouvez ajouter des dépendances supplémentaires en lançant
guix shell
:
guix shell -D guix help2man git strace --pure
Vous pouvez maintenant générer l’infrastructure du système de construction avec Autoconf et Automake :
./bootstrap
Si vous obtenez une erreur de ce type :
configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES
cela signifie probablement qu’Autoconf n’a pas pu trouver pkg.m4 qui est fournit par pkg-config. Assurez-vous que pkg.m4 est disponible. C’est aussi vrai pour l’ensemble de macros de guile.m4 fournies par Guile. Par exemple, si vous avez installé Automake dans /usr/local, il ne cherchera pas les fichiers .m4 dans /usr/share. Dans ce case vous devez invoquer la commande suivante :
export ACLOCAL_PATH=/usr/share/aclocal
Voir Macro Search Path dans The GNU Automake Manual, pour plus d’information.
Ensuite lancez :
./configure
Optionally, --localstatedir
and --sysconfdir
can also be
provided as arguments. By default, localstatedir
is /var
(voir Le dépôt, for information about this) and sysconfdir
is
/etc. Note that you will probably not run make install
at
the end (you don’t have to) but it’s still important to pass the right
localstatedir
and sysconfdir
values, which get recorded in the
(guix config)
Guile module.
Enfin, vous pouvez construire Guix et, si vous le souhaitez, lancer les tests (voir Lancer la suite de tests) :
make make check
Si quelque chose échoue, jetez un œil aux instructions d’installation (voir Installation) ou envoyez un message à la liste guix-devel@gnu.org.
À partir de maintenant, vous pouvez authentifier tous les commits de votre extrait en lançant :
guix git authenticate \ 9edb3f66fd807b096b48283debdcddccfea34bad \ "BBB0 2DDF 2CEA F6A8 0D1D E643 A2A0 6DF2 A33A 54FA"
The first run takes a couple of minutes, but subsequent runs are faster. On subsequent runs, you can run the command without any arguments since the introduction (the commit ID and OpenPGP fingerprints above) will have been recorded47:
guix git authenticate
When your configuration for your local Git repository doesn’t match the
default one, you can provide the reference for the keyring
branch
via the -k option. The following example assumes that you have
a Git remote called ‘myremote’ pointing to the official repository:
guix git authenticate \ -k myremote/keyring \ 9edb3f66fd807b096b48283debdcddccfea34bad \ "BBB0 2DDF 2CEA F6A8 0D1D E643 A2A0 6DF2 A33A 54FA"
Voir Invoquer guix git authenticate
, for more information on this command.
Remarque : By default, hooks are installed such that
guix git authenticate
is invoked anytime you rungit pull
orgit push
.
Après la mise à jour du dépôt, make
peut échouer avec une erreur
semblable à celle de l’exemple suivant :
error: failed to load 'gnu/packages/linux.scm': ice-9/eval.scm:293:34: In procedure abi-check: #<record-type <origin>>: record ABI mismatch; recompilation needed
Cela signifie qu’un des types d’enregistrement que Guix définie (dans cet
exemple, l’enregistrement origin
) a changé, et que l’entièreté de
guix doit être recompilé pour prendre ce changement en compte. Pour ce
faire, lancez make clean-go
suivi de make
.
Should make
fail with an Automake error message after updating,
you need to repeat the steps outlined in this section, commencing with
./bootstrap
.
Suivant: Lancer Guix avant qu’il ne soit installé, Précédent: Construire depuis Git, Monter: Contribuer [Table des matières][Index]
Après avoir lancé configure
et make
correctement, c’est une
bonne idée de lancer la suite de tests. Elle peut aider à trouver des
erreurs avec la configuration ou l’environnement, ou des bogues dans Guix
lui-même — et vraiment, rapporter des échecs de tests est une bonne manière
d’aider à améliorer le logiciel. Pour lancer la suite de tests, tapez :
make check
Les cas de tests peuvent être lancés en parallèle : vous pouvez utiliser
l’option -j
de GNU make pour accélérer les choses. Le premier
lancement peut prendre plusieurs minutes sur une machine récente ; les
lancements suivants seront plus rapides car le dépôt créé pour les tests
aura déjà plusieurs choses en cache.
Il est aussi possible de lancer un sous-ensemble des tests en définissant la
variable makefile TESTS
comme dans cet exemple :
make check TESTS="tests/store.scm tests/cpio.scm"
Par défaut, les résultats des tests sont affichés au niveau du fichier.
Pour voir les détails de chaque cas de test individuel, il est possible de
définir la variable makefile SCM_LOG_DRIVER_FLAGS
comme dans cet
exemple :
make check TESTS="tests/base64.scm" SCM_LOG_DRIVER_FLAGS="--brief=no"
Le pilote de tests Automake personnalisé avec SRFI 64 utilisé pour la suite de tests « check » (située dans build-aux/test-driver.scm) permet aussi de choisir les cas de test à lancer à plus fine granularité, via ses options --select et --exclude. Voici un exemple, pour lancer tous les cas de tests du fichier de tests tests/packages.scm dont les noms commencent par « transaction-upgrade-entry » :
export SCM_LOG_DRIVER_FLAGS="--select=^transaction-upgrade-entry" make check TESTS="tests/packages.scm"
Pour celles et ceux qui veulent inspecter les résultats des tests échoués
directement depuis la ligne de commande, il est possible d’ajouter l’option
--errors-only=yes à la variable SCM_LOG_DRIVER_FLAGS
du
Makefile et d’initialiser la variable Automake du Makefile VERBOSE
,
de cette manière :
make check SCM_LOG_DRIVER_FLAGS="--brief=no --errors-only=yes" VERBOSE=1
L’option --show-duration=yes peut être utilisée pour afficher la durée des cas de test individuels, en combinaison avec --brief=no :
make check SCM_LOG_DRIVER_FLAGS="--brief=no --show-duration=yes"
Voir Parallel Test Harness dans GNU Automake pour plus d’information sur le banc de tests parallèle d’Automake.
Après un échec, envoyez un courriel à bug-guix@gnu.org et attachez le fichier test-suite.log. Précisez la version de Guix utilisée ainsi que les numéros de version de ses dépendances (voir Prérequis) dans votre message.
Guix possède aussi une suite de tests de systèmes complets qui test des instances complètes du système Guix. Elle ne peut être lancée qui sur un système où Guix est déjà installé, avec :
make check-system
ou, de nouveau, en définissant TESTS
pour choisir un sous-ensemble
des tests à lancer :
make check-system TESTS="basic mcron"
Ces tests systèmes sont définis dans les modules (gnu tests
…)
. Ils fonctionnent en lançant les systèmes d’exploitation sous test
avec une instrumentation légère dans une machine virtuelle (VM). Ils
peuvent être intenses en terme de calculs ou plutôt rapides en fonction de
la disponibilité des substituts de leurs dépendances (voir Substituts).
Certains requièrent beaucoup d’espace disque pour contenir les images des
VM.
If you encounter an error like:
Compiling Scheme modules... ice-9/eval.scm:142:16: In procedure compile-top-call: error: all-system-tests: unbound variable hint: Did you forget `(use-modules (gnu tests))'?
there may be inconsistencies in the work tree from previous builds. To
resolve this, try running make clean-go
followed by
make
.
De nouveau, en cas d’échec, envoyez tous les détails à bug-guix@gnu.org.
Suivant: La configuration parfaite, Précédent: Lancer la suite de tests, Monter: Contribuer [Table des matières][Index]
Pour garder un environnement de travail sain, il est utile de tester les changement localement sans les installer pour de vrai. Pour pouvoir distinguer votre rôle « d’utilisateur·rice final·e » de celui parfois haut en couleur de « développeur·euse ».
To that end, all the command-line tools can be used even if you have not run
make install
. To do that, you first need to have an environment with
all the dependencies available (voir Construire depuis Git), and then simply
prefix each command with ./pre-inst-env
(the pre-inst-env
script lives in the top build tree of Guix; voir Construire depuis Git to
generate it). As an example, here is how you would build the hello
package as defined in your working tree (this assumes guix-daemon
is already running on your system; it’s OK if it’s a different version):
$ ./pre-inst-env guix build hello
De même, pour une session Guile qui utilise les modules Guix :
$ ./pre-inst-env guile -c '(use-modules (guix utils)) (pk (%current-system))' ;;; ("x86_64-linux")
… et pour une REPL (voir Utiliser Guix de manière interactive) :
$ ./pre-inst-env guile scheme@(guile-user)> ,use(guix) scheme@(guile-user)> ,use(gnu) scheme@(guile-user)> (define snakes (fold-packages (lambda (package lst) (if (string-prefix? "python" (package-name package)) (cons package lst) lst)) '())) scheme@(guile-user)> (length snakes) $1 = 361
Si vous travaillez sur le démon et son code supporté ou si
guix-daemon
n’est pas déjà lancé sur votre système, vous pouvez le
lancer directement depuis l’arborescence de construction48 :
$ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild
Le script pre-inst-env
paramètre toutes les variables
d’environnement nécessaires, dont PATH
et GUILE_LOAD_PATH
.
Remarquez que ./pre-inst-env guix pull
ne met pas à jour
l’arborescence des sources locale ; cela met seulement à jour le lien
symbolique de ~/.config/guix/current (voir Invoquer guix pull
).
Lancez git pull
à la place si vous voulez mettre à jour votre
arborescence des source locale.
Parfois, surtout si vous avez récemment mis à jour votre dépôt, lancer
./pre-inst-env
affichera des messages semblables à l’exemple
suivant :
;;; note: source file /home/user/projects/guix/guix/progress.scm ;;; newer than compiled /home/user/projects/guix/guix/progress.go
Ce n’est qu’une remarque et vous pouvez l’ignorer sans problème. Vous pouvez
vous débarrasser de ce message en lançant make -j4
. Jusqu’à ce que
vous fassiez cela, Guile sera un tout petit peu plus lent parce qu’il doit
interpréter le code au lieu d’utiliser les fichiers objets Guile
(.go) précompilés.
Vous pouvez lancer make
automatiquement quand vous travaillez avec
watchexec
du paquet watchexec
. Par exemple, pour construire
de nouveau à chaque fois que vous modifiez un fichier de paquet lancez
‘watchexec -w gnu/packages -- make -j4’.
Suivant: Alternative Setups, Précédent: Lancer Guix avant qu’il ne soit installé, Monter: Contribuer [Table des matières][Index]
La configuration parfaite pour travailler sur Guix est simplement la configuration parfaite pour travailler en Guile (voir Using Guile in Emacs dans Guile Reference Manual). Tout d’abord, vous avez besoin de mieux qu’un éditeur de texte, vous avez besoin de Emacs, amélioré par le superbe Geiser. Pour paramétrer cela, lancez :
guix install emacs guile emacs-geiser emacs-geiser-guile
Geiser permet le développement interactif et incrémental depuis Emacs : la compilation du code et son évaluation depuis les tampons, l’accès à la documentation en ligne (docstrings), la complétion sensible au contexte, M-. pour sauter à la définition d’un objet, un REPL pour tester votre code, et bien plus (voir Introduction dans Geiser User Manual). Si vous permettez à Emacs de charger le fichier .dir-locals.el à la racine du projet, cela permettra à Geiser d’ajouter automatiquement les sources Guix locales au chemin de chargement de Guile.
Pour effectivement éditer le code, Emacs a déjà un très bon mode Scheme. Mais en plus de ça, vous ne devez pas rater Paredit. Il fournit des fonctionnalités pour opérer directement sur l’arbre de syntaxe, comme relever une s-expression ou l’envelopper, absorber ou rejeter la s-expression suivante, etc.
Nous fournissons aussi des modèles pour les messages de commit git courants et les définitions de paquets dans le répertoire etc/snippets. Ces modèles s’utilisent pour étendre de courtes phrases d’amorce en des bouts de texte interactifs. Si vous utilisez YASnippet, vous voudrez peut-être ajouter le répertoire des modèles, etc/snippets/yas, dans la variable d’environnement yas-snippet-dirs. Si vous utilisez Tempel, vous voudrez peut-être ajouter le chemin etc/snippets/tempel/* dans la variable tempel-path d’Emacs.
;; En supposant que le dépôt git de Guix est dans ~/src/guix. ;; Configuration Yasnippet (with-eval-after-load 'yasnippet (add-to-list 'yas-snippet-dirs "~/src/guix/etc/snippets/yas")) ;; Configuration Tempel (with-eval-after-load 'tempel ;; S'assure que tempel-path est une liste — elle peut aussi être une chaine. (unless (listp 'tempel-path) (setq tempel-path (list tempel-path))) (add-to-list 'tempel-path "~/src/guix/etc/snippets/tempel/*"))
Les extraits de messages de commit dépendent de Magit pour afficher les fichiers sélectionnés. Lors de la modification
d’un message de commit, tapez add
suivi de TAB pour insérer un
modèle de message de commit pour ajouter un paquet ; tapez update
suivi de TAB pour insérer un modèle pour la mise à jour d’un paquet ;
tapez https
suivi de TAB pour insérer un modèle pour le
changement à HTTPS de l’URI de la page d’accueil.
L’extrait principal pour scheme-mode
est lancé en tapant
package…
suivi par TAB. Cet extrait insère aussi la chaîne de
déclenchement origin…
, qui peut aussi être étendue. L’extrait
origin
lui-même peut aussi insérer des chaînes de déclenchement qui
finissent sur …
, qui peuvent aussi être étendues.
De plus, nous fournissons l’insertion et la mise à jour automatique d’une ligne de copyright dans etc/copyright.el. Vous voudrez sans doute indiquer votre nom complet, adresse de courriel et charger le fichier.
(setq user-full-name "Alice Doe") (setq user-mail-address "alice@mail.org") ;; En supposant que le dépôt Guix est dans ~/src/guix. (load-file "~/src/guix/etc/copyright.el")
Pour insérer une ligne de copyright à la ligne actuelle invoquez M-x
guix-copyright
.
Pour mettre à jour une ligne de copyright vous devez spécifier un
copyright-names-regexp
.
(setq copyright-names-regexp
(format "%s <%s>" user-full-name user-mail-address))
Vous pouvez vérifier si votre ligne de copyright est à jour en évaluant
M-x copyright-update
. Si vous voulez le faire automatiquement après
chaque sauvegarde de tampon ajoutez (add-hook 'after-save-hook
'copyright-update)
dans Emacs.
Monter: La configuration parfaite [Table des matières][Index]
Emacs has a nice minor mode called bug-reference
, which, when
combined with ‘emacs-debbugs’ (the Emacs package), can be used to open
links such as ‘<https://bugs.gnu.org/58697>’ or
‘<https://issues.guix.gnu.org/58697>’ as bug report buffers. From
there you can easily consult the email thread via the Gnus interface, reply
or modify the bug status, all without leaving the comfort of Emacs! Below is
a sample configuration to add to your ~/.emacs configuration file:
;;; Bug references. (require 'bug-reference) (add-hook 'prog-mode-hook #'bug-reference-prog-mode) (add-hook 'gnus-mode-hook #'bug-reference-mode) (add-hook 'erc-mode-hook #'bug-reference-mode) (add-hook 'gnus-summary-mode-hook #'bug-reference-mode) (add-hook 'gnus-article-mode-hook #'bug-reference-mode) ;;; This extends the default expression (the top-most, first expression ;;; provided to 'or') to also match URLs such as ;;; <https://issues.guix.gnu.org/58697> or <https://bugs.gnu.org/58697>. ;;; It is also extended to detect "Fixes: #NNNNN" git trailers. (setq bug-reference-bug-regexp (rx (group (or (seq word-boundary (or (seq (char "Bb") "ug" (zero-or-one " ") (zero-or-one "#")) (seq (char "Pp") "atch" (zero-or-one " ") "#") (seq (char "Ff") "ixes" (zero-or-one ":") (zero-or-one " ") "#") (seq "RFE" (zero-or-one " ") "#") (seq "PR " (one-or-more (char "a-z+-")) "/")) (group (one-or-more (char "0-9")) (zero-or-one (seq "#" (one-or-more (char "0-9")))))) (seq (? "<") "https://bugs.gnu.org/" (group-n 2 (one-or-more (char "0-9"))) (? ">")) (seq (? "<") "https://issues.guix.gnu.org/" (? "issue/") (group-n 2 (one-or-more (char "0-9"))) (? ">")))))) (setq bug-reference-url-format "https://issues.guix.gnu.org/%s") (require 'debbugs) (require 'debbugs-browse) (add-hook 'bug-reference-mode-hook #'debbugs-browse-mode) (add-hook 'bug-reference-prog-mode-hook #'debbugs-browse-mode) ;; The following allows Emacs Debbugs user to open the issue directly within ;; Emacs. (setq debbugs-browse-url-regexp (rx line-start "http" (zero-or-one "s") "://" (or "debbugs" "issues.guix" "bugs") ".gnu.org" (one-or-more "/") (group (zero-or-one "cgi/bugreport.cgi?bug=")) (group-n 3 (one-or-more digit)) line-end)) ;; Change the default when run as 'M-x debbugs-gnu'. (setq debbugs-gnu-default-packages '("guix" "guix-patches")) ;; Show feature requests. (setq debbugs-gnu-default-severities '("serious" "important" "normal" "minor" "wishlist"))
For more information, refer to Bug Reference dans The GNU Emacs Manual and Minor Mode dans The Debbugs User Guide.
Suivant: Source Tree Structure, Précédent: La configuration parfaite, Monter: Contribuer [Table des matières][Index]
Alternative setups than Emacs may let you work on Guix with a similar development experience and they might work better with the tools you currently use or help you make the transition to Emacs.
The options listed below only provide the alternatives to the Emacs based setup, which is the most widely used in the Guix community. If you want to really understand how is the perfect setup for Guix development supposed to work, we encourage you to read the section before this regardless the editor you choose to use.
Suivant: Vim and NeoVim, Monter: Alternative Setups [Table des matières][Index]
Guile Studio is a pre-configured Emacs with mostly everything you need to start hacking in Guile. If you are not familiar with Emacs it makes the transition easier for you.
guix install guile-studio
Guile Studio comes with Geiser preinstalled and prepared for action.
Précédent: Guile Studio, Monter: Alternative Setups [Table des matières][Index]
Vim (and NeoVim) are also packaged in Guix, just in case you decided to go for the evil path.
guix install vim
If you want to enjoy a similar development experience to that in the perfect
setup, you should install several plugins to configure the editor. Vim (and
NeoVim) have the equivalent to Paredit,
paredit.vim
, that will help you with the structural editing of
Scheme files (the support for very large files is not great, though).
guix install vim-paredit
We also recommend that you run :set autoindent
so that your code is
automatically indented as you type.
For the interaction with Git,
fugitive.vim
is the most commonly used plugin:
guix install vim-fugitive
And of course if you want to interact with Guix directly from inside of vim,
using the built-in terminal emulator, we have our very own guix.vim
package!
guix install vim-guix-vim
In NeoVim you can even make a similar setup to Geiser using Conjure that lets you connect to a running Guile process and inject your code there live (sadly it’s not packaged in Guix yet).
Suivant: Consignes d’empaquetage, Précédent: Alternative Setups, Monter: Contribuer [Table des matières][Index]
If you’re willing to contribute to Guix beyond packages, or if you’d like to learn how it all fits together, this section provides a guided tour in the code base that you may find useful.
Overall, the Guix source tree contains almost exclusively Guile modules, each of which can be seen as an independent library (voir Modules dans GNU Guile Reference Manual).
The following table gives an overview of the main directories and what they
contain. Remember that in Guile, each module name is derived from its file
name—e.g., the module in file guix/packages.scm is called
(guix packages)
.
This is the location of core Guix mechanisms. To illustrate what is meant by “core”, here are a few examples, starting from low-level tools and going towards higher-level tools:
(guix store)
Connecting to and interacting with the build daemon (voir Le dépôt).
(guix derivations)
Creating derivations (voir Dérivations).
(guix gexps)
Writing G-expressions (voir G-Expressions).
(guix packages)
Defining packages and origins (voir Référence de package
).
(guix download)
(guix git-download)
The url-fetch
and git-fetch
origin download methods
(voir Référence de origin
).
(guix swh)
Fetching source code from the Software Heritage archive.
(guix search-paths)
Implementing search paths (voir Chemins de recherche).
(guix build-system)
The build system interface (voir Systèmes de construction).
(guix profiles)
Implementing profiles.
This directory contains specific build system implementations (voir Systèmes de construction), such as:
(guix build-system gnu)
the GNU build system;
(guix build-system cmake)
the CMake build system;
(guix build-system pyproject)
The Python “pyproject” build system.
This contains code generally used on the “build side” (voir strata of code). This includes code used to build packages or other operating system components, as well as utilities:
(guix build utils)
Utilities for package definitions and more (voir Utilitaires de construction).
(guix build gnu-build-system)
(guix build cmake-build-system)
(guix build pyproject-build-system)
Implementation of build systems, and in particular definition of their build phases (voir Phases de construction).
(guix build syscalls)
Interface to the C library and to Linux system calls.
This contains modules corresponding to guix
sub-commands. For
example, the (guix scripts shell)
module exports the
guix-shell
procedure, which directly corresponds to the guix
shell
command (voir Invoquer guix shell
).
This contains supporting code for the importers and updaters
(voir Invoquer guix import
, and voir Invoquer guix refresh
). For
example, (guix import pypi)
defines the interface to PyPI, which is
used by the guix import pypi
command.
The directories we have seen so far all live under guix/. The other
important place is the gnu/ directory, which contains primarily
package definitions as well as libraries and tools for Guix System
(voir Configuration du système) and Guix Home (voir Configuration du dossier personnel),
all of which build upon functionality provided by (guix …)
modules49.
This is by far the most crowded directory of the source tree: it contains package modules that export package definitions (voir Modules de paquets). A few examples:
(gnu packages base)
Module providing “base” packages: glibc
, coreutils
,
grep
, etc.
(gnu packages guile)
Guile and core Guile packages.
(gnu packages linux)
The Linux-libre kernel and related packages.
(gnu packages python)
Python and core Python packages.
(gnu packages python-xyz)
Miscellaneous Python packages (we were not very creative).
In any case, you can jump to a package definition using guix edit
(voir Invoquer guix edit
) and view its location with guix show
(voir Invoquer guix package
).
This directory contains patches applied against packages and obtained using
the search-patches
procedure.
This contains service definitions, primarily for Guix System (voir Services) but some of them are adapted and reused for Guix Home as we will see below. Examples:
(gnu services)
The service framework itself, which defines the service and service type data types (voir Composition de services).
(gnu services base)
“Base” services (voir Services de base).
(gnu services desktop)
“Desktop” services (voir Services de bureaux).
(gnu services shepherd)
Support for Shepherd services (voir Services Shepherd).
You can jump to a service definition using guix system edit
and
view its location with guix system search
(voir Invoquer guix system
).
These are core Guix System modules, such as:
(gnu system)
Defines operating-system
(voir Référence de operating-system
).
(gnu system file-systems)
Defines file-system
(voir Systèmes de fichiers).
(gnu system mapped-devices)
Defines mapped-device
(voir Périphériques mappés).
These are modules that are either used on the “build side” when building operating systems or packages, or at run time by operating systems.
(gnu build accounts)
Creating /etc/passwd, /etc/shadow, etc. (voir Comptes utilisateurs).
(gnu build activation)
Activating an operating system at boot time or reconfiguration time.
(gnu build file-systems)
Searching, checking, and mounting file systems.
(gnu build linux-boot)
(gnu build hurd-boot)
Booting GNU/Linux and GNU/Hurd operating systems.
(gnu build linux-initrd)
Creating a Linux initial RAM disk (voir Disque de RAM initial).
This contains all things Guix Home (voir Configuration du dossier personnel); examples:
(gnu home services)
Core services such as home-files-service-type
.
(gnu home services ssh)
SSH-related services (voir Shell sécurisé).
This contains the text-mode graphical system installer (voir Installation graphique guidée).
These are the machine abstractions used by guix deploy
(voir Invoquer guix deploy
).
This contains system tests—tests that spawn virtual machines to check that system services work as expected (voir Lancer la suite de tests).
Last, there’s also a few directories that contain files that are not Guile modules:
This is the C++ implementation of guix-daemon
, inherited from Nix
(voir Invoquer guix-daemon
).
These are unit tests, each file corresponding more or less to one module, in
particular (guix …)
modules (voir Lancer la suite de tests).
This is the documentation in the form of Texinfo files: this manual and the Cookbook. Voir Writing a Texinfo File dans GNU Texinfo, for information on Texinfo markup language.
This is the location of translations of Guix itself, of package synopses and descriptions, of the manual, and of the cookbook. Note that .po files that live here are pulled directly from Weblate (voir Traduire Guix).
Miscellaneous files: shell completions, support for systemd and other init systems, Git hooks, etc.
With all this, a fair chunk of your operating system is at your fingertips!
Beyond grep
and git grep
, voir La configuration parfaite on
how to navigate code from your editor, and voir Utiliser Guix de manière interactive
for information on how to use Scheme modules interactively. Enjoy!
Suivant: Style de code, Précédent: Source Tree Structure, Monter: Contribuer [Table des matières][Index]
La distribution GNU est jeune et vos paquets préférés peuvent manquer. Cette section décrit comment vous pouvez aider à agrandir la distribution.
Les paquets de logiciels libres sont habituellement distribués sous forme d’archives de sources — typiquement des fichiers .tar.gz contenant tous les fichiers sources. Ajouter un paquet à la distribution signifie en substance deux choses : ajouter une recette qui décrit comment construire le paquet, avec une liste d’autres paquets requis pour le construire, et ajouter des métadonnées de paquet avec la recette, comme une description et une licence.
Dans Guix, toutes ces informations sont incorporées dans les définitions de paquets. Les définitions de paquets fournissent une vue de haut-niveau du paquet. Elles sont écrites avec la syntaxe du langage de programmation Scheme ; en fait, pour chaque paquet nous définissons une variable liée à la définition et exportons cette variable à partir d’un module (voir Modules de paquets). Cependant, il n’est pas nécessaire d’avoir une connaissance approfondie du Scheme pour créer des paquets. Pour plus d’informations sur les définitions des paquets, voir Définition des paquets.
Une fois une définition de paquet en place, stocké dans un fichier de
l’arborescence des sources de Guix, il peut être testé avec la commande
guix build
(voir Invoquer guix build
). Par exemple, en
supposant que le nouveau paquet s’appelle gnew
, vous pouvez lancer
cette commande depuis l’arborescence de construction de Guix (voir Lancer Guix avant qu’il ne soit installé) :
./pre-inst-env guix build gnew --keep-failed
Utiliser --keep-failed
rend facile le débogage des échecs car il
fournit l’accès à l’arborescence de construction qui a échouée. Une autre
sous-commande utile pour le débogage est --log-file
, pour accéder au
journal de construction.
Si le paquet n’est pas connu de la commande guix
, il se peut que
le fichier source ait une erreur de syntaxe, ou qu’il manque une clause
define-public
pour exporter la variable du paquet. Pour comprendre
cela, vous pouvez charger le module depuis Guile pour avoir plus
d’informations sur la véritable erreur :
./pre-inst-env guile -c '(use-modules (gnu packages gnew))'
Une fois que votre paquet est correctement construit, envoyez-nous un correctif (voir Contribuer). Enfin, si vous avez besoin d’aide, nous serons ravis de vous aider aussi. Une fois que le correctif soumis est commité dans le dépôt Guix, le nouveau paquet est automatiquement construit sur les plate-formes supportées par notre système d’intégration continue.
On peut obtenir la nouvelle définition du paquet simplement en lançant
guix pull
(voir Invoquer guix pull
). Lorsque
bordeaux.guix.gnu.org
a fini de construire le paquet,
l’installation du paquet y télécharge automatiquement les binaires
(voir Substituts). La seule intervention humaine requise est pendant la
revue et l’application du correctif.
Suivant: Conventions de nommage, Monter: Consignes d’empaquetage [Table des matières][Index]
Le système d’exploitation GNU a été développé pour que les utilisatrices et utilisateurs puissent utiliser leur ordinateur en toute liberté. GNU est un logiciel libre, ce qui signifie que chaque personne l’utilisant bénéficie des quatre libertés essentielles : exécuter le programmer, étudier et modifier le programme sous sa forme source, redistribuer des copies exactes et distribuer les versions modifiées. Les paquets qui se trouvent dans la distribution GNU ne fournissent que des logiciels qui respectent ces quatre libertés.
En plus, la distribution GNU suit les recommandations pour les distributions systèmes libres. Entre autres choses, ces recommandations rejettent les microgiciels non libres, les recommandations de logiciels non libres et discute des façon de gérer les marques et les brevets.
Certaines sources amont autrement parfaitement libres contiennent une petite
partie facultative qui viole les recommandations ci-dessus, par exemple car
cette partie est du code non-libre. Lorsque cela arrive, les éléments en
question sont supprimés avec des correctifs ou des bouts de codes appropriés
dans la forme origin
du paquet (voir Définition des paquets). De cette
manière, guix build --source
renvoie la source « libérée » plutôt que
la source amont sans modification.
Suivant: Numéros de version, Précédent: Liberté logiciel, Monter: Consignes d’empaquetage [Table des matières][Index]
Un paquet a en fait deux noms qui lui sont associés. Premièrement il y a le
nom de la variable Scheme, celui qui suit define-public
. Par
ce nom, le paquet peut se faire connaître par le code Scheme, par exemple
comme entrée d’un autre paquet. Deuxièmement, il y a la chaîne dans le
champ name
d’une définition de paquet. Ce nom est utilisé par les
commandes de gestion des paquets comme guix package
et
guix build
.
Les deux sont habituellement les mêmes et correspondent à la conversion en
minuscule du nom du projet choisi en amont, où les underscores sont
remplacés par des tirets. Par exemple, GNUnet est disponible en tant que
gnunet
et SDL_net en tant que sdl-net
.
Une exception notable à cette règle est lorsque le nom du projet consiste en
un unique caractère, ou si un projet maintenu plus ancien avec le même nom
existe déjà — indépendamment de s’il a été empaqueté dans Guix on
nom. Utilisez votre bon sens pour éviter de rendre ces noms ambigües et de
leur enlever leur sens. Par exemple, le paquet Guix pour le shell nommé « s
» en amont est s-shell
et pas s
. N’hésitez pas à
demander si vous êtes en panne d’inspiration.
Nous n’ajoutons pas de préfixe lib
au bibliothèques de paquets, à
moins qu’il ne fasse partie du nom officiel du projet. Mais voir Modules Python et Modules Perl pour des règles spéciales concernant les
modules pour les langages Python et Perl.
Les noms de paquets de polices sont gérés différemment, voir Polices de caractères.
Suivant: Synopsis et descriptions, Précédent: Conventions de nommage, Monter: Consignes d’empaquetage [Table des matières][Index]
Nous n’incluons en général que la dernière version d’un projet de logiciel
libre donné. Mais parfois, par exemple pour des versions incompatibles de
bibliothèques, deux (ou plus) versions du même paquet sont requises. Elles
ont besoin d’un nom de variable Scheme différent. Nous utilisons le nom
défini dans Conventions de nommage pour la version la plus récente ; les
versions précédentes utilisent le même nom, suffixé par -
et le plus
petit préfixe du numéro de version qui permet de distinguer deux versions.
Le nom dans la définition du paquet est le même pour toutes les versions d’un paquet et ne contient pas de numéro de version.
Par exemple, les version 2.24.20 et 3.9.12 de GTK+ peuvent être inclus de cette manière :
(define-public gtk+ (package (name "gtk+") (version "3.9.12") ...)) (define-public gtk+-2 (package (name "gtk+") (version "2.24.20") ...))
Si nous voulons aussi GTK+ 3.8.2, cela serait inclus de cette manière
Parfois, nous incluons des paquets provenant d’instantanés de systèmes de
contrôle de version (VCS) au lieu de versions publiées formellement. Cela
devrait rester exceptionnel, car c’est le rôle des développeurs amont de
spécifier quel est la version stable. Cependant, c’est parfois nécessaire.
Donc, que faut-il mettre dans le champ version
?
Clairement, nous devons rendre l’identifiant de commit de l’instantané du
VCS visible dans la version, mais nous devons aussi nous assurer que la
version augmente de manière monotone pour que guix package
--upgrade
puisse déterminer quelle version est la plus récente. Comme les
identifiants de commits, notamment avec Git, n’augmentent pas, nous ajoutons
un numéro de révision qui nous augmentons à chaque fois que nous mettons à
jour vers un nouvel instantané. La chaîne qui en résulte ressemble à cela :
2.0.11-3.cabba9e ^ ^ ^ | | `-- ID du commit en amont | | | `--- révision du paquet Guix | dernière version en amont
C’est une bonne idée de tronquer les identifiants dans le champ
version
à disons 7 caractères. Cela évite un problème esthétique (en
supposant que l’esthétique ait un rôle à jouer ici) et des problèmes avec
les limites de l’OS comme la longueur maximale d’un shebang (127 octets pour
le noyau Linux). Il y a des fonctions auxiliaires pour faire cela avec les
paquets qui utilisent git-fetch
ou hg-fetch
(voir plus
bas). Il vaut mieux cependant utiliser l’identifiant de commit complet dans
origin
, pour éviter les ambiguïtés. Une définition de paquet peut
ressembler à ceci :
(define my-package
(let ((commit "c3f29bc928d5900971f65965feaae59e1272a3f7")
(revision "1")) ;révision du paquet Guix
(package
(version (git-version "0.9" revision commit))
(source (origin
(method git-fetch)
(uri (git-reference
(url "git://example.org/my-package.git")
(commit commit)))
(sha256 (base32 "1mbikn…"))
(file-name (git-file-name name version))))
;; …
)))
Renvoie la chaîne de version pour les paquets qui utilisent
git-fetch
.
(git-version "0.2.3" "0" "93818c936ee7e2f1ba1b315578bde363a7d43d05") ⇒ "0.2.3-0.93818c9"
Renvoie la chaîne de version pour les paquets qui utilisent
hg-fetch
. Cela fonctionne de la même manière que git-fetch
.
Suivant: Substituts ou Phases, Précédent: Numéros de version, Monter: Consignes d’empaquetage [Table des matières][Index]
Comme nous l’avons vu avant, chaque paquet dans GNU Guix contient un
résumé et une description (voir Définition des paquets). Les résumés et les
descriptions sont importants : ce sont eux que recherche guix
package --search
, et c’est une source d’informations cruciale pour aider
les utilisateur·rices à déterminer si un paquet donné correspond à leurs
besoins. En conséquence, il convient de prêter attention à leur contenu
lorsqu’on travaille sur un paquet.
Les résumés doivent commencer par une lettre capitale et ne doit pas finir par un point. Ils ne doivent pas commencer par « a » ou « the » (« un » ou « le/la »), ce qui n’apporte généralement rien ; par exemple, préférez « File-frobbing tool » (« Outil de frobage de fichier ») à « A tool that frobs file » (« Un outil qui frobe les fichiers »). Le résumé devrait dire ce que le paquet est — p. ex. « Utilitaire du cœur de GNU (fichier, text, shell) » — ou ce à quoi il sert — p. ex. le résumé de grep est « Affiche des lignes correspondant à un motif ».
Gardez à l’esprit que le résumé doit avoir du sens pour un large public. Par exemple « Manipulation d’alignements au format SAM » peut avoir du sens pour un bioinformaticien chevronné, mais n’aidera pas ou pourra perdre une audience de non-spécialistes. C’est une bonne idée de créer un résumé qui donne une idée du domaine d’application du paquet. Dans cet exemple, cela donnerait « Manipulation d’alignements de séquences de nucléotides », ce qui devrait donner une meilleure idée à la personne qui le lit pour savoir si c’est ce qu’elle recherche.
Les descriptions devraient faire entre cinq et dix lignes. Utilisez des phrases complètes, et évitez d’utiliser des acronymes sans les introduire d’abord. Évitez les expressions commerciales comme « world-leading », « industrial-strength » et « next-generation » et évitez les superlatifs comme « the most advanced » — ils ne sont pas utiles aux personnes qui cherchent un paquet et semblent même un peu suspects. À la place, essayez d’être factuels, en mentionnant les cas d’utilisation et les fonctionnalités.
Les descriptions peuvent inclure du balisage Texinfo, ce qui est utile pour
introduire des ornements comme @code
ou @dfn
, des listes à
points ou des hyperliens (voir Overview dans GNU Texinfo).
Cependant soyez prudents lorsque vous utilisez certains symboles, par
exemple ‘@’ et les accolades qui sont les caractères spéciaux de base
en Texinfo (voir Special Characters dans GNU Texinfo). Les
commandes et outils comme guix show
prennent en charge le rendu.
Les résumés et les descriptions sont traduits par des volontaires sur Weblate pour que le plus de personnes possible puissent les lire dans leur langue natale. Les interfaces les recherchent et les affichent dans la langue spécifiée par le paramètre de régionalisation actuel.
Pour permettre à xgettext
de les extraire comme des chaînes
traduisibles, les résumés et les descriptions doivent être des chaînes
litérales. Cela signifie que vous ne pouvez pas utiliser
string-append
ou format
pour construire ces chaînes :
(package
;; …
(synopsis "Ceci est traduisible")
(description (string-append "Ceci n'est " "*pas*" " traduisible.")))
La traduction demande beaucoup de travail, faites donc d’autant plus attention à vos résumés et descriptions lorsque vous développez un paquet car chaque changement peut demander du de travail de la part des traducteur·rices. Pour les aider, il est possible de donner des recommandations ou des instructions qu’ils et elles pourront voir en insérant des commentaires spéciaux comme ceci (voir xgettext Invocation dans GNU Gettext) :
;; TRANSLATORS: "X11 resize-and-rotate" should not be translated. (description "ARandR is designed to provide a simple visual front end for the X11 resize-and-rotate (RandR) extension. …")
Suivant: Cyclic Module Dependencies, Précédent: Synopsis et descriptions, Monter: Consignes d’empaquetage [Table des matières][Index]
La différence entre l’utilisation d’un bout de code (snippet) dans origin et
une phase de construction pour modifier les sources d’un paquet peut être
particulièrement subtile. Les bouts de code dans origin sont en général
utilisés pour supprimer des fichiers indésirables, comme des bibliothèques
incluses, des sources non libres ou pour appliquer de simples
substitutions. La source dérivée d’un objet origin devrait produire une
source qui peut être utilisée pour construire le paquet sur n’importe quel
système pris en charge par le paquet en amont (c.-à-d., être la source
correspondante). En particulier, les bouts de code dans origin ne doivent
pas inclure d’éléments du dépôt dans les sources ; de telles corrections
devraient plutôt être faites avec une phase de construction. Référez-vous à
la documentation sur l’enregistrement origin
pour plus d’information
(voir Référence de origin
).
Suivant: Paquets Emacs, Précédent: Substituts ou Phases, Monter: Consignes d’empaquetage [Table des matières][Index]
While there cannot be circular dependencies between packages, Guile’s lax module loading mechanism allows circular dependencies between Guile modules, which doesn’t cause problems as long as the following conditions are followed for two modules part of a dependency cycle:
arguments
, native-inputs
, inputs
,
propagated-inputs
or replacement
Straying away from the above rules may work while there are no dependency cycles between modules, but given such cycles are confusing and difficult to troubleshoot, it is best to follow the rules to avoid introducing problems down the line.
Here is a common trap to avoid:
(define-public avr-binutils
(package
(inherit (cross-binutils "avr"))
(name "avr-binutils")))
In the above example, the avr-binutils
package was defined in the
module (gnu packages avr)
, and the cross-binutils
procedure in
(gnu packages cross-base)
. Because the inherit
field is not
delayed (thunked), it is evaluated at the top level at load time, which is
problematic in the presence of module dependency cycles. This could be
resolved by turning the package into a procedure instead, like:
(define (make-avr-binutils)
(package
(inherit (cross-binutils "avr"))
(name "avr-binutils")))
Care would need to be taken to ensure the above procedure is only ever used in a package delayed fields or within another procedure also not called at the top level.
Suivant: Modules Python, Précédent: Cyclic Module Dependencies, Monter: Consignes d’empaquetage [Table des matières][Index]
Les paquets Emacs devraient plutôt utiliser le système de construction Emacs
(voir emacs-build-system), pour l’uniformité et les bénéfices apportés
par ses phases de construction, comme la génération automatique du fichier
autoloads et la compilation des sources. Comme il n’y a pas de manière
standardisée de lancer une suite de tests pour les paquets Emacs, les tests
sont désactivés par défaut. Lorsqu’une suite de tests est disponible, elle
devrait être activée en mettant l’argument #:tests?
à
#true
. Par défaut, la commande pour lancer les tests est
make check
, mais on peut spécifier une autre commande via
l’argument #:test-command
. L’argument #:test-command
attend
une liste contenant une commande et ses arguments, à invoquer pendant la
phase check
.
Les dépendances Elisp des paquets Emacs sont en général fournie dans
propagated-inputs
lorsqu’elles sont requises à l’exécution. Comme
pour les autres paquets, les dépendances de test et de construction doivent
être spécifiées dans native-inputs
.
Les paquets Emacs dépendent parfois de répertoires de ressources qui
devraient être installés avec les fichiers Elisp. L’argument
#:include
peut être utilisé pour cela, en spécifiant une liste
d’expression régulières. La bonne pratique pour utiliser l’argument
#:include
est d’étendre plutôt que de remplacer sa valeur par défaut
(accessible via la variable %default-include
). Par exemple, un paquet
d’extension yasnippet inclut en général un répertoire snippets, qui
pourrait être copié vers le répertoire d’installation avec :
#:include (cons "^snippets/" %default-include)
Lorsque vous rencontrez des problèmes, il est utile de vérifier la présence
de l’en-tête d’extension Package-Requires
dans le fichier source
principal du paquet, et si les dépendances et leurs versions qui y sont
listées sont satisfaites.
Suivant: Modules Perl, Précédent: Paquets Emacs, Monter: Consignes d’empaquetage [Table des matières][Index]
Nous incluons actuellement Python 2 et Python 3, sous les noms de variables
Scheme python-2
et python
comme expliqué dans Numéros de version. Pour éviter la confusion et les problèmes de noms avec d’autres
langages de programmation, il semble désirable que le nom d’un paquet pour
un module Python contienne le mot python
.
Certains modules ne sont compatibles qu’avec une version de Python, d’autres
avec les deux. Si le paquet Toto ne compile qu’avec Python 3, on le nomme
python-toto
. S’il est compilé avec Python 2, on le nome
python2-toto
. Les paquets Python 2 sont en train d’être supprimés de
la distribution. Merci de ne plus soumettre de nouveaux paquets Python 2.
Si un projet contient déjà le mot python
, on l’enlève, par exemple le
module python-dateutil est packagé sous les noms python-dateutil
et
python2-dateutil
. Si le nom du projet commence par py
(p.
ex. pytz
), on le garde et on le préfixe comme décrit ci-dessus.
Remarque : Il y a actuellement deux systèmes de construction différents pour les paquets Python dans Guix : python-build-system et pyproject-build-system. Pendant longtemps, les paquets Python étaient construits à partir d’un fichier setup.py à la spécification informelle. Cela fonctionnait très bien, étant donné le succès de Python, mais il était difficile de construire des outils par dessus. En conséquence, de nombreuses alternatives ont émergé et la communauté a finalement retenu un standard formel pour spécifier les prérequis de construction. pyproject-build-system est l’implémentation de ce standard par Guix. Il est considéré comme « expérimental » dans le sens où il ne prend pas encore en charge les divers moteurs de construction de PEP-517, mais nous vous encourageons à l’essayer pour les nouveaux paquets Python et à rapporter tout problème que vous rencontreriez. Il finira par être rendu obsolète et fusionné dans python-build-system.
Les informations de dépendances pour les paquets Python se trouvent généralement dans l’arborescence des source du paquet, avec plus ou moins de précision : dans le fichier pyproject.toml, le fichier setup.py, dans requirements.txt ou dans tox.ini (ce dernier surtout pour les dépendances de test).
Votre mission, lorsque vous écrivez une recette pour un paquet Python, est
de faire correspondre ces dépendances au bon type « d’entrée »
(voir inputs). Bien que l’importeur pypi
fasse
du bon boulot (voir Invoquer guix import
), vous devriez vérifier la liste
suivant pour déterminer où va telle dépendance.
setuptools
et pip
installé par
défaut. Cela va changer, et nous vous encourageons à utiliser
python-toolchain
si vous voulez un environnement de construction pour
Python.
guix lint
vous avertira si setuptools
ou pip
sont
ajoutés en entrées natives car ils ne sont en général pas nécessaires.
propagated-inputs
. Elles sont typiquement définies dans le mot-clef
install_requires
dans setup.py ou dans le fichier
requirements.txt.
build-system.requires
dans pyproject.toml ou dans
le mot-clef setup_requires
de setup.py — ou les dépendances
seulement pour les tests — p. ex. ceux dans tests_require
— vont
dans native-inputs
. La raison est qu’ils n’ont pas besoin d’être
propagés car ils ne sont pas requis à l’exécution et dans le cas d’une
compilation croisée, c’est l’entrée « native » qu’il nous faut.
Les cadriciels de tests pytest
, mock
et nose
sont des
exemples. Bien sûr si l’un de ces paquets est aussi requis à l’exécution,
il doit aller dans propagated-inputs
.
inputs
, par exemple des programmes pour des bibliothèques C requises
pour construire des paquets Python avec des extensions C.
extras_require
),
c’est à vous de décider de les ajouter ou non, en fonction du ratio entre
utilité et complexité (voir guix size
).
Suivant: Paquets Java, Précédent: Modules Python, Monter: Consignes d’empaquetage [Table des matières][Index]
Les programmes Perl utiles en soit sont nommés comme les autres paquets,
avec le nom amont en minuscule. Pour les paquets Perl contenant une seule
classe, nous utilisons le nom de la classe en minuscule, en remplaçant les
occurrences de ::
par des tirets et en préfixant le tout par
perl-
. Donc la classe XML::Parser
devient
perl-xml-parser
. Les modules contenant plusieurs classes gardent
leur nom amont en minuscule et sont aussi préfixés par perl-
. Ces
modules tendent à avoir le mot perl
quelque part dans leur nom, que
nous supprimons en faveur du préfixe. Par exemple, libwww-perl
devient perl-libwww
.
Suivant: Paquets Rust, Précédent: Modules Perl, Monter: Consignes d’empaquetage [Table des matières][Index]
Le programmes Java utiles en soit sont nommés comme les autres paquets, avec le nom amont en minuscule.
Pour éviter les confusions et les problèmes de nom avec d’autres langages de
programmation, il est désirable que le nom d’un paquet Java soit préfixé par
java-
. Si un projet contient déjà le mot java
, nous le
supprimons, par exemple le paquet ngsjava
est empaqueté sous le nom
java-ngs
.
Pour les paquets java contenant une seul classe ou une petite hiérarchie de
classes, nous utilisons le nom de la classe en minuscule, en remplaçant les
occurrences de .
par des tirets et en préfixant le tout par
java-
. Donc la classe apache.commons.cli
devient
java-apache-commons-cli
.
Suivant: Paquets elm, Précédent: Paquets Java, Monter: Consignes d’empaquetage [Table des matières][Index]
Le programmes Rust utiles en soit sont nommés comme les autres paquets, avec le nom amont en minuscule.
Pour éviter des collisions de noms nous préfixons les autres paquets avec le
préfixe rust-
. Vous devrez changer le nom en minuscule et garder les
tirets en place.
Dans l’écosystème rust il est courant d’avoir plusieurs versions
incompatibles d’un paquet utilisées en même temps, donc toutes les
définitions des paquets devraient avoir un suffixe de version. Le suffixe de
version est le nombre le plus à gauche qui n’est pas un zéro (et tous les
zéros précédents, évidemment). Cela suit les conventions de version « caret
» de Cargo. Par exemple rust-clap-2
, rust-rand-0.6
.
À cause de la difficulté à réutiliser des paquets rust en entrées
précompilées pour d’autres paquets, le systèmes de construction Cargo
(voir cargo-build-system
) présente les mots-clefs
#:cargo-inputs
et cargo-development-inputs
en argument du
système de construction. Vous pouvez y penser comme les équivalents de
propagated-inputs
et native-inputs
. Les dependencies
et build-dependencies
de Rust devraient aller dans
#:cargo-inputs
et dev-dependencies
dans
#:cargo-development-inputs
. Si un paquet Rust se lie à d’autres
bibliothèques alors vous devriez utiliser l’emplacement inputs
standard et compagnie.
Vous devriez faire attention à vous assurer que la bonne version des
dépendances est utilisée ; pour cela nous essayons d’éviter de passer les
tests ou d’utiliser #:skip-build?
lorsque c’est possible. Bien sûr
ce n’est pas toujours possible, comme le paquet peut être développé sur un
autre système d’exploitation, dépendre d’une fonctionnalité du compilateur
Rust Nightly ou la suite de test atrophiée depuis la sortie.
Suivant: Polices de caractères, Précédent: Paquets Rust, Monter: Consignes d’empaquetage [Table des matières][Index]
Les applications Elm peuvent être nommée comme les autres logiciels : leur nom n’a pas besoin de mentionner Elm.
Les paquets au sens de Elm (voir elm-build-system
dans Systèmes de construction) doivent utiliser un nom au format
auteur/
projet, où à la fois l’auteur et le
projet peuvent contenir des tirets, et auteur contient parfois
des lettres majuscules.
Pour former le nom de paquet Guix à partir du nom en amont, nous suivons une
convention similaire à celle des paquets Python (voir Modules Python), en
ajoutant le préfixe elm-
à moins que le nom ne commence déjà par
elm-
.
Dans la plupart des cas on peut reconstruire le nom d’un paquet Elm en amont
avec une heuristique, mais, comme la conversion vers le nom Guix implique
une perte d’information, cela n’est pas toujours possible. Vous devrez faire
attention à ajouter la propriété 'upstream-name
si nécessaire pour
que ‘guix import elm’ fonctionne correctement (voir Invoquer guix import
). Les scénarios les plus importants où il faut spécifier
explicitement le nom en amont sont :
elm
et que le projet contient une ou
plusieurs tirets, comme elm/virtual-dom
et
Elm-Canvas/raster-shapes
— à moins que l’auteur ne soit
elm-explorations
, qui est géré à part, donc un paquet comme
elm-explorations/markdown
n’a pas besoin d’utiliser la
propriété 'upstream-name
.
Le module (guix build-system elm)
fournit les utilitaires suivants
pour travailler avec les noms et les conventions associées :
Renvoie une origine Git en utilisant le nom et les tags du dépôts, requis pour publier un paquet Elm avec le nom amont elm-name à la version version avec la somme de contrôle sha256 hash.
Par exemple :
(package
(name "elm-html")
(version "1.0.0")
(source
(elm-package-origin
"elm/html"
version
(base32 "15k1679ja57vvlpinpv06znmrxy09lbhzfkzdc89i01qa8c4gb4a")))
...)
Renvoie le nom de paquet Guix pour un paquet Elm avec le nom amont elm-name.
Remarquez qu’il y a plus d’un elm-name possible pour un résultat de
elm->package-name
donné.
Étant donné un paquet Elm, renvoie le nom amont éventuellement inféré,
ou #f
si le nom amont n’est pas spécifié via la propriété
'upstream-name
et qu’il ne peut pas être deviné par
infer-elm-package-name
.
Étant donné le guix-name d’un paquet Elm, renvoie le nom amont inféré,
ou #f
si le nom amont ne peut pas être inféré. Si le résultat n’est
pas #f
, l’envoyer à elm->package-name
produirait
guix-name.
Précédent: Paquets elm, Monter: Consignes d’empaquetage [Table des matières][Index]
Pour les polices qui ne sont en général pas installées pour être utilisées pour du traitement de texte, ou qui sont distribuées en tant que partie d’un paquet logiciel plus gros, nous nous appuyons sur les règles générales pour les logiciels ; par exemple, cela s’applique aux polices livrées avec le système X.Org ou les polices qui font partie de TeX Live.
Pour rendre plus facile la recherche par l’utilisatrice ou l’utilisateur, les noms des autres paquets contenant seulement des polices sont construits ainsi, indépendamment du nom du paquet en amont.
Le nom d’un paquet contenant une unique famille de polices commence par
font-
; il est suivi du nom du fondeur et d’un tiret -
si le
fondeur est connu, et du nom de la police, dont les espaces sont remplacés
par des tirets (et comme d’habitude, toutes les lettres majuscules sont
transformées en minuscules). Par exemple, la famille de polices Gentium de
SIL est empaqueté sous le nom font-sil-gentium
.
Pour un paquet contenant plusieurs familles de polices, le nom de la
collection est utilisée à la place du nom de la famille. Par exemple les
polices Liberation consistent en trois familles, Liberation Sans, Liberation
Serif et Liberation Mono. Elles pourraient être empaquetées séparément sous
les noms font-liberation-sans
etc, mais comme elles sont distribuées
ensemble sous un nom commun, nous préférons les empaqueter ensemble en tant
que font-liberation
.
Dans le cas où plusieurs formats de la même famille ou collection sont
empaquetés séparément, une forme courte du format, préfixé d’un tiret est
ajouté au nom du paquet. Nous utilisont -ttf
pour les polices
TrueType, -otf
pour les polices OpenType et -type1
pour les
polices Type 1 de PostScript.
Suivant: Envoyer des correctifs, Précédent: Consignes d’empaquetage, Monter: Contribuer [Table des matières][Index]
En général notre code suit le Standard de Code GNU (voir GNU Coding Standards). Cependant, il ne parle pas beaucoup de Scheme, donc voici quelques règles supplémentaires.
Suivant: Modules, Monter: Style de code [Table des matières][Index]
Le code Scheme dans Guix est écrit dans un style purement fonctionnel. Le
code qui s’occupe des entrées-sorties est une exception ainsi que les
procédures qui implémentent des concepts bas-niveau comme la procédure
memoize
.
Suivant: Types de données et reconnaissance de motif, Précédent: Paradigme de programmation, Monter: Style de code [Table des matières][Index]
Guile modules that are meant to be used on the builder side must live in the
(guix build …)
name space. They must not refer to other Guix
or GNU modules. However, it is OK for a “host-side” module to use a
build-side module. As an example, the (guix search-paths)
module
should not be imported and used by a package since it isn’t meant to be used
as a “build-side” module. It would also couple the module with the
package’s dependency graph, which is undesirable.
Les modules qui s’occupent du système GNU général devraient se trouver dans
l’espace de nom (gnu …)
plutôt que (guix …)
.
Suivant: Formatage du code, Précédent: Modules, Monter: Style de code [Table des matières][Index]
La tendance en Lisp classique est d’utiliser des listes pour tout
représenter et de naviguer dedans « à la main ( avec car
, cdr
,
cadr
et compagnie. Il y a plusieurs problèmes avec ce style,
notamment le fait qu’il soit dur à lire, source d’erreur et un obstacle aux
rapports d’erreur bien typés.
Le code de Guix devrait définir des types de données appropriées (par
exemple, avec define-record-type*
) plutôt que d’abuser des listes.
En plus, il devrait utiliser la recherche de motifs, via le module Guile
(ice-9 match)
, surtout pour rechercher dans des listes
(voir Pattern Matching dans GNU Guile Reference Manual). La
reconnaissance de motif pour les enregistrement se fait plus facilement avec
match-record
de (guix records)
qui, contrairement à
match
, vérifie le nom des champs à l’expansion des macros.
When defining a new record type, keep the record type descriptor (RTD)
private (voir Records dans GNU Guile Reference Manual, for more on
records and RTDs). As an example, the (guix packages)
module defines
<package>
as the RTD for package records but it does not export it;
instead, it exports a type predicate, a constructor, and field accessors.
Exporting RTDs would make it harder to change the application binary
interface (because code in other modules might be matching fields by
position) and would make it trivial for users to forge records of that type,
bypassing any checks we may have in the official constructor (such as
“field sanitizers”).
Précédent: Types de données et reconnaissance de motif, Monter: Style de code [Table des matières][Index]
Lorsque nous écrivons du code Scheme, nous suivons la sagesse commune aux programmeurs Scheme. En général, nous suivons les règles de style de Riastradh. Ce document décrit aussi les conventions utilisées dans le code de Guile. Il est bien pensé et bien écrit, alors n’hésitez pas à le lire.
Certaines formes spéciales introduites dans Guix comme la macro
substitute*
ont des règles d’indentation spécifiques. Elles sont
définies dans le fichier .dir-locals.el qu’Emacs utilise
automatiquement. Remarquez aussi qu’Emacs-Guix fournit le mode
guix-devel-mode
qui indente et colore le code Guix correctement
(voir Development dans The Emacs-Guix Reference Manual).
Si vous n’utilisez pas Emacs, assurez-vous que votre éditeur connaisse ces règles. Pour indenter automatiquement une définition de paquet, vous pouvez aussi lancer :
./pre-inst-env guix style paquet
Voir Invoquer guix style
, pour plus d’informations.
Nous demandons que toutes les procédure de premier niveau contiennent une
chaîne de documentation. Ce prérequis peut être relâché pour les procédures
privées simples dans l’espace de nom (guix build …)
cependant.
Les procédures ne devraient pas avoir plus de quatre paramètres positionnés. Utilisez des paramètres nommés pour les procédures qui prennent plus de quatre paramètres.
Suivant: Suivi des bogues et des changements, Précédent: Style de code, Monter: Contribuer [Table des matières][Index]
Le développement se fait avec le système de contrôle de version Git. Ainsi,
l’accès au dépôt n’est pas strictement nécessaire. Nous accueillons les
contributions sous forme de correctifs produits par git format-patch
envoyés sur la liste de diffusion guix-patches@gnu.org
(voir Submitting patches to a project dans Git User Manual). Si vous
voulez contribuer, nous vous encourageons à prendre un moment pour changer
quelques options du dépôt Git pour améliorer la lisibilité des correctifs
avant de commencer (voir Configurer Git). Si vous avez bien expérimenté
la contribution à Guix, vous pouvez aussi regarder la section sur les accès
en commit (voir Accès en commit).
Cette liste de diffusion est gérée par une instance Debbugs, qui nous permet
de suivre les soumissions (voir Suivi des bogues et des changements). Chaque
message envoyé à cette liste se voit attribuer un nouveau numéro de suivi ;
les gens peuvent ensuite répondre à cette soumission en envoyant un courriel
à NUMÉRO_PROBLÈME@debbugs.gnu.org
, où NUMÉRO_PROBLÈME
est le numéro de suivi (voir Envoyer une série de correctifs).
Veuillez écrire les messages de commit dans le format ChangeLog (voir Change Logs dans GNU Coding Standards) ; vous pouvez regarder l’historique des commits pour trouver des exemples.
Vous pouvez aider à rendre le processus de revue plus efficace et ainsi augmenter les chances que votre correctif soit revu rapidement, en décrivant le contexte de votre correctif et l’impact qu’il pourrait avoir. Par exemple, si votre correctif corrige un paquet cassé, décrivez le problème et la manière dont votre correctif le corrige. Dites-nous comment vous avez testé votre correctif. Les personnes qui utilisent du code changé par votre correctif devront-elles ajuster leur utilisation ? Si c’est le cas, expliquez de quelle manière. En général, essayez d’imaginer les questions que vous poserait la personne qui relit votre correctif, et répondez à ces questions en avance.
Avant de soumettre un correctif qui ajoute ou modifie la définition d’un paquet, veuillez vérifier cette check-list :
gpg --verify
.
guix lint paquet
, où paquet est le nom du
nouveau paquet ou du paquet modifié, et corrigez les erreurs qu’il rapporte
(voir Invoquer guix lint
).
guix style paquet
pour formater la nouvelle
définition du paquet en suivant les conventions du projet (voir Invoquer guix style
).
guix build paquet
.
qemu-binfmt-service-type
pour les émuler. Pour cela, ajoutez le
module de service virtualization
et le service suivant à la liste des
services dans votre configuration de système d’exploitation :
(service qemu-binfmt-service-type
(qemu-binfmt-configuration
(platforms (lookup-qemu-platforms "arm" "aarch64"))))
Puis reconfigurez votre système.
Vous pourrez ensuite construire les paquets pour différentes plate-formes en
spécifiant l’option --system
. Par exemple pour construire le paquet
« hello » pour les architectures armhf ou aarch64, vous devrez lancer les
commandes suivantes, respectivement :
guix build --system=armhf-linux --rounds=2 hello guix build --system=aarch64-linux --rounds=2 hello
Parfois, les paquets incluent des copie du code source de leurs dépendances pour le confort des utilisateur·rices. Cependant, en tant que distribution, nous voulons nous assurer que ces paquets utilisent bien les copient que nous avons déjà dans la distribution si elles existent. Cela améliore l’utilisation des ressources (la dépendance n’est construite et stockée qu’une seule fois) et permet à la distribution de faire des changements transversaux comme appliquer des correctifs de sécurité pour un paquet donné depuis un unique emplacement et qu’ils affectent tout le système, ce qu’empêchent les copies groupées.
guix size
(voir Invoquer guix size
). Cela vous permettra de remarquer des références à d’autres paquets
qui ont été retenus sans que vous vous y attendiez. Il peut aussi aider à
déterminer s’il faut découper le paquet (voir Des paquets avec plusieurs résultats) et quelles dépendances facultatives utiliser. En particulier,
évitez d’ajouter texlive
en dépendance : à cause de sa taille
extrême, utilisez la procédure updmap.cfg
à la place.
guix refresh --list-dependant
paquet
vous aidera (voir Invoquer guix refresh
).
Une manière simple de le faire est de reconstruire le paquet plusieurs fois
à la suite sur votre machine (voir Invoquer guix build
) :
guix build --rounds=2 mon-paquet
Cela est suffisant pour trouver une classe de non-déterminisme commune, comme l’horodatage ou des sorties générées aléatoirement dans le résultat de la construction.
Une autre option consiste à utiliser guix challenge
(voir Invoquer guix challenge
). Vous pouvez lancer la commande une fois
que les paquets ont été committés et construits par
bordeaux.guix.gnu.org
pour vérifier s’il obtient le même
résultat que vous. Mieux encore : trouvez une autre machine qui peut le
construire et lancez guix publish
. Puisque la machine distante
est sûrement différente de la vôtre, cela peut trouver des problèmes de
non-déterminisme liés au matériel — par exemple utiliser une extension du
jeu d’instruction — ou du noyau du système d’exploitation — par exemple se
reposer sur uname
ou les fichiers de /proc.
Ajouter plusieurs paquet ou une mise à jour d’un paquet avec des corrections dans ce paquet sont des exemples de changements sans rapport.
guix style
pour le faire automatiquement (voir Formatage du code).
guix download
). Utilisez des URL stable, pas des URL générées. Par
exemple, les archives GitHub ne sont pas nécessairement identiques d’une
génération à la suivante, donc il vaut mieux dans ce cas cloner le dépôt.
N’utilisez pas le champ name
dans l’URL : ce n’est pas très utile et
si le nom change, l’URL sera probablement erronée.
guix pull
avec :
guix pull --url=/path/to/your/checkout --profile=/tmp/guix.master
Lorsque vous envoyez un correctif à la liste de diffusion, utilisez
‘[PATCH] …’ comme objet. Si votre correctif doit être appliqué à
une autre branche que master
, comme core-updates
, spécifiez-le
dans l’objet comme dans ‘[PATCH core-updates] …’.
You may use your email client, the git send-email
command
(voir Envoyer une série de correctifs) or the mumi send-email
command
(voir Interfaces utilisateurs à Debbugs). We prefer to get patches in plain text
messages, either inline or as MIME attachments. You are advised to pay
attention if your email client changes anything like line breaks or
indentation which could potentially break the patches.
Attendez-vous à un délai entre le moment où vous envoyez votre tout premier correctif à guix-patches@gnu.org et le moment où le message sera reçu. Vous devez attendre de recevoir un message de confirmation avec le numéro de suivi assigné à votre correctif. Les confirmations suivantes ne seront pas retardées.
Lorsqu’un bogue est résolu, veuillez fermer le fil en envoyant un courriel à NUMÉRO_PROBLÈME-done@debbugs.gnu.org.
Suivant: Envoyer une série de correctifs, Monter: Envoyer des correctifs [Table des matières][Index]
Si vous ne l’avez pas encore fait, vous devriez indiquer un nom et une
adresse de courriel qui seront associés à vos commits (voir Telling Git your name dans Git User Manual). Si vous
souhaitez utiliser un nom ou une adresse différent pour les commits de ce
dépôt, vous pouvez utiliser git config --local
, ou modifier
.git/config dans le dépôt au lieu de ~/.gitconfig.
Other important Git configuration will automatically be configured when building the project (voir Construire depuis Git). A .git/hooks/commit-msg hook will be installed that embeds ‘Change-Id’ Git trailers in your commit messages for traceability purposes. It is important to preserve these when editing your commit messages, particularly if a first version of your proposed changes was already submitted for review. If you have a commit-msg hook of your own you would like to use with Guix, you can place it under the .git/hooks/commit-msg.d/ directory.
Précédent: Configurer Git, Monter: Envoyer des correctifs [Table des matières][Index]
La commande git send-email
est la meilleure manière d’envoyer
aussi bien des correctifs isolés que des séries de correctifs
(voir Plusieurs correctifs) à la liste de diffusion de Guix. Envoyer des
correctifs en pièce-jointe peut les rendre plus difficile à revoir dans
certains clients de courriel et git diff
ne stocke pas les
métadonnées des commits.
Remarque : La commande
git send-email
est fournie par la sortiesend-email
du paquetgit
, c.-à-d.git:send-email
.
The following command will create a patch email from the latest commit, open it in your EDITOR or VISUAL for editing, and send it to the Guix mailing list to be reviewed and merged. Assuming you have already configured Git according to Voir Configurer Git, you can simply use:
$ git send-email --annotate -1
Astuce : Pour ajouter un préfixe à l’objet de votre correctif, vous pouvez utiliser l’option --subject-prefix. Le projet Guix utilise cela pour spécifier si un correctif est prévu pour une autre branche ou un autre dépôt que la branche
master
de https://git.savannah.gnu.org/cgit/guix.git.git send-email --annotate --subject-prefix='PATCH core-updates' -1
The patch email contains a three-dash separator line after the commit message. You may “annotate” the patch with explanatory text by adding it under this line. If you do not wish to annotate the email, you may drop the --annotate option.
If you need to send a revised patch, don’t resend it like this or send a
“fix” patch to be applied on top of the last one; instead, use
git commit --amend
or git
rebase
to modify the commit, and use the
ISSUE_NUMBER@debbugs.gnu.org address and the -v flag
with git send-email
.
$ git commit --amend $ git send-email --annotate -vREVISION \ --to=ISSUE_NUMBER@debbugs.gnu.org -1
Remarque : À cause d’un bogue dans
git send-email
, -v RÉVISION (avec un espace) ne marchera pas. Vous devez utiliser -vRÉVISION.
Vous pouvez trouver NUMÉRO_PROBLÈME soit en cherchant sur l’interface mumi sur https://issues.guix.gnu.org le nom de votre correctif ou en lisant l’accusé de réception envoyé automatiquement par Debbugs en réponse aux bogues et correctifs entrants, qui contient le numéro de suivi.
If your git checkout has been correctly configured (voir Configurer Git), the git send-email
command will automatically notify the
appropriate team members, based on the scope of your changes. This relies
on the etc/teams.scm script, which can also be invoked manually if
you do not use the preferred git send-email
command to submit
patches. To list the available actions of the script, you can invoke it via
the etc/teams.scm help
command. For more information regarding
teams, voir Équipes.
Remarque : On foreign distros, you might have to use
./pre-inst-env git send-email
for etc/teams.scm to work.
Alors que git send-email
seul suffira pour un unique correctif, un
problème malheureux de Debbugs fait que vous devrez faire plus attention
pour envoyer plusieurs correctifs : si vous les envoyez tous à l’adresse
guix-patches@gnu.org, un nouveau ticket sera créé pour chaque
correctif !
Lorsque vous envoyez une série de correctifs, il vaut mieux envoyer d’abord
un « résumé » Git pour donner un aperçu de votre série de correctifs aux
relecteur·ices. Vous pouvez créer un répertoire nommé sortant
contenant à la fois votre série de correctifs et un résumé appelé
0000-cover-letter.patch avec git format-patch
.
$ git format-patch -NOMBRE_COMMITS -o sortant \ --cover-letter --base=auto
Vous pouvez maintenant envoyer seulement le résumé à l’adresse guix-patches@gnu.org ce qui créera un ticket auquel vous pourrez envoyer le reste des correctifs.
$ git send-email outgoing/0000-cover-letter.patch --annotate $ rm outgoing/0000-cover-letter.patch # we don't want to resend it!
Assurez-vous de modifier le courriel pour ajouter une ligne d’objet appropriée et un petit texte avant de l’envoyer. Remarquez le journal court et les statistiques de changements générés automatiquement sous votre texte.
Une fois que le logiciel de Debbugs a répondu à votre courriel de résumé, vous pouvez envoyer les correctifs à l’adresse de suivi nouvellement créée.
$ git send-email outgoing/*.patch --to=ISSUE_NUMBER@debbugs.gnu.org $ rm -rf outgoing # we don't need these anymore
Heureusement, cette danse avec git format-patch
n’est pas
nécessaire pour envoyer une série modifiée car un ticket existe déjà pour la
suite de correctifs.
$ git send-email -NUMBER_COMMITS -vREVISION \ --to=ISSUE_NUMBER@debbugs.gnu.org
If need be, you may use --cover-letter --annotate to send another cover letter, e.g. for explaining what’s changed since the last revision, and these changes are necessary.
Suivant: Équipes, Précédent: Envoyer des correctifs, Monter: Contribuer [Table des matières][Index]
This section describes how the Guix project tracks its bug reports, patch submissions and topic branches.
Suivant: Managing Patches and Branches, Monter: Suivi des bogues et des changements [Table des matières][Index]
Les rapports de bogue et les correctifs soumis sont actuellement suivis par
l’instance Debbugs https://bugs.gnu.org. Les rapports de bogue sont
rempli pour le « paquet » guix
(dans le vocabulaire de Debbugs), en
envoyant un courriel à bug-guix@gnu.org, tandis que les correctifs
sont soumis pour le paquet guix-patches
en envoyant un courriel à
guix-patches@gnu.org (voir Envoyer des correctifs).
Suivant: Interfaces utilisateurs à Debbugs, Précédent: L’outil de gestion des défauts, Monter: Suivi des bogues et des changements [Table des matières][Index]
Changes should be posted to guix-patches@gnu.org. This mailing
list fills the patch-tracking database (voir L’outil de gestion des défauts). It also
allows patches to be picked up and tested by the quality assurance tooling;
the result of that testing eventually shows up on the dashboard at
‘https://qa.guix.gnu.org/issue/ISSUE_NUMBER
’, where
ISSUE_NUMBER is the number assigned by the issue tracker. Leave time
for a review, without committing anything.
As an exception, some changes considered “trivial” or “obvious” may be
pushed directly to the master
branch. This includes changes to fix
typos and reverting commits that caused immediate problems. This is subject
to being adjusted, allowing individuals to commit directly on
non-controversial changes on parts they’re familiar with.
Changes which affect more than 300 dependent packages (voir Invoquer guix refresh
) should first be pushed to a topic branch other than master
;
the set of changes should be consistent—e.g., “GNOME update”, “NumPy
update”, etc. This allows for testing: the branch will automatically show
up at ‘https://qa.guix.gnu.org/branch/branch
’, with an
indication of its build status on various platforms.
To help coordinate the merging of branches, you must create a new guix-patches issue each time you create a branch (voir L’outil de gestion des défauts). The title of the issue requesting to merge a branch should have the following format:
Request for merging "name" branch
The QA infrastructure recognizes such issues and lists the merge requests on its main page. The following points apply to managing these branches:
Normally branches will be merged in a “first come, first merged” manner, tracked through the guix-patches issues. If you agree on a different order with those involved, you can track this by updating which issues block50 which other issues. Therefore, to know which branch is at the front of the queue, look for the oldest issue, or the issue that isn’t blocked by any other branch merges. An ordered list of branches with the open issues is available at https://qa.guix.gnu.org.
Once a branch is at the front of the queue, wait until sufficient time has
passed for the build farms to have processed the changes, and for the
necessary testing to have happened. For example, you can check
‘https://qa.guix.gnu.org/branch/branch
’ to see information
on some builds and substitute availability.
Once the branch has been merged, the issue should be closed and the branch deleted.
Suivant: Étiquettes personnalisées de Debbugs, Précédent: Managing Patches and Branches, Monter: Suivi des bogues et des changements [Table des matières][Index]
Une interface web (en fait deux interfaces web !) sont disponibles pour naviguer dans les tickets :
Pour consulter les discussions relatives au numéro d’édition n,
rendez-vous sur ‘https://issues.guix.gnu.org/n
’ ou
‘https://bugs.gnu.org/n
’.
Mumi also comes with a command-line interface that can be used to search existing issues, open new issues, compose replies, apply and send patches. You do not need to use Emacs to use the mumi command-line client. You interact with it only on the command-line.
To use the mumi command-line interface, navigate to a local clone of the Guix git repository, and drop into a shell with mumi, git and git:send-email installed.
$ cd guix ~/guix$ guix shell mumi git git:send-email
To search for issues, say all open issues about "zig", run
~/guix [env]$ mumi search zig is:open #60889 Add zig-build-system opened on 17 Jan 17:37 Z by Ekaitz Zarraga #61036 [PATCH 0/3] Update zig to 0.10.1 opened on 24 Jan 09:42 Z by Efraim Flashner #39136 [PATCH] gnu: services: Add endlessh. opened on 14 Jan 2020 21:21 by Nicol? Balzarotti #60424 [PATCH] gnu: Add python-online-judge-tools opened on 30 Dec 2022 07:03 by gemmaro #45601 [PATCH 0/6] vlang 0.2 update opened on 1 Jan 2021 19:23 by Ryan Prior
Pick an issue and make it the "current" issue.
~/guix [env]$ mumi current 61036 #61036 [PATCH 0/3] Update zig to 0.10.1 opened on 24 Jan 09:42 Z by Efraim Flashner
Once an issue is the current issue, you can open the issue in a web browser, compose replies, apply patches, send patches, etc. with short succinct commands.
Open the issue in your web browser using
~/guix [env]$ mumi www
Compose a reply using
~/guix [env]$ mumi compose
Compose a reply and close the issue using
~/guix [env]$ mumi compose --close
mumi compose
opens your mail client by passing ‘mailto:’ URIs
to xdg-open
. So, you need to have xdg-open
set up to
open your mail client correctly.
Apply the latest patchset from the issue using
~/guix [env]$ mumi am
You may also apply a patchset of a specific version (say, v3) using
~/guix [env]$ mumi am v3
Or, you may apply a patch from a specific e-mail message. For example, to apply the patch from the 4th message (message index starts from 0), run
~/guix [env]$ mumi am @4
mumi am
is a wrapper around git am
. You can pass
git am
arguments to it after a ‘--’. For example, to add a
Signed-off-by trailer, run
~/guix [env]$ mumi am -- -s
Create and send patches to the issue using
~/guix [env]$ git format-patch origin/master ~/guix [env]$ mumi send-email foo.patch bar.patch
Note that you do not have to pass in ‘--to’ or ‘--cc’ arguments to
git format-patch
. mumi send-email
will put them in
correctly when sending the patches.
To open a new issue, run
~/guix [env]$ mumi new
and send an email (using mumi compose
) or patches (using
mumi send-email
).
mumi send-email
is really a wrapper around git
send-email
that automates away all the nitty-gritty of sending patches. It
uses the current issue state to automatically figure out the correct
‘To’ address to send to, other participants to ‘Cc’, headers to
add, etc.
Also note that, unlike git send-email
, mumi send-email
works perfectly well with single and multiple patches alike. It automates
away the debbugs dance of sending the first patch, waiting for a response
from debbugs and sending the remaining patches. It does so by sending the
first patch, polling the server for a response, and then sending the
remaining patches. This polling can unfortunately take a few minutes. So,
please be patient.
Si vous utilisez Emacs, vous pourriez trouver plus confortable d’interagir avec les tickets en utilisant debbugs.el, que vous pouvez installer avec :
guix install emacs-debbugs
Par exemple, pour lister tous les tickets ouverts sur guix-patches
,
tapez :
C-u M-x debbugs-gnu RET RET guix-patches RET n y
For a more convenient (shorter) way to access both the bugs and patches
submissions, you may want to configure the
debbugs-gnu-default-packages
and
debbugs-gnu-default-severities
Emacs variables (voir Voir des bugs avec Emacs).
To search for bugs, ‘M-x debbugs-gnu-guix-search’ can be used.
Voir Debbugs User Guide, pour plus d’info sur cet outil pratique !
Suivant: Cuirass Build Notifications, Précédent: Interfaces utilisateurs à Debbugs, Monter: Suivi des bogues et des changements [Table des matières][Index]
Debbugs provides a feature called usertags that allows any user to tag
any bug with an arbitrary label. Bugs can be searched by usertag, so this
is a handy way to organize bugs52. If you use Emacs Debbugs, the
entry-point to consult existing usertags is the ‘C-u M-x
debbugs-gnu-usertags’ procedure. To set a usertag, press ‘C’ while
consulting a bug within the *Guix-Patches* buffer opened with ‘C-u M-x
debbugs-gnu-bugs’ buffer, then select usertag
and follow the
instructions.
Par exemple, pour voir tous les rapports de bogues (ou les correctifs, dans
le cas de guix-patches
avec l’étiquette personnalisée
powerpc64le-linux
pour l’utilisateur guix
, ouvrez cette URL
dans un navigateur web :
https://debbugs.gnu.org/cgi-bin/pkgreport.cgi?tag=powerpc64le-linux;users=guix.
Pour plus d’informations sur le fonctionnement des étiquettes personnalisées, référez-vous à la documentation de Debbugs ou à la documentation de n’importe quel outil que vous utilisez pour interagir avec Debbugs.
In Guix, we are experimenting with usertags to keep track of
architecture-specific issues, as well as reviewed ones. To facilitate
collaboration, all our usertags are associated with the single user
guix
. The following usertags currently exist for that user:
powerpc64le-linux
Le but de cet étiquettes est de faciliter la découverte des problèmes qui
sont les plus importants pour le type de système
powerpc64le-linux
. Assignez cette étiquette aux bogues et aux
correctifs qui affectent powerpc64le-linux
mais pas les autres types
de systèmes. En plus, vous pouvez l’utiliser pour identifier les problèmes
particulièrement importants pour le type de système
powerpc64le-linux
, même si le problème affecte d’autres types de
systèmes aussi.
reproductibilité
Pour les problèmes de reproductibilité. Par exemple, ce serait approprié d’assigner cette étiquette à un rapport de bogue pour un paquet qui ne se construit pas de manière reproductible.
reviewed-looks-good
You have reviewed the series and it looks good to you (LGTM).
Si vous avez les droits en commit et que vous souhaitez ajouter une
étiquette personnalisée, utilisez-la simplement avec l’utilisateur
guix
. Si l’étiquette vous est utile, vous pourrez alors mettre à jour
cette section du manuel pour que d’autres puissent savoir ce que votre
étiquette signifie.
Précédent: Étiquettes personnalisées de Debbugs, Monter: Suivi des bogues et des changements [Table des matières][Index]
Cuirass includes RSS (Really Simple Syndication) feeds as one of its features (voir (cuirass)Notifications). Since Berlin runs an instance of Cuirass, this feature can be used to keep track of recently broken or fixed packages caused by changes pushed to the Guix git repository. Any RSS client can be used. A good one, included with Emacs, is Voir (gnus)Gnus. To register the feed, copy its URL, then from the main Gnus buffer, ‘*Group*’, do the following:
G R https://ci.guix.gnu.org/events/rss/?specification=master RET Guix CI - master RET Build events for specification master. RET
Then, back at the ‘*Group*’ buffer, press s to save the newly added RSS group. As for any other Gnus group, you can update its content by pressing the g key. You should now receive notifications that read like:
. [ ?: Cuirass ] Build tree-sitter-meson.aarch64-linux on master is fixed. . [ ?: Cuirass ] Build rust-pbkdf2.aarch64-linux on master is fixed. . [ ?: Cuirass ] Build rust-pbkdf2.x86_64-linux on master is fixed.
where each RSS entry contains a link to the Cuirass build details page of the associated build.
Suivant: Making Decisions, Précédent: Suivi des bogues et des changements, Monter: Contribuer [Table des matières][Index]
To organize work on Guix, including but not just development efforts, the project has a set of teams. Each team has its own focus and interests and is the primary contact point for questions and contributions in those areas. A team’s primary mission is to coordinate and review the work of individuals in its scope (voir Examiner le travail d’autres personnes); it can make decisions within its scope, in agreement with other teams whenever there is overlap or a close connection, and in accordance with other project rules such as seeking consensus (voir Making Decisions).
As an example, the Python team is responsible for core Python packaging
matters; it can decide to upgrade core Python packages in a dedicated
python-team
branch, in collaboration with any team whose scope is
directly dependent on Python—e.g., the Science team—and following
branching rules (voir Managing Patches and Branches). The Documentation
team helps review changes to the documentation and can initiate overarching
documentation changes. The Translations team organizes translation of Guix
and its manual and coordinates efforts in that area. The Core team is
responsible for the development of core functionality and interfaces of
Guix; because of its central nature, some of its work may require soliciting
input from the community at large and seeking consensus before enacting
decisions that would affect the entire community.
Teams are defined in the etc/teams.scm file in the Guix repository. The scope of each team is defined, when applicable, as a set of files or as a regular expression matching file names.
Anyone with interest in a team’s domain and willing to contribute to its work can apply to become a member by contacting current members by email; commit access is not a precondition. Membership is formalized by adding the person’s name and email address to etc/teams.scm. Members who have not been participating in the team’s work for one year or more may be removed; they are free to reapply for membership later.
One or more people may propose the creation of a new team by reaching out to the community by email at guix-devel@gnu.org, clarifying the intended scope and purpose. When consensus is reached on the creation of this team, someone with commit access formalizes its creation by adding it and its initial members to etc/teams.scm.
To list existing teams, run the following command from a Guix checkout:
$ ./etc/teams.scm list-teams id: mentors name: Mentors description: A group of mentors who chaperone contributions by newcomers. members: + Charlie Smith <charlie@example.org> …
You can run the following command to have the Mentors team put in CC of a patch series:
$ git send-email --to=ISSUE_NUMBER@debbugs.gnu.org \ --header-cmd='etc/teams.scm cc-mentors-header-cmd' *.patch
L’équipe ou les équipes appropriées peuvent aussi être inférées à partir des fichiers modifiés. Par exemple, si vous voulez envoyer les deux derniers commits du dépôt Git actuel à la revue, vous pouvez exécuter :
$ guix shell -D guix [env]$ git send-email --to=ISSUE_NUMBER@debbugs.gnu.org -2
Suivant: Accès en commit, Précédent: Équipes, Monter: Contribuer [Table des matières][Index]
It is expected from all contributors, and even more so from committers, to help build consensus and make decisions based on consensus. By using consensus, we are committed to finding solutions that everyone can live with. It implies that no decision is made against significant concerns and these concerns are actively resolved with proposals that work for everyone.
A contributor (who may or may not have commit access) wishing to block a proposal bears a special responsibility for finding alternatives, proposing ideas/code or explain the rationale for the status quo to resolve the deadlock. To learn what consensus decision making means and understand its finer details, you are encouraged to read https://www.seedsforchange.org.uk/consensus.
Suivant: Examiner le travail d’autres personnes, Précédent: Making Decisions, Monter: Contribuer [Table des matières][Index]
Everyone can contribute to Guix without having commit access (voir Envoyer des correctifs). However, for frequent contributors, having write access to the repository can be convenient. As a rule of thumb, a contributor should have accumulated fifty (50) reviewed commits to be considered as a committer and have sustained their activity in the project for at least 6 months. This ensures enough interactions with the contributor, which is essential for mentoring and assessing whether they are ready to become a committer. Commit access should not be thought of as a “badge of honor” but rather as a responsibility a contributor is willing to take to help the project.
Committers are in a position where they enact technical decisions. Such decisions must be made by actively building consensus among interested parties and stakeholders. Making Decisions, for more on that.
Les sections suivantes expliquent comment recevoir des accès en commit, comment se préparer à pousser des commits et la politique et les attentes de la communauté pour les commits poussés en amont.
Lorsque vous l’estimez nécessaire, pensez à candidater à l’accès en commit en suivant les étapes suivantes :
Les commiteurs devront avoir eu des interactions avec vous en tant que contributeur et pouvoir juger si vous êtes suffisament familier avec les pratiques du projet. Ce n’est pas un jugement sur la valeur de votre travail, donc vous devriez plutôt interpréter un refus comme un « essayons un peu plus tard ».
Configurer GnuPG de manière à ce qu’il n’utilise jamais l’algorithme de hachage SHA1 pour les signatures numériques, dont on sait qu’il est dangereux depuis 2019, par exemple en ajoutant la ligne suivante à ~/.gnupg/gpg.conf (voir GPG Esoteric Options dans The GNU Privacy Guard Manual) :
digest-algo sha512
Important : Avant d’envoyer pour la première fois, les mainteneur·ses doivent :
- ajoutez votre clé OpenPGP à la branche
keyring
;- ajoutez votre empreinte OpenPGP au fichier .guix-authorizations de la (des) branche(s) sur laquelle (lesquelles) vous vous engagez.
Remarque : Les mainteneur·ses se réjouissent de donnéer l’accès en commit aux personnes qui ont contribué depuis un certain temps et ont un historique — ne soyez pas timide et ne sous-estimez pas votre travail !
Cependant, remarquez que le projet travail sur un système de revu de correctifs et de fusion plus automatisé, qui, en conséquence, pourra nous faire réduire le nombre de personne ayant accès en commit au dépôt principal. Restez à l’écoute !
Tous les commits poussés sur le dépôt central sur Savannah doivent être
signés avec une clef OpenPGP et la clef publique doit être chargée sur votre
compte utilisateur dans Savannah et les serveurs de clef publique, comme
keys.opengpg.org
. Pour configurer Git pour signer automatiquement
vos commits, lancez :
git config commit.gpgsign true # Remplacez l'empreinte par celle de votre clé PGP publique git config user.signingkey CABBA6EA1DC0FF33
Pour vérifier que les commits sont signés avec une clé correcte, utilisez :
guix git authenticate
Voir Construire depuis Git for running the first authentication of a Guix checkout.
To avoid accidentally pushing unsigned or signed with the wrong key commits to Savannah, make sure to configure Git according to Voir Configurer Git.
Si vous avez accès en commit, assurez-vous de respecter la politique ci-dessous (les discussions à propos de cette politique peuvent avoir lieu sur guix-devel@gnu.org).
Ensure you’re aware of how the changes should be handled (voir Managing Patches and Branches) prior to being pushed to the repository, especially
for the master
branch.
If you’re committing and pushing your own changes, try and wait at least one week (two weeks for more significant changes, up to one month for changes such as removing a package—voir Package Removal) after you send them for review. After this, if no one else is available to review them and if you’re confident about the changes, it’s OK to commit.
Lorsque vous poussez un commit pour le compte de quelqu’un d’autre, ajoutez
une ligne Signed-off-by
à la fin du message de commit — p. ex.
avec git am --signoff
. Cela amélior le suivi que qui fait quoi.
Quand vous ajoutez de nouvelles entrées au canal (voir Writing Channel News), assurez-vous qu’elles sont bien formées en exécutant la commande suivante juste avant d’envoyer :
make check-channel-news
La revue par les pairs (voir Envoyer des correctifs) et les outils comme
guix lint
(voir Invoquer guix lint
) et la suite de tests
(voir Lancer la suite de tests) devraient trouver les problèmes avant
qu’ils ne soient poussés. Pourtant, il arrive parfois que des commits qui «
cassent » une fonctionnalité passent à travers les mailles du filet. Lorsque
cela arrive, il y a deux priorités : minimiser l’impact et comprendre ce qui
s’est passé, pour réduire les chances qu’un incident similaire se produise à
nouveau. Les personnes impliquées ont la plus grande part de responsabilité
dans ces deux tâches, mais comme pour tout le reste, c’est aussi un travail
commun.
Certains problèmes peuvent directement affecter les utilisateurs et
utilisatrices — par exemple si guix pull
échoue ou qu’une
fonctionnalité importante est cassée parce que des paquets importants sont
cassés (à la construction ou à l’exécution), ou parce qu’ils introduisent
des problèmes de sécurités connus.
Les personnes impliquées, auteurs, relecteurs et ayant poussé ces commits devraient avant tout réduire leur impact rapidement en poussant un nouveau commit qui le corrige (si c’est possible) ou en inversant les commits pour laisser du temps avant de trouver un correctif satisfaisant, et en communiquant le problème aux autres développeurs.
Si ces personnes ne peuvent pas s’occuper du problème à temps, les autres commiteurs peuvent inverser les commits, en expliquant le problème dans le message de commit et sur la liste de diffusion, dans le but de donner du temps au commiteur, aux relecteurs et aux auteurs de proposer une solution.
Une fois que le problème a été réglé, il est de la responsabilité des personnes impliquées de s’assurer que la situation a été comprise. Si vous travaillez à comprendre ce qui est arrivé, efforcez-vous de récolter des informations plutôt que de désigner des coupables. Demandez aux gens impliqués de décrire ce qui est arrivé, ne leur demandez pas d’expliquer la situation – ce qui les mettrait implicitement dans une position de responsabilité et n’est d’aucune aide. La responsabilité vient une fois atteint un consensus sur le problème, qui permet d’apprendre de ce qui s’est passé et d’améliorer les processus afin qu’il soit moins à risque de se reproduire.
Pour réduire la probabilité de faire une erreur, celles et ceux qui peuvent commiter seront retiré·e·s du projet Guix sur Savannah et leur clé supprimée de .guix-authorizations après 12 mois d’inactivité ; ils et elles pourront retrouver leur accès en envoyant un courriel aux mainteneur·ses, sans avoir à passer par le processus de cooptation.
Les mainteneur·ses53 peuvent aussi révoquer les droits en commit de quelqu’un, en dernier recours, si la coopération avec le reste de la communauté a créé trop de friction – même en restant dans le cadre du code de conduite (voir Contribuer) du projet. Ils ne le feraient qu’après une discussion publique ou privée avec la personne concernée et un avertissement clair. Voici des exemples de comportements qui gênent la coopération et pourraient mener à une telle décision :
Quand les mainteneurs recourent à une telle décision, ils en informent les développeurs sur guix-devel@gnu.org ; des questions peuvent être envoyées à guix-maintainers@gnu.org. Suivant la situation, les contributions de la personne peuvent rester bienvenues.
Une dernière chose : le projet continue à avancer non seulement parce que les commiteurs poussent leurs propres changements, mais aussi parce qu’ils offrent de leur temps pour revoir et pousser les changements des autres personnes. En tant que commiteur, vous pouvez utiliser votre expertise et vos droits en commit pour aider d’autres contributeaurs aussi !
Suivant: Mettre à jour Guix, Précédent: Accès en commit, Monter: Contribuer [Table des matières][Index]
Perhaps the biggest action you can do to help GNU Guix grow as a project is to review the work contributed by others. You do not need to be a committer to do so; applying, reading the source, building, linting and running other people’s series and sharing your comments about your experience will give some confidence to committers. You must ensure the check list found in the Envoyer des correctifs section has been correctly followed. A reviewed patch series should give the best chances for the proposed change to be merged faster, so if a change you would like to see merged hasn’t yet been reviewed, this is the most appropriate thing to do! If you would like to review changes in a specific area and to receive notifications for incoming patches relevant to that domain, consider joining the relevant team(s) (voir Équipes).
Review comments should be unambiguous; be as clear and explicit as you can about what you think should be changed, ensuring the author can take action on it. Please try to keep the following guidelines in mind during review:
When you deem the proposed change adequate and ready for inclusion within Guix, the following well understood/codified ‘Reviewed-by: Your Name <your-email@example.com>’ 55 line should be used to sign off as a reviewer, meaning you have reviewed the change and that it looks good to you:
If you are not a committer, you can help others find a series you
have reviewed more easily by adding a reviewed-looks-good
usertag for
the guix
user (voir Étiquettes personnalisées de Debbugs).
Suivant: Deprecation Policy, Précédent: Examiner le travail d’autres personnes, Monter: Contribuer [Table des matières][Index]
Il est quelquefois souhaitable de mettre à jour le paquet guix
lui-même (le paquet défini dans (gnu packages package-management)
),
par exemple pour rendre de nouvelles caractéristiques disponibles à
l’utilisation par le type de service guix-service-type
. Afin de
simplifier cette tâche, la commande suivante peut être utilisée :
make update-guix-package
Le make target update-guix-package
utilisera le dernier commit
connu correspondant à HEAD
dans votre checkout Guix, calculera le
hash des sources Guix correspondant à ce commit et mettra à jour la
définition des paquets commit
, revision
et le hash du paquet
guix
.
Pour avoir la certitude que les hash du paquet guix
mis à jour sont
corrects et qu’il peut être construit avec succès, la commande suivante peut
être lancée depuis le répertoire de votre checkout Guix :
./pre-inst-env guix build guix
Pour éviter de mettre à jour accidentellement le paquet guix
en un
commit auquel les autres ne peuvent pas se référer, on vérifie que le commit
utilisé a déjà été placé dans le dépôt git de Guix hébergé par Savannah.
Cette vérification peut être désactivée, à vos risques et périls, en
passant la variable d’environnement
GUIX_ALLOW_ME_TO_USE_PRIVATE_COMMIT
. Lorsque cette variable est
initialisée, les source du paquet mis à jour est aussi ajouté au dépôt.
Cela est utilisé dans le processus de publication de Guix.
Suivant: Écrire de la documentation, Précédent: Mettre à jour Guix, Monter: Contribuer [Table des matières][Index]
As any lively project with a broad scope, Guix changes all the time and at all levels. Because it’s user-extensible and programmable, incompatible changes can directly impact users and make their life harder. It is thus important to reduce user-visible incompatible changes to a minimum and, when such changes are deemed necessary, to clearly communicate them through a deprecation period so everyone can adapt with minimum hassle. This section defines the project’s commitments for smooth deprecation and describes procedures and mechanisms to honor them.
There are several ways to use Guix; how to handle deprecation will depend on each use case. Those can be roughly categorized like this:
operating-system
and/or
home-environment
interfaces together with the service interfaces;
(guix ...)
modules.
These use cases form a spectrum with varying degrees of coupling—from “distant” to tightly coupled. Based on this insight, we define the following deprecation policies that we consider suitable for each of these levels.
Guix sub-commands should be thought of as remaining available “forever”. Once a Guix sub-command is to be removed, it should be deprecated first, and then remain available for at least one year after the first release that deprecated it.
Deprecation should first be announced in the manual and as an entry in
etc/news.scm; additional communication such as a blog post explaining
the rationale is welcome. Months before the scheduled removal date, the
command should print a warning explaining how to migrate. An example of
this is the replacement of guix environment
by guix
shell
, started in October 202156.
Because of the broad impact of such a change, we recommend conducting a user survey before enacting a plan.
When a package name changes, it must remain available under its old name for
at least one year. For example, go-ipfs
was renamed to
kubo
following a decision made upstream; to communicate the name
change to users, the package module provided this definition:
(define-public go-ipfs
(deprecated-package "go-ipfs" kubo))
That way, someone running guix install go-ipfs
or similar sees a
deprecation warning mentioning the new name.
Packages whose upstream developers have declared as having reached “end of life” or being unmaintained may be removed; likewise, packages that have been failing to build for two months or more may be removed.
There is no formal deprecation mechanism for this case, unless a replacement
exists, in which case the deprecated-package
procedure mentioned
above can be used.
If the package being removed is a “leaf” (no other packages depend on it), it may be removed after a one-month review period of the patch removing it (this applies even when the removal has additional motivations such as security problems affecting the package).
If it has many dependent packages—as is the case for example with Python version 2—the relevant team must propose a deprecation removal agenda and seek consensus with other packagers for at least one month. It may also invite feedback from the broader user community, for example through a survey. Removal of all impacted packages may be gradual, spanning multiple months, to accommodate all use cases.
When the package being removed is considered popular, whether or not it is a
leaf, its deprecation must be announced as an entry in etc/news.scm
.
In the case of packages with many dependents and/or many users, an upgrade may be treated like the removal of the previous version.
Examples include major version upgrades of programming language implementations, as we’ve seen above with Python, and major upgrades of “big” libraries such as Qt or GTK.
Changes to services for Guix Home and Guix System have a direct impact on user configuration. For a user, adjusting to interface changes is rarely rewarding, which is why any such change must be clearly communicated in advance through deprecation warnings and documentation.
Renaming of variables related to service, home, or system configuration must
be communicated for at least six months before removal using the (guix
deprecation)
mechanisms. For example, renaming of
murmur-configuration
to mumble-server-configuration
was
communicated through a series of definitions like this one:
(define-deprecated/public-alias
murmur-configuration
mumble-server-configuration)
Procedures slated for removal may be defined like this:
(define-deprecated (elogind-service #:key (config (elogind-configuration)))
elogind-service-type
(service elogind-service-type config))
Record fields, notably fields of service configuration records, must follow
a similar deprecation period. This is usually achieved through ad hoc
means though. For example, the hosts-file
field of
operating-system
was deprecated by adding a sanitized
property
that would emit a warning:
(define-record-type* <operating-system> ;; … (hosts-file %operating-system-hosts-file ;deprecated (default #f) (sanitize warn-hosts-file-field-deprecation))) (define-deprecated (operating-system-hosts-file os) hosts-service-type (%operating-system-hosts-file os))
When deprecating interfaces in operating-system
,
home-environment
, (gnu services)
, or any popular service, the
deprecation must come with an entry in etc/news.scm
.
Core programming interfaces, in particular the (guix ...)
modules,
may be relied on by a variety of external tools and channels. Any
incompatible change must be formally deprecated with
define-deprecated
, as shown above, for at least one year before
removal. The manual must clearly document the new interface and, except in
obvious cases, explain how to migrate from the old one.
As an example, the build-expression->derivation
procedure was
superseded by gexp->derivation
and remained available as a deprecated
symbol:
(define-deprecated (build-expression->derivation store name exp
#:key …)
gexp->derivation
…)
Sometimes bindings are moved from one module to another. In those cases, bindings must be reexported from the original module for at least one year.
This section does not cover all possible situations but hopefully allows users to know what to expect and developers to stick to its spirit. Please email guix-devel@gnu.org for any questions.
Suivant: Traduire Guix, Précédent: Deprecation Policy, Monter: Contribuer [Table des matières][Index]
Guix est documenté avec le système Texinfo. Si vous n’êtes pas à l’aise avec, nous acceptons les contributions pour la documentation dans la plupart des formats. Cela comprends le texte brut, Markdown, Org, etc.
Vous pouvez envoyer des contributions pour la documentation à guix-patches@gnu.org. Ajoutez ‘[DOCUMENTATION]’ au début de l’objet.
Lorsque vous avez besoin de faire plus qu’un simple ajout à la documentation, nous préférons que vous envoyiez un correctif plutôt que d’envoyer un courriel comme précisé plus haut. Voir Envoyer des correctifs pour en apprendre plus sur l’envoie de vos correctifs.
Pour modifier la documentation, vous devrez modifier doc/guix.texi et doc/contributing.texi (qui contient cette section de la documentation) ou doc/guix-cookbook.texi pour le livre de recettes. Si vous avez déjà compilé le dépôt Guix, vous aurez bien plus de fichiers .texi qui sont les traductions de ces documents. Ne les modifiez pas, les traductions sont gérées par Weblate. Voir Traduire Guix pour plus de détails.
Pour générer la documentation, vous devez d’abord vous assurer d’avoir lancé
./configure
dans votre arborescence des sources (voir Lancer Guix avant qu’il ne soit installé). Ensuite, vous pourrez lancer l’une des
commandes suivantes :
info doc/guix.info
.
Précédent: Écrire de la documentation, Monter: Contribuer [Table des matières][Index]
Écrire du code et des paquets n’est pas la seule manière possible de proposer une contribution intéressante à Guix. Traduire vers une langue que vous parlez est un autre exemple de contribution importante que vous pouvez faire. Cette section décrit le processus de traduction. Elle vous donner des conseils sur comment vous impliquer, ce qui peut être traduit, les erreurs à éviter et ce que vous pouvez faire pour nous aider !
Guix est un gros projet qui a plusieurs composants traduisibles. Nous coordonnons l’effort de traduction sur une instance Weblate hébergée par nos amis de Fedora. Vous aurez besoin d’un compte pour soumettre vos traductions.
Certains logiciels empaquetés par Guix contiennent aussi des
traductions. Nous n’hébergeons pas de plateforme de traduction pour eux. Si
vous voulez traduire un paquet fournit par Guix, vous devrez contacter ses
développeurs ou trouver plus d’information sur son site web. Par exemple,
vous pouvez trouver la page d’accueil du paquet hello
en lançant
guix show hello
. Sur la ligne indiquant « homepage », vous verrez
que la page d’accueil est https://www.gnu.org/software/hello/.
De nombreux paquets GNU et non-GNU peuvent être traduits sur le Projet de traduction. Certains projets avec de multiples composants ont leur propre plateforme. Par exemple, GNOME a sa propre plateforme, Damned Lies.
Guix a cinq composants hébergés sur Weblate.
guix
contient toutes les chaînes du logiciel Guix (le guide
d’installation du système, le gestionnaire de paquets, etc), en dehors des
paquets.
packages
contient le synopsis (une description courte en
une ligne) et la description (longue) des paquets de Guix.
website
contient le site web officiel de Guix, en dehors
des billets de blog et du contenu multimédia.
documentation-manual
correspond à ce manuel.
documentation-cookbook
est le composant du livre de recettes.
Une fois que vous aurez un compte, vous pourrez choisir un composant dans projet guix, et choisir une langue. Si votre langue n’apparaît pas dans la liste, allez en bas et cliquez sur le bouton « commencer une nouvelle traduction ». Choisissez la langue en laquelle vous voulez traduire dans la liste pour commencer votre nouvelle traduction.
Comme de nombreux autres logiciels libres, Guix utilise GNU Gettext pour ses traductions. Grâce à lui, les chaînes traduisibles sont extraites du code source en des fichier dits PO.
Même si les fichiers PO sont des fichiers textes, vous devriez les modifier non pas avec un éditeur de texte mais avec un logiciel d’édition de PO. Weblate intègre une fonctionnalité d’édition de PO. Autrement, vous pouvez utiliser n’importe lequel des divers outils libres pour remplir les traductions, dont Poedit est un exemple, et (après vous être connecté) téléverser le fichier modifié. Il y a aussi un mode d’édition de PO spécial pour GNU Emacs. Avec le temps vous trouverez les logiciels qui vous satisfont et les fonctionnalités dont vous avez besoin.
Sur Weblate, vous trouverez plusieurs liens vers l’éditeur, qui vous montreront divers sous-ensemble (ou la totalité) des chaînes. Explorez Weblate et consultez la documentation pour vous familiariser avec la plateforme.
Dans cette section, nous proposons un guide plus détaillé du processus de traduction, ainsi que des détails sur ce que vous devriez ou ne devriez pas faire. Si vous avez un doute, contactez-nous, nous serons ravis de vous aider !
Guix est écrit dans le langage de programmation Guile, et certaines chaînes
contiennent du formatage spécial interprété par Guile. Ce formatage spécial
devrait être mis en évidence par Weblate. Il commence par ~
suivi
d’un ou plusieurs caractères.
Lors de l’affichage des chaînes, Guile remplace les symboles de formatage
spéciaux avec les vrais valeurs. Par exemple, la chaîne ‘ambiguous
package specification `~a'’ serait modifiée pour contenir la spécification
du paquet en question au lieu de ~a
. Pour traduire cette chaîne
correctement, vous devez garder le formatage dans vos traduction, même si
vous pouvez le placer là où cela a le plus de sens dans votre langue. Par
exemple, la traduction française dit ‘spécification du paquet « ~a »
ambiguë’ parce que l’adjectif doit être placé à la fin de la phrase.
S’il y a plusieurs symboles de formatage, assurez-vous de respecter l’ordre. Guile ne sait pas dans quel ordre vous voulez qu’il lise la chaîne, donc il remplacera les symboles dans le même ordre que la phrase anglaise.
Par exemple, vous ne pouvez pas traduire ‘package '~a' has been superseded by '~a'’ par ‘« ~a » remplace le paquet « ~a »’, parce que le sens serait renversé. Si toto est remplacé par titi, la traduction dirait ‘« toto » remplace le paquet « titi »’. Pour éviter ce problème, il est possible d’utiliser un formatage plus avancé pour désigner une donnée particulière, au lieu de suivre l’ordre anglais par défaut. Voir Formatted Output dans GNU Guile Reference Manual, pour plus d’information sur le formatage en Guile.
Les descriptions de paquets contiennent parfois du balisage Texinfo (voir Synopsis et descriptions). Le balisage Texinfo ressemble à ‘@code{rm -rf}’, ‘@emph{important}’, etc. Lors de la traduction, laissez le balisage tel quel.
Les caractères après « @ » forment le nom de la balise, et le texte entre «
{ » et « } » est son contenu. En général, vous ne devriez pas traduire le
contenu des balises comme @code
, car elles contiennent littéralement
du code qui ne change pas avec la langue. Vous pouvez traduire le contenu
des balises de formatage comme @emph
, @i
, @itemize
,
@item
. Cependant, ne traduisez pas le nom de la balise, ou elle ne
sera plus reconnue. Ne traduisez pas le mot après @end
, c’est le nom
de la balise fermée à cet endroit (p. ex. @itemize ... @end
itemize
).
La première étape pour assurer la traduction du manuel est de trouver et traduire les chaîne suivantes en premier :
version.texi
: Traduisez cette chaîne en version-xx.texi
,
où xx
est le code de votre langue (celui affiché dans l’URL sur
weblate).
contributing.texi
: Traduisez cette chaîne en
contributing.xx.texi
, où xx
est le même code de langue.
Top
: Ne traduisez pas cette chaîne, c’est important pour Texinfo.
Si vous la traduisez, le document sera vide (il manquera le nœud
Top). Cherchez-là et utilisez Top
comme traduction.
Traduire ces chaînes en premier s’assure que nous pouvez inclure vos
traduction dans le dépôt guix sans casser le processus make ni la machinerie
derrière guix pull
.
Le manuel et le livre de recettes utilisent tous les deux Texinfo. Comme
pour packages
, gardez le balisage Texinfo intact. Il y a plus de
types de balises possibles dans le manuel que dans les descriptions de
paquets. En général, ne traduisez pas le contenu de @code
,
@file
, @var
, @value
, etc. Vous devriez traduire le
contenu des balises de formatage comme @emph
, @i
, etc.
Le manuel contient des sections auxquelles on peut se référer par leur nom
avec @ref
, @xref
et @pxref
. Nous avons mis en place
un mécanisme pour que vous n’ayez pas besoin de traduire leur contenu. Si
vous gardez le titre anglais, nous le remplacerons automatiquement par votre
traduction de ce titre. Cela s’assure que Texinfo sera toujours capable de
trouver le nœud. Si vous décidez de changer la traduction du titre, les
références seront automatiquement mises à jour et vous n’aurez pas à les
mettre à jour vous-même.
Lorsque vous traduirez des références de livre de recettes vers le manuel,
vous devrez remplacer le nom du manuel et le nom de la section. Par exemple,
pour traduire @pxref{Defining Packages,,, guix, GNU Guix Reference
Manual}
, vous devrez remplacer Defining Packages
par le titre de
cette section dans le manuel traduit seulement si ce titre est
traduit. Si le titre n’est pas encore traduit dans votre langue, ne le
traduisez pas ici, ou le lien sera cassé. Remplacez guix
par
guix.xx
où xx
est le code de votre langue. GNU Guix
Reference Manual
est le texte du lien. Vous pouvez le traduire comme bon
vous semble.
Les pages du site web sont écrite en SXML, une manière d’écrire du HTML, le langage de base du web, avec des s-expressions. Nous avons un processus pour extraire les chaînes traduisibles dans les sources, et pour remplacer les s-expressions complexes avec du balisage XML plus familier, où chaque balise est numérotée. Vous pouvez changer l’ordre comme bon vous semble, comme dans l’exemple suivant.
#. TRANSLATORS: Defining Packages is a section name #. in the English (en) manual. #: apps/base/templates/about.scm:64 msgid "Packages are <1>defined<1.1>en</1.1><1.2>Defining-Packages.html</1.2></1> as native <2>Guile</2> modules." msgstr "Pakete werden als reine <2>Guile</2>-Module <1>definiert<1.1>de</1.1><1.2>Pakete-definieren.html</1.2></1>."
Remarquez que vous devez inclure les même balises. Vous ne devez pas en oublier.
Si vous faites une erreur, le composant peut échouer à construire correctement dans votre langue, voir casser guix pull. Pour éviter cela, nous avons mis en place un processus pour vérifier le contenu des fichiers avant de les pousser dans notre dépôt. Nous ne pourrons alors pas mettre à jour la traduction en votre langue dans Guix, donc nous vous notifierons (à travers weblate ou par courriel) pour que vous puissez corriger le problème.
Actuellement, certaines parties de Guix ne peuvent pas être traduites sur Weblate, nous avons besoin d’aide !
guix pull
peuvent être traduites dans news.scm, mais ne sont
pas disponibles sur Weblate. Si vous voulez fournir une traduction, vous
pouvez préparer un correctif comme décrit plus haut, ou simplement nous
envoyer votre traduction avec le nom de l’entrée que vous avez traduite et
votre langue. Voir Écrire des nouveautés de canaux, pour plus d’information sur les
nouvelles de canaux.
Il n’y a pas de condition particulière pour ajouter de nouvelles traductions
aux composants guix
et guix-packages
, en dehors du fait
qu’elles doivent avoir au moins une chaîne traduite. Les nouvelles langues
seront ajoutées à Guix le plus tôt possible. Les fichiers peuvent être
supprimés s’ils ne sont plus synchronisés et qu’ils n’ont plus aucune chaîne
traduite.
Étant donné que le site web est prévu pour les nouveaux utilisateurs, nous souhaitons que ses traductions soient les plus complètes possible avant de les inclure dans le menu des langues. Pour qu’une nouvelle langue soit ajoutée, elle doit atteindre au moins les 80% de complétion. Lorsqu’une langue est incluse, elle peut être supprimée dans le futur si elle reste désynchronisée et que sa complétion descend en dessous des 60%.
Le manuel et le livre de recettes sont automatiquement ajoutés à la cible de compilation par défaut. Chaque fois que nous synchronisons les traductions, les développeurs et développeuses doivent recompiler tous les manuels et les livres de recettes traduits. C’est inutile s’il s’agit en grande partie du manuel ou du livre de recettes en anglais. De ce fait, nous n’inclurons les nouvelles langues que si elles atteignent 10% de complétion dans le composant en question. Lorsqu’une langue est ajoutée, elle pourra être supprimée dans le futur si elle reste désynchronisée et que son taux de complétion descend en dessous des 5%.
Weblate s’appuie sur un dépôt git à partir duquel il découvre les nouvelles chaînes à traduire et vers lequel il pousse les nouvelles traductions. Normalement, il suffirait de lui donner accès en commit à nos dépôts. Cependant, nous avons préféré utiliser un dépôt séparé pour deux raisons. Tout d’abord, nous aurions du donner à Weblate l’accès en commit et autoriser sa clé de signature, mais nous ne lui faisons pas autant confiance qu’aux développeurs de guix, d’autant plus que nous ne gérons pas l’instance nous-même. Ensuite, si les traducteurs et les traductrices font une erreur, cela peut casser la génération du site web ou guix pull pour tout le monde, quelle que soit la langue.
Pour ces raisons, nous utilisons un dépôt dédié pour héberger les traductions, et nous le synchronisons avec nos dépôts guix et artwork après avoir vérifié qu’aucun problème n’est introduit par les traductions.
vous pouvez télécharger les derniers fichiers PO de weblate dans le dépôt
Guix en lançant la commande make download-po
. Cela télécharge
automatiquement les derniers fichiers de weblate, les reformate vers une
forme canonique, et vérifie qu’ils ne contiennent pas de problème. Le manuel
doit être reconstruit pour vérifier qu’il n’y a pas de problème
supplémentaire qui ferait planter Texinfo.
Avant de pousser de nouveaux fichiers de traduction, qui n’existaient pas avant, vous devez les ajouter à la machinerie make pour que les traductions soit effectivement disponibles. Le processus diffère en fonction des composants.
guix
et packages
doivent
être enregistrés en ajoutant la nouvelle langue dans po/guix/LINGUAS
ou po/packages/LINGUAS.
documentation-manuel
doivent
être enregistrés en ajoutant le nom de fichier à DOC_PO_FILES
dans
po/doc/local.mk, le manuel généré %D%/guix.xx.texi à
info_TEXINFOS
dans doc/local.mk et les fichiers
%D%/guix.xx.texi et %D%/contributing.xx.texi à
TRANSLATED_INFO
aussi dans doc/local.mk.
documentation-cookbook
doivent
être enregistrés en ajoutant le nom de fichier à
DOC_COOKBOOK_PO_FILES
dans po/doc/local.mk, le manuel généré
%D%/guix-cookbook.xx.texi à info_TEXINFOS
dans
doc/local.mk et le fichier généré %D%/guix-cookbook.xx.texi à
TRANSLATED_INFO
aussi dans doc/local.mk.
website
doivent être ajoutés dans
le dépôt guix-artwork
, dans website/po/. Vous devez mettre à
jour website/po/LINGUAS et website/po/ietf-tags.scm en
fonction (voir website/i18n-howto.txt pour plus d’information sur le
processus).
Suivant: La licence GNU Free Documentation, Précédent: Contribuer, Monter: GNU Guix [Table des matières][Index]
Guix se base sur le https://nixos.org/nix/ gestionnaire de paquets Nix conçu et implémenté par Eelco Dolstra, avec des contributions d’autres personnes (voir le fichier nix/AUTHORS dans Guix). Nix a inventé la gestion de paquet fonctionnelle et promu des fonctionnalités sans précédents comme les mises à jour de paquets transactionnelles et les retours en arrière, les profils par utilisateurs et les processus de constructions transparents pour les références. Sans ce travail, Guix n’existerait pas.
Les distributions logicielles basées sur Nix, Nixpkgs et NixOS, ont aussi été une inspiration pour Guix.
GNU Guix lui-même est un travail collectif avec des contributions d’un grand nombre de personnes. Voyez le fichier AUTHORS dans Guix pour plus d’information sur ces personnes de qualité. Le fichier THANKS liste les personnes qui ont aidé en rapportant des bogues, en prenant soin de l’infrastructure, en fournissant des images et des thèmes, en faisant des suggestions et bien plus. Merci !
Suivant: Index des concepts, Précédent: Remerciements, Monter: GNU Guix [Table des matières][Index]
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.
The “publisher” means any person or entity that distributes copies of the Document to the public.
A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.
You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See https://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.
“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.
“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.
“Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.
An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.
The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.
To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
Copyright (C) year your name. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''.
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:
with the Invariant Sections being list their titles, with the Front-Cover Texts being list, and with the Back-Cover Texts being list.
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.
Suivant: Index de programmation, Précédent: La licence GNU Free Documentation, Monter: GNU Guix [Table des matières][Index]
Aller à: | .
/
A B C D E F G H I J K L M N O P Q R S T U V W X Z É |
---|
Aller à: | .
/
A B C D E F G H I J K L M N O P Q R S T U V W X Z É |
---|
Précédent: Index des concepts, Monter: GNU Guix [Table des matières][Index]
Aller à: | #
$
%
'
(
,
>
`
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z |
---|
Aller à: | #
$
%
'
(
,
>
`
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z |
---|
« Guix » se prononce comme « geeks » (en prononçant le « s »), ou « ɡiːks » dans l’alphabet phonétique international (API).
Nous appelions par le passé le système Guix « la
distribution système Guix » ou « GuixSD ». Nous considérons maintenant
qu’il est plus pertinent de tout regrouper sous la bannière de « Guix »
comme, après tout, Guix System est directement disponible sous la commande
guix system
, meme si vous utilisez une autre distro en dessous
!
Le terme « libre » se réfère ici bien sûr à la liberté offerte à la personne qui utilise ces logiciels.
Hurd support is currently limited.
https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh
Si votre machine utilise le système
d’initialisation systemd, copiez le fichier
prefix/lib/systemd/system/guix-daemon.service dans
/etc/systemd/system pour vous assurer que guix-daemon
est
démarré automatiquement. De même, si votre machine utilise le système
d’initialisation Upstart, copiez le fichier
prefix/lib/upstart/system/guix-daemon.conf dans
/etc/init.
« presque », parce que même si l’ensemble des
fichiers qui apparaissent dans le /dev
du chroot sont déterminés à
l’avance, la plupart de ces fichiers ne peut pas être créée si l’hôte ne les
a pas.
Cette fonctionnalité n’est disponible que si Guile-SSH est présent.
La taille du paquet glibc-locales
est
réduite à environ 213 Mio avec la déduplication du dépôt et encore à
67 Mio si vous utilisez le système de fichiers Btrfs compressé avec
zstd
Actuellement Guix System ne prend en charge que les systèmes de fichiers ext4, btrfs, JFS, F2FS et XFS. En particulier, le code qui lit les UUID des systèmes de fichiers et les étiquettes ne fonctionne que pour ces types de systèmes de fichiers.
Cet exemple
fonctionnera sur plusieurs types de systèmes de fichiers (p. ex. ext4).
Cependant, pour les systèmes de fichiers qui utilisent la copie sur écriture
(COW) comme btrfs, les étapes requises peuvent varier. Pour plus de
détails, regardez les pages de manuel de mkswap
et
swapon
.
Si vous ne savez pas ce qu’est une DeLorean, envisagez un voyage vers les années 1980. (Retour vers le futur (1985))
Les commits de Git forment un graphe acyclique orienté (DAG en anglais). Chaque commit peut avoir zéro ou plusieurs parents ; les commits « usuels » ont un seul parent et les commits de fusion ont deux parents. Lisez Git for Computer Scientists pour une bonne vue d’ensemble.
Assurez-vous d’utiliser l’option
--check la première fois que vous utilisez guix shell
de
manière interactive pour vous assurer que le shell ne défait pas les effets
de --pure.
Par exemple, le
paquet fontconfig
inspecte ~/.guix-profile/share/fonts pour
trouver des polices supplémentaires.
Les utilisatrice·eur·s ajoutent parfois à tort des
valeurs supplémentaires dans les variables comme PATH
dans leur
~/.bashrc. En conséquence, lorsque guix environment
le
lance, Bash peut lire ~/.bashrc, ce qui produit des « impuretés »
dans ces variables d’environnement. C’est une erreur de définir ces
variables d’environnement dans .bashrc ; à la place, elles devraient
être définie dans .bash_profile, qui est sourcé uniquement par les
shells de connexion. Voir Bash Startup Files dans The GNU Bash
Reference Manual, pour des détails sur les fichiers de démarrage de Bash.
Par exemple, le
paquet fontconfig
inspecte ~/.guix-profile/share/fonts pour
trouver des polices supplémentaires.
Il y a une astuce
pour s’en souvenir : on peut envisager -RR
, qui ajoute le support
PRoot, comme étant l’abréviation de « Réellement Repositionnable ». Pas
mal, hein ?
Remarquez que les paquets sous
l’espace de nom (gnu packages …)
ne sont pas nécessairement des
« paquets GNU ». Le nom de ce module suit la convention de nommage usuelle
de Guile : gnu
signifie que ces modules sont distribués dans le
système GNU, et packages
identifie les modules qui définissent les
paquets.
Remarquez que le nom du fichier et le nom du module doivent
correspondre. Par exemple, le module (my-packages emacs)
doit être
stocké dans un fichier my-packages/emacs.scm relatif au chemin de
chargement spécifié avec --load-path ou GUIX_PACKAGE_PATH
.
Voir Modules and the File System dans GNU Guile Reference Manual,
pour plus de détails.
Nous présentons une vue simplifiée de ces phases de
construction, mais jetez un œil à (guix build gnu-build-system)
pour
voir tous les détails !
Alternatively known as SGML catalog.
NdT : il y a là un jeu de mot en anglais qui se base sur un double sens de « run », qui peut se traduire par « exécuter » dans ce contexte.
Cette opération est souvent appelée « bind », mais ce nom dénote une procédure qui n’a rien à voir en Guile. Ainsi, nous empruntons ce symbole quelque peu cryptique au langage Haskell
Le terme de strate dans ce contexte a été inventé par Manuel Serrano et ses collègues dans le contexte de leurs travaux sur Hop. Oleg Kiselyov, qui a écrit des essais perspicaces ainsi que du code sur le sujet, utilise le terme de « mise en scène » pour ce genre de génération de code.
Plus précisément, guix size
cherche les variantes
non greffées des paquets donnés, tels qu’ils sont renvoyés par
guix build paquet --no-graft
. Voir Mises à jour de sécurité pour des
informations sur les greffes
Cette commande n’est disponible que si Guile-SSH est trouvé. Voir Prérequis, pour des détails
Les sessions distantes,
lorsque guix-daemon
est démarré avec --listen en
spécifiant un point d’entrée TCP, ne sont pas listées.
Actuellement, seul le noyau Linux-libre est entièrement pris en charge. L’utilisation de GNU mach avec le GNU Hurd est expérimentale et n’est disponible que lors de la construction d’une image disque de machine virtuelle.
Remarquez que, s’il est tentant d’utiliser /dev/disk/by-uuid et autres chemins similaires pour obtenir le même résultat, ce n’est pas recommandé : ces nœuds de périphériques spéciaux sont créés par le démon udev et peuvent ne pas être disponibles au moment de monter le périphérique.
La forme uuid
s’attend à des UUID sur 16
octets définis dans la RFC 4122. C’est la forme des UUID utilisées par la famille de
systèmes de fichiers ext2 et d’autres, mais ce n’est pas le même type d’UUID
que ceux qui se trouvent sur les systèmes de fichiers FAT par exemple
Remarquez que le Hurd ne fait pas de différence entre le concept de « périphérique mappé » et celle d’un système de fichiers : les deux correspondent à la traduction des opérations d’entrée-sortie faites sur un fichier en des opérations sur ce qui le contient. Ainsi, le Hurd implémente les périphériques mappés, comme les systèmes de fichiers, avec le mécanisme des traducteurs générique (voir Translators dans The GNU Hurd Reference Manual).
Versions 2.23 et suivantes de GNU libc ignorera simplement les données locales incompatibles, ce qui est déjà une amélioration.
See the agetty(8)
man page for
more information.
NdT : je vous rassure, c’est aussi mon sentiment au moment de traduire ces lignes. Et pour moi, c’est encore loin d’être fini.
D-Bus is an inter-process communication facility. Its system bus is used to allow system services to communicate and to be notified of system-wide events.
NdT : Voir la conférence en Français de Stéphane Bortzmeyer pour en apprendre plus sur le DNS : https://iletaitunefoisinternet.fr/dns-bortzmeyer/index.html
The most widespread example of time traps is test suites that involve checking the expiration date of a certificate. Such tests exists in TLS implementations such as OpenSSL and GnuTLS, but also in high-level software such as Python.
En créant le fichier magique git-daemon-export-ok dans le répertoire du dépôt.
Lancez man git-daemon
pour plus d’informations.
Cette action (et les action liées que sont
switch-generation
et roll-back
) ne sont utilisables que sur
les systèmes sous Guix System.
La base de donnée parcourue par man -k
est
uniquement créée dans les profils qui contiennent le paquet man-db
.
No rule without
exception! As the monolithic TeX Live does not contain the
biber
executable, it is okay to combine it with
texlive-biber
, which does.
Les paquets comme gcc-2.95.3
,
binutils-2.14
, glicb-2.2.5
, gzip-1.2.4
, tar-1.22
et certains autres. Pour les détails, voir
gnu/packages/commencement.scm.
Vous remarquerez qu’elle s’appelle glibc-intermediate
, ce
qui suggère qu’elle n’est pas tout à fait finale, mais c’est une
bonne approximation tout de même.
Les liaisons Guile de GnuTLS faisaient partie de GnuTLS jusqu’à la version 3.7.8 incluse.
This requires a recent version of Guix, from May 2024 or more recent.
Le drapeau
-E de sudo
garantit que GUILE_LOAD_PATH
est
correctement configuré de sorte que guix-daemon
et les outils
qu’il utilise puissent trouver les modules Guile dont ils ont besoin.
For this reason, (guix …)
modules must
generally not depend on (gnu …)
modules, with notable
exceptions: (guix build-system …)
modules may look up packages
at run time—e.g., (guix build-system cmake)
needs to access the
cmake
variable at run time—, (guix scripts …)
often
rely on (gnu …)
modules, and the same goes for some of the
(guix import …)
modules.
You can mark an issue as blocked by another by emailing
control@debbugs.gnu.org with the following line in the body of the
email: block XXXXX by YYYYY
. Where XXXXX
is the number for
the blocked issue, and YYYYY
is the number for the issue blocking
it.
Mumi is a nice piece of software written in Guile, and you can help! See https://git.savannah.gnu.org/cgit/guix/mumi.git.
The list of usertags is public information, and anyone can modify any user’s list of usertags, so keep that in mind if you choose to use this feature.
Voir https ://guix.gnu.org/fr/about pour la liste à jour des mainteneur·ses. Vous pouvez leur envoyer un courriel en privé à l’adresse guix-maintainers@gnu.org.
The tendency to discuss minute details at length is often referred to as “bikeshedding”, where much time is spent discussing each one’s preference for the color of the shed at the expense of progress made on the project to keep bikes dry.
The ‘Reviewed-by’ Git trailer is used by other projects such as Linux, and is understood by third-party tools such as the ‘b4 am’ sub-command, which is able to retrieve the complete submission email thread from a public-inbox instance and add the Git trailers found in replies to the commit patches.
For more details on the
guix shell
transition, see
https://guix.gnu.org/en/blog/2021/from-guix-environment-to-guix-shell/.