> For the complete documentation index, see [llms.txt](https://ayakaleaf-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://ayakaleaf-pro.ayaka.space/on-premises/it/per-iniziare/what-is-the-overleaf-toolkit.md). # Che cos'è l'Ayakaleaf Toolkit? Il toolkit ayakaleaf è il metodo di distribuzione consigliato per le installazioni on-premises della Community Edition, Ayakaleaf 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 per `docker` i comandi per aiutare con la parte più tecnica 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 tutti gli argomenti passati 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 aiutare con le 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** container * `bin/doctor`: script usato per raccogliere informazioni sull'installazione e sul deployment. Vedi la sezione "Controllare il tuo server" qui sotto * `bin/mongo`: avvia una shell all'interno del **mongo** container e passa al database corretto (**sharelatex**) * `bin/backup-config`: crea una copia (zip o tar) della tua configurazione attuale e salvala in una directory di destinazione a tua scelta * `bin/logs`: visualizza/segui i log del servizio * `bin/error-logs`: visualizza/segui 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`: strumento di supporto per semplificare l'esecuzione di script memorizzati all'interno del **sharelatex** container * `bin/upgrade`: aiuta con gli aggiornamenti dell'istanza. Lo script controllerà gli aggiornamenti del Toolkit (tramite git) e offrirà di scaricare le modifiche, controllerà l'ultima versione dell'immagine Docker e offrirà di aggiornarla. Fornisce conferma passo dopo passo, l'opzione per eseguire il backup della configurazione attuale e gestisce l'arresto/l'avvio dei servizi Docker. Vedi Aggiornare il tuo deployment per maggiori informazioni: {% hint style="info" %} Se preferisci eseguire la tua istanza senza collegarti ai log di Docker puoi eseguire `bin/up -d` per eseguire in modalità detached. {% endhint %} #### Controllo del tuo server L'Overleaf Toolkit include un pratico script chiamato `bin/doctor` che produce un report che indica eventuali dipendenze non soddisfatte. Prima di continuare, esegui lo `bin/doctor` script e controlla che tutto funzioni correttamente: {% code title="Esegui Overleaf Doctor" %} ```bash bin/doctor ``` {% endcode %} Esempio di output (troncato/illustrativo):
Output di esempio da 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 Versione: 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 (Libreria: 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 eseguito 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 incontri problemi, esegui prima `bin/doctor` e controllane l'output per individuare eventuali avvisi. {% hint style="info" %} * Gli utenti della Ayakaleaf Pro Edition possono aprire una issue su GitHub: 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://ayakaleaf-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.