Contribuer à markas.fr

Le dépôt contenant le code de l’infrastructure markas.fr est https://framagit.org/markas/infrastructure

Ce dépôt contient également des tickets décrivant les prochaines tâches à réaliser.

Prérequis

L’infrastructure repose fortement sur l’outil Nix et la distribution NixOS. Pour contribuer, il faut donc installer le gestionnaire de paquet Nix. Ce gestionnaire de paquet fonctionne sur toutes les distributions en n’entre pas en conflit avec les paquets de votre distribution.

Pour installer Nix:

curl https://nixos.org/nix/install | sh

Si besoin, le manuel Nix fournit plus d’information et d’options d’installation.

Essayer le serveur localement

Il est possible de lancer construire et démarrer une machine virtuelle correspondant à la configuration du serveur. Cette machine peut être utilisée pour tester un changement ou étudier la configuration du serveur.

Avertissement

KVM est nécessaire pour faire fonctionner la machine virtuelle et doit donc être utilisable par votre utilisateur courant. Cette documentation Ubuntu fournies les informations nécessaires à l’activation de KVM.

Pour démarrer le serveur localement

./start-infrastructure

Ce script lance une machine virtuelle, puis une instance Firefox. Cette instance Firefox permet d’accèder aux services web hebergés par la machine virtuelle (via un proxy SOCKS).

Une fois la machine virtuelle démarrée, il est possible de s’authentifier avec le compte root et un mot de passe vide.

Les services suivant sont accessibles directement depuis la machine hôte:

Note: La machine virtuelle ne démarre pas si les ports 3000, 9090, 9100 de la machine hôte sont utilisés.

Tester un changement ou une Merge Request

Des tests NixOS sont disponibles pour valider certaines fonctionnalités du serveur. Pour jouer ces tests:

nix-build -A tests

La documentation explique également comment jouer ces tests intéractivement.

Soumettre une modification du serveur

Le serveur applique toute les minutes la configuration définie dans la branche master de ce dépôt. Pour appliquer une modification, il faut donc soumettre une Merge Request (MR) à destination de la branche master. Une fois que cette MR est mergée, le serveur se met à jour une minute plus tard.

Lorsque ce dépôt est récupéré, la signature du commit HEAD est vérifiée avec les clés publiques contenues dans le répertoire ./keys. La configuration est alors uniquement déployée si la signature est valide. Cela permet de s’assurer qu’un attaquant ne puisse pas compromettre le dépôt de configuration.

Contribuer à la documentation

La documentation se trouve dans ./docs, est écrite en Markdown ou ReST et rendu par Sphinx. Pour générer le site statique:

nix-build -A documentation
firefox ./result/index.html

Il suffit ensuite modifier un fichier et relancer cette commande. Une Merge Request peut ensuite être créée avec les modifications.

Langue utilisée

Les utilisateurs de Markas étant français, nous privilégions cette langue afin de permettre à nos utilisateurs de suivre ce projet. Nous utilisons cependant une miriade de projets open source dans lesquels la langue utilisée est l’anglais. Parce que nous souhaitons reverser autant que possible notre code à ces communautés, il est préférable d’écrire ce code en anglais.

Nous faisons donc le compromis suivant: tout ce qui n’est pas partageable est prioritairement en français; ce qui est partageable est prioritairement en anglais mais toute contribution en français est la bienvenue.

Concrètement, est prioritairement en français:

  • la documentation

  • les README

  • les message de commits

  • les tickets

  • les documents internes

Nous privilégions l’anglais uniquement pour le code et ses commentaires. Le français reste néanmoins possible afin de ne restreindre aucun contributeur.