SimplePHPdocs

25/11/2023

Un comodo sistema per la documentazione stile wiki, basato su file e cartelle


Negli ultimi tempi, presso Fablab Imperia, stavamo cercando di ridurre la complessità della nostra infrastruttura di rete. Con il trascorrere degli anni si erano accumulati svariati servizi: uno per la mail, uno per il sito principale, uno per la Wiki, uno per l'autenticazione utenti, e così via.

Di conseguenza, è nata la necessità di semplificarne la gestione. Da qui nasce l'idea di SimplePHPdocs: un sistema per la documentazione basato su semplici file e cartelle, senza bisogno di database, né di sistemi di autenticazione esterni. L'archiviazione su file di testo consente rapidità di trasferimento del sito ad altri provider e di backup. È stato scelto il linguaggio PHP in ragione della sua grande diffusione sui provider hosting condivisi, più economici. Il software è stato mantenuto ultra leggero, per poter gestire un numero ragionevole di utenti.

La configurazione è stata resa altrettanto semplice: il software viene configurato con un classico file di testo, con coppie chiave-valore al suo interno. Viene fornito un file .htaccess di esempio che include i principali header http di sicurezza.

Grazie a una opportuna configurazione di git, vengono ignorati tutti i file utente, contenuti delle pagine e file di configurazione non direttamente relativi al software stesso. In questo modo, l'intero software è aggiornabile con un solo comando, senza temere per i propri dati.

Il software, con l'intero codice sorgente e le informazioni di copyright e di licenza, è pubblicato sulla mia pagina GitLab al seguente indirizzo: https://gitlab.com/MassiminoilTrace/simple-php-docs.