GitHub Codespacen käyttäminen

Helpoin tapa kokeilla Ayakaleaf Prota on käyttää GitHub Codespacea, jossa kaikki ympäristömuuttujat on valmiiksi määritetty, joten voit käyttää sitä heti.

Kun ajat Docker-kontteja GitHub Codespacesissa, Codespace ei sammu automaattisesti, vaan siitä laskutetaan edelleen. GitHub Codespacesin laskutussäännöt löydät sivulta github codespaces billing rules.

Voit hallita GitHub Codespacejasi osoitteessa https://github.com/codespaces. Kun et enää tarvitse Codespacea, poista se ajoissa.

Olemme valmiiksi määrittäneet seuraavat ominaisuudet:

• Hiekkalaatikossa tehtävä LaTeX-kääntäminen TeXLive Basic -versiolla (2024–2026)
• Pandoc-tuonti/-vienti (SaaS-alustan ominaisuus)
• Python-skriptien suoritus (SaaS-alustan ominaisuus)
• Git-Bridge-tuki (Server Pron ominaisuus)
• Edistynyt lähdeviitehaku (SaaS-alustan ominaisuus)
• Ylläpitopaneeli (kaikkien käyttäjien/projektien hallinta)
• Muutosten seuranta (arviointi- ja kommenttipaneelilla)
• Täysi projektihistoria (palautus ja lataus)
• Symbolipaletti (Server Pron/SaaS-alustan ominaisuus)

Tavalliset GitHub Codespacet tarjoavat 32 Gt tallennustilaa. Se ei riitä texlive-full-asennuksellemme. Jos haluat kokeilla täyttä imagea, lähetä GitHubin tukeen pyyntö Codespacesta, jossa on suuret ajoympäristöt (8+ ydintä).

GitHub Sync, LDAP, OAuth, SSO, Zotero-integraatio ja muut ominaisuudet ovat tässä kokeiluympäristössä määrittämättä. Katso Toolkit-asetuksista lisätietoja näiden ominaisuuksien määrittämisestä omaan käyttöönottoosi.

1. Luo GitHub Codespace

   Napsauta seuraavaa painiketta luodaksesi GitHub Codespacen. Palvelinkokoonpanoksi 2 ydintä ja 8 Gt RAM-muistia riittää yleensä testikäyttöön. Jos aiot käyttää TeX Live Full -imagea, suosittelemme valitsemaan kokoonpanon, jossa on 8 ydintä ja 64 Gt.

   

2. Alusta Overleaf-instanssi

   Kun Codespace on valmis, aja seuraava komento bash-komentotulkissa alustaaksesi Overleaf-instanssin.

   bash

   ./init.sh
   

   Saatat joutua odottamaan vähintään 3 minuuttia, ennen kuin kaikki tarvittavat Docker-imaget on haettu.

   
3. Avaa portti 80

   Siirry Ports-välilehdelle ja tee portista 80 julkinen seuraavien ohjeiden mukaisesti.

   

   Sen jälkeen voit avata Overleaf-instanssisi napsauttamalla Forwarded Address -osoitetta. Sinun on ehkä lisättävä osoitteeseen /launchpad päästäksesi Overleafin tervetulosivulle.

4. Luo ylläpitäjätili

   Syötä ylläpitäjätilin tunnus ja salasana ja napsauta sitten Register-painiketta.

   
5. Nauti kirjoittamisesta

   Nyt on aika nauttia $\LaTeX$-kirjoittamisesta!

   

​

TeXLive Full -imagen käyttäminen

Jos käytössäsi on 8 ytimen/64 Gt:n GitHub Codespace, voit käyttää tässä kokeiluympäristössä TeXLive Full -imagea. Muuta seuraavat ympäristömuuttujat tiedostossa toolkit/config/variables.env, jotta TeXLive Basic -imagen sijaan käytetään TeXLive Full -imagea.

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

Ympäristömuuttujien muuttamisen jälkeen Toolkit on käynnistettävä uudelleen, jotta muutokset tulevat voimaan. Voit käynnistää Toolkitin uudelleen seuraavalla komennolla.

cd toolkit && bin/up -d