From c36f29ea7a4fa57f8128ef275f4966adc8e1fdd4 Mon Sep 17 00:00:00 2001
From: A Holt <holta@users.noreply.github.com>
Date: Sun, 23 Jun 2019 04:03:11 -0400
Subject: [PATCH] Update iiab-diagnostics.README.md

---
 scripts/iiab-diagnostics.README.md | 58 ++++++++++++------------------
 1 file changed, 22 insertions(+), 36 deletions(-)

diff --git a/scripts/iiab-diagnostics.README.md b/scripts/iiab-diagnostics.README.md
index d5edc0e3a..a26cc1be8 100644
--- a/scripts/iiab-diagnostics.README.md
+++ b/scripts/iiab-diagnostics.README.md
@@ -1,54 +1,36 @@
 ## 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 file, that can be easily circulated online AND offline.
+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.
 
-The ``pastebinit`` command can then be used to upload this file, creating a short URL that makes things even easier.
+The ``pastebinit`` command can then be used to upload this file, creating a short URL that makes it easier to pass around.
 
-But first off, the file is compiled by harvesting 4 kinds of things:
+But first off, the file is compiled by harvesting 5 main kinds of things:
 
-1. Files
-   1. /etc/iiab/iiab.env
-   2. /etc/iiab/iiab.ini
-   3. /etc/iiab/local_vars.yml
-   4. /etc/iiab/config_vars.yml
-   5. /etc/iiab/openvpn_handle
-   6. /etc/resolv.conf
-   7. /etc/network/interfaces
-   8. /usr/bin/iiab-gen-iptables
-   9. /.iiab-image
+1. Files specially requested (if you run ``iiab-diagnostics FILENAME1 FILENAME2``)
 
-2. Contents of Directories:
-   1. /etc/network/interfaces.d
-   2. /etc/sysconfig/network-scripts/if-cfg*
-   3. /etc/NetworkManager/system-connections
-   4. /etc/systemd/network/
+2. Regular Files
 
-3. Output from Commands:
-   1. ip addr    # Network interfaces
-   2. ifconfig    # Network interfaces (old view)
-   3. brctl show    # Bridge for LAN side
-   4. netstat -rn    # Routing table
-   5. netstat -natp    # Ports/Services in use
-   6. iptables-save    # Firewall rules
-   7. systemctl status dnsmasq    # Is dnsmasq Ok?
-   8. journalctl -u dnsmasq    # dnsmasq log
-   9. ansible localhost -m setup 2>/dev/null    # All Ansible facts
+3. Content of Directories, 1-level deep
 
-4. Log Files -- last 100 lines:
-   1. /opt/iiab/iiab-install.log
-   2. /opt/iiab/iiab-network.log
-   3. /opt/iiab/iiab-debug.log
-   4. /opt/iiab/iiab-admin-console/admin-install.log
+4. Output of Commands
 
-#### Suggested Usage 
+5. Log Files: (last 100 lines of each)
 
-1. Run the diagnostics:
+## Usage 
+
+1. Run it as follows:
 
    ```
    sudo iiab-diagnostics
    ```
 
-   ( This will bundle up all the diagnostics, into a new file places in: /etc/iiab/diagnostics/ )
+   To bundle in more files, run:
+
+   ```
+   sudo iiab-diagnostics FILENAME1 FILENAME2
+   ```
+
+   ( This will bundle up all the diagnostics, into a new file placed in: /etc/iiab/diag/ )
 
 2. Upload the file using the pastebinit command:
 
@@ -63,3 +45,7 @@ But first off, the file is compiled by harvesting 4 kinds of things:
    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](iiab-diagnostics) to learn more about which common IIAB files make rapid troubleshooting possible.