add documentation

This commit is contained in:
Simon Vieille 2019-06-12 14:09:50 +02:00
parent cd750cabb0
commit de5c15b5c2
Signed by: deblan
GPG Key ID: 03383D15A1D31745
2 changed files with 8 additions and 4 deletions

View File

@ -45,7 +45,14 @@ Inclure l'analyse S.M.A.R.T via smartmontools :
export SMART_DEVICES="/dev/sdXX /dev/sdYY"
```
Inclure les graphiques du jour générés par Munin :
```
export MUNIN_DIRECTORY="/var/cache/munin/www/foo/bar/"
```
Le projet inclut un rendu HTML et un rendu en texte. Le rendu par défaut est l'HTML.
Vous pouvez créer vos templates (se référer au code source).
```
# HTML
@ -55,6 +62,4 @@ export TEMPLATE=/path/to/deblan-report/templates/deblan/
export TEMPLATE=/path/to/deblan-report/templates/deblan-text/
```
…et vous pouvez créer vos templates (se référer au code source).
Une fois les variables d'environnement ajoutées, il suffit de lancer `./report`.
Une fois les variables d'environnement ajoutées, il suffit de lancer `sudo ./report`.

1
report
View File

@ -1,6 +1,5 @@
#!/bin/sh
# export EMAIL_RECIPIENT=you@example.com
# export EMAIL_SENDER=system@example.com
# export EMAIL_SUBJECT="[$(hostname)] Rapport journalier"