> 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/it/per-iniziare/what-is-the-overleaf-toolkit.md). # Che cos'è l'Overleaf Toolkit? Overleaf Toolkit è il metodo di distribuzione consigliato per le installazioni on-premises della Community Edition, Server Pro o Overleaf Pro; è stato progettato per funzionare con l'ambiente più comune: un singolo server fisico o una macchina virtuale. Il Toolkit utilizza `docker compose` per gestire i container Docker del tuo server e fornisce un insieme di script che fanno da wrapper a `docker` comandi per aiutare con gli aspetti più tecnici della gestione di una versione on-premises di Overleaf. #### Il `bin/docker-compose` wrapper Il `bin/docker-compose` script è un wrapper attorno a `docker compose`. Carica la configurazione da `config/` directory, prima di invocare `docker compose` con qualunque argomento sia stato passato allo script. Puoi considerare `bin/docker-compose` come un wrapper trasparente per il `docker compose` programma installato sulla tua macchina. Esempio: {% code title="Controlla i container in esecuzione" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Script di utilità Oltre a `bin/docker-compose`, il Toolkit fornisce script utili per aiutarti con attività comuni: * `bin/up`: scorciatoia per `bin/docker-compose up` * `bin/start`: scorciatoia per `bin/docker-compose start` * `bin/stop`: scorciatoia per `bin/docker-compose stop` * `bin/shell`: avvia una shell all'interno del **sharelatex** contenitore * `bin/doctor`: script utilizzato per raccogliere informazioni sull'installazione e sulla distribuzione. Vedi la sezione "Checking your server" qui sotto * `bin/mongo`: avvia una shell all'interno del **mongo** contenitore e passa al database corretto (**sharelatex**) * `bin/backup-config`: crea una copia (zip o tar) della configurazione attuale e salvala in una directory di destinazione a tua scelta * `bin/logs`: visualizza/scorri i log del servizio * `bin/error-logs`: visualizza/scorri i log degli errori del servizio * `bin/rename-env-vars-5-0`: script di migrazione per aggiornare le variabili d'ambiente in **config/variables.env** (rebranding da ShareLaTeX a Overleaf) * `bin/rename-rc-vars`: script di migrazione per aggiornare le variabili d'ambiente in **config/overleaf.rc** (rebranding da ShareLaTeX a Overleaf) * `bin/run-script`: utilità per semplificare l'esecuzione di script archiviati all'interno del **sharelatex** contenitore * `bin/upgrade`: aiuta con gli aggiornamenti dell'istanza. Lo script controllerà la presenza di aggiornamenti del Toolkit (tramite git) e offrirà di scaricare le modifiche, controllerà la versione più recente dell'immagine Docker e offrirà di aggiornarla. Fornisce conferma passo per passo, l'opzione di eseguire il backup della configurazione attuale e gestisce l'arresto/avvio dei servizi Docker. Per ulteriori informazioni, vedi Aggiornamento della tua distribuzione: {% hint style="info" %} Se preferisci eseguire la tua istanza senza collegarti ai log di Docker, puoi eseguire `bin/up -d` per eseguirlo in modalità detached. {% endhint %} #### Controllo del tuo server Overleaf Toolkit include un pratico script chiamato `bin/doctor` che genera un report che indica eventuali dipendenze non soddisfatte. Prima di continuare, esegui lo `bin/doctor` script e verifica che tutto funzioni correttamente: {% code title="Esegui Overleaf Doctor" %} ```bash bin/doctor ``` {% endcode %} Esempio di output (troncato/illustrativo):
Esempio di output di bin/doctor ``` ====== Overleaf Doctor ====== - Informazioni sull'host - Linux - Output di 'lsb_release -a': Non sono disponibili moduli LSB. ID distributore: Ubuntu Descrizione: Ubuntu 22.04.5 LTS Rilascio: 22.04 Nome in codice: jammy - Dipendenze - bash - stato: presente - info versione: 5.1.16(1)-release - docker - stato: presente - info versione: Docker version 27.3.1, build ce12230 - realpath - stato: presente - info versione: realpath (GNU coreutils) 8.32 - perl - stato: presente - info versione: 5.034000 - awk - stato: presente - info versione: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - stato: presente - info versione: OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022) - docker compose - stato: presente - info versione: Docker Compose version v2.29.7 - Demone Docker - stato: attivo ====== Configurazione ====== - config/version - stato: presente - versione: 5.1.1 - config/overleaf.rc - stato: presente - valori - OVERLEAF_DATA_PATH: data/overleaf - OVERLEAF_LOG_PATH: data/overleaf/logs - SERVER_PRO: true - accesso effettuato a 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 - stato: presente - valori - OVERLEAF_FILESTORE_BACKEND: fs - OVERLEAF_HISTORY_BACKEND: fs ====== Avvisi ====== - Nessuno, tutto bene ====== Fine ====== ```
Se mancano dipendenze, il doctor stamperà avvisi. Se riscontri problemi, esegui prima `bin/doctor` e controlla il suo output per eventuali avvisi. {% hint style="info" %} * Gli utenti della Community Edition gratuita dovrebbero aprire un issue su GitHub: * Gli utenti di Server Pro dovrebbero contattare il supporto: mailto: In entrambi i casi, includi l'output di `bin/doctor` nel tuo messaggio. {% 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/it/per-iniziare/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.