Browse Source

add documentation

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

10
README.md

@ -29,7 +29,7 @@ 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_SUBJECT="Rapport de $(hostname)"
@ -37,26 +37,26 @@ export EMAIL_SUBJECT="Rapport de $(hostname)"
Générér un fichier :
```
```bash
export HTML_OUTPUT=/var/www/html/report.html
```
Inclure l'analyse S.M.A.R.T via smartmontools :
```
```bash
export SMART_DEVICES="/dev/sdXX /dev/sdYY"
```
Inclure les graphiques du jour générés par Munin (rapport mail uniquement) :
```
```bash
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).
```
```bash
# HTML
export TEMPLATE=/path/to/deblan-report/templates/deblan/

Loading…
Cancel
Save