kyopages/docs/scripts/getInfo.md

154 lines
5.5 KiB
Markdown
Raw Normal View History

2017-08-17 10:49:12 +02:00
# getInfo
2017-10-11 01:30:15 +02:00
> * script bash qui rassemble un certain nombre d'informations techniques sur la configuration d'un PC
> * un rapport au format **markdown** est formé
> * ce rapport peut être exporté sur un pastebin (avec rendu markdown) pour partager les informations
> * par défaut le paste sera conservé 7 jours
> * aucune donnée confidentielle n'est contenue dans le rapport
2017-10-13 21:57:55 +02:00
> * tout est collecté avec les droits utilisateur, **sauf dmesg** où le mot de passe sera demandé
pour obtenir les droits administratifs (sans être obligatoire)
2017-10-11 01:30:15 +02:00
> * l'installation du script est possible en option. il se mettra alors éventuellement à jour automatiquement
2017-08-17 10:49:12 +02:00
## chargement et lancement du script:
```shell
2017-10-11 01:30:15 +02:00
wget -O getInfo https://frama.link/getInfo
2017-08-17 10:49:12 +02:00
chmod +x getInfo
```
2017-09-25 09:12:16 +02:00
2017-10-12 09:00:10 +02:00
* liens de chargement alternatif `wget -O getInfo https://framagit.org/kyodev/kyopages/raw/master/scripts/getInfo`
2017-09-25 09:12:16 +02:00
2017-08-17 10:49:12 +02:00
```shell
./getInfo
```
```text
_ ___ __
__ _ ___| |_|_ _|_ __ / _| ___
/ _' |/ _ \ __|| || '_ \| |_ / _ \
| (_| | __/ |_ | || | | | _| (_) |
\__, |\___|\__|___|_| |_|_| \___/
|___/
2017-10-13 21:57:55 +02:00
version 2.5.0 - 13/10/2017
2017-08-17 10:49:12 +02:00
2017-10-13 21:57:55 +02:00
----------------------------------------------------------------------
2017-10-11 01:30:15 +02:00
Mot de passe :
.
2017-08-17 10:49:12 +02:00
2017-10-11 01:30:15 +02:00
exporter sur le pastebin par défaut? [o/N]
le rapport est disponible en local, fichier: getInfo_rapport.md
vous pouvez le visualiser ultérieurement avec getInfo -l
vous pourrez l'exporter ultérieurement avec getInfo -p
2017-08-17 10:49:12 +02:00
```
2017-10-11 01:30:15 +02:00
* par défaut, l'export sur un pastebin ne se fera pas (touche <Entrée\>)
* répondre o + <Entrée\> permet d'exporter et de récupérer un lien le paste sera visible pendant 7 jours en
standard. Après ce délai il sera supprimé.
2017-08-17 10:49:12 +02:00
2017-10-11 01:30:15 +02:00
```text
exporter sur le pastebin par défaut? [o/N] o
2017-08-17 10:49:12 +02:00
2017-10-11 01:30:15 +02:00
votre paste: https://www.pastery.net/yrqasp/
(valide pendant 7 jours)
2017-08-17 10:49:12 +02:00
2017-10-11 01:30:15 +02:00
le rapport est disponible en local, fichier: getInfo_rapport.md
vous pouvez le visualiser ultérieurement avec getInfo -l
vous pourrez l'exporter ultérieurement avec getInfo -p
2017-08-17 10:49:12 +02:00
```
2017-09-03 09:38:43 +02:00
2017-10-11 01:30:15 +02:00
* les erreurs/warnings/critiques via _dmesg_ ne sont pas rapportées sans saisie de mot de passe superutilisateur.
À défaut, les extraits dmesg ne seront pas dans le rapport final.
* export ou non, le rapport au format markdown est disponible dans le répertoire courant, dans le fichier
**getInfo_rapport.md**
* ultérieurement, le rapport est consultable avec la commande `./getInfo -l`
* ultérieurement, le rapport peut être (re)exporté avec la commande `./getInfo -p`
* la durée du paste peut être configurée avec l'option supplémentaire `-tn` (n=nombre de jours), par exemple:
* `.getInfo -p -t14` pour exporter un rapport existant pour une période de 14 jours
* `.getInfo -t21` pour former et exporter un rapport pour une période de 21 jours
2017-08-17 10:49:12 +02:00
2017-10-11 01:30:15 +02:00
## exemple de rapport
2017-08-17 10:49:12 +02:00
[getInfo_rapport](getInfo_rapport.md)
2017-10-11 01:30:15 +02:00
2017-08-17 10:49:12 +02:00
## help
```shell
./getInfo -h
```
```text
_ ___ __
__ _ ___| |_|_ _|_ __ / _| ___
/ _' |/ _ \ __|| || '_ \| |_ / _ \
| (_| | __/ |_ | || | | | _| (_) |
\__, |\___|\__|___|_| |_|_| \___/
|___/
2017-10-13 21:57:55 +02:00
version 2.5.0 - 13/10/2017
2017-08-17 10:49:12 +02:00
----------------------------------------------------------------------
2017-10-11 01:30:15 +02:00
./getInfo : exécution normale, rapport markdown de la configuration
2017-08-17 10:49:12 +02:00
getInfo : exécution normale si script installé dans le système
options:
2017-10-11 01:30:15 +02:00
-c : (catégorie) menu sélection catégorie d'analyse
-h : (help) affichage aide
-l : (list) afficher le rapport markdown existant
-p : (paste) exporte le rapport markdown existant, durée standard du paste 7 jours
-tn : durée du paste de n jour(s)
--dmesg : dmesg {erreur & warning & critique} et journaux Xorg, root requis, rapport markdown créé
--ip : affiche ip(s) publique(s) (ipv4 / ipv6), infos confidentielles, pas de rapport markdown
--mac : affiche les adresses Mac, infos confidentielles, pas de rapport markdown
--ssid : affiche configurations ssid, infos confidentielles, pas de rapport markdown,
root et NetworkManager requis
2017-10-13 21:57:55 +02:00
--debug-batt : scan valeurs power_supply et rapport markdown
--debug-hw : scan valeurs hwmon et rapport markdown
--debug-dmi : scan valeurs dmi et rapport markdown
2017-10-11 01:30:15 +02:00
--debug-paste : le résultat json du paste sera affiché après export
-i, --install : installation du script dans le système, root requis
-r, --remove : suppression du script dans le système, root requis
2017-08-17 10:49:12 +02:00
-u, --upgrade : upgrade script si maj possible
-v, --version : version du script, en ligne et en cours d'exécution
2017-10-12 09:00:10 +02:00
plus d'infos: https://frama.link/doc-getInfo
2017-08-30 01:16:09 +02:00
2017-10-11 01:30:15 +02:00
```
2017-08-17 10:49:12 +02:00
2017-10-11 01:30:15 +02:00
## informations avancées
2017-08-17 10:49:12 +02:00
2017-10-11 01:30:15 +02:00
[getInfo avancé](getInfo_plus.md)
2017-08-17 10:49:12 +02:00
## sources
sur [framagit](https://framagit.org/kyodev/kyopages/blob/master/scripts/getInfo)
## 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
2017-10-11 01:30:15 +02:00
* [wireless-info](https://github.com/UbuntuForums/wireless-info) pour la détection des managers
ou des modules réseaux
* [pastery.net](https://www.pastery.net/) pour héberger des pastebins avec rendu markdown