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

# Utiliser GitHub Codespace

Le moyen le plus simple de tester Ayakaleaf Pro est d'utiliser GitHub Codespace : toutes les variables d'environnement y sont préconfigurées pour que vous puissiez l'utiliser immédiatement.

<Warning>
  Lorsque vous exécutez des conteneurs Docker avec GitHub Codespaces, le Codespace ne s'arrête pas automatiquement et continue d'être **facturé**. Pour connaître les règles de facturation de GitHub Codespaces, consultez les [règles de facturation de GitHub Codespaces](https://docs.github.com/en/billing/concepts/product-billing/github-codespaces).

  Pour gérer vos GitHub Codespaces, rendez-vous sur [https://github.com/codespaces](https://github.com/codespaces). Lorsque vous n'en avez plus besoin, pensez à supprimer votre Codespace rapidement.
</Warning>

Nous avons **préconfiguré** les fonctionnalités suivantes :

* [x] Compilation LaTeX en bac à sable avec TeX Live **Basic** (2024-2026)
* [x] Import/export Pandoc (fonctionnalité de la plateforme SaaS)
* [x] Exécution de scripts Python (fonctionnalité de la plateforme SaaS)
* [x] Prise en charge de Git-Bridge (fonctionnalité de Server Pro)
* [x] Recherche avancée de références (fonctionnalité de la plateforme SaaS)
* [x] Panneau d'administration (gestion globale des utilisateurs et des projets)
* [x] Suivi des modifications (avec panneau de relecture et de commentaires)
* [x] Historique complet du projet (avec restauration et téléchargement)
* [x] Palette de symboles (fonctionnalité de Server Pro et de la plateforme SaaS)

<Warning>
  Les GitHub Codespaces standard offrent 32 Go de stockage, ce qui est insuffisant pour notre installation `texlive-full`. Pour tester l'image complète, ouvrez un ticket auprès du support GitHub afin d'obtenir un Codespace avec des runners plus puissants (8 cœurs ou plus).
</Warning>

La synchronisation GitHub, LDAP, OAuth, le SSO, l'intégration Zotero et d'autres fonctionnalités ne sont ***pas configurés*** dans cet environnement de test. Consultez les [paramètres du Toolkit](/fr/on-premises/configuration/overleaf-toolkit/toolkit-settings) pour savoir comment configurer ces fonctionnalités dans votre propre déploiement.

<Steps>
  <Step title="Créer votre GitHub Codespace">
    Cliquez sur le bouton suivant pour créer votre GitHub Codespace. Côté configuration du serveur, **2 cœurs et 8 Go de RAM** suffisent généralement pour un test. Si vous prévoyez d'utiliser [**TeX Live Full**](https://github.com/ayaka-notes/texlive-full), nous vous recommandons une configuration à **8 cœurs et 64 Go**.

    [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/ayaka-notes/ayakaleaf-pro-playground)
  </Step>

  <Step title="Initialiser l'instance Overleaf">
    Une fois votre Codespace prêt, exécutez la commande suivante dans votre terminal bash pour initialiser votre instance Overleaf.

    ```bash title="bash" theme={null}
    ./init.sh
    ```

    <Info>
      Il vous faudra peut-être patienter au moins 3 minutes, le temps de télécharger toutes les images Docker nécessaires.
    </Info>

    <Frame>
      <img src="https://mintcdn.com/ayakaleaf-pro/x9kfDjtWlyyhG_mR/images/on-premises/image-26.png?fit=max&auto=format&n=x9kfDjtWlyyhG_mR&q=85&s=8566b61de0757c1b270e7e5011d48a3e" alt="" width="1181" height="626" data-path="images/on-premises/image-26.png" />
    </Frame>
  </Step>

  <Step title="Rendre le port 80 accessible">
    Passez à l'onglet **Ports**, puis suivez ces étapes pour rendre le port 80 public.

    <Frame>
      <img src="https://mintcdn.com/ayakaleaf-pro/GmaXa-Cu4QQRFT4C/images/on-premises/img-db37d3e4.png?fit=max&auto=format&n=GmaXa-Cu4QQRFT4C&q=85&s=81e5a18f3aebbd396a57d163a2460739" alt="" width="1452" height="694" data-path="images/on-premises/img-db37d3e4.png" />
    </Frame>

    Vous pouvez ensuite cliquer sur **Forwarded Address** pour accéder à votre instance Overleaf. Il vous faudra peut-être ajouter `/launchpad` pour accéder à la page d'accueil d'Overleaf.
  </Step>

  <Step title="Créer votre compte administrateur">
    Saisissez l'identifiant et le mot de passe de votre compte administrateur, puis cliquez sur le bouton Register.

    <Frame>
      <img src="https://mintcdn.com/ayakaleaf-pro/x9kfDjtWlyyhG_mR/images/on-premises/img-1ae40ae0.png?fit=max&auto=format&n=x9kfDjtWlyyhG_mR&q=85&s=82d769561891fd4b4566ee2ad9c48065" alt="" width="2736" height="1798" data-path="images/on-premises/img-1ae40ae0.png" />
    </Frame>
  </Step>

  <Step title="Place à la rédaction">
    Il ne vous reste plus qu'à profiter de la rédaction en $\LaTeX$ !

    <Frame>
      <img src="https://mintcdn.com/ayakaleaf-pro/x9kfDjtWlyyhG_mR/images/on-premises/image-25.png?fit=max&auto=format&n=x9kfDjtWlyyhG_mR&q=85&s=1d4e1fac863cbee906d9d3ad2f3c08d7" alt="" width="2104" height="1415" data-path="images/on-premises/image-25.png" />
    </Frame>
  </Step>
</Steps>

#### Utiliser l'image TeX Live Full

Si vous avez accès à des GitHub Codespaces de 8 cœurs et 64 Go, vous pouvez utiliser l'image TeX Live Full dans cet environnement de test. Modifiez les variables d'environnement suivantes dans le fichier `toolkit/config/variables.env` pour utiliser l'image TeX Live Full à la place de l'image TeX Live Basic.

```dotenv wrap theme={null}
ALL_TEX_LIVE_DOCKER_IMAGES=ghcr.io/ayaka-notes/texlive-full:2026.1, ghcr.io/ayaka-notes/texlive-full:2025.1, ghcr.io/ayaka-notes/texlive-full:2024.1
ALL_TEX_LIVE_DOCKER_IMAGE_NAMES=Texlive 2026, Texlive 2025, Texlive 2024
TEX_LIVE_DOCKER_IMAGE=ghcr.io/ayaka-notes/texlive-full:2026.1
```

Après avoir modifié les variables d'environnement, vous devez redémarrer le Toolkit pour appliquer les changements. Exécutez la commande suivante pour redémarrer le Toolkit.

```bash theme={null}
cd toolkit && bin/up -d
```


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