iiab/scripts/iiab-diagnostics.README.md

Objective

To streamline troubleshooting of remote Internet-in-a-Box (IIAB) installations, we bundle up common machine/software diagnostics, all together in 1 human-readable small file, that can be easily circulated online AND offline.

Passwords (including Wi-Fi passwords) are auto-redacted from this file, to protect your community confidentiality.

The pastebinit command can then be used to auto-upload this file, creating a short URL that makes it much easier to circulate among volunteers.

But first off, the file is compiled by harvesting 1 + 6 kinds of things:

0. Filename Header + Git Hashes + Raspberry Pi Model + OS + CPU Architecture(s)

1. Files specially requested (if you run sudo iiab-diagnostics PATH/FILE1 PATH/FILE2)

2. Regular Files

3. Content of Directories (1-level deep)

4. Output of Commands

5. Firewall Rules

6. Log Files (last 100 lines of each)

Usage

1. Run it as follows:

   iiab-diagnostics
   

   Better yet, for more complete results, run it as root:

   sudo iiab-diagnostics
   

   To bundle in yet more files, run:

   sudo iiab-diagnostics PATH/FILE1 PATH/FILE2 ...
   

   ( All diagnostics will be bundled up into a single human-readable file, placed in: /etc/iiab/diag/ )

2. Make sure you're online, as you will be prompted to auto-publish your newly-compiled diagnostics file to a web pastebin.

   Or, you can later/manually upload it using the pastebinit command:

   pastebinit -b sprunge.us < /etc/iiab/diag/NEW-FILE-NAME
   

   Either way, this will generate an actual web link (URL).

3. Post this link (URL) to a "New issue" at https://github.com/iiab/iiab/issues

   Include a description of the symptoms, and how to reproduce the problem.

4. If you don't understand Step 3, email everything to bugs@iiab.io instead.

Source Code

Please look over the bottom of iiab-diagnostics (lines 106-224 especially) to learn more about which common IIAB files and commands make this rapid troubleshooting possible.