> 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/da/kom-godt-i-gang/what-is-the-overleaf-toolkit.md). # Hvad er Ayakaleaf Toolkit? ayakaleaf-værktøjskassen er den anbefalede implementeringsmetode til lokale installationer af Community Edition, Ayakaleaf Pro. Den er designet til at fungere i det mest almindelige miljø: en enkelt fysisk server eller virtuel maskine. Værktøjskassen bruger `docker compose` til at administrere din servers Docker-containere og leverer et sæt scripts, som omslutter `docker` kommandoer, der hjælper med den mere tekniske del af at administrere en lokal version af Overleaf. #### Den `bin/docker-compose` wrapper Den `bin/docker-compose` scriptet er en wrapper omkring `docker compose`. Det indlæser konfiguration fra `config/` mappen, før det kalder `docker compose` med de argumenter, der blev sendt til scriptet. Du kan betragte `bin/docker-compose` som en gennemsigtig wrapper for `docker compose` programmet, der er installeret på din maskine. Eksempel: {% code title="Tjek kørende containere" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Nyttige hjælpeværktøjer Ud over `bin/docker-compose`, leverer Toolkit praktiske scripts til at hjælpe med almindelige opgaver: * `bin/up`: genvej til `bin/docker-compose up` * `bin/start`: genvej til `bin/docker-compose start` * `bin/stop`: genvej til `bin/docker-compose stop` * `bin/shell`: starter en shell inde i **sharelatex** containeren * `bin/doctor`: script, der bruges til at indsamle installations- og implementeringsoplysninger. Se afsnittet "Kontrol af din server" nedenfor * `bin/mongo`: starter en shell inde i **mongo** containeren og skifter til den korrekte database (**sharelatex**) * `bin/backup-config`: opret en kopi (zip eller tar) af din nuværende konfiguration og gem den i en destinationsmappe efter eget valg * `bin/logs`: vis/efterfølg tjenestelogfiler * `bin/error-logs`: vis/efterfølg tjenestens fejllogfiler * `bin/rename-env-vars-5-0`: migreringsscript til at opdatere miljøvariabler i **config/variables.env** (rebranding fra ShareLaTeX til Overleaf) * `bin/rename-rc-vars`: migreringsscript til at opdatere miljøvariabler i **config/overleaf.rc** (rebranding fra ShareLaTeX til Overleaf) * `bin/run-script`: hjælpefunktion til at forenkle kørsel af scripts, der er gemt i **sharelatex** containeren * `bin/upgrade`: hjælper med opgraderinger af instansen. Scriptet vil tjekke for Toolkit-opdateringer (via git) og tilbyde at hente ændringer, tjekke den seneste Docker-imageversion og tilbyde at opdatere den. Det giver trinvis bekræftelse, mulighed for at tage backup af den nuværende konfiguration og håndterer stop/start af Docker-tjenester. Se Opgradering af din implementering for mere information: {% hint style="info" %} Hvis du foretrækker at køre din instans uden at tilknytte Docker-loggene, kan du køre `bin/up -d` for at køre i afkoblet tilstand. {% endhint %} #### Kontrol af din server Overleaf Toolkit indeholder et praktisk script kaldet `bin/doctor` som genererer en rapport, der peger på eventuelle manglende afhængigheder. Før du fortsætter, skal du køre `bin/doctor` scriptet og kontrollere, at alt fungerer korrekt: {% code title="Kør Overleaf Doctor" %} ```bash bin/doctor ``` {% endcode %} Eksempeloutput (afkortet/illustrativt):
Eksempeloutput fra bin/doctor ``` ====== Overleaf Doctor ====== - Værtsoplysninger - Linux - Output af 'lsb_release -a': Ingen LSB-moduler er tilgængelige. Distributør-ID: Ubuntu Beskrivelse: Ubuntu 22.04.5 LTS Udgivelse: 22.04 Kodenavn: jammy - Afhængigheder - bash - status: til stede - versionsinfo: 5.1.16(1)-release - docker - status: til stede - versionsinfo: Docker-version 27.3.1, build ce12230 - realpath - status: til stede - versionsinfo: realpath (GNU coreutils) 8.32 - perl - status: til stede - versionsinfo: 5.034000 - awk - status: til stede - versionsinfo: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - status: til stede - versionsinfo: OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022) - docker compose - status: til stede - versionsinfo: Docker Compose-version v2.29.7 - Docker-daemon - status: kører ====== Konfiguration ====== - config/version - status: til stede - version: 5.1.1 - config/overleaf.rc - status: til stede - værdier - OVERLEAF_DATA_PATH: data/overleaf - OVERLEAF_LOG_PATH: data/overleaf/logs - SERVER_PRO: true - logget ind 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: til stede - værdier - OVERLEAF_FILESTORE_BACKEND: fs - OVERLEAF_HISTORY_BACKEND: fs ====== Advarsler ====== - Ingen, alt er fint ====== Slut ====== ```
Hvis der mangler afhængigheder, vil doctor udskrive advarsler. Hvis du støder på problemer, skal du først køre `bin/doctor` og kontrollere dens output for advarsler. {% hint style="info" %} * Brugere af Ayakaleaf Pro Edition kan oprette et issue på GitHub: I begge tilfælde skal du inkludere outputtet af `bin/doctor` i din besked. {% 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/da/kom-godt-i-gang/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.