Browse Source

add documentation

develop
Simon Vieille 2 years ago
parent
commit
4a12a1a736
Signed by: deblan GPG Key ID: 03383D15A1D31745
  1. 10
      README.md

10
README.md

@ -30,15 +30,15 @@ Configuration
Générér un mail (assurez-vous d'avoir la commande `sendmail` qui fonctionne) :
```bash
export EMAIL_RECIPIENT=you@example.com
export EMAIL_SENDER=system@example.com
export EMAIL_RECIPIENT="you@example.com"
export EMAIL_SENDER="system@example.com"
export EMAIL_SUBJECT="Rapport de $(hostname)"
```
Générér un fichier :
```bash
export HTML_OUTPUT=/var/www/html/report.html
export HTML_OUTPUT="/var/www/html/report.html"
```
Inclure l'analyse S.M.A.R.T via smartmontools :
@ -58,10 +58,10 @@ Vous pouvez créer vos templates (se référer au code source).
```bash
# HTML
export TEMPLATE=/path/to/deblan-report/templates/deblan/
export TEMPLATE="/path/to/deblan-report/templates/deblan/"
# Text
export TEMPLATE=/path/to/deblan-report/templates/deblan-text/
export TEMPLATE="/path/to/deblan-report/templates/deblan-text/"
```
Une fois les variables d'environnement ajoutées, il suffit de lancer `sudo ./report`.
Loading…
Cancel
Save