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

# Vad är Ayakaleaf Toolkit?

Ayakaleaf Toolkit är den rekommenderade driftsättningsmetoden för lokala installationer av Community Edition och Ayakaleaf Pro. Den är utformad för den vanligaste miljön: en enda fysisk server eller virtuell maskin. Toolkit använder `docker compose` för att hantera serverns Docker-containrar och tillhandahåller en uppsättning skript som omsluter `docker`-kommandon för att underlätta den mer tekniska sidan av att hantera en lokal Overleaf-version.

#### Omslaget `bin/docker-compose`

Skriptet `bin/docker-compose` är ett omslag (wrapper) runt `docker compose`. Det läser in konfigurationen från katalogen `config/` innan det anropar `docker compose` med de argument som skickats till skriptet.

Du kan betrakta `bin/docker-compose` som ett transparent omslag för programmet `docker compose` som är installerat på din dator.

Exempel:

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

#### Praktiska hjälpskript

Utöver `bin/docker-compose` tillhandahåller Toolkit praktiska skript som underlättar vanliga uppgifter:

* `bin/up`: genväg för `bin/docker-compose up`
* `bin/start`: genväg för `bin/docker-compose start`
* `bin/stop`: genväg för `bin/docker-compose stop`
* `bin/shell`: startar ett skal i containern **sharelatex**
* `bin/doctor`: skript som samlar in information om installation och driftsättning. Se avsnittet "Kontrollera din server" nedan
* `bin/mongo`: startar ett skal i containern **mongo** och växlar till rätt databas (**sharelatex**)
* `bin/backup-config`: skapar en kopia (zip eller tar) av din aktuella konfiguration och lagrar den i en valfri målkatalog
* `bin/logs`: visa/följ tjänsteloggar
* `bin/error-logs`: visa/följ tjänsternas felloggar
* `bin/rename-env-vars-5-0`: migreringsskript som uppdaterar miljövariabler i **config/variables.env** (namnbyte från ShareLaTeX till Overleaf)
* `bin/rename-rc-vars`: migreringsskript som uppdaterar miljövariabler i **config/overleaf.rc** (namnbyte från ShareLaTeX till Overleaf)
* `bin/run-script`: hjälpskript som förenklar körning av skript som lagras i containern **sharelatex**
* `bin/upgrade`: hjälper till med uppgradering av instansen. Skriptet söker efter uppdateringar av Toolkit (via git) och erbjuder sig att hämta ändringarna, söker efter den senaste versionen av Docker-imagen och erbjuder sig att uppdatera den. Det ger stegvis bekräftelse, möjlighet att säkerhetskopiera den aktuella konfigurationen och hanterar stopp/start av Docker-tjänster. Mer information finns i Uppgradera din driftsättning: [https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment](https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment)

<Info>
  Om du föredrar att köra din instans utan att koppla till Docker-loggarna kan du köra `bin/up -d` för att köra i frånkopplat läge.
</Info>

#### Kontrollera din server

Overleaf Toolkit innehåller ett praktiskt skript som heter `bin/doctor` och som tar fram en rapport som pekar ut eventuella ouppfyllda beroenden.

Innan du fortsätter, kör skriptet `bin/doctor` och kontrollera att allt fungerar korrekt:

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

Exempel på utdata (förkortat/illustrativt):

<Accordion title="Exempel på utdata från 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>

Om några beroenden saknas skriver doctor ut varningar. Om du stöter på problem, kör först `bin/doctor` och kontrollera utdata efter varningar.

<Info>
  * Användare av Ayakaleaf Pro Edition kan öppna ett ärende på GitHub: [https://github.com/ayaka-notes/toolkit/issues](https://github.com/ayaka-notes/toolkit/issues)

  I båda fallen ska du inkludera utdata från `bin/doctor` i ditt meddelande.
</Info>


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