kyopages/docs/scripts/getInfo.md

# getInfo

> * c'est un script bash qui rassemble un certain nombre d'informations techniques sur la configuration d'un PC
> * le rapport est au format **markdown**
> * il propose un export du rapport sur un pastebin pour partager les informations, par défaut le paste sera 
  conservé 7 jours
> * aucunes données confidentielles ne sont contenues dans le rapport
> majoritairement, tout est collecté avec les droits utilisateur, sauf dmesg et la config réseau ssid de 
  NetworkManager les nécessitent pour être affichés (mais pas obligatoire)
> * l'installation du script est possible, en option. il se mettra alors éventuellement à jour automatiquement


## chargement et lancement du script:

```shell
wget -O getInfo https://frama.link/getinfo
chmod +x getInfo
```

 * liens de chargement alternatif `wget -O getInfo https://framagit.org/kyodev/kyopages/raw/master/scripts/getInfo`


 * lancer le script avec les droits **root**, permettra d'accéder à _dmesg_

```shell
./getInfo
```
```text
            _   ___        __       
  __ _  ___| |_|_ _|_ __  / _| ___  
 / _' |/ _ \ __|| || '_ \| |_ / _ \ 
| (_| |  __/ |_ | || | | |  _| (_) |
 \__, |\___|\__|___|_| |_|_|  \___/ 
 |___/                              
     version 1.13.0 - 04/09/2017

................
exporter sur un pastebin par défaut? [o/N] 
  
 le rapport est disponible en local, fichier: getInfo_rapport.md

  vous pouvez le visualiser avec getInfo -l

```
* sauf, à lancer le script avec les privilèges root, les extraits des erreurs/warnings/critiques de dmesg ne sont 
  pas rapportés, ce qui peut être dommage en recherche de diagnostics
* export ou non, le rapport au format markdown est disponible dans le répertoire courant, sous le nom: 
  **getInfo_rapport.md**
* par défaut, l'export sur un pastebin ne se fera pas (touche Entrée)
* répondre o + \[ entrée \] permet de récupérer un lien où le paste sera visible

```text
exporter sur un pastebin par défaut? [o/N] o
  

  votre paste:
  https://www.pastery.net/xpzyff/

  
 le rapport est disponible en local, fichier: getInfo_rapport.md

  vous pouvez le visualiser avec getInfo -l

```

si vous n'avez pas exporté de suite, vous pouvez le faire avec la commande `./getInfo -p` ou revoir à l'écran 
le rapport avec `./getInfo -l`

### exemple de rapport

[getInfo_rapport](getInfo_rapport.md)

## help

```shell
./getInfo -h
```
```text
            _   ___        __       
  __ _  ___| |_|_ _|_ __  / _| ___  
 / _' |/ _ \ __|| || '_ \| |_ / _ \ 
| (_| |  __/ |_ | || | | |  _| (_) |
 \__, |\___|\__|___|_| |_|_|  \___/ 
 |___/                              
     version 1.13.0 - 04/09/2017

  ----------------------------------------------------------------------
  ./getInfo    : exécution normale, rapport markdown configuration & diagnostic
  getInfo      : exécution normale si script installé dans le système

  options:
     -d, --dmesg    : dmesg erreur, warning, critique. root requis, rapport markdown seul de dmesg
     -h, --help     : affichage aide
     -l, --list     : afficher le rapport markdown existant
     -p, --paste    : exporte le rapport markdown existant, durée du paste standard 7 jours
         --ip       : affiche ip(s) publique(s) (ipv4 / ipv6), infos confidentielles, sans rapport markdown
     -m, --mac      : affiche les adresses Mac, infos confidentielles, sans rapport markdown
     -s, --ssid     : affiche configurations ssid, infos confidentielles
                      pas de rapport markdown, root et NetworkManager requis

     debug          : le résultat json du paste sera affiché après export
     -tn            : durée du paste de n jour(s)

     -i, --install  : installation du script dans le système, droits root requis
     -r, --remove   : suppression du script dans le système, droits root requis
     -u, --upgrade  : upgrade script si maj possible
     -v, --version  : version du script, en ligne et en cours d'exécution

```

## options diverses

* l'extrait dmesg peut être isolé avec `./getInfo -d` ou `getInfo -d`, lancé avec les droits **root**.
 _getInfo_rapport.md_ contiendra uniquement cet extrait
* un rapport _getInfo_rapport.md_ existant peut être exporté sur le pastebin avec `./getInfo -p` 
  ou `getInfo -p`
* `./getInfo -l` ou `/getInfo -l` permet d'afficher un rapport _getInfo_rapport.md_ existant
* `./getInfo --ip` ou `getInfo --ip` affiche les IPs publiques du PC (ipV4 et/ou ipV6)
* `./getInfo -m` ou `getInfo -m` affiche les adresses Mac
* `./getInfo -s` ou `getInfo --ssid` affiche seulement (pas de rapport construit) la configuration des ssid 
  de NetworkManger. Attention, cela affichera probablement les mot de passe des réseaux wifi configurés.
  Les **droits root** sont requis
* l'option `debug` permettra de visualiser le retour json lors de l'export paste sur pastery.net
* l'option `-tn` permet de remplacer la durée de conservation standard de 7 jours par n jours
  (par exemple -t1: le paste sera effacé au bout de 1 jour)


## installation et exploitation du script

* `./getInfo -i` **droits root** requis. Installation du script dans le système, pour
  exploitation plus fréquente. Le script téléchargé sera effacé du répertoire courant. Le lancement se fera 
  donc par `getInfo`. Le script sera mis à jour automatiquement, avec une périodicité hebdomadaire.
* `getInfo -u` mise à jour manuelle si possible, du script. Cette opération étant
  automatiquement lancée toutes les semaines si le script est installé.
* `getInfo -r` **droits root** requis. Suppression du script du système. 
* `getInfo -v` affiche la version du script et la version en ligne.


## sources

sur [framagit](https://framagit.org/kyodev/kyopages/blob/master/scripts/getInfo)


## changelog

sur [framagit](https://framagit.org/kyodev/kyopages/blob/master/scripts/getInfo_changelog.md)


## contact

pour tout problème ou suggestion concernant ce script, n'hésitez pas à ouvrir une issue 
[Framagit](https://framagit.org/kyodev/kyopages/issues)

IRC freenode: ##sdeb


## license

[LPRAB/WTFPL](https://framagit.org/kyodev/kyopages/blob/master/scripts/LICENSE.md)


## remerciements

* [neofetch](https://github.com/dylanaraps/neofetch) pour du code sur la détection système.   
  neofetch est un successeur dynamique de screenfetch avec du code sympa 
* [wireless-info](https://github.com/UbuntuForums/wireless-info) pour savoir comment détecter les managers 
  de réseaux
* [pastery.net](https://www.pastery.net/) pour héberger des pastebin au format markdown