> 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/on-premises-no/kom-i-gang/what-is-the-overleaf-toolkit.md). # Hva er Ayakaleaf Toolkit? Ayakaleaf-verktøysettet er den anbefalte distribusjonsmetoden for lokale installasjoner av Community Edition, Ayakaleaf Pro. Det er utformet for å fungere med det vanligste miljøet: en enkelt fysisk server eller virtuell maskin. Verktøysettet bruker `docker compose` for å administrere serverens Docker-containere og tilbyr et sett med skript som pakker inn `docker` -kommandoer for å hjelpe med den mer tekniske delen av å administrere en lokal versjon av Overleaf. #### Den `bin/docker-compose` wrapper Den `bin/docker-compose` -skriptet er et omslag rundt `docker compose`. Det laster inn konfigurasjon fra `config/` -katalogen, før det kaller `docker compose` med de argumentene som ble sendt til skriptet. Du kan betrakte `bin/docker-compose` som et transparent omslag for `docker compose` -programmet installert på maskinen din. Eksempel: {% code title="Sjekk kjørende containere" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Praktiske hjelpere I tillegg til `bin/docker-compose`tilbyr verktøysettet praktiske skript for å hjelpe med vanlige oppgaver: * `bin/up`: snarvei til `bin/docker-compose up` * `bin/start`: snarvei til `bin/docker-compose start` * `bin/stop`: snarvei til `bin/docker-compose stop` * `bin/shell`: starter et skall inne i **sharelatex** -containeren * `bin/doctor`: skript brukt til å samle installasjons- og distribusjonsinformasjon. Se delen «Sjekke serveren din» nedenfor * `bin/mongo`: starter et skall inne i **mongo** -containeren og bytter til riktig database (**sharelatex**) * `bin/backup-config`: opprett en kopi (zip eller tar) av din nåværende konfigurasjon og lagre den i en målkatalog du selv velger * `bin/logs`: vis/følg tjenestelogger * `bin/error-logs`: vis/følg feillogger for tjenesten * `bin/rename-env-vars-5-0`: migreringsskript for å oppdatere miljøvariabler i **config/variables.env** (rebranding fra ShareLaTeX til Overleaf) * `bin/rename-rc-vars`: migreringsskript for å oppdatere miljøvariabler i **config/overleaf.rc** (rebranding fra ShareLaTeX til Overleaf) * `bin/run-script`: hjelpemiddel for å forenkle kjøring av skript som er lagret i **sharelatex** -containeren * `bin/upgrade`: hjelper med oppgraderinger av instansen. Skriptet vil sjekke etter oppdateringer av verktøysettet (via git) og tilby å hente endringene, sjekke den nyeste Docker-image-versjonen og tilby å oppdatere den. Det gir trinnvis bekreftelse, mulighet til å sikkerhetskopiere gjeldende konfigurasjon, og håndterer stopping/start av Docker-tjenester. Se Oppgradering av distribusjonen din for mer informasjon: {% hint style="info" %} Hvis du foretrekker å kjøre instansen din uten å koble til Docker-loggene, kan du kjøre `bin/up -d` for å kjøre i frakoblet modus. {% endhint %} #### Sjekke serveren din Overleaf-verktøysettet inkluderer et praktisk skript kalt `bin/doctor` som genererer en rapport som peker på eventuelle udekkede avhengigheter. Før du fortsetter, kjør `bin/doctor` -skriptet og sjekk at alt fungerer som det skal: {% code title="Kjør Overleaf Doctor" %} ```bash bin/doctor ``` {% endcode %} Eksempelutdata (avkortet/illustrativt):
Eksempelutdata fra bin/doctor ``` ====== Overleaf Doctor ====== - Vertsinformasjon - Linux - Utdata fra 'lsb_release -a': Ingen LSB-moduler er tilgjengelige. Distributør-ID: Ubuntu Beskrivelse: Ubuntu 22.04.5 LTS Utgave: 22.04 Kodenavn: jammy - Avhengigheter - bash - status: til stede - versjonsinformasjon: 5.1.16(1)-release - docker - status: til stede - versjonsinformasjon: Docker-versjon 27.3.1, build ce12230 - realpath - status: til stede - versjonsinformasjon: realpath (GNU coreutils) 8.32 - perl - status: til stede - versjonsinformasjon: 5.034000 - awk - status: til stede - versjonsinformasjon: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - status: til stede - versjonsinformasjon: OpenSSL 3.0.2 15 Mar 2022 (Bibliotek: OpenSSL 3.0.2 15 Mar 2022) - docker compose - status: til stede - versjonsinformasjon: Docker Compose-versjon v2.29.7 - Docker-demon - status: oppe ====== Konfigurasjon ====== - config/version - status: til stede - versjon: 5.1.1 - config/overleaf.rc - status: til stede - verdier - OVERLEAF_DATA_PATH: data/overleaf - OVERLEAF_LOG_PATH: data/overleaf/logs - SERVER_PRO: true - logget inn 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 - verdier - OVERLEAF_FILESTORE_BACKEND: fs - OVERLEAF_HISTORY_BACKEND: fs ====== Advarsler ====== - Ingen, alt er bra ====== Slutt ====== ```
Hvis noen avhengigheter mangler, vil doctor skrive ut advarsler. Hvis du støter på problemer, kjør først `bin/doctor` og sjekk utdataene for advarsler. {% hint style="info" %} * Brukere av Ayakaleaf Pro-utgaven kan åpne en sak på GitHub: I begge tilfeller, inkluder utdataene fra `bin/doctor` i meldingen din. {% 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/on-premises-no/kom-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.