Personnaliser votre instance
Avant de démarrer votre instance Overleaf pour la première fois, mettez à jour deux fichiers de configuration 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
Adresse et port d'écoute
Par défaut, le Toolkit publie l’interface web sur
127.0.0.1:80 : elle ne peut donc être ouverte que depuis un navigateur sur le serveur lui-même. Les autres ordinateurs obtiennent une erreur « connection refused » ou « server not found ». Pour modifier cela, éditez config/overleaf.rc :config/overleaf.rc
OVERLEAF_LISTEN_IP est l’adresse IP de l’hôte à laquelle le conteneur se lie, et OVERLEAF_PORT est le port de l’hôte. Ensemble, ils forment la correspondance de ports Docker OVERLEAF_LISTEN_IP:OVERLEAF_PORT:80. Choisissez les valeurs adaptées à votre configuration :Si le port
80 est déjà utilisé sur l’hôte, par exemple par un autre serveur web, définissez OVERLEAF_PORT sur un port libre comme 8080. Sinon, bin/up échoue avec bind: address already in use.Vous pouvez commencer avec la valeur par défaut et ouvrir d’abord l’instance sur localhost. Pour autoriser ultérieurement l’accès depuis d’autres ordinateurs, modifiez ces deux variables dans config/overleaf.rc ainsi que OVERLEAF_SITE_URL dans config/variables.env, puis exécutez à nouveau bin/up pour recréer les conteneurs.3
Variables d'environnement requises
Mettez à jour les variables suivantes dans
config/variables.env :OVERLEAF_SITE_URL est l’adresse que les utilisateurs saisissent dans leur navigateur, et non l’adresse d’écoute. Incluez le port lorsqu’il ne s’agit pas de 80 (HTTP) ou 443 (HTTPS), par exemple http://192.168.1.20:8080. N’utilisez pas http://0.0.0.0. Si OVERLEAF_SITE_URL ne correspond pas à l’adresse affichée dans le navigateur, l’éditeur ne parvient pas à se connecter, et les liens des e-mails ainsi que les callbacks OAuth pointent au mauvais endroit.Sans serveur de messagerie, laissez OVERLEAF_EMAIL_FROM_ADDRESS non défini : Overleaf n’envoie alors aucun e-mail, et vous pouvez transmettre vous-même leur lien d’activation aux nouveaux utilisateurs, voir les questions/réponses dans Accès public.Définissez également OVERLEAF_SESSION_SECRET sur une valeur générée avec openssl rand -hex 32. Sans elle, chaque bin/up qui recrée le conteneur, ainsi que chaque mise à niveau, déconnecte tous les utilisateurs. Voir les questions/réponses dans Variables d’environnement.Une fois ces variables d’environnement mises à jour, enregistrez et quittez.4
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
5
Démarrer votre instance
Pour démarrer votre instance, exécutez :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 the instance
Start without attaching to logs
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.OVERLEAF_LISTEN_IP ou OVERLEAF_PORT, ouvrez plutôt l’adresse indiquée dans le tableau de l’étape Adresse et port d’écoute, par exemple http://<server-ip>:8080.
Pour vérifier sur quelle adresse et quel port l’interface web est publiée, exécutez :
Show the published port
0.0.0.0:8080, indique l’adresse IP et le port de l’hôte utilisés. Si elle affiche 127.0.0.1, l’instance n’est accessible que depuis le serveur lui-même.