Déploiement et exploitation

GitHub App et interrupteurs

101Maintain lit et écrit sur GitHub par une GitHub App dédiée. Chaque fonction qui agit à l'extérieur est désactivée par défaut et s'active par une variable. Cette page décrit la préparation de l'App, puis chaque interrupteur.

Qui peut le faire : l'exploitant, avec un propriétaire de l'organisation GitHub pour installer l'App et accepter ses permissions.

Créer la GitHub App#

  1. Créez une GitHub App dédiée à l'instance, dans l'organisation GitHub concernée.
  2. Webhook : activez-le, URL https://maintenance.maintain.example/webhooks/github, secret aléatoire.
  3. Abonnez l'App aux événements Issues.
  4. Accordez les permissions du tableau ci-dessous, selon les fonctions voulues.
  5. Générez une clé privée.
  6. Saisissez dans la ressource Coolify, en secrets : MVP_GITHUB_APP_ID, MVP_GITHUB_APP_PRIVATE_KEY (multiligne) et MVP_GITHUB_WEBHOOK_SECRET (le secret du webhook).
  7. Installez l'App sur les seuls dépôts à maintenir. Le lien d'installation a la forme https://github.com/apps/<slug>/installations/new. L'interface le propose quand l'App manque.

Le webhook vérifie la signature avant de lire le contenu. Il refuse les corps de plus de 256 Kio et les événements non pris en charge. La désinstallation de l'App, sa suspension ou le retrait d'un dépôt de l'installation désactivent les rattachements concernés.

Côté utilisateurs, le rattachement d'un dépôt se fait ensuite avec Vérifier et rattacher : voir Lier le dépôt à la GitHub App.

Permissions de la GitHub App#

PermissionNiveauSert àNécessaire pour
MetadataLectureLister et identifier les dépôts installésToujours (acquise par toute App)
IssuesLectureRecevoir et vérifier les issuesToujours
IssuesÉcritureOuvrir une issue depuis un constat d'auditMVP_AUDIT_ISSUES_ENABLED
ContentsLectureLecture du code par les agents et par les auditsMVP_AGENT_MODE=live, MVP_REPOSITORY_AUDITS_ENABLED
ContentsÉcritureCréer la branche de travail et ses commitsMVP_GITHUB_PUBLICATION_ENABLED
Pull requestsÉcritureOuvrir la PR brouillon, demander la revue, suivre la PRMVP_GITHUB_PUBLICATION_ENABLED
ChecksLectureAfficher le résultat de la CI dans le suiviFacultatif : sans elle, la CI s'affiche comme inconnue
Dependabot alertsLectureContrôle des dépendances dans un auditFacultatif
Members (organisation)LectureProposer les membres comme responsable GitHubFacultatif : sans elle, saisie manuelle du login

L'App ne fusionne jamais une PR, ne déclenche aucun déploiement et ne modifie aucune protection de branche.

Interrupteurs de fonctionnalités#

Les variables sont transmises au web et au worker. Après tout changement, redéployez la ressource.

VariableActivePrérequis
MVP_AGENT_MODE=liveLes exécutions de maintenance (cinq agents). Avec off, les demandes restent en attente.MVP_LANGDOCK_API_KEY, MVP_LANGDOCK_MODEL, App avec Contents et Issues en lecture.
MVP_PUBLICATION_NOTICES_ENABLED=trueLes notifications avant publication.Messagerie configurée ou webhook d'équipe (voir ci-dessous). Destinataire réglé sur chaque dépôt.
MVP_GITHUB_PUBLICATION_ENABLED=trueLes écritures GitHub : branche, PR brouillon, demande de revue, questions.Contents et Pull requests en écriture. Notifications actives.
MVP_REPOSITORY_AUDITS_ENABLED=trueLes audits de dépôt. Sans elle, la demande répond 503 repository_audits_disabled.Contents en lecture.
MVP_AUDIT_ISSUES_ENABLED=trueL'ouverture d'issues depuis les constats.Audits activés, Issues en écriture.
ACTIVE_TESTS_ENABLED=trueLes accords de recette et les contrôles dynamiques.Profil scanner.
MVP_BENCHMARK_MODELe banc d'essai : simulated (aucun fournisseur) ou live.Profil benchmark.

Les fonctions côté utilisateur sont décrites aux chapitres Maintenance assistée et Audits et banc d'essai.

Canal de notification#

  • E-mail : utilise la messagerie de l'instance. Voir Messagerie et codes de sécurité.
  • Webhook d'équipe : MVP_NOTICE_WEBHOOK_URL (HTTPS approuvée) et MVP_NOTICE_WEBHOOK_SECRET (32 octets au moins). Le corps JSON est signé en HMAC SHA-256. Le canal ne doit répondre 2xx que s'il accepte la prise en charge.
  • Rebonds Resend : enregistrez https://maintenance.maintain.example/webhooks/resend/publication chez Resend, pour les événements email.bounced, email.failed et email.suppressed, et renseignez MVP_RESEND_BOUNCE_SECRET.

Tarifs du modèle#

MVP_LANGDOCK_RATES contient les tarifs contractuels, par million de jetons, en chaînes décimales. Exemple fictif :

json
[
  {
    "model": "modele-exemple",
    "currency": "EUR",
    "input": "2.00",
    "cachedInput": "0.50",
    "output": "4.00",
    "effectiveFrom": "2026-01-01",
    "source": "Contrat exemple"
  }
]

Le nom du modèle doit correspondre exactement à MVP_LANGDOCK_MODEL. Sans tarif applicable, le coût reste inconnu. Voir Comprendre la consommation.

Profils scanner et benchmark#

Profil scanner#

Le scanner effectue les contrôles dynamiques d'une recette autorisée. Il est isolé : seul le worker peut lui parler, et ses sorties passent par un proxy qui refuse les adresses internes.

  1. Générez une paire TLS pour le proxy, dans un dossier de l'hôte lisible par l'UID 1000 :
bash
openssl req -x509 -newkey rsa:2048 -nodes -days 825 -subj /CN=scanner-egress -keyout egress-key.pem -out egress-cert.pem -addext subjectAltName=DNS:scanner-egress
  1. Renseignez SCANNER_EGRESS_TLS_DIR avec ce dossier.
  2. Générez trois secrets distincts : SCANNER_TOKEN, SCANNER_EGRESS_TOKEN, ZAP_API_KEY.
  3. Renseignez MVP_SCANNER_URL=http://scanner:8080 et ACTIVE_TESTS_ENABLED=true.
  4. Ajoutez scanner à COMPOSE_PROFILES, puis redéployez.

Les conteneurs du scanner refusent de démarrer sans leurs secrets.

Profil benchmark#

  1. Placez sur l'hôte une copie de confiance du dossier bench/ du dépôt, lisible par l'UID 1000.
  2. Renseignez BENCHMARK_FIXTURES_DIR avec ce dossier et MVP_BENCHMARK_MODE (simulated ou live).
  3. Ajoutez benchmark à COMPOSE_PROFILES, puis redéployez.

Pour continuer#

Surveillez l'instance avec Santé, métriques et alertes.