Aggironamento documentazione
This commit is contained in:
Thomas Zilio
parent
66b20731e0
commit
30227465c8
|
|
@ -49,6 +49,9 @@ menu:
|
|||
moduli:
|
||||
text: Moduli
|
||||
relativeUrl: moduli.html
|
||||
upload:
|
||||
text: Gestione degli upload
|
||||
relativeUrl: upload.html
|
||||
widget:
|
||||
text: Plugin
|
||||
relativeUrl: widget.html
|
||||
|
|
|
|||
13
docs/API.md
13
docs/API.md
|
|
@ -13,6 +13,7 @@ Di seguito sono elencate le basi per connettersi al sistema e ottenere i dati a
|
|||
|
||||
<!-- TOC depthFrom:2 depthTo:6 orderedList:false updateOnSave:true withLinks:true -->
|
||||
|
||||
- [Requisiti aggiuntivi](#requisiti-aggiuntivi)
|
||||
- [Standard di comunicazione](#standard-di-comunicazione)
|
||||
- [Ottenere la chiave](#ottenere-la-chiave)
|
||||
- [Formato dei componenti](#formato-dei-componenti)
|
||||
|
|
@ -29,6 +30,18 @@ Di seguito sono elencate le basi per connettersi al sistema e ottenere i dati a
|
|||
|
||||
<!-- /TOC -->
|
||||
|
||||
## Requisiti aggiuntivi
|
||||
|
||||
Per rendere la gestione dell'API maggiormente mantenibile e unificata, il suo funzionamento è stato sottoposto al seguente requisito aggiuntivo:
|
||||
|
||||
- MySQL >= 5.6.5
|
||||
|
||||
Se queste requisito non viene soddisfatto, l'installazione del gestionale procederà correttamente, ma i tentativi di connessione con l'API saranno rifiutati con il codice di errore `503` e lo stato `Servizio non disponibile`.
|
||||
|
||||
Nel caso, a seguito dell'installazione di OpenSTAManager, venisse aggiornato il servizio MySQL per permettere il funzionamento dell'API, sarà necessaro causare l'esecuzione della procedura di aggiornamento del gestionale, che organizzarà correttamente il database per la compatibilità con l'API.
|
||||
|
||||
**Attenzione**: il solo aggiornamento del servizio MySQL senza il successivo aggiornamento del gestionale potrebbe causare malfunzionamenti di vario genere nell'utilizzo dell'API.
|
||||
|
||||
## Standard di comunicazione
|
||||
|
||||
Il funzionamento dell'API si basa fondamentalmente sull'utilizzo di una chiave di accesso, ospitata all'interno della tabella `zz_tokens` del database del progetto, univoca per ogni istanza dell'utente.
|
||||
|
|
|
|||
|
|
@ -10,18 +10,24 @@ Esistono due procedure ufficiale per effettuare l'aggiornamento di OpenSTAManage
|
|||
|
||||
In ogni caso, il corretto procedimento prevede di [scaricare una release ufficiale del progetto](https://github.com/devcode-it/openstamanager/releases) ed **effettuare un backup della versione corrente** (comprensivo di file e database).
|
||||
|
||||
<!-- TOC depthFrom:2 depthTo:6 orderedList:false updateOnSave:true withLinks:true -->
|
||||
|
||||
- [Aggiornamento semplificato](#aggiornamento-semplificato)
|
||||
- [Aggiornamento manuale](#aggiornamento-manuale)
|
||||
- [Migrazione dalla versione 1.x](#migrazione-dalla-versione-1x)
|
||||
- [Reimpostare la password di admin](#reimpostare-la-password-di-admin)
|
||||
- [Recupero della password](#recupero-della-password)
|
||||
- [Account comune](#account-comune)
|
||||
- [Account amministrativo](#account-amministrativo)
|
||||
|
||||
<!-- /TOC -->
|
||||
|
||||
## Aggiornamento semplificato
|
||||
|
||||
La procedura di aggiornamento semplificato ha l'obiettivo di fornire un sistema di facile utilizzo per favorire l'aggiornamento, e migliorare in questo modo l'interazione con l'utente finale.
|
||||
|
||||
L'utilizzo di questa procedura è però sottoposto alla seguenti condizioni nelle impostazioni PHP:
|
||||
- upload_max_filesize >= 16MB
|
||||
- post_max_size >= 16MB
|
||||
- `upload_max_filesize` >= 16MB
|
||||
- `post_max_size` >= 16MB
|
||||
|
||||
Di seguito la procedura:
|
||||
1. Accedere con un account amministrativo
|
||||
|
|
@ -36,7 +42,7 @@ La procedura di aggiornamento manuale è resa disponibile per ovviare ai problem
|
|||
|
||||
Di seguito la procedura:
|
||||
1. De-comprimere il contenuto del file _.zip_ in una cartella temporanea
|
||||
2. Rinominare il file VERSION dell'installazione corrente in VERSION.old (rispettando minuscole e maiuscole) [facoltativo a partire dalla versione 2.3]
|
||||
2. Rinominare il file `VERSION` dell'installazione corrente in `VERSION.old` (rispettando minuscole e maiuscole) [facoltativo a partire dalla versione 2.3]
|
||||
3. Copiare i file della nuova versione dalla cartella temporanea alla cartella del server, in modo che le cartelle principali (`files`, `modules`, `templates`, ...) vengano sovrascritte
|
||||
|
||||
Dopo l'esecuzione di queste azioni, il gestionale effettuerà automaticamente il logout di tutti gli utenti connessi e renderà disponibile l'interfaccia di aggiornamento.
|
||||
|
|
@ -59,14 +65,25 @@ Dopo l'esecuzione di queste azioni, il gestionale renderà disponibile l'interfa
|
|||
|
||||
**Attenzione**: le stampe di _Interventi_, _Riepilogo interventi_, _Contratti_ e _Preventivi_ potrebbero non essere compatibili per via dell’aggiornamento degli orari di lavoro, perciò è possibile riscrivere solo la parte di calcolo ore o partire dal template nuovo e apportare le dovute modifiche.
|
||||
|
||||
## Reimpostare la password di admin
|
||||
## Recupero della password
|
||||
|
||||
Non esiste una procedura semplificata per permettere la reimpostazione o il recupero della password dell'account di amministrazione di default (_admin_).
|
||||
Non esiste una procedura semplificata per permettere il recupero della password degli account di amministrazione (di default, _admin_) o di quelli comuni.
|
||||
Si ricorda che è comunque possibile **cambiare** la password in ogni momento, se è stato effettuato l'accesso, attraverso l'utilizzo del modulo **Utenti e permessi** (**Gestione permessi** per versioni precedenti alla 2.3) disponibile sotto la dicitura **Strumenti**.
|
||||
|
||||
Può però essere necessario procedere alla sua reimpostazione, sia perché l'account _admin_ viene utilizzato da più persone o perché è stata dimenticata.
|
||||
In questi casi, per procedere è necessario accedere al database ed eseguire la seguente query:
|
||||
```sql
|
||||
UPDATE `zz_utenti` SET password = MD5('nuova_password') WHERE username = 'admin';
|
||||
```
|
||||
Può però essere necessario **reimpostare** la password, in particolare se è stata dimenticata, per ripristinare l'accesso ad OpenSTAManager.
|
||||
|
||||
Si ricorda che è comunque possibile cambiare la password in ogni momento, se è stato effettuato l'accesso, attraverso l'utilizzo del modulo **Utenti e permessi**.
|
||||
### Account comune
|
||||
|
||||
Per procedere alla reimpostazione della password di un account comune (non amministrativo) è necessario accedere con un account amministrativo e utilizzare il modulo **Utenti e permessi** (**Gestione permessi** per versioni precedenti alla 2.3), disponibile sotto la dicitura **Strumenti**.
|
||||
In particolare, una volta entrati nella corretta categoria di accesso (_Agenti_, _Amministratori_, _Clienti_, ...) dell'account da modificare, è possibile utilizzare la procedura semplificata di cambio password attraverso l'_icona del lucchetto aperto_.
|
||||
|
||||
Nel caso non sia possibile accedere con un account amministrativo, contattare l'amministratore.
|
||||
|
||||
### Account amministrativo
|
||||
|
||||
Per reimpostare la password di un account amministrativo è possibile procedere in due modi:
|
||||
- Se esiste un altro account amministrativo, seguire la procedura precedente per gli account comuni;
|
||||
- Accedere al database ed eseguire la seguente query:
|
||||
```sql
|
||||
UPDATE `zz_utenti` SET password = MD5('nuova_password') WHERE username = 'admin';
|
||||
```
|
||||
|
|
|
|||
|
|
@ -26,13 +26,13 @@ Segue un'analisi della struttura fisica e logica del nucleo dei moduli supportat
|
|||
- [actions.php](#actionsphp)
|
||||
- [add.php e edit.php](#addphp-e-editphp)
|
||||
- [init.php](#initphp)
|
||||
- [controller_after.php e controller_before.php](#controller_afterphp-e-controller_beforephp)
|
||||
- [controller_after.php e controller_before.php](#controllerafterphp-e-controllerbeforephp)
|
||||
- [modutil.php](#modutilphp)
|
||||
- [Database](#database)
|
||||
- [zz_modules](#zz_modules)
|
||||
- [zz_permissions e zz_group_module](#zz_permissions-e-zz_group_module)
|
||||
- [zz_views e zz_group_view](#zz_views-e-zz_group_view)
|
||||
- [zz_plugins e zz_widgets](#zz_plugins-e-zz_widgets)
|
||||
- [zz_modules](#zzmodules)
|
||||
- [zz_permissions e zz_group_module](#zzpermissions-e-zzgroupmodule)
|
||||
- [zz_views e zz_group_view](#zzviews-e-zzgroupview)
|
||||
- [zz_plugins e zz_widgets](#zzplugins-e-zzwidgets)
|
||||
- [Consigli per lo sviluppo](#consigli-per-lo-sviluppo)
|
||||
- [Progettazione](#progettazione)
|
||||
- [Sviluppo](#sviluppo)
|
||||
|
|
@ -40,7 +40,7 @@ Segue un'analisi della struttura fisica e logica del nucleo dei moduli supportat
|
|||
- [Installazione](#installazione)
|
||||
- [Archivio ZIP](#archivio-zip)
|
||||
- [update/VERSIONE.sql](#updateversionesql)
|
||||
- [update/unistall.php (INCLUDE)](#updateunistallphp-include)
|
||||
- [update/unistall.php](#updateunistallphp)
|
||||
- [MODULE](#module)
|
||||
- [Moduli di base](#moduli-di-base)
|
||||
|
||||
|
|
@ -202,7 +202,7 @@ L'archivio scaricato deve contenere direttamente al proprio interno i contenuti
|
|||
|
||||
Il file `VERSIONE.sql` (dove VERSIONE sta per la versione del modulo con `_`[underscore] al posto di `.`[punto]) contiene le operazioni di installazione del modulo a livello del database, comprendenti la creazione delle tabelle di base del modulo e l'inserimento di ulteriori dati nelle altre tabelle.
|
||||
|
||||
#### update/unistall.php (INCLUDE)
|
||||
#### update/unistall.php
|
||||
|
||||
Il file `unistall.php` contiene le operazioni di disinstallazione del modulo a livello del database, comprendenti l'eliminazione delle tabelle non più necessarie e dei dati inutilizzati.
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ Pagina in costruzione.
|
|||
- [HTML2PDF](#html2pdf)
|
||||
- [Struttura](#struttura)
|
||||
- [pdfgen.php](#pdfgenphp)
|
||||
- [pdfgen_variables.php (INCLUDE)](#pdfgenvariablesphp-include)
|
||||
- [pdfgen_variables.php](#pdfgenvariablesphp)
|
||||
- [Struttura interna](#struttura-interna)
|
||||
|
||||
|
||||
|
|
@ -32,7 +32,7 @@ La cartella _templates_ contiene tutti i template per la creazione dei PDF, ragg
|
|||
|
||||
Il file `pdfgen.php` si occupa della formattazione dei contenuti dei template per la visualizzazione vera e propria del PDF, inizializzando l'oggetto relativo ed eseguendone l'output.
|
||||
|
||||
#### pdfgen_variables.php (INCLUDE)
|
||||
#### pdfgen_variables.php
|
||||
|
||||
Il file `pdfgen_variables.php` si occupa della sostituzione delle variabili comuni a tutti i template, e viene richiamata dal file `pdfgen.MODULO.php` descritto di seguito.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
---
|
||||
currentMenu: file
|
||||
currentMenu: upload
|
||||
---
|
||||
|
||||
# File
|
||||
# Gestione degli upload
|
||||
|
||||
Pagina in costruzione.
|
||||
|
||||
La cartella `files` viene utilizzata dal progetto per gestire in modo unificato contenuti di vario tipo per i moduli installati.
|
||||
In generale, questa cartella è dedicata alla memorizzazione dei file di cui viene fatto l'upload attraverso la funzione fornita in automatico dal getionale, ma sono presenti delle specifiche personalizzazioni necessarie per l'adeguato funzionamento di alcuni moduli.
|
||||
Loading…
Reference in New Issue