> ## 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.

# Hvad er Ayakaleaf Toolkit?

Ayakaleaf Toolkit er den anbefalede udrulningsmetode til on-premises-installationer af Community Edition og Ayakaleaf Pro. Den er designet til at fungere i det mest almindelige miljø: en enkelt fysisk server eller virtuel maskine. Toolkit bruger `docker compose` til at administrere din servers Docker-containere og stiller en række scripts til rådighed, som omslutter `docker`-kommandoer for at hjælpe med de mere tekniske aspekter af at administrere en on-premises-version af Overleaf.

#### `bin/docker-compose`-wrapperen

Scriptet `bin/docker-compose` er en wrapper omkring `docker compose`. Det indlæser konfigurationen fra mappen `config/`, før det kalder `docker compose` med de argumenter, der blev givet til scriptet.

Du kan betragte `bin/docker-compose` som en transparent wrapper for det `docker compose`-program, der er installeret på din maskine.

Eksempel:

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

#### Praktiske hjælpescripts

Ud over `bin/docker-compose` stiller Toolkit praktiske scripts til rådighed, der hjælper 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 oplysninger om installation og udrulning. 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`: opretter en kopi (zip eller tar) af din nuværende konfiguration og gemmer den i en destinationsmappe efter eget valg
* `bin/logs`: vis/følg tjenestelogs
* `bin/error-logs`: vis/følg tjenesternes fejllogs
* `bin/rename-env-vars-5-0`: migreringsscript til opdatering af miljøvariabler i **config/variables.env** (omdøbning fra ShareLaTeX til Overleaf)
* `bin/rename-rc-vars`: migreringsscript til opdatering af miljøvariabler i **config/overleaf.rc** (omdøbning fra ShareLaTeX til Overleaf)
* `bin/run-script`: hjælpeværktøj, der forenkler kørsel af scripts, som ligger i **sharelatex**-containeren
* `bin/upgrade`: hjælper med opgradering af instanser. Scriptet tjekker for opdateringer af Toolkit (via git) og tilbyder at hente ændringerne, tjekker for den nyeste version af Docker-imaget og tilbyder at opdatere det. Det giver trinvis bekræftelse, mulighed for at sikkerhedskopiere den nuværende konfiguration og håndterer stop/start af Docker-tjenester. Se Opgradering af din udrulning for flere oplysninger: [https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment](https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment)

<Info>
  Hvis du foretrækker at køre din instans uden at være tilknyttet Docker-loggene, kan du køre `bin/up -d` for at køre i frakoblet tilstand.
</Info>

#### Kontrol af din server

Overleaf Toolkit indeholder et praktisk script kaldet `bin/doctor`, der laver en rapport, som peger på eventuelle uopfyldte afhængigheder.

Før du fortsætter, skal du køre scriptet `bin/doctor` og kontrollere, at alt fungerer korrekt:

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

Eksempel på output (forkortet/illustrativt):

<Accordion title="Eksempel på output 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 der mangler afhængigheder, udskriver doctor advarsler. Hvis du støder på problemer, skal du først køre `bin/doctor` og tjekke dets output for advarsler.

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

  Medtag i begge tilfælde outputtet fra `bin/doctor` i din besked.
</Info>


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