Czym jest Ayakaleaf Toolkit?

Ayakaleaf Toolkit to zalecana metoda wdrażania lokalnych instalacji Community Edition oraz Ayakaleaf Pro. Został zaprojektowany z myślą o najpopularniejszym środowisku: pojedynczym serwerze fizycznym lub maszynie wirtualnej. Toolkit wykorzystuje docker compose do zarządzania kontenerami Docker na serwerze i udostępnia zestaw skryptów opakowujących polecenia docker, które ułatwiają bardziej techniczne aspekty zarządzania lokalną wersją Overleaf.

Wrapper bin/docker-compose

Skrypt bin/docker-compose jest wrapperem dla docker compose. Ładuje konfigurację z katalogu config/, a następnie wywołuje docker compose z argumentami przekazanymi do skryptu.

Możesz traktować bin/docker-compose jako przezroczysty wrapper programu docker compose zainstalowanego na Twojej maszynie.

Przykład:

Check running containers

$ bin/docker-compose ps

Skrypty pomocnicze

Oprócz bin/docker-compose Toolkit udostępnia wygodne skrypty ułatwiające wykonywanie typowych zadań:

• bin/up: skrót dla bin/docker-compose up
• bin/start: skrót dla bin/docker-compose start
• bin/stop: skrót dla bin/docker-compose stop
• bin/shell: uruchamia powłokę wewnątrz kontenera sharelatex
• bin/doctor: skrypt służący do zbierania informacji o instalacji i wdrożeniu. Zobacz sekcję „Sprawdzanie serwera” poniżej
• bin/mongo: uruchamia powłokę wewnątrz kontenera mongo i przełącza się na właściwą bazę danych (sharelatex)
• bin/backup-config: tworzy kopię (zip lub tar) bieżącej konfiguracji i zapisuje ją w wybranym katalogu docelowym
• bin/logs: wyświetlanie/śledzenie logów usług
• bin/error-logs: wyświetlanie/śledzenie logów błędów usług
• bin/rename-env-vars-5-0: skrypt migracyjny aktualizujący zmienne środowiskowe w config/variables.env (zmiana marki z ShareLaTeX na Overleaf)
• bin/rename-rc-vars: skrypt migracyjny aktualizujący zmienne środowiskowe w config/overleaf.rc (zmiana marki z ShareLaTeX na Overleaf)
• bin/run-script: skrypt pomocniczy upraszczający uruchamianie skryptów przechowywanych w kontenerze sharelatex
• bin/upgrade: pomaga w aktualizacji instancji. Skrypt sprawdza dostępność aktualizacji Toolkit (przez git) i proponuje pobranie zmian, sprawdza najnowszą wersję obrazu Docker i proponuje jego aktualizację. Zapewnia potwierdzanie krok po kroku, możliwość wykonania kopii zapasowej bieżącej konfiguracji oraz obsługuje zatrzymywanie i uruchamianie usług Docker. Więcej informacji znajdziesz w sekcji Upgrading your deployment: https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment

Jeśli wolisz uruchamiać instancję bez podłączania się do logów Dockera, możesz uruchomić bin/up -d, aby działała w trybie odłączonym.

Sprawdzanie serwera

Overleaf Toolkit zawiera przydatny skrypt bin/doctor, który generuje raport wskazujący wszelkie niespełnione zależności.

Zanim przejdziesz dalej, uruchom skrypt bin/doctor i sprawdź, czy wszystko działa poprawnie:

Run Overleaf Doctor

bin/doctor

Przykładowe wyjście (skrócone/poglądowe):

Przykładowe wyjście 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 ======

Jeśli brakuje jakichkolwiek zależności, doctor wyświetli ostrzeżenia. Jeśli napotkasz problemy, najpierw uruchom bin/doctor i sprawdź, czy w jego wyjściu nie ma ostrzeżeń.

• Użytkownicy Ayakaleaf Pro Edition mogą zgłosić problem na GitHubie: https://github.com/ayaka-notes/toolkit/issues

W obu przypadkach dołącz do wiadomości wyjście polecenia bin/doctor.