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

# Mikä on Ayakaleaf Toolkit?

Ayakaleaf Toolkit on suositeltu käyttöönottotapa Community Editionin ja Ayakaleaf Pron paikallisille asennuksille. Se on suunniteltu toimimaan yleisimmässä ympäristössä: yhdellä fyysisellä palvelimella tai virtuaalikoneella. Toolkit käyttää `docker compose` -työkalua palvelimesi Docker-konttien hallintaan ja tarjoaa joukon `docker`-komentoja kääriviä skriptejä, jotka helpottavat Overleafin paikallisen version hallinnan teknisempää puolta.

#### `bin/docker-compose`-kääre

`bin/docker-compose`-skripti on `docker compose` -komennon kääre. Se lataa konfiguraation `config/`-hakemistosta ennen kuin se kutsuu `docker compose` -komentoa skriptille annetuilla argumenteilla.

Voit käsitellä `bin/docker-compose`-skriptiä läpinäkyvänä kääreenä koneellesi asennetulle `docker compose` -ohjelmalle.

Esimerkki:

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

#### Käteviä apuskriptejä

`bin/docker-compose`-skriptin lisäksi Toolkit tarjoaa käteviä skriptejä yleisten tehtävien helpottamiseksi:

* `bin/up`: pikakomento komennolle `bin/docker-compose up`
* `bin/start`: pikakomento komennolle `bin/docker-compose start`
* `bin/stop`: pikakomento komennolle `bin/docker-compose stop`
* `bin/shell`: käynnistää komentotulkin **sharelatex**-kontin sisällä
* `bin/doctor`: skripti, jolla kerätään asennus- ja käyttöönottotietoja. Katso alla oleva osio ”Palvelimen tarkistaminen”
* `bin/mongo`: käynnistää komentotulkin **mongo**-kontin sisällä ja vaihtaa oikeaan tietokantaan (**sharelatex**)
* `bin/backup-config`: luo kopion (zip tai tar) nykyisestä konfiguraatiostasi ja tallentaa sen valitsemaasi kohdehakemistoon
* `bin/logs`: näytä/seuraa palveluiden lokeja
* `bin/error-logs`: näytä/seuraa palveluiden virhelokeja
* `bin/rename-env-vars-5-0`: siirtoskripti, joka päivittää ympäristömuuttujat tiedostossa **config/variables.env** (nimenmuutos ShareLaTeXista Overleafiksi)
* `bin/rename-rc-vars`: siirtoskripti, joka päivittää ympäristömuuttujat tiedostossa **config/overleaf.rc** (nimenmuutos ShareLaTeXista Overleafiksi)
* `bin/run-script`: apuskripti, joka helpottaa **sharelatex**-konttiin tallennettujen skriptien ajamista
* `bin/upgrade`: avustaa instanssin päivityksissä. Skripti tarkistaa Toolkitin päivitykset (gitin kautta) ja tarjoutuu hakemaan muutokset, tarkistaa uusimman Docker-imagen version ja tarjoutuu päivittämään sen. Se pyytää vahvistuksen vaihe vaiheelta, tarjoaa mahdollisuuden varmuuskopioida nykyisen konfiguraation ja huolehtii Docker-palveluiden pysäyttämisestä ja käynnistämisestä. Lisätietoja on sivulla Käyttöönoton päivittäminen: [https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment](https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment)

<Info>
  Jos haluat ajaa instanssia liittymättä Docker-lokeihin, voit suorittaa `bin/up -d`, jolloin se käynnistyy irrotetussa tilassa.
</Info>

#### Palvelimen tarkistaminen

Overleaf Toolkit sisältää kätevän `bin/doctor`-skriptin, joka tuottaa raportin mahdollisista täyttymättömistä riippuvuuksista.

Ennen kuin jatkat, suorita `bin/doctor`-skripti ja tarkista, että kaikki toimii oikein:

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

Esimerkkituloste (lyhennetty/havainnollistava):

<Accordion title="Esimerkkituloste komennosta 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>

Jos riippuvuuksia puuttuu, doctor tulostaa varoituksia. Jos kohtaat ongelmia, suorita ensin `bin/doctor` ja tarkista sen tulosteesta mahdolliset varoitukset.

<Info>
  * Ayakaleaf Pro -version käyttäjät voivat avata issuen GitHubissa: [https://github.com/ayaka-notes/toolkit/issues](https://github.com/ayaka-notes/toolkit/issues)

  Liitä molemmissa tapauksissa viestiisi `bin/doctor`-komennon tuloste.
</Info>


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