5. Personnaliser votre instance

​

Personnaliser votre instance

Avant de démarrer votre instance Overleaf pour la première fois, mettez à jour le fichier de configuration config/variables.env avec vos informations personnalisées.

1. Modifier le fichier de variables

   Ouvrez config/variables.env dans votre éditeur de texte préféré et renseignez les variables d’environnement ci-dessous avec les valeurs requises.

2. Variables d'environnement requises

   Mettez à jour les variables suivantes dans config/variables.env :

   Nom	Description	Exemple
   OVERLEAF_SITE_URL	L’adresse publique de votre instance Overleaf. Elle est utilisée dans les liens publics et lors des connexions websocket : elle doit donc être configurée correctement !	https://overleaf.lilliput.com
   OVERLEAF_EMAIL_FROM_ADDRESS	Cette adresse e-mail sera utilisée comme adresse d’expéditeur (from) pour tous les e-mails sortants.	[e-mail]
   OVERLEAF_ADMIN_EMAIL	L’adresse e-mail à laquelle les utilisateurs peuvent joindre la personne qui gère le site.	[e-mail]

   Une fois ces variables d’environnement mises à jour, enregistrez et quittez.

3. Configurer la compilation en sandbox

   Configurez ensuite TeX Live Full pour les sandboxed-compiles.md. Ouvrez config/variables.env et mettez à jour les variables d’environnement suivantes :

   config/variables.env

   ALL_TEX_LIVE_DOCKER_IMAGES=ghcr.io/ayaka-notes/texlive-full:2026.1, ghcr.io/ayaka-notes/texlive-full:2025.1
   ALL_TEX_LIVE_DOCKER_IMAGE_NAMES=Texlive 2026, Texlive 2025
   TEX_LIVE_DOCKER_IMAGE=ghcr.io/ayaka-notes/texlive-full:2026.1
   
4. Démarrer votre instance

   Pour démarrer votre instance, exécutez :

   Start the instance

   bin/up
   

   Cette commande télécharge les images nécessaires, y compris TeX Live, crée les conteneurs (avec vos personnalisations) et démarre l’instance. Vous devriez voir s’afficher les journaux des différents conteneurs Docker.

   Pour les redémarrer plus tard (sans vous attacher à la sortie des journaux), exécutez :

   Start without attaching to logs

   bin/start
   

Le Toolkit utilise docker compose pour gérer les conteneurs Docker d’Overleaf. Il fournit un ensemble de scripts qui encapsulent docker compose et gèrent la plupart des détails à votre place.

Si tout se passe bien, vous devriez voir la page de connexion de votre nouvelle instance Overleaf en ouvrant http://127.0.0.1/ ou http://localhost/ dans votre navigateur.

Selon votre configuration réseau et l’endroit où votre instance Overleaf est hébergée, des modifications de configuration supplémentaires peuvent être nécessaires. Consultez les paramètres du Toolkit pour plus de détails : toolkit-settings.md