FUSS - Manuale per il tecnico

(1)

FUSS - Manuale per il tecnico

Release 0.1

FUSS Lab

May 26, 2019

(2)

(3)

CHAPTER 1 Quickstart

Questa è intesa come procedura essenziale per poter avviare il programma.

I passi di questa guida sono intesi su sistemi *nix derivati da Debian e che utilizzino apt come package manager.

1.1 Ambiente virtuale (opzionale)

Se si vuole utilizzare un virtual environment per isolare l’installazione, procedere con l’installazione di python3-virtualenvper avviare l’ambiente:

# apt install python3-virtualenv

Si può quindi avviare l’ambiente ed iniziare ad utilizzarlo

$ virtualenv --python=python3 venv

$ . venv/bin/activate

1.2 Ottenere una copia del sorgente

Può essere scaricata direttamente dal repository o richiedendo copia dell’archivio compresso via e-mail.

(venv)$ git clone https://work.fuss.bz.it/git/gestione-piano-aggiornamento

1.3 Installare le dipendenze

(venv)$ cd gestione-piano-aggiornamento (venv)$ pip3 install -r requirements.txt

alcune librerie utilizzano libreria di sistema che devono essere installate col package manager di sistema. Con- sultare la documentazione della singola dipendenza in caso di errori.

3

(8)

1.4 Configurare le personalizzazioni

Si faccia riferimento alla sezione “settings.py”

1.5 Creare le migrazioni

Le migrazioni sono le entità che Django utilizza per mantenere traccia della struttura del database che sta utiliz- zando e quella disegnata dallo sviluppatore nei modelli. Per ogni installazione è necessario generare le migrazioni dopo aver collegato Django al database.

(venv)$ python3 manage.py makemigrations updates upmin certificates poll

1.6 Creare il database ed un utente

L’username di tutti gli utenti che devono accedere alla piattaforma devono essere indirizzi e-mail validi e che terminino con un dominio autorizzato nel file settings.

(venv)$ python3 manage.py migrate

(venv)$ python3 manage.py createsuperuser [email protected] --email=

1.7 Importare i template e-mail

Il sistema utilizza dei template di post-office per inviare le email che devono essere preventivamente caricati dai template salvati nel repository.

(venv)$ python3 manage.py shell -c 'import scripts.importa_templatemail'

4 Chapter 1. Quickstart

(9)

CHAPTER 2 File settings.py

Il file settings.py definisce tutte le impostazioni essenziali di Django. Può essere esteso con personalizzazioni caratteristiche dell’installazione nel file settings_local.py le cui variabili sovrascriveranno quelle contenute nel settings.py.

• EDUCATIONAL_AREAS: questa variabile contiene le aree nelle quali sono suddivisi i corsi di aggiornamento

# Elenco aree

EDUCATIONAL_AREAS = [

("1","Innovazione didattica"),

("2","Valutazione delle competenze"), ("3","Orientamento"),

("4","Cittadinanza e coesione sociale") ]

• ALLOWED_MAILS: è una lista che contiene i provider e-mail autorizzati all’accesso.

# Indirizzi e-mail per il login ALLOWED_MAILS = [

"@scuola.alto-adige.it",

"@provincia.bz.it",

"@fuss.bz.it"

]

• [post_office] DEFAULT_FROM_EMAIL: questa variabile contiene il mittente di default per le email inviate da parte della piattaforma

# Invio e-mail

DEFAULT_FROM_EMAIL = "FUSS Corsi di aggiornamento <[email protected]>"

• [post_office] POST_OFFICE: dizionario di configurazione “avanzata” di post_office. Il valore de- fault_priority fa sì che le email vengano inviate istantaneamente. Ciò accelera le procedure che richiedono l’uso dell’e-mail

POST_OFFICE = {

"DEFAULT_PRIORITY": "now", }

• [django-sites] SITE_ID: indica l’ID nel database del sito attualmente in uso

5

(10)

(default: example.com , modificare da admin) SITE_ID = 1

• [password_reset] PASSWORD_RESET_TOKEN_EXPIRES: configura la durata del token generato per il recupero della password. Di default è impostato a 2 ore.

PASSWORD_RESET_TOKEN_EXPIRES = 7200 # 2 hours

6 Chapter 2. File settings.py

(11)

CHAPTER 3 Contribuisci

Chiunque può contribuire a migliorare questa documentazione che è scritta inreStructuredText.

3.1 Autori

• Piergiorgio Cemin

• Marco Marinello

I dettagli e lo storico dei contributi sono disponibili sulrepository git.

7

(12)

8 Chapter 3. Contribuisci

(13)

CHAPTER 4 Licenze

9

FUSS - Manuale per il tecnico