From 73a7ded3d49f1d5c856fe76cebcd00e4507090d7 Mon Sep 17 00:00:00 2001
From: ziirish <ziirish@ziirish.info>
Date: Tue, 12 Jun 2018 18:29:51 +0200
Subject: [PATCH] improve bug report/contributing documentation

---
 .gitlab/issue_templates/Bug.md |  4 +-
 README.rst                     |  2 +
 docs/contributing.rst          |  8 +++-
 docs/manage.rst                | 67 +++++++++++++++++++++-------------
 4 files changed, 52 insertions(+), 29 deletions(-)

diff --git a/.gitlab/issue_templates/Bug.md b/.gitlab/issue_templates/Bug.md
index 21a09b1c..0dd5008f 100644
--- a/.gitlab/issue_templates/Bug.md
+++ b/.gitlab/issue_templates/Bug.md
@@ -47,8 +47,8 @@ burp-2.1.18
 
 ```
 $ bui-manage sysinfo
-Python version:      3.6.1
-Burp-UI version:     0.5.0 (stable)
+Python version:      3.6.5
+Burp-UI version:     0.6.1 (stable)
 Single mode:         True
 Backend version:     2
 WebSocket embedded:  False
diff --git a/README.rst b/README.rst
index 2eb4337b..0adb2681 100644
--- a/README.rst
+++ b/README.rst
@@ -84,6 +84,8 @@ I have closed the *github tracker* to have a unique tracker system.
 
 Also please, read the `Contributing`_ page before reporting any issue to make
 sure we have all the informations to help you.
+Bug report that don't comply with the rules will likely be **ignored** because
+my spare time is quite limited.
 
 See also
 --------
diff --git a/docs/contributing.rst b/docs/contributing.rst
index 0f25ebfa..3d0de172 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -136,8 +136,10 @@ A Bug Report template is available directly in the Issue Tracker:
 The template illustrate the commands to run in order to provide as much details
 as you can in order to help reproduce the issue.
 
-If you are running ``Burp-UI`` bellow *v0.5.0*, you can get those informations
-using the following commands:
+Any un-complete bug report will likely be **ignored**.
+
+If you are running ``Burp-UI`` <= *v0.5.0*, you can get those informations using
+the following commands:
 
 ::
 
@@ -157,6 +159,8 @@ Questions
 Ask questions in the `discussion forum <https://forum.burp-ui.org/>`__. Do not
 use the issue tracker for this purpose.
 
+You can also join the ``#burp-ui`` room on irc.freenode.org.
+
 ``Burp-UI`` has extensive online documentation please read the `doc
 <https://burp-ui.readthedocs.io/en/latest/>`__.
 
diff --git a/docs/manage.rst b/docs/manage.rst
index 0808d382..917681c6 100644
--- a/docs/manage.rst
+++ b/docs/manage.rst
@@ -292,11 +292,15 @@ Example:
 
     bui-manage sysinfo
 
-    Python version:  2.7.9
-    Burp-UI version: 0.6.0 (stable)
-    Single mode:     True
-    Backend version: 2
-    Config file:     share/burpui/etc/burpui.sample.cfg
+    Python version:      3.6.5
+    Burp-UI version:     0.6.1 (stable)
+    OS:                  Linux:4.16.0-1-amd64 (posix)
+    Distribution:        debian buster/sid
+    Single mode:         True
+    Backend version:     2
+    WebSocket embedded:  False
+    WebSocket available: True
+    Config file:         share/burpui/etc/burpui.sample.cfg
 
 
 You can also add the ``-v`` flag while running ``sysinfo`` but please **MAKE
@@ -307,20 +311,29 @@ Example:
 ::
 
     bui-manage sysinfo -v
-    Python version:  2.7.9
-    Burp-UI version: 0.6.0 (stable)
-    Single mode:     True
-    Backend version: 2
-    Config file:     share/burpui/etc/burpui.sample.cfg
+
+    Python version:      3.6.5
+    Burp-UI version:     0.6.1 (stable)
+    OS:                  Linux:4.16.0-1-amd64 (posix)
+    Distribution:        debian buster/sid
+    Single mode:         True
+    Backend version:     2
+    WebSocket embedded:  False
+    WebSocket available: True
+    Config file:         share/burpui/etc/burpui.sample.cfg
     >>>>> Extra verbose informations:
     !!! PLEASE MAKE SURE NO SENSITIVE DATA GET EXPOSED !!!
 
-        [Burp] section:
-        8<---------------------------------------------------------------------BEGIN
-        8<-----------------------------------------------------------------------END
+        8<-------------------------------------------------------------BEGIN[Global]
+        version = 2
+        single = true
+        auth = basic
+        acl = basic
+        prefix = none
+        plugins = none
+        8<---------------------------------------------------------------END[Global]
 
-        [Production] section:
-        8<---------------------------------------------------------------------BEGIN
+        8<---------------------------------------------------------BEGIN[Production]
         storage = default
         session = default
         cache = default
@@ -329,17 +342,21 @@ Example:
         database = none
         limiter = false
         ratio = 60/minute
-        8<-----------------------------------------------------------------------END
+        8<-----------------------------------------------------------END[Production]
 
-        [Global] section:
-        8<---------------------------------------------------------------------BEGIN
-        version = 2
-        single = true
-        auth = basic
-        acl = basic
-        prefix = none
-        plugins = none
-        8<-----------------------------------------------------------------------END
+        8<---------------------------------------------------------------BEGIN[Burp]
+        bconfcli = /etc/burp/burp.conf
+        stripbin = /usr/bin/vss_strip
+        bconfsrv = /etc/burp/burp-server.conf
+        tmpdir = /tmp/bui/
+        8<-----------------------------------------------------------------END[Burp]
+
+        8<----------------------------------------------------------BEGIN[WebSocket]
+        enabled = true
+        embedded = false
+        url = document.domain + ':5001'
+        debug = true
+        8<------------------------------------------------------------END[WebSocket]
 
 
 Diag