GitHub Codespace gebruiken

De eenvoudigste manier om Ayakaleaf Pro te testen is via GitHub Codespace, waar alle omgevingsvariabelen vooraf zijn geconfigureerd, zodat je het direct kunt gebruiken.

Wanneer je Docker-containers draait met GitHub Codespaces, wordt de Codespace niet automatisch afgesloten en blijven er kosten in rekening worden gebracht. Raadpleeg voor de factureringsregels van GitHub Codespaces de factureringsregels van GitHub Codespaces.

Ga naar https://github.com/codespaces om je GitHub Codespaces te beheren. Verwijder je Codespace tijdig wanneer je deze niet meer nodig hebt.

We hebben de volgende functies vooraf geconfigureerd:

• LaTeX-compilatie in een sandbox met TeXLive Basic (2024-2026)
• Pandoc-import/-export (functie van het SaaS-platform)
• Python-scripts uitvoeren (functie van het SaaS-platform)
• Ondersteuning voor Git-Bridge (functie van Server Pro)
• Geavanceerd zoeken naar referenties (functie van het SaaS-platform)
• Beheerpaneel (globaal beheer van gebruikers/projecten)
• Wijzigingen bijhouden (met review- en opmerkingenpaneel)
• Volledige projectgeschiedenis (met herstellen en downloaden)
• Symbolenpalet (functie van Server Pro/SaaS-platform)

Standaard GitHub Codespaces bieden 32 GB opslag. Dat is onvoldoende voor onze texlive-full-installatie. Om de volledige image te testen, dien je een supportticket bij GitHub in voor een Codespace met grote runners (8+ cores).

GitHub Sync, LDAP, OAuth, SSO, Zotero-integratie en andere functies zijn in deze playground niet geconfigureerd. Raadpleeg de Toolkit-instellingen voor meer informatie over het configureren van deze functies in je eigen implementatie.

1. Je GitHub Codespace aanmaken

   Klik op de volgende knop om je GitHub Codespace aan te maken. Wat de serverconfiguratie betreft, volstaan 2 cores met 8 GB RAM doorgaans voor een test. Als je van plan bent TeX Live Full te gebruiken, raden we een configuratie met 8 cores en 64 GB aan.

   

2. De Overleaf-instantie initialiseren

   Wanneer je Codespace klaar is, voer je de volgende opdracht uit in je bash om je Overleaf-instantie te initialiseren.

   bash

   ./init.sh
   

   Je moet mogelijk minstens 3 minuten wachten totdat alle benodigde Docker-images zijn opgehaald.

   
3. Poort 80 beschikbaar maken

   Ga naar het tabblad Ports en volg deze stappen om poort 80 openbaar te maken.

   

   Daarna kun je op het Forwarded Address klikken om je Overleaf-instantie te bezoeken. Mogelijk moet je /launchpad toevoegen om de welkomstpagina van Overleaf te openen.

4. Je beheerdersaccount aanmaken

   Voer je beheerdersaccount en wachtwoord in en klik op de knop Register.

   
5. Veel schrijfplezier

   Tijd om te genieten van het schrijven in $\LaTeX$!

   

​

De volledige TeXLive-image gebruiken

Als je toegang hebt tot GitHub Codespaces met 8 cores/64 GB, kun je in deze playground de volledige TeXLive-image gebruiken. Je kunt de volgende omgevingsvariabelen in het bestand toolkit/config/variables.env wijzigen om de TeXLive Full-image te gebruiken in plaats van de TeXLive Basic-image.

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

Na het wijzigen van de omgevingsvariabelen moet je de Toolkit herstarten om de wijzigingen toe te passen. Voer de volgende opdracht uit om de Toolkit te herstarten.

cd toolkit && bin/up -d