Contribuer¶
Les sources de ce site sont dans le repo fulgurmotors/docs, accessible aux membres de l'organisation.
Modifier une page¶
- Cliquer sur l'icône en haut à droite de la page : elle s'ouvre dans l'éditeur de GitHub.
- Écrire en Markdown, puis Commit changes sur
main. - Le site est mis à jour dans les 5 minutes.
Pour une nouvelle page : créer le fichier dans docs/guides/ et l'ajouter dans la section nav: de mkdocs.yml.
Ce qu'on peut écrire ici¶
Ce site est public
N'importe qui sur Internet peut le lire. On n'y met que des procédures génériques, avec des exemples comme <CTID>, <domaine>, 10.0.0.<XX>.
| Ici (public) | Dans le repo privé de l'infra |
|---|---|
| Comment créer une CT | Quelles CT existent, leur état |
| Comment publier un site | Quels sites sont publiés, leurs failles |
| Les pièges rencontrés | Les problèmes non résolus |
| Où ranger un secret, en général | Où est rangé tel secret précis |
Le test : si un inconnu lit la page, est-ce que ça l'aide à attaquer le serveur ? Si oui, elle va dans le repo privé.
Le garde-fou¶
Avant chaque publication, garde-fou.py cherche dans les pages : clés privées, tokens, mots de passe écrits en clair, IP publiques ou Tailscale, adresses e-mail. S'il trouve quelque chose, le site n'est pas mis à jour et l'ancienne version reste en ligne. Même chose si la construction échoue (lien cassé, page absente de la navigation).
Si ta modification n'apparaît pas au bout de 5 minutes, c'est probablement ça. Pour vérifier en local avant de pousser :
pip install -r requirements.txt
python garde-fou.py
mkdocs serve # aperçu sur http://127.0.0.1:8000
En cas de faux positif, ajouter <!-- garde-fou: ignorer --> à la fin de la ligne concernée.