Étude de cas technique

Transformer le Toolkit Overleaf en service Coolify

Le retour d’expérience complet du déploiement Overleaf Community Edition 6.2.2 sur Coolify, du premier diagnostic à la reprise.

Contexte

Transformer le Toolkit Overleaf en service Coolify examine une difficulté propre à cette architecture. La composition réunit l’application Overleaf, un bootstrap administrateur, MongoDB et Redis. Les nombreux processus internes du produit restent supervisés dans l’image et ne deviennent pas artificiellement des services Compose. Le Toolkit amont orchestre un hôte ; son vocabulaire ne peut donc pas être copié tel quel dans Coolify sans distinguer runtime et orchestration. L’objectif était de conserver le contrat du produit tout en confiant à Coolify le déploiement, les domaines et le renouvellement des conteneurs.

Pourquoi cette solution

Overleaf Community Edition est une solution de rédaction collaborative de documents latex adaptée à des usages structurés et à un hébergement maîtrisé. Le choix d’un logiciel existant permet de concentrer l’ingénierie sur l’adaptation, la gouvernance et l’exploitation plutôt que de recréer son cœur fonctionnel.

Architecture amont

L’architecture du produit distingue interface, logique métier, traitements différés et états persistants. Cette carte des responsabilités a servi de référence avant toute modification liée à Coolify. Overleaf Community Edition offre un environnement partagé pour écrire, compiler et organiser des projets LaTeX.

Contraintes du déploiement

Le Toolkit joue un rôle d’orchestrateur hôte. Reprendre ses noms de services et ses substitutions sans les traduire a introduit des collisions avec la configuration interne et des erreurs dans le script d’administrateur.

Coolify ajoute son propre proxy, sa gestion des domaines, ses variables magiques, ses fichiers gérés et son cycle de redéploiement. Chaque adaptation devait donc être analysée à la frontière entre la plateforme et le logiciel. Il convient à un groupe de confiance qui accepte les limites de l’édition communautaire et dispose des compétences pour administrer les compilateurs.

Diagnostic

Le diagnostic a suivi les couches dans l’ordre : validation de la composition, création des services, santé des magasins d’état, fin des tâches d’initialisation, réponse du service public, authentification et parcours fonctionnel. Cette méthode évite de confondre un problème de réseau avec une migration inachevée ou un secret incohérent. L’organisation doit encadrer les comptes, les modèles, les pièces jointes et l’exécution de documents non fiables.

Les journaux ont été lus par responsabilité. Un échec de la passerelle ne signifie pas nécessairement que la base est en cause ; un conteneur actif ne garantit pas qu’un worker consomme une vraie tâche. Les contrôles ont donc porté sur les effets observables de chaque service. La composition réunit l’application Overleaf, un bootstrap administrateur, MongoDB et Redis.

Corrections et architecture finale

La composition finale sépare les responsabilités du Toolkit de celles du runtime, conserve les processus internes dans l’image Overleaf et automatise l’administrateur avec une syntaxe compatible avec les différents interpréteurs.

La correction retenue est la plus petite modification capable de rétablir le contrat du produit. Les services dont l’utilité était démontrée ont été conservés ; les composants ajoutés uniquement par habitude ont été écartés. Les nombreux processus internes du produit restent supervisés dans l’image et ne deviennent pas artificiellement des services Compose.

Validation

Administration, création de projet, compilation latex en pdf, édition, téléversement, temps réel, redémarrage, redéploiement, sauvegarde et restauration isolée.

Le parcours part d’une ressource neuve et se termine par un redéploiement avec conservation des données. Lorsqu’une sauvegarde et une restauration sont prévues, la vérification se fait dans des volumes isolés et revient à l’interface pour contrôler un objet métier connu. Le Toolkit amont orchestre un hôte ; son vocabulaire ne peut donc pas être copié tel quel dans Coolify sans distinguer runtime et orchestration.

Persistance et reprise

MongoDB, Redis, projets et configuration stable forment un point de reprise cohérent.

Les volumes sont classés selon leur rôle : état autoritatif, fichier métier, file durable, cache reconstructible ou journal opérationnel. Cette classification détermine l’ordre de sauvegarde, l’ordre de restauration et les tests nécessaires avant remise en service. Une première adaptation avait transformé le nom de service en configuration applicative et cassé le routage interne.

Leçons d’ingénierie

Une adaptation fiable commence par comprendre le logiciel, pas par compter les conteneurs. La complexité utile provient des responsabilités réelles : base, recherche, files, tâches, temps réel, passerelle ou stockage. La plateforme doit simplifier leur exploitation sans modifier silencieusement leur contrat. Le bootstrap administrateur traversait aussi Compose, le shell et JavaScript, chacun interprétant les signes dollar.

