Robot
/
kyopages
mirror of https://framagit.org/kyodev/kyopages.git
2
0
Fork 0
Code Issues Releases Wiki Activity

2.1.0

This commit is contained in:
kyodev 2017-10-11 01:30:15 +02:00
parent a55244d986
commit 811de3c02a
2 changed files with 129 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

144
docs/scripts/getInfo.md
View File

@ -1,27 +1,23 @@
# getInfo # getInfo
> * c'est un script bash qui rassemble un certain nombre d'informations techniques sur la configuration d'un PC > * script bash qui rassemble un certain nombre d'informations techniques sur la configuration d'un PC
> * le rapport est au format **markdown** > * un rapport au format **markdown** est formé
> * il propose un export du rapport sur un pastebin pour partager les informations, par défaut le paste sera > * ce rapport peut être exporté sur un pastebin (avec rendu markdown) pour partager les informations
conservé 7 jours > * par défaut le paste sera conservé 7 jours
> * aucunes données confidentielles ne sont contenues dans le rapport > * aucune donnée confidentielle n'est contenue dans le rapport
> majoritairement, tout est collecté avec les droits utilisateur, sauf dmesg et la config réseau ssid de > * tout est collecté avec les droits utilisateur, sauf dmesg et la config réseau ssid de NetworkManager
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
> * l'installation du script est possible, en option. il se mettra alors éventuellement à jour automatiquement
## chargement et lancement du script: ## chargement et lancement du script:
```shell ```shell
wget -O getInfo https://frama.link/getinfo wget -O getInfo https://frama.link/getInfo
chmod +x getInfo chmod +x getInfo
``` ```
* liens de chargement alternatif `wget -O getInfo https://framagit.org/kyodev/kyopages/raw/master/scripts/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 ```shell
./getInfo ./getInfo
``` ```
@ -32,44 +28,53 @@ chmod +x getInfo
| (_| | __/ |_ | || | | | _| (_) | | (_| | __/ |_ | || | | | _| (_) |
\__, |\___|\__|___|_| |_|_| \___/ \__, |\___|\__|___|_| |_|_| \___/
|___/ |___/
version 1.13.0 - 04/09/2017 version 2.1.0 - 10/10/2017
................ ....................
exporter sur un pastebin par défaut? [o/N] Mot de passe :
.
le rapport est disponible en local, fichier: getInfo_rapport.md
vous pouvez le visualiser avec getInfo -l 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
``` ```
* 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 * par défaut, l'export sur un pastebin ne se fera pas (touche <Entrée\>)
* export ou non, le rapport au format markdown est disponible dans le répertoire courant, sous le nom: * répondre o + <Entrée\> permet d'exporter et de récupérer un lien où le paste sera visible pendant 7 jours en
**getInfo_rapport.md** standard. Après ce délai il sera supprimé.
* 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 ```text
exporter sur un pastebin par défaut? [o/N] o exporter sur le pastebin par défaut? [o/N] o
votre paste:
https://www.pastery.net/xpzyff/
le rapport est disponible en local, fichier: getInfo_rapport.md votre paste: https://www.pastery.net/yrqasp/
(valide pendant 7 jours)
vous pouvez le visualiser avec getInfo -l 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
``` ```
si vous n'avez pas exporté de suite, vous pouvez le faire avec la commande `./getInfo -p` ou revoir à l'écran * les erreurs/warnings/critiques via _dmesg_ ne sont pas rapportées sans saisie de mot de passe superutilisateur.
le rapport avec `./getInfo -l` À 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
### exemple de rapport
## exemple de rapport
[getInfo_rapport](getInfo_rapport.md) [getInfo_rapport](getInfo_rapport.md)
## help ## help
```shell ```shell
@ -82,58 +87,40 @@ le rapport avec `./getInfo -l`
| (_| | __/ |_ | || | | | _| (_) | | (_| | __/ |_ | || | | | _| (_) |
\__, |\___|\__|___|_| |_|_| \___/ \__, |\___|\__|___|_| |_|_| \___/
|___/ |___/
version 1.13.0 - 04/09/2017 version 2.1.0 - 10/10/2017
---------------------------------------------------------------------- ----------------------------------------------------------------------
./getInfo : exécution normale, rapport markdown configuration & diagnostic ./getInfo : exécution normale, rapport markdown de la configuration
getInfo : exécution normale si script installé dans le système getInfo : exécution normale si script installé dans le système
options: options:
-d, --dmesg : dmesg erreur, warning, critique. root requis, rapport markdown seul de dmesg -c : (catégorie) menu sélection catégorie d'analyse
-h, --help : affichage aide -h : (help) affichage aide
-l, --list : afficher le rapport markdown existant -l : (list) afficher le rapport markdown existant
-p, --paste : exporte le rapport markdown existant, durée du paste standard 7 jours -p : (paste) exporte le rapport markdown existant, durée standard du paste 7 jours
--ip : affiche ip(s) publique(s) (ipv4 / ipv6), infos confidentielles, sans rapport markdown -tn : durée du paste de n jour(s)
-m, --mac : affiche les adresses Mac, infos confidentielles, sans rapport markdown
-s, --ssid : affiche configurations ssid, infos confidentielles --dmesg : dmesg {erreur & warning & critique} et journaux Xorg, root requis, rapport markdown créé
pas de rapport markdown, root et NetworkManager requis --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
debug : le résultat json du paste sera affiché après export --debug-batt : rapport batterie avec affichage BAT?/uevent et rapport markdown
-tn : durée du paste de n jour(s) --debug-paste : le résultat json du paste sera affiché après export
-i, --install : installation du script dans le système, droits root requis -i, --install : installation du script dans le système, root requis
-r, --remove : suppression du script dans le système, droits root requis -r, --remove : suppression du script dans le système, root requis
-u, --upgrade : upgrade script si maj possible -u, --upgrade : upgrade script si maj possible
-v, --version : version du script, en ligne et en cours d'exécution -v, --version : version du script, en ligne et en cours d'exécution
plus d'infos: https://frama.link/doc-getinfo
``` ```
## options diverses ## informations avancées
* l'extrait dmesg peut être isolé avec `./getInfo -d` ou `getInfo -d`, lancé avec les droits **root**. [getInfo avancé](getInfo_plus.md)
_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 ## sources
@ -141,11 +128,6 @@ le rapport avec `./getInfo -l`
sur [framagit](https://framagit.org/kyodev/kyopages/blob/master/scripts/getInfo) 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 ## contact
pour tout problème ou suggestion concernant ce script, n'hésitez pas à ouvrir une issue pour tout problème ou suggestion concernant ce script, n'hésitez pas à ouvrir une issue
@ -163,6 +145,6 @@ IRC freenode: ##sdeb
* [neofetch](https://github.com/dylanaraps/neofetch) pour du code sur la détection système. * [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 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 * [wireless-info](https://github.com/UbuntuForums/wireless-info) pour la détection des managers
de réseaux ou des modules réseaux
* [pastery.net](https://www.pastery.net/) pour héberger des pastebin au format markdown * [pastery.net](https://www.pastery.net/) pour héberger des pastebins avec rendu markdown

66
docs/scripts/getInfo_plus.md Normal file
View File

@ -0,0 +1,66 @@
# getInfo avancé
## catégories
`./getInfo -c` ou `/getInfo -c` permet d'obtenir un menu de sélection de quatre catégories d'analyse pour
limiter la taille du rapport ou cibler une analyse
```text
_ ___ __
__ _ ___| |_|_ _|_ __ / _| ___
/ _' |/ _ \ __|| || '_ \| |_ / _ \
| (_| | __/ |_ | || | | | _| (_) |
\__, |\___|\__|___|_| |_|_| \___/
|___/
version 2.1.0 - 10/10/2017
getInfo -h : afficher l'aide
getInfo -cs : catégorie système getInfo -cc : catégorie configuration
getInfo -cr : catégorie réseau getInfo -ca : catégorie analyse
les catégories peuvent être cumulées:
getInfo -csa générera un rapport sur le système & l'analyse
choix des catégories à générer (all pour toutes)?
( ne pas saisir le préfixe -c, all par défaut)
```
## options principales
* `./getInfo -h` ou `/getInfo -h` affiche l'aide
* `./getInfo -l` ou `/getInfo -l` affiche un rapport _getInfo_rapport.md_ existant
* `./getInfo -p` ou `getInfo -p` exporte un rapport _getInfo_rapport.md_ existant sur le pastebin
* l'option supplémentaire `-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)
## options diverses
* `./getInfo --dmesg` ou `getInfo --dmesg` isole les extraits dmesg (avec les logs Xorg). Les
droits **superutilisateur** ou **root* sont requis. _getInfo_rapport.md_ est construit uniquement
avec les extraits dmesg et les logs Xorg
* `./getInfo --ip` ou `getInfo --ip` affiche les IPs publiques (ipv4 et/ou ipv6)
* `./getInfo --mac` ou `getInfo --mac` affiche les adresses Mac
* `./getInfo --ssid` ou `getInfo --ssid` affiche seulement (pas de rapport construit) la configuration des ssid
de NetworkManager. Attention, cela affichera probablement les mot de passe des réseaux wifi configurés.
les **droits root** sont requis
## options debug
* `./getInfo --debug-batt` Cette option permet de d'afficher les informations sur le(s) batterie(s) mais aussi
le(s) fichier(s) _/sys/class/power_supply/BAT?/uevent_
* `--debug-paste` Cette option supplémentaire permettra de visualiser le retour json lors de l'export
sur pastery.net
## installation et exploitation du script
Une fois installé, le script est accessible à tous les utilisateurs. Un test hebdomadaire est effectué et le
script est mis à jour si une nouvelle version est disponible.
* `./getInfo -i` **droits root** requis. Installation du script dans le système. Le script téléchargé sera
effacé du répertoire courant. Le lancement se fera donc par `getInfo`.
* `getInfo -r` **droits root** requis. Suppression du script du système.
* `getInfo -u` Mise à jour du script. Cette opération est automatiquement lancée toutes les semaines
si le script est installé.
* `getInfo -v` Affiche la version du script et la version en ligne.