> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Hva er Ayakaleaf Toolkit?

Ayakaleaf Toolkit er den anbefalte distribusjonsmetoden for lokale installasjoner av Community Edition og Ayakaleaf Pro. Den er utformet for å fungere i det vanligste miljøet: én fysisk server eller virtuell maskin. Toolkit bruker `docker compose` til å administrere serverens Docker-containere og tilbyr et sett med skript som pakker inn `docker`-kommandoer for å hjelpe med den mer tekniske siden av å administrere en lokal versjon av Overleaf.

#### Innpakningen `bin/docker-compose`

Skriptet `bin/docker-compose` er en innpakning rundt `docker compose`. Det laster inn konfigurasjon fra katalogen `config/` før det kaller `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:

```bash title="Check running containers" theme={null}
$ bin/docker-compose ps
```

#### Praktiske hjelpeskript

I tillegg til `bin/docker-compose` tilbyr Toolkit praktiske skript som hjelper med vanlige oppgaver:

* `bin/up`: snarvei for `bin/docker-compose up`
* `bin/start`: snarvei for `bin/docker-compose start`
* `bin/stop`: snarvei for `bin/docker-compose stop`
* `bin/shell`: starter et skall inne i **sharelatex**-containeren
* `bin/doctor`: skript som samler inn informasjon om installasjon og distribusjon. Se delen «Sjekke serveren» nedenfor
* `bin/mongo`: starter et skall inne i **mongo**-containeren og bytter til riktig database (**sharelatex**)
* `bin/backup-config`: lager en kopi (zip eller tar) av gjeldende konfigurasjon og lagrer den i en målkatalog du velger
* `bin/logs`: vis/følg tjenestelogger
* `bin/error-logs`: vis/følg feillogger for tjenester
* `bin/rename-env-vars-5-0`: migreringsskript for å oppdatere miljøvariabler i **config/variables.env** (navnebytte fra ShareLaTeX til Overleaf)
* `bin/rename-rc-vars`: migreringsskript for å oppdatere miljøvariabler i **config/overleaf.rc** (navnebytte fra ShareLaTeX til Overleaf)
* `bin/run-script`: hjelpeskript som forenkler kjøring av skript som ligger i **sharelatex**-containeren
* `bin/upgrade`: hjelper med oppgradering av instanser. Skriptet ser etter oppdateringer av Toolkit (via git) og tilbyr å hente endringene, ser etter den nyeste versjonen av Docker-imaget og tilbyr å oppdatere det. Det gir bekreftelse trinn for trinn, mulighet til å sikkerhetskopiere gjeldende konfigurasjon, og håndterer stopp/start av Docker-tjenester. Se Oppgradere distribusjonen for mer informasjon: [https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment](https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment)

<Info>
  Hvis du foretrekker å kjøre instansen uten å koble deg til Docker-loggene, kan du kjøre `bin/up -d` for å kjøre i frakoblet modus.
</Info>

#### Sjekke serveren

Overleaf Toolkit inkluderer et praktisk skript kalt `bin/doctor` som lager en rapport som peker på eventuelle uoppfylte avhengigheter.

Før du fortsetter, kjør skriptet `bin/doctor` og sjekk at alt fungerer som det skal:

```bash title="Run Overleaf Doctor" theme={null}
bin/doctor
```

Eksempel på utdata (forkortet/illustrativt):

<Accordion title="Eksempel på utdata fra bin/doctor">
  ```text theme={null}
  ====== 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 ======
  ```
</Accordion>

Hvis det mangler avhengigheter, vil doctor skrive ut advarsler. Hvis du får problemer, kjør først `bin/doctor` og se etter advarsler i utdataene.

<Info>
  * Brukere av Ayakaleaf Pro Edition kan opprette en issue på GitHub: [https://github.com/ayaka-notes/toolkit/issues](https://github.com/ayaka-notes/toolkit/issues)

  I begge tilfeller må du ta med utdataene fra `bin/doctor` i meldingen din.
</Info>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.