Browse Source

add documentation

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

60
README.md

@ -0,0 +1,60 @@
Deblan report
=============
Projet qui génère un rapport générique sur une distribution Debian GNU/Linux (+ Ubuntu).
* Nom du système
* État des paquets et uptime
* Points de montage
* Espaces disques
* Rapport Smartmontools
* …
Ce rapport pourra être enregistré dans un fichier et/ou envoyé par mail.
Installation
------------
```
$ sudo apt install gettext-base coreutils smartmontools
$ git clone https://gitnet.fr/deblan/deblan-report.git
```
Configuration
-------------
`./report` va lancer des scripts qui vont analyser des variables d'environnement.
Générér un mail (assurez-vous d'avoir la commande `sendmail` qui fonctionne) :
```
export EMAIL_RECIPIENT=you@example.com
export EMAIL_SENDER=system@example.com
export EMAIL_SUBJECT="Rapport de $(hostname)"
```
Générér un fichier :
```
export HTML_OUTPUT=/var/www/html/report.html
```
Inclure l'analyse S.M.A.R.T via smartmontools :
```
export SMART_DEVICES="/dev/sdXX /dev/sdYY"
```
Le projet inclut un rendu HTML et un rendu en texte. Le rendu par défaut est l'HTML.
```
# HTML
export TEMPLATE=/path/to/deblan-report/templates/deblan/
# Text
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`.
Loading…
Cancel
Save