> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 5. Personnaliser votre instance

### 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 :

| Fichier | Lu par | À définir ici |
| - | - | - |
| `config/overleaf.rc` | les scripts du Toolkit, comme `bin/up` | l'exécution des conteneurs : `OVERLEAF_LISTEN_IP`, `OVERLEAF_PORT`, `SERVER_PRO`, chemins des données |
| `config/variables.env` | l'application dans le conteneur | le comportement d'Overleaf : `OVERLEAF_SITE_URL`, e-mail, images TeX Live |

**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` :

```bash title="config/overleaf.rc" theme={null}
OVERLEAF_LISTEN_IP=0.0.0.0
OVERLEAF_PORT=8080
```

`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 :

| Configuration | `OVERLEAF_LISTEN_IP` | `OVERLEAF_PORT` | Adresse dans le navigateur |
| - | - | - | - |
| Uniquement sur cette machine (par défaut) | `127.0.0.1` | `80` | `http://localhost` |
| D'autres ordinateurs du réseau local ou d'Internet se connectent directement | `0.0.0.0`, ou une IP du serveur | `80`, ou tout port libre | `http://<server-ip>:<port>` |
| Derrière votre propre reverse proxy (NGINX, Caddy, Cloudflare Tunnel) sur le même hôte | `127.0.0.1` | tout port libre | l'URL du proxy |
| Derrière le [proxy TLS](https://ayakaleaf-pro.mintlify.site/fr/on-premises/configuration/overleaf-toolkit/tls-proxy.md) du Toolkit | `127.0.0.1` | `80` | `https://<your-domain>` |

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`.

> [!WARNING]
>
> Les ports publiés par Docker contournent les pare-feu de l'hôte tels que `ufw` et `firewalld`. Avec `0.0.0.0`, l'instance est accessible depuis tous les réseaux auxquels le serveur est connecté. Sur un serveur cloud, vous devez également autoriser le port dans le groupe de sécurité du fournisseur. Utilisez HTTPS avant d'exposer l'instance à Internet, voir [Proxy TLS](https://ayakaleaf-pro.mintlify.site/fr/on-premises/configuration/overleaf-toolkit/tls-proxy.md).

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` :

| 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. | `no-reply@lilliput.com` |
| `OVERLEAF_ADMIN_EMAIL` | L'adresse e-mail à laquelle les utilisateurs peuvent joindre la personne qui gère le site. | `it-services@lilliput.com` |

`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](https://ayakaleaf-pro.mintlify.site/fr/on-premises/configuration/overleaf-toolkit/authentication/public-access.md).

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](https://ayakaleaf-pro.mintlify.site/fr/on-premises/configuration/overleaf-toolkit/environment-variables.md).

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](https://ayakaleaf-pro.mintlify.site/fr/on-premises/configuration/overleaf-toolkit/sandboxed-compiles.md "mention"). Ouvrez `config/variables.env` et mettez à jour les variables d'environnement suivantes :

```dotenv title="config/variables.env" wrap theme={null}
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
```

**5. Démarrer votre instance**

Pour démarrer votre instance, exécutez :

```text title="Start the instance" theme={null}
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 :

```text title="Start without attaching to logs" theme={null}
bin/start
```

> [!NOTE]
>
> 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/](http://127.0.0.1/) ou [http://localhost/](http://localhost/) dans votre navigateur. Si vous avez modifié `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 :

```text title="Show the published port" theme={null}
bin/docker-compose port sharelatex 80
```

La sortie, par exemple `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.

> [!WARNING]
>
> 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](https://ayakaleaf-pro.mintlify.site/fr/on-premises/configuration/overleaf-toolkit/toolkit-settings.md "mention")


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.