Avun saaminen

​

Doctor

Overleaf Toolkitin mukana tulee kätevä doctor-skripti vianmäärityksen avuksi. Suorita bin/doctor, niin skripti tulostaa tietoja isäntäympäristöstäsi, konfiguraatiostasi ja Toolkitin tarvitsemista riippuvuuksista. Tämä tuloste voi myös auttaa meitä diagnosoimaan Ayakaleaf Pro -asennustesi ongelmia.

Overleaf Pron käyttäjät voivat avata issuen GitHubissa.

On hyvä idea liittää viestiisi bin/doctor-skriptin tuloste.

​

Doctorin konsultointi

Suorita doctor-skripti:

Run doctor

bin/doctor

Näet alla olevan esimerkin kaltaisen tulosteen.

Esimerkki koko tulosteesta

====== 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 28.0.4, build b8034c0
    - docker compose
        - status: present
        - version info: Docker Compose version v2.34.0
    - realpath
        - status: present
        - version info: realpath (GNU coreutils) 8.32
    - perl
        - status: present
        - version info: 5.034000
    - awk
        - status: present
        - version info: mawk 1.3.4 20200120
- Docker Daemon
    - status: up
====== Configuration ======
- config/version
    - status: present
    - version: 5.4.0
- config/overleaf.rc
    - status: present
    - values
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: data/overleaf/logs
        - SERVER_PRO: true
        - SIBLING_CONTAINERS_ENABLED: true
            - logged in to quay.io: true
        - MONGO_ENABLED: true
        - REDIS_ENABLED: true
- config/variables.env
    - status: present
    - values
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs

====== Warnings ======
- None, all good
====== End ======

​

Isäntäkoneen tiedot

Host Information -osio sisältää tietoja Toolkitia ajavasta koneesta (esimerkiksi Linux-jakelu ja sen versio).

Esimerkki Host Information -tulosteesta

- 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

​

Riippuvuudet

Dependencies-osiossa luetellaan työkalut, joita Toolkit tarvitsee toimiakseen. Jos työkalu on asennettu, se näytetään muodossa status: present versiotietoineen. Jos se puuttuu, se näytetään muodossa status: MISSING!, ja doctor-tulosteen loppuun lisätään varoitus.

Esimerkki Dependency-tulosteesta (asennettu)

- docker
    - status: present
    - version info: Docker version 28.0.4, build b8034c0

Esimerkki Dependency-tulosteesta (puuttuu)

- docker
    - status: MISSING!

Jos riippuvuuksia puuttuu, Toolkit ei lähes varmasti toimi.

​

Konfiguraatio

Configuration-osio sisältää tietoja config/-hakemiston tiedostoista. Tiedostosta config/overleaf.rc doctor tulostaa joitakin keskeisiä arvoja. Puuttuvat tiedostot näytetään muodossa status: MISSING!, ja doctor-tulosteen loppuun lisätään varoitus.

Esimerkki Configuration-tulosteesta

====== Configuration ======
- config/version
    - status: present
    - version: 5.4.0
- config/overleaf.rc
    - status: present
    - values
        - OVERLEAF_DATA_PATH: /tmp/overleaf
        - SERVER_PRO: false
        - MONGO_ENABLED: false
        - REDIS_ENABLED: true
- config/variables.env
    - status: MISSING!

Huomioita yllä olevasta esimerkistä:

• OVERLEAF_DATA_PATH, jonka arvo on /tmp/overleaf, ei välttämättä ole turvallinen sijainti tärkeälle datalle.
• MONGO_ENABLED: false tarkoittaa, että Toolkit ei luo omaa MongoDB:tä; varmista tarvittaessa, että MONGO_URL osoittaa ulkoisesti hallinnoituun MongoDB:hen.
• config/variables.env puuttuu esimerkissä.

​

Varoitukset

Warnings-osio tiivistää doctor-skriptin havaitsemat ongelmat. Jos ongelmia ei ole, osio ilmoittaa siitä.

Esimerkki Warnings-tulosteesta

====== Warnings ======
- configuration file variables.env not found
- rc file, OVERLEAF_DATA_PATH not set
====== End =======