Wat is de Ayakaleaf Toolkit?

De Ayakaleaf Toolkit is de aanbevolen deploymentmethode voor on-premises installaties van de Community Edition en Ayakaleaf Pro. Hij is ontworpen voor de meest voorkomende omgeving: één fysieke server of virtuele machine. De Toolkit gebruikt docker compose om de Docker-containers van je server te beheren en biedt een reeks scripts die docker-commando’s omhullen, om je te helpen met de meer technische kant van het beheren van een on-premises versie van Overleaf.

De bin/docker-compose-wrapper

Het script bin/docker-compose is een wrapper rond docker compose. Het laadt de configuratie uit de map config/ voordat het docker compose aanroept met de argumenten die aan het script zijn meegegeven.

Je kunt bin/docker-compose beschouwen als een transparante wrapper voor het programma docker compose dat op je machine is geïnstalleerd.

Voorbeeld:

Check running containers

$ bin/docker-compose ps

Handige hulpscripts

Naast bin/docker-compose biedt de Toolkit handige scripts voor veelvoorkomende taken:

• 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 om informatie over de installatie en deployment te verzamelen. Zie de sectie “Je server controleren” hieronder
• bin/mongo: start een shell binnen de mongo-container en schakelt over naar de juiste database (sharelatex)
• bin/backup-config: maakt een kopie (zip of tar) van je huidige configuratie en slaat deze op in een doelmap naar keuze
• bin/logs: servicelogs bekijken/volgen
• bin/error-logs: foutlogs van services bekijken/volgen
• bin/rename-env-vars-5-0: migratiescript om omgevingsvariabelen in config/variables.env bij te werken (rebranding van ShareLaTeX naar Overleaf)
• bin/rename-rc-vars: migratiescript om omgevingsvariabelen in config/overleaf.rc bij te werken (rebranding van ShareLaTeX naar Overleaf)
• bin/run-script: hulpmiddel om het uitvoeren van scripts in de sharelatex-container te vereenvoudigen
• bin/upgrade: helpt bij het upgraden van instanties. Het script controleert op Toolkit-updates (via git) en biedt aan wijzigingen te pullen, controleert op de nieuwste versie van de Docker-image en biedt aan deze bij te werken. Het vraagt stap voor stap om bevestiging, biedt de optie om de huidige configuratie te back-uppen en regelt het stoppen/starten van Docker-services. Zie Upgrading your deployment voor meer informatie: https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment

Als je je instantie liever draait zonder aan de Docker-logs gekoppeld te zijn, kun je bin/up -d uitvoeren om in detached-modus te draaien.

Je server controleren

De Overleaf Toolkit bevat een handig script genaamd bin/doctor dat een rapport genereert van eventuele ontbrekende afhankelijkheden.

Voer voordat je verdergaat het script bin/doctor uit en controleer of alles correct werkt:

Run Overleaf Doctor

bin/doctor

Voorbeelduitvoer (ingekort/ter illustratie):

Voorbeelduitvoer van bin/doctor

====== Overleaf Doctor ======
- Host Information
    - Linux
    - Output of 'lsb_release -a':
            No LSB modules are available.
            Distributor ID:     Ubuntu
            Description:        Ubuntu 22.04.5 LTS
            Release:    22.04
            Codename:   jammy
- Dependencies
    - bash
        - status: present
        - version info: 5.1.16(1)-release
    - docker
        - status: present
        - version info: Docker version 27.3.1, build ce12230
    - realpath
        - status: present
        - version info: realpath (GNU coreutils) 8.32
    - perl
        - status: present
        - version info: 5.034000
    - awk
        - status: present
        - version info: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1)
    - openssl
        - status: present
        - version info: OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022)
    - docker compose
        - status: present
        - version info: Docker Compose version v2.29.7
- Docker Daemon
    - status: up
====== Configuration ======
- config/version
    - status: present
    - version: 5.1.1
- config/overleaf.rc
    - status: present
    - values
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: data/overleaf/logs
        - SERVER_PRO: true
            - logged in to 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: present
    - values
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs
====== Warnings ======
- None, all good
====== End ======

Als er afhankelijkheden ontbreken, toont de doctor waarschuwingen. Loop je tegen problemen aan, voer dan eerst bin/doctor uit en controleer de uitvoer op waarschuwingen.

• Gebruikers van de Ayakaleaf Pro Edition kunnen een issue openen op GitHub: https://github.com/ayaka-notes/toolkit/issues

Voeg in beide gevallen de uitvoer van bin/doctor toe aan je bericht.