Vai al contenuto

🛠️ Strumenti da Riga di Comando

LibreFolio fornisce lo script dev.py per le attività di amministrazione. Questa pagina copre i comandi più rilevanti per gli amministratori di sistema.

Contesto dell'Ambiente Virtuale Python

Se si esegue LibreFolio direttamente sulla macchina host, tutte le operazioni da riga di comando devono essere eseguite all'interno dell'ambiente virtuale Python. È possibile anteporre pipenv run a ciascun comando (es. pipenv run ./dev.py server) oppure accedere all'ambiente virtuale una sola volta eseguendo pipenv shell.

Se ci si trova all'interno del terminale di un container Docker (ad esempio, accedendovi tramite docker exec), non è necessario usare pipenv run o pipenv shell, poiché le dipendenze sono preinstallate a livello globale all'interno dell'immagine del container. È possibile eseguire direttamente i comandi ./dev.py.

👩‍💻 Per gli Sviluppatori

Per i comandi specifici per lo sviluppo (build del frontend, test runner, sincronizzazione API, audit i18n), consulta la Guida al Workflow per Sviluppatori.

🖥️ Server (Produzione)

▶️ Avvio del Server

# Standard start
pipenv run ./dev.py server

# With auto-calculated workers (2 × (CPU-1))
pipenv run ./dev.py server --workers N

# Kill existing process on port before starting
pipenv run ./dev.py server --force

Multi-worker

Per la produzione, usa --workers per eseguire più worker Uvicorn. Questo migliora il throughput ed è raccomandato per qualsiasi deployment con più di 1 core CPU.

👤 Gestione Utenti

La gestione degli utenti avviene tramite i sottocomandi di ./dev.py user:

# Create a user (first user becomes admin automatically)
pipenv run ./dev.py user create <username> <email> <password>

# List all users
pipenv run ./dev.py user list

# Reset a user's password
pipenv run ./dev.py user reset <username> <new_password>

# Promote a user to admin
pipenv run ./dev.py user promote <username>

# Demote an admin to regular user
pipenv run ./dev.py user demote <username>

⚙️ Gestione di Sistema

🔧 Inizializza Impostazioni Globali

pipenv run ./dev.py user init-settings

Inserisce i dati predefiniti delle Impostazioni Globali nel database se non esistono già.

🗄️ Migrazioni del Database

# Apply pending migrations
pipenv run ./dev.py db upgrade

🗄️ Reset del Database

pipenv run ./dev.py db create-clean ricrea il database da zero — tutti i dati andranno persi. Usalo solo se hai bisogno di un nuovo inizio.

📚 Documentazione

# Build and deploy MkDocs documentation to GitHub Pages
pipenv run ./dev.py mkdocs deploy

# Generate gallery screenshots (requires running server + test data)
pipenv run ./dev.py mkdocs gallery

📋 Albero Completo dei Comandi

Per un elenco completo di tutti i comandi disponibili:

pipenv run ./dev.py --help

👩‍💻 Comandi per Sviluppatori

Comandi aggiuntivi per i flussi di lavoro di sviluppo: