2. Familiarizzare con il Toolkit

​

Diamo un’occhiata

Ora che hai una copia locale del Toolkit, diamo un’occhiata alla struttura del repository usando il comando ls.

Run this

ls -l

Il comando ls -l mostra un elenco dettagliato in formato esteso del contenuto di una directory, fornendo informazioni aggiuntive sui file come permessi, proprietario e dimensione.

Se la clonazione è andata a buon fine, dovresti vedere qualcosa di simile:

drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 bin
-rw-r--r-- 1 fry fry  6465 Aug 30 14:16 CHANGELOG.md
drwxr-xr-x 2 fry fry  4096 Sep  6 12:43 config
drwxr-xr-x 5 fry fry  4096 Aug 30 14:22 data
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 doc
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 lib
-rw-r--r-- 1 fry fry 34520 Aug 30 14:16 LICENSE
-rw-r--r-- 1 fry fry  1178 Aug 30 14:16 README.md

Tutti i file di configurazione di proprietà dell’utente si trovano nella directory config/. Questa directory è esclusa dal sistema di controllo di versione git, quindi non verrà modificata dall’aggiornamento del Toolkit.

​

Struttura del repository

Nome	Descrizione
bin	Questa cartella contiene una raccolta di script che ti aiutano a gestire la tua istanza del server Overleaf. Puoi leggere di più su questi script nella sezione Comandi più avanti.
config	Questa cartella contiene i tuoi file di configurazione locali.
lib	Questa cartella contiene i file di configurazione di base utilizzati dal Toolkit.
data	Per impostazione predefinita, questa cartella contiene la posizione di archiviazione per MongoDb, Redis e Overleaf. Per ulteriori informazioni, consulta la sezione Dati persistenti più avanti.

Ti consigliamo di non modificare direttamente i file al di fuori della cartella /config. Se invece devi apportare modifiche, puoi farlo tramite variabili d’ambiente impostate in config/variables.env o config/overleaf.rc.
Ad esempio, per impostare l’immagine del servizio mongo, invece di modificare direttamente lib/docker-compose.mongo.yml, imposta l’immagine usando la variabile d’ambiente MONGO_IMAGE in config/overleaf.rc. Per ulteriori informazioni, consulta la pagina Impostazioni del Toolkit.

Il Toolkit non modificherà alcun dato nella directory config/ senza il tuo permesso.

​

Comandi

Esegui questi script dalla directory del Toolkit. Ognuno mostra le proprie opzioni con --help.

Comando	Cosa fa
bin/init	Crea i file di configurazione in config/ la prima volta. bin/init --tls aggiunge la configurazione del proxy TLS NGINX.
bin/up	Crea e avvia i container (bin/docker-compose up). Aggiungi -d per eseguirli in background invece di seguire i log. Eseguilo dopo ogni modifica in config/: ricrea i container la cui configurazione è cambiata.
bin/start	Riavvia i container esistenti (bin/docker-compose start). Non applica le modifiche alla configurazione.
bin/stop	Arresta i container e li conserva (bin/docker-compose stop).
bin/docker-compose	Esegue docker compose con i file del Toolkit, ad esempio bin/docker-compose ps o bin/docker-compose restart sharelatex.
bin/logs	Mostra o segue i log di uno o più servizi, ad esempio bin/logs -f web.
bin/error-logs	Come bin/logs, ma mostra solo gli errori.
bin/shell	Apre una shell all’interno del container sharelatex.
bin/mongo	Apre una shell MongoDB sul database sharelatex.
bin/run-script	Esegue uno script incluso nel container sharelatex.
bin/doctor	Controlla l’host e la configurazione e stampa un report da condividere quando chiedi aiuto.
bin/images	Elenca le immagini Docker di Overleaf presenti sull’host.
bin/backup-config	Copia la directory config/ in una posizione di backup (copia, zip o tar).
bin/upgrade	Aggiorna passo dopo passo il Toolkit e l’immagine di Overleaf, vedi Aggiornare la distribuzione.
bin/rename-env-vars-5-0, bin/rename-rc-vars	Migrazioni una tantum dei vecchi nomi di variabile SHARELATEX_* in OVERLEAF_*.

Quando bin/up ricrea un container, tutto ciò che è stato modificato al suo interno va perso, ad esempio i pacchetti installati o i file modificati tramite bin/shell. Vengono conservate solo le directory dei dati (data/ per impostazione predefinita) e config/. Apporta invece le modifiche permanenti tramite config/variables.env, config/overleaf.rc o config/docker-compose.override.yml.

Se ogni bin/up disconnette tutti gli utenti, imposta OVERLEAF_SESSION_SECRET. Senza di essa i cookie di sessione vengono firmati con un secret che viene rigenerato ogni volta che il container viene ricreato, vedi le Q&A in Variabili d’ambiente.