From 8d74091c3c5142f22aa323c463c7c98e0b90a54f Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Wed, 12 Jun 2019 14:19:09 +0200 Subject: [PATCH] add documentation --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2d911e1..785f2a3 100644 --- a/README.md +++ b/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/