> For the complete documentation index, see [llms.txt](https://overleaf-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://overleaf-pro.ayaka.space/on-premises/on-premises-no/kom-i-gang/what-is-the-overleaf-toolkit.md). # Hva er Overleaf Toolkit? Overleaf Toolkit er den anbefalte distribusjonsmetoden for lokale installasjoner av Community Edition, Server Pro eller Overleaf Pro. Den er utformet for å fungere med det vanligste miljøet: én fysisk server eller én virtuell maskin. Toolkit bruker `docker compose` for å administrere Docker-containerne på serveren din, 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` innpakning Den `bin/docker-compose` skriptet er en innpakning rundt `docker compose`. Den laster inn konfigurasjon fra `config/` katalogen, før den kaller opp `docker compose` med de argumentene som ble sendt til skriptet. Du kan behandle `bin/docker-compose` som en transparent innpakning for `docker compose` programmet som er installert på maskinen din. Eksempel: {% code title="Sjekk kjørende containere" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Praktiske hjelpeskripter I tillegg til `bin/docker-compose`, tilbyr Toolkit 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 som brukes til å samle inn informasjon om installasjon og utrulling. Se seksjonen «Kontroll av serveren din» nedenfor * `bin/mongo`: starter et skall inne i **mongo** containeren og bytter til riktig database (**sharelatex**) * `bin/backup-config`: lag en kopi (zip eller tar) av den gjeldende konfigurasjonen din og lagre den i en målkatalog du selv velger * `bin/logs`: vis/følg tjenestelogger * `bin/error-logs`: vis/følg tjenestens feillogger * `bin/rename-env-vars-5-0`: migreringsskript for å oppdatere miljøvariabler i **config/variables.env** (ny profilering fra ShareLaTeX til Overleaf) * `bin/rename-rc-vars`: migreringsskript for å oppdatere miljøvariabler i **config/overleaf.rc** (ny profilering 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 om det finnes oppdateringer for Toolkit (via git) og tilby å hente endringene, sjekke den nyeste versjonen av Docker-imaget og tilby å oppdatere det. Det gir bekreftelse trinn for trinn, mulighet til å ta sikkerhetskopi av gjeldende konfigurasjon, og håndterer stopping og 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 %} #### Kontroll av serveren din Overleaf Toolkit inkluderer et praktisk skript kalt `bin/doctor` som lager 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/illustrativ):
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 Utgivelse: 22.04 Kodenavn: jammy - Avhengigheter - bash - status: til stede - versjonsinfo: 5.1.16(1)-release - docker - status: til stede - versjonsinfo: Docker-versjon 27.3.1, bygg ce12230 - realpath - status: til stede - versjonsinfo: realpath (GNU coreutils) 8.32 - perl - status: til stede - versjonsinfo: 5.034000 - awk - status: til stede - versjonsinfo: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - status: til stede - versjonsinfo: OpenSSL 3.0.2 15 Mar 2022 (bibliotek: OpenSSL 3.0.2 15 Mar 2022) - docker compose - status: til stede - versjonsinfo: Docker Compose-versjon v2.29.7 - Docker-daemon - 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 i orden ====== Slutt ====== ```
Hvis noen av avhengighetene mangler, vil doctor skrive ut advarsler. Hvis du støter på problemer, kjør først `bin/doctor` og se etter advarsler i utdataene. {% hint style="info" %} * Brukere av den gratis Community Edition bør opprette en sak på GitHub: * Brukere av Server Pro bør kontakte support: mailto: 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://overleaf-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.