github-starred/burp-ui
2
0
Fork 0
mirror of https://github.com/ziirish/burp-ui.git synced 2026-05-15 14:16:08 -06:00
Code Issues 1 Projects Packages Wiki Activity Actions

improve bug report/contributing documentation

Browse source
This commit is contained in:
ziirish 2018-06-12 18:29:51 +02:00
parent 02d7563ead
commit 73a7ded3d4
No known key found for this signature in database
GPG key ID: 72DB229A64B54E46
4 changed files with 52 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

4
.gitlab/issue_templates/Bug.md
View file

@ -47,8 +47,8 @@ burp-2.1.18
``` ```
$ bui-manage sysinfo $ bui-manage sysinfo
Python version: 3.6.1 Python version: 3.6.5
Burp-UI version: 0.5.0 (stable) Burp-UI version: 0.6.1 (stable)
Single mode: True Single mode: True
Backend version: 2 Backend version: 2
WebSocket embedded: False WebSocket embedded: False

2
README.rst
View file

@ -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 Also please, read the `Contributing`_ page before reporting any issue to make
sure we have all the informations to help you. 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 See also
-------- --------

8
docs/contributing.rst
View file

@ -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 The template illustrate the commands to run in order to provide as much details
as you can in order to help reproduce the issue. 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 Any un-complete bug report will likely be **ignored**.
using the following commands:
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 Ask questions in the `discussion forum <https://forum.burp-ui.org/>`__. Do not
use the issue tracker for this purpose. 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 ``Burp-UI`` has extensive online documentation please read the `doc
<https://burp-ui.readthedocs.io/en/latest/>`__. <https://burp-ui.readthedocs.io/en/latest/>`__.

67
docs/manage.rst
View file

@ -292,11 +292,15 @@ Example:
bui-manage sysinfo bui-manage sysinfo
Python version: 2.7.9 Python version: 3.6.5
Burp-UI version: 0.6.0 (stable) Burp-UI version: 0.6.1 (stable)
Single mode: True OS: Linux:4.16.0-1-amd64 (posix)
Backend version: 2 Distribution: debian buster/sid
Config file: share/burpui/etc/burpui.sample.cfg 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 You can also add the ``-v`` flag while running ``sysinfo`` but please **MAKE
@ -307,20 +311,29 @@ Example:
:: ::
bui-manage sysinfo -v bui-manage sysinfo -v
Python version: 2.7.9
Burp-UI version: 0.6.0 (stable) Python version: 3.6.5
Single mode: True Burp-UI version: 0.6.1 (stable)
Backend version: 2 OS: Linux:4.16.0-1-amd64 (posix)
Config file: share/burpui/etc/burpui.sample.cfg 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: >>>>> Extra verbose informations:
!!! PLEASE MAKE SURE NO SENSITIVE DATA GET EXPOSED !!! !!! PLEASE MAKE SURE NO SENSITIVE DATA GET EXPOSED !!!
[Burp] section: 8<-------------------------------------------------------------BEGIN[Global]
8<---------------------------------------------------------------------BEGIN version = 2
8<-----------------------------------------------------------------------END single = true
auth = basic
acl = basic
prefix = none
plugins = none
8<---------------------------------------------------------------END[Global]
[Production] section: 8<---------------------------------------------------------BEGIN[Production]
8<---------------------------------------------------------------------BEGIN
storage = default storage = default
session = default session = default
cache = default cache = default
@ -329,17 +342,21 @@ Example:
database = none database = none
limiter = false limiter = false
ratio = 60/minute ratio = 60/minute
8<-----------------------------------------------------------------------END 8<-----------------------------------------------------------END[Production]
[Global] section: 8<---------------------------------------------------------------BEGIN[Burp]
8<---------------------------------------------------------------------BEGIN bconfcli = /etc/burp/burp.conf
version = 2 stripbin = /usr/bin/vss_strip
single = true bconfsrv = /etc/burp/burp-server.conf
auth = basic tmpdir = /tmp/bui/
acl = basic 8<-----------------------------------------------------------------END[Burp]
prefix = none
plugins = none 8<----------------------------------------------------------BEGIN[WebSocket]
8<-----------------------------------------------------------------------END enabled = true
embedded = false
url = document.domain + ':5001'
debug = true
8<------------------------------------------------------------END[WebSocket]
Diag Diag