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.

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.

Pour gérer vos GitHub Codespaces, rendez-vous sur https://github.com/codespaces. Lorsque vous n’en avez plus besoin, pensez à supprimer votre Codespace rapidement.

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

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

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

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 pour savoir comment configurer ces fonctionnalités dans votre propre déploiement.

1. 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, nous vous recommandons une configuration à 8 cœurs et 64 Go.

   

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

   ./init.sh
   

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

   
3. Rendre le port 80 accessible

   Passez à l’onglet Ports, puis suivez ces étapes pour rendre le port 80 public.

   

   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.

4. Créer votre compte administrateur

   Saisissez l’identifiant et le mot de passe de votre compte administrateur, puis cliquez sur le bouton Register.

   
5. Place à la rédaction

   Il ne vous reste plus qu’à profiter de la rédaction en $\LaTeX$ !

   

​

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.

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.

cd toolkit && bin/up -d