add documentation
This commit is contained in:
parent
25d227da95
commit
8d74091c3c
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) :
|
Générér un mail (assurez-vous d'avoir la commande `sendmail` qui fonctionne) :
|
||||||
|
|
||||||
```
|
```bash
|
||||||
export EMAIL_RECIPIENT=you@example.com
|
export EMAIL_RECIPIENT=you@example.com
|
||||||
export EMAIL_SENDER=system@example.com
|
export EMAIL_SENDER=system@example.com
|
||||||
export EMAIL_SUBJECT="Rapport de $(hostname)"
|
export EMAIL_SUBJECT="Rapport de $(hostname)"
|
||||||
|
@ -37,26 +37,26 @@ export EMAIL_SUBJECT="Rapport de $(hostname)"
|
||||||
|
|
||||||
Générér un fichier :
|
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 :
|
Inclure l'analyse S.M.A.R.T via smartmontools :
|
||||||
|
|
||||||
```
|
```bash
|
||||||
export SMART_DEVICES="/dev/sdXX /dev/sdYY"
|
export SMART_DEVICES="/dev/sdXX /dev/sdYY"
|
||||||
```
|
```
|
||||||
|
|
||||||
Inclure les graphiques du jour générés par Munin (rapport mail uniquement) :
|
Inclure les graphiques du jour générés par Munin (rapport mail uniquement) :
|
||||||
|
|
||||||
```
|
```bash
|
||||||
export MUNIN_DIRECTORY="/var/cache/munin/www/foo/bar/"
|
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.
|
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).
|
Vous pouvez créer vos templates (se référer au code source).
|
||||||
|
|
||||||
```
|
```bash
|
||||||
# HTML
|
# HTML
|
||||||
export TEMPLATE=/path/to/deblan-report/templates/deblan/
|
export TEMPLATE=/path/to/deblan-report/templates/deblan/
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue