> 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/fi/aloittaminen/what-is-the-overleaf-toolkit.md). # Mikä on Overleaf Toolkit? Overleaf Toolkit on suositeltu käyttöönottotapa Community Editionin, Server Pron tai Overleaf Pron paikallisiin asennuksiin, ja se on suunniteltu toimimaan yleisimmän ympäristön kanssa: yhdellä fyysisellä palvelimella tai virtuaalikoneella. Toolkit käyttää `docker compose` palvelimesi Docker-säilöiden hallintaan ja tarjoaa joukon skriptejä, jotka käärittävät `docker` -komentoja auttaakseen Overleafin paikallisen version hallinnan teknisemmässä osassa. #### The `bin/docker-compose` kääre The `bin/docker-compose` skripti on kääre `docker compose`. Se lataa asetukset `config/` hakemistosta ennen kuin se kutsuu `docker compose` sillä argumenteilla, jotka skriptille annettiin. Voit käsitellä `bin/docker-compose` läpinäkyvänä kääreenä `docker compose` ohjelmalle, joka on asennettu koneellesi. Esimerkki: {% code title="Tarkista käynnissä olevat kontit" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Kätevät apuohjelmat Lisäksi `bin/docker-compose`, Toolkit tarjoaa käteviä skriptejä tavallisten tehtävien helpottamiseksi: * `bin/up`: pikakuvake `komennolle bin/docker-compose up` * `bin/start`: pikakuvake `bin/docker-compose start` * `bin/stop`: pikakuvake `bin/docker-compose stop` * `bin/shell`: käynnistää komentotulkin **sharelatex** säiliön sisällä * `bin/doctor`: skripti, jota käytetään asennus- ja käyttöönottotietojen keräämiseen. Katso alla oleva osio "Palvelimesi tarkistaminen" * `bin/mongo`: käynnistää komentotulkin **mongo** säiliöön ja vaihtaa oikeaan tietokantaan (**sharelatex**) * `bin/backup-config`: luo kopion (zip- tai tar-muodossa) nykyisestä kokoonpanostasi ja tallentaa sen valitsemaasi kohdehakemistoon * `bin/logs`: katso/päivitä palvelulogit * `bin/error-logs`: katso/päivitä palvelun virhelokit * `bin/rename-env-vars-5-0`: migraatioskripti ympäristömuuttujien päivittämiseksi tiedostossa **config/variables.env** (uudelleenbrändäys ShareLaTeXista Overleafiin) * `bin/rename-rc-vars`: migraatioskripti ympäristömuuttujien päivittämiseksi tiedostossa **config/overleaf.rc** (uudelleenbrändäys ShareLaTeXista Overleafiin) * `bin/run-script`: apuohjelma, joka yksinkertaistaa skriptien suorittamista **sharelatex** säiliön sisällä * `bin/upgrade`: auttaa instanssin päivityksissä. Skripti tarkistaa Toolkit-päivitykset (gitin kautta) ja tarjoaa muutosten noutamista, tarkistaa uudemman Docker-kuvan version ja tarjoaa sen päivittämistä. Se tarjoaa vaiheittaisen vahvistuksen, mahdollisuuden varmuuskopioida nykyinen kokoonpano sekä huolehtii Docker-palvelujen pysäyttämisestä ja käynnistämisestä. Katso lisätietoja kohdasta Käyttöönoton päivittäminen: {% hint style="info" %} Jos haluat mieluummin ajaa instanssiasi ilman yhteyttä Docker-lokeihin, voit suorittaa komennon `bin/up -d` ajon irrotetussa tilassa. {% endhint %} #### Palvelimesi tarkistaminen Overleaf Toolkit sisältää kätevän skriptin nimeltä `bin/doctor` joka tuottaa raportin, joka osoittaa kaikki täyttämättömät riippuvuudet. Ennen kuin jatkat, suorita `bin/doctor` skripti ja tarkista, että kaikki toimii oikein: {% code title="Aja Overleaf Doctor" %} ```bash bin/doctor ``` {% endcode %} Esimerkkituloste (lyhennetty/kuvaava):
Esimerkkituloste komennosta bin/doctor ``` ====== Overleaf Doctor ====== - Palvelintiedot - Linux - komennon 'lsb_release -a' tuloste: Mitään LSB-moduuleja ei ole saatavilla. Jakelijan tunnus: Ubuntu Kuvaus: Ubuntu 22.04.5 LTS Julkaisu: 22.04 Koodinimi: jammy - Riippuvuudet - bash - tila: löytyy - versiotiedot: 5.1.16(1)-release - docker - tila: löytyy - versiotiedot: Dockerin versio 27.3.1, build ce12230 - realpath - tila: löytyy - versiotiedot: realpath (GNU coreutils) 8.32 - perl - tila: löytyy - versiotiedot: 5.034000 - awk - tila: löytyy - versiotiedot: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - tila: löytyy - versiotiedot: OpenSSL 3.0.2 15 Mar 2022 (Kirjasto: OpenSSL 3.0.2 15 Mar 2022) - docker compose - tila: löytyy - versiotiedot: Docker Compose -versio v2.29.7 - Docker-daemon - tila: käynnissä ====== Kokoonpano ====== - config/version - tila: löytyy - versio: 5.1.1 - config/overleaf.rc - tila: löytyy - arvot - OVERLEAF_DATA_PATH: data/overleaf - OVERLEAF_LOG_PATH: data/overleaf/logs - SERVER_PRO: true - kirjautunut quay.io:hon: 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 - tila: löytyy - arvot - OVERLEAF_FILESTORE_BACKEND: fs - OVERLEAF_HISTORY_BACKEND: fs ====== Varoitukset ====== - Ei mitään, kaikki kunnossa ====== Loppu ====== ```
Jos joitakin riippuvuuksia puuttuu, doctor tulostaa varoituksia. Jos kohtaat ongelmia, suorita ensin `bin/doctor` ja tarkista sen tulosteesta varoitukset. {% hint style="info" %} * Ilmaisen Community Editionin käyttäjien tulisi avata ongelma GitHubissa: * Server Pron käyttäjien tulisi ottaa yhteyttä tukeen: mailto: Molemmissa tapauksissa sisällytä viestiisi `bin/doctor` tuloste. {% 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/fi/aloittaminen/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.