deblan-report/README.md
2019-06-13 11:16:06 +02:00

75 lines
1.6 KiB
Markdown

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
* Uptime
* Points de montage
* Espaces disques
* Rapports S.M.A.R.T
*
Ce rapport pourra être enregistré dans un fichier et/ou envoyé par mail.
![](https://upload.deblan.org/u/2019-06/5d00ed7a.jpg)
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) :
```bash
export EMAIL_RECIPIENT="you@example.com"
export EMAIL_SENDER="system@example.com"
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/"
```
Utiliser votre logo :
```bash
export LOGO_URL="https://www.example.com/logo.png"
```
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/"
# Text
export TEMPLATE="/path/to/deblan-report/templates/deblan-text/"
```
Une fois les variables d'environnement ajoutées, il suffit de lancer `sudo ./report`.