From 8e62369ac434fc037cc8ab072af2812791dbee3a Mon Sep 17 00:00:00 2001
From: Mattia Tadini <tadini@poloinformatico.it>
Date: Fri, 29 Nov 2024 15:27:19 +0000
Subject: [PATCH] Add readme.md

---
 readme.md | 94 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 94 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..72822c5
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,94 @@
+# Manuale di Utilizzo dello Script di Backup Database
+
+## Introduzione
+
+Questo script facilita il processo di installazione e configurazione degli script di backup per database Microsoft SQL Server (MSSQL) o PostgreSQL. Il script crea un cron job per eseguire periodicamente i backup dei dati.
+
+## Prerequisiti
+
+1. **Sistema Operativo**: Debian/Ubuntu
+2. **Permessi Di Super Utente**: Il tuo account deve avere il privilegio di installare file e programmi.
+3. **Software**:
+   - `wget`: Usato per scaricare gli script di backup.
+
+## Uso del Script
+
+### 1. Scarica lo Script
+
+Prima di iniziare, è necessario scaricare lo script. Puoi fare questo utilizzando il comando `wget`:
+
+```bash
+wget https://dl.poloinformatico.it/assistenza/Scripts/install_backup_script.sh -O install_backup_script.sh
+```
+
+### 2. Esegui lo Script
+
+Rendi eseguibile lo script con il comando `chmod` e poi eseguilo:
+
+```bash
+chmod +x install_backup_script.sh
+sudo ./install_backup_script.sh
+```
+
+### 3. Seleziona il Tipo di Database
+
+Durante l'esecuzione dello script, verrà chiesto di scegliere tra MSSQL o PostgreSQL.
+
+```bash
+Vuoi installare lo script per MSSQL o PostgreSQL? (mssql/postgres):
+```
+
+Seleziona `mssql` o `postgres` a seconda del database che vuoi configurare.
+
+### 4. Imposta l'Orario di Backup
+
+Il sistema chiede all'utente di inserire l'ora di esecuzione dei backup nel formato HH:MM.
+
+```bash
+Inserisci l'ora di esecuzione del backup (HH:MM):
+```
+
+Ad esempio, per un backup alle 23:00, inserisci `23:00`.
+
+## Configurazione Automatica
+
+Lo script gestisce automaticamente:
+
+- **Creazione della Cartella**: Crea la cartella `/zucchetti/backupdb` se non esiste.
+- **Download degli Script**: Scarica gli script di backup per MSSQL o PostgreSQL e li posiziona nella cartella creata.
+- **Impostazione dei Permessi**: Imposta i permessi eseguibili agli script scaricati.
+- **Configurazione del Cron Job**: Aggiunge un cron job nel file `/etc/crontab` per eseguire il backup alle ore specificate.
+
+## Verifica dello Script
+
+Per verificare se lo script è stato installato correttamente, puoi controllare i cron jobs attivi:
+
+```bash
+cat /etc/crontab
+```
+
+Dovresti vedere una voce simile a questa:
+
+```bash
+0 23 * * * root /bin/bash /zucchetti/backupdb/mssql-backup.sh >> /var/log/backup-db.log 2>&1
+```
+
+Il comando `>> /var/log/backup-db.log 2>&1` redirige l'output del script nei file di log per il debug.
+
+## Debugging
+
+Se incontri problemi, controlla i file di log:
+
+```bash
+cat /var/log/backup.log
+```
+
+Questo ti fornirà informazioni dettagliate sull'esecuzione dello script.
+
+---
+
+### Contribuisci
+
+Se vuoi contribuire al progetto, fai un fork del repository su Gitea e invia una pull request con le tue modifiche.
+
+**Ricorda**: Assicurati che tutte le modifiche siano documentate nel manuale del progetto per facilitare la comprensione da parte di altri utenti.
\ No newline at end of file