Les domaines publics, les URL canoniques et les cibles internes doivent rester distincts. Les secrets partagés utilisent une identité stable. Les migrations ont un seul propriétaire. Les contrôles de santé observent la fonction du service et la reprise porte sur tous les états qui rendent l’application utilisable. La correction a choisi une identité de service neutre et une échappée propre à chaque couche, puis validé projet, compilation PDF, téléversement et édition temps réel.

Réutilisation

Le modèle Docker Compose et le guide de déploiement associés permettent de reproduire l’architecture. Pour une nouvelle version, le travail reprend par la lecture des changements amont, une sauvegarde restaurable et un environnement isolé. Le même parcours fonctionnel sert ensuite de test de non-régression. Le modèle protège ensemble MongoDB, Redis et le répertoire des projets.

Passage en exploitation

Le passage en exploitation réunit le responsable fonctionnel, l’administrateur de l’application et l’équipe infrastructure. Ensemble, ils confirment les comptes, les droits, le courrier sortant, les domaines, les sauvegardes, la supervision et la procédure d’assistance. Les utilisateurs disposent d’un point d’entrée unique et d’instructions adaptées à leur rôle. Redis participe ici à l’état de collaboration et ne doit pas être classé automatiquement comme cache jetable.

Une fenêtre de maintenance est définie pour les mises à jour. Les changements de version sont d’abord reproduits sur une copie isolée, puis le parcours critique est rejoué. Les observations sont consignées dans une procédure courte afin que le service ne dépende pas d’une mémoire individuelle. Le domaine canonique et les en-têtes de proxy sont transmis à l’application.

Ce que cette expérience change dans la méthode

Cette étude renforce une règle simple : l’architecture doit être expliquée par les responsabilités qu’elle remplit. Chaque service, volume, variable et contrôle de santé répond à une fonction identifiable. Lorsqu’une modification ne peut pas être reliée à cette carte, elle mérite d’être remise en question. Toute montée de version commence par une copie cohérente de ces magasins et une compilation sur l’environnement restauré.

La validation doit ensuite suivre la même logique. Elle commence par l’infrastructure, traverse le produit et revient jusqu’à la décision de l’utilisateur. La restauration referme la boucle en montrant que l’organisation peut récupérer son service et ses données après un incident. Overleaf Community Edition offre un environnement partagé pour écrire, compiler et organiser des projets LaTeX.

Chronologie de résolution

Chaque itération a été traitée comme une hypothèse à vérifier. Une composition valide était d’abord déployée sur une ressource neuve. L’équipe observait ensuite le premier service qui ne remplissait pas sa responsabilité, corrigeait la cause la plus proche et rejouait le parcours depuis le début. Cette chronologie a empêché l’accumulation de modifications sans relation avec le problème. Il convient à un groupe de confiance qui accepte les limites de l’édition communautaire et dispose des compétences pour administrer les compilateurs.

Les corrections ont été comparées avec l’architecture attendue et avec les effets visibles dans l’application. Lorsqu’un changement améliorait le démarrage mais cassait une fonction, il était rejeté. L’architecture finale conserve ainsi les choix qui satisfont ensemble installation, usage, persistance et reprise. L’organisation doit encadrer les comptes, les modèles, les pièces jointes et l’exécution de documents non fiables.

Décisions structurantes

Trois décisions reviennent dans le cas : choisir le bon service public, attribuer clairement l’initialisation et protéger tout l’état autoritatif. Elles conditionnent le domaine, les contrôles de santé, les dépendances et la stratégie de sauvegarde. Leur formulation explicite facilite le passage de relais vers l’équipe d’exploitation. La composition réunit l’application Overleaf, un bootstrap administrateur, MongoDB et Redis.

Contrôles après déploiement

Après la mise en service, les contrôles sont rejoués à intervalles réguliers : connexion, création ou modification d’un objet, traitement différé, redéploiement et lecture des données. Un exercice de restauration planifié vérifie que les sauvegardes restent compatibles avec la version courante et que l’équipe sait reconstruire le service. Les nombreux processus internes du produit restent supervisés dans l’image et ne deviennent pas artificiellement des services Compose.

Le basculement décisif

Une première adaptation avait transformé le nom de service en configuration applicative et cassé le routage interne. Le bootstrap administrateur traversait aussi Compose, le shell et JavaScript, chacun interprétant les signes dollar. La correction a choisi une identité de service neutre et une échappée propre à chaque couche, puis validé projet, compilation PDF, téléversement et édition temps réel.