> For the complete documentation index, see [llms.txt](https://ayakaleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ayakaleaf-pro.ayaka.space/on-premises/nl/aan-de-slag/what-is-the-overleaf-toolkit.md). # Wat is de Ayakaleaf Toolkit? De ayakaleaf-toolkit is de aanbevolen implementatiemethode voor on-premises installaties van de Community Edition, Ayakaleaf Pro. Deze is ontworpen om te werken met de meest gangbare omgeving: een enkele fysieke server of virtuele machine. De Toolkit gebruikt `docker compose` om de Docker-containers van uw server te beheren en biedt een reeks scripts die `docker` -commando's om de meer technische kant van het beheren van een on-premises versie van Overleaf te ondersteunen. #### De `bin/docker-compose` wrapper De `bin/docker-compose` script is een wrapper rond `docker compose`. Het laadt configuratie uit de `config/` map, voordat het `docker compose` aanroept met de argumenten die aan het script zijn doorgegeven. U kunt `bin/docker-compose` behandelen als een transparante wrapper voor het `docker compose` programma dat op uw machine is geïnstalleerd. Voorbeeld: {% code title="Draaiende containers controleren" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Handige hulpfuncties Naast `bin/docker-compose`biedt de Toolkit handige scripts om veelvoorkomende taken te ondersteunen: * `bin/up`: snelkoppeling voor `bin/docker-compose up` * `bin/start`: snelkoppeling voor `bin/docker-compose start` * `bin/stop`: snelkoppeling voor `bin/docker-compose stop` * `bin/shell`: start een shell binnen de **sharelatex** container * `bin/doctor`: script dat wordt gebruikt om installatie- en implementatie-informatie te verzamelen. Zie hieronder de sectie "Uw server controleren" * `bin/mongo`: start een shell binnen de **mongo** container en schakelt over naar de juiste database (**sharelatex**) * `bin/backup-config`: maak een kopie (zip of tar) van uw huidige configuratie en sla deze op in een doelmap naar keuze * `bin/logs`: service-logboeken bekijken/tailen * `bin/error-logs`: foutlogboeken van de service bekijken/tailen * `bin/rename-env-vars-5-0`: migratiescript om omgevingsvariabelen bij te werken in **config/variables.env** (hermerkering van ShareLaTeX naar Overleaf) * `bin/rename-rc-vars`: migratiescript om omgevingsvariabelen bij te werken in **config/overleaf.rc** (hermerkering van ShareLaTeX naar Overleaf) * `bin/run-script`: hulpmiddel om het uitvoeren van scripts die zijn opgeslagen in de **sharelatex** container * `bin/upgrade`: helpt bij het upgraden van de instantie. Het script controleert op Toolkit-updates (via git) en biedt aan om wijzigingen op te halen, controleert op de nieuwste versie van de Docker-image en biedt aan deze bij te werken. Het biedt stapsgewijze bevestiging, de optie om de huidige configuratie te back-uppen, en behandelt het stoppen/starten van Docker-services. Zie Uw implementatie upgraden voor meer informatie: {% hint style="info" %} Als u uw instantie liever uitvoert zonder de Docker-logs te volgen, kunt u `bin/up -d` uitvoeren om in losgekoppelde modus te draaien. {% endhint %} #### Uw server controleren De Overleaf Toolkit bevat een handig script genaamd `bin/doctor` dat een rapport genereert dat naar eventuele onvervulde afhankelijkheden verwijst. Voordat u doorgaat, voert u het `bin/doctor` script uit en controleert u of alles correct werkt: {% code title="Overleaf Doctor uitvoeren" %} ```bash bin/doctor ``` {% endcode %} Voorbeelduitvoer (ingekort/ter illustratie):
Voorbeelduitvoer van bin/doctor ``` ====== Overleaf Doctor ====== - Hostinformatie - Linux - Uitvoer van 'lsb_release -a': Er zijn geen LSB-modules beschikbaar. Distributeur-ID: Ubuntu Beschrijving: Ubuntu 22.04.5 LTS Release: 22.04 Codenaam: jammy - Afhankelijkheden - bash - status: aanwezig - versie-informatie: 5.1.16(1)-release - docker - status: aanwezig - versie-informatie: Docker-versie 27.3.1, build ce12230 - realpath - status: aanwezig - versie-informatie: realpath (GNU coreutils) 8.32 - perl - status: aanwezig - versie-informatie: 5.034000 - awk - status: aanwezig - versie-informatie: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - status: aanwezig - versie-informatie: OpenSSL 3.0.2 15 mrt 2022 (Bibliotheek: OpenSSL 3.0.2 15 mrt 2022) - docker compose - status: aanwezig - versie-informatie: Docker Compose-versie v2.29.7 - Docker-daemon - status: actief ====== Configuratie ====== - config/version - status: aanwezig - versie: 5.1.1 - config/overleaf.rc - status: aanwezig - waarden - OVERLEAF_DATA_PATH: data/overleaf - OVERLEAF_LOG_PATH: data/overleaf/logs - SERVER_PRO: true - ingelogd bij quay.io: true - SIBLING_CONTAINERS_ENABLED: true - OVERLEAF_LISTEN_IP: 0.0.0.0 - OVERLEAF_PORT: 80 - MONGO_ENABLED: true - MONGO_IMAGE: mongo - MONGO_VERSION: 6.0 - MONGO_DATA_PATH: data/mongo - REDIS_ENABLED: true - REDIS_IMAGE: redis:6.2 - REDIS_DATA_PATH: data/redis - config/variables.env - status: aanwezig - waarden - OVERLEAF_FILESTORE_BACKEND: fs - OVERLEAF_HISTORY_BACKEND: fs ====== Waarschuwingen ====== - Geen, alles is in orde ====== Einde ====== ```
Als er afhankelijkheden ontbreken, zal de doctor waarschuwingen afdrukken. Als u problemen ondervindt, voer dan eerst `bin/doctor` uit en controleer de uitvoer op waarschuwingen. {% hint style="info" %} * Gebruikers van de Ayakaleaf Pro-editie kunnen een issue openen op GitHub: Neem in beide gevallen de uitvoer van `bin/doctor` op in uw bericht. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://ayakaleaf-pro.ayaka.space/on-premises/nl/aan-de-slag/what-is-the-overleaf-toolkit.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.