> 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/sv/komma-igang/what-is-the-overleaf-toolkit.md). # Vad är Ayakaleaf Toolkit? ayakaleaf toolkit är den rekommenderade driftsättningsmetoden för lokala installationer av Community Edition, Ayakaleaf Pro, och den har utformats för att fungera med den vanligaste miljön: en enda fysisk server eller virtuell maskin. Toolkiten använder `docker compose` för att hantera din servers Docker-containrar och tillhandahåller en uppsättning skript som omsluter `docker` kommandon för att hjälpa till med den mer tekniska sidan av att hantera en lokal version av Overleaf. #### Det `bin/docker-compose` omslag Det `bin/docker-compose` skriptet är ett omslag runt `docker compose`. Det läser in konfiguration från `config/` katalogen, innan det anropar `docker compose` med vilka argument som än skickades till skriptet. Du kan betrakta `bin/docker-compose` som ett transparent omslag för `docker compose` programmet som är installerat på din maskin. Exempel: {% code title="Kontrollera körande containrar" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Praktiska hjälpverktyg Utöver `bin/docker-compose`tillhandahåller Toolkiten praktiska skript för att hjälpa till med vanliga uppgifter: * `bin/up`: genväg till `bin/docker-compose up` * `bin/start`: genväg till `bin/docker-compose start` * `bin/stop`: genväg till `bin/docker-compose stop` * `bin/shell`: startar ett skal inuti **sharelatex** containern * `bin/doctor`: skript som används för att samla in installations- och driftsättningsinformation. Se avsnittet "Kontrollera din server" nedan * `bin/mongo`: startar ett skal inuti **mongo** containern och växlar till rätt databas (**sharelatex**) * `bin/backup-config`: skapa en kopia (zip eller tar) av din aktuella konfiguration och spara den i en målkatalog som du själv väljer * `bin/logs`: visa/följ tjänstloggar * `bin/error-logs`: visa/följ tjänstfel-loggar * `bin/rename-env-vars-5-0`: migreringsskript för att uppdatera miljövariabler i **config/variables.env** (omprofilering från ShareLaTeX till Overleaf) * `bin/rename-rc-vars`: migreringsskript för att uppdatera miljövariabler i **config/overleaf.rc** (omprofilering från ShareLaTeX till Overleaf) * `bin/run-script`: hjälpverktyg för att förenkla körning av skript som lagras i **sharelatex** containern * `bin/upgrade`: hjälper till med uppgraderingar av instansen. Skriptet kommer att kontrollera om det finns uppdateringar av Toolkiten (via git) och erbjuda att hämta ändringarna, kontrollera den senaste versionen av Docker-avbildningen och erbjuda att uppdatera den. Det ger steg-för-steg-bekräftelse, möjlighet att säkerhetskopiera den aktuella konfigurationen och hanterar att stoppa/starta Docker-tjänster. Se Uppgradera din driftsättning för mer information: {% hint style="info" %} Om du föredrar att köra din instans utan att ansluta till Docker-loggarna kan du köra `bin/up -d` för att köra i frikopplat läge. {% endhint %} #### Kontrollera din server Overleaf Toolkit innehåller ett praktiskt skript som heter `bin/doctor` som skapar en rapport som pekar ut eventuella ouppfyllda beroenden. Innan du fortsätter, kör `bin/doctor` skriptet och kontrollera att allt fungerar korrekt: {% code title="Kör Overleaf Doctor" %} ```bash bin/doctor ``` {% endcode %} Exempelutskrift (förkortad/illustrativ):
Exempelutskrift från bin/doctor ``` ====== Overleaf Doctor ====== - Värdinformation - Linux - Utdata från 'lsb_release -a': Inga LSB-moduler är tillgängliga. Distributörs-ID: Ubuntu Beskrivning: Ubuntu 22.04.5 LTS Utgåva: 22.04 Kodnamn: jammy - Beroenden - bash - status: finns - versionsinfo: 5.1.16(1)-release - docker - status: finns - versionsinfo: Docker version 27.3.1, build ce12230 - realpath - status: finns - versionsinfo: realpath (GNU coreutils) 8.32 - perl - status: finns - versionsinfo: 5.034000 - awk - status: finns - versionsinfo: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - status: finns - versionsinfo: OpenSSL 3.0.2 15 Mar 2022 (Bibliotek: OpenSSL 3.0.2 15 Mar 2022) - docker compose - status: finns - versionsinfo: Docker Compose version v2.29.7 - Docker-demon - status: igång ====== Konfiguration ====== - config/version - status: finns - version: 5.1.1 - config/overleaf.rc - status: finns - värden - OVERLEAF_DATA_PATH: data/overleaf - OVERLEAF_LOG_PATH: data/overleaf/logs - SERVER_PRO: true - inloggad på 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: finns - värden - OVERLEAF_FILESTORE_BACKEND: fs - OVERLEAF_HISTORY_BACKEND: fs ====== Varningar ====== - Inga, allt är bra ====== Slut ====== ```
Om några beroenden saknas kommer Doctor att skriva ut varningar. Om du stöter på problem, kör först `bin/doctor` och kontrollera dess utdata för varningar. {% hint style="info" %} * Användare av Ayakaleaf Pro Edition kan skapa ett ärende på GitHub: i båda fallen, inkludera utdata från `bin/doctor` i ditt meddelande. {% 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/sv/komma-igang/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.