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

update README

Browse source
This commit is contained in:
ziirish 2014-08-26 11:38:42 +02:00
parent af10598b13
commit e7ab1a094a
2 changed files with 14 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -28,27 +28,19 @@ On Debian, you can install `pip` with the following command:
aptitude install python-pip
```
Once `pip` is installed, you can install `Flask` and the other requirements this
way:
Once `pip` is installed, you can install `Burp-UI` this way:
```
pip install Flask
pip install flask-login
pip install WTForms
pip install Flask-WTF
```
Then you need to download the sources.
For example:
```
git clone http://git.ziirish.me/ziirish/burp-ui.git
pip install burp-ui
```
You can setup various parameters in the [burpui.cfg](burpui.cfg) file.
This file can be specified with the `-c` flag or should be present in
`/etc/burp/burpui.cfg`.
By default `Burp-UI` ships with a default file located in
`$BURPUIDIR/../share/burpui/etc/burpui.cfg`.
Then you can run `burp-ui`: `python burp-ui.py`
Then you can run `burp-ui`: `burp-ui`
By default, `burp-ui` listens on all interfaces (including IPv6) on port 5000.
@ -63,7 +55,6 @@ I have closed the *github tracker* to have a unique tracker system.
Here is a non-exhaustive list of things I'd like to add:
* Authentication so that only admins can access to burp stats.
* server-initiated restoration (with burp, you can create a special file that triggers
a restoration when the client contacts the server the next time. In this case the
client must accepts server-initiated restoration).

23
README.rst
View file

@ -35,29 +35,20 @@ On Debian, you can install ``pip`` with the following command:
aptitude install python-pip
Once ``pip`` is installed, you can install ``Flask`` and the other requirements this
way:
Once ``pip`` is installed, you can install ``Burp-UI`` this way:
::
pip install Flask
pip install flask-login
pip install WTForms
pip install Flask-WTF
Then you need to download the sources.
For example:
::
git clone http://git.ziirish.me/ziirish/burp-ui.git
pip install burp-ui
You can setup various parameters in the `burpui.cfg`_ file.
This file can be specified with the ``-c`` flag or should be present in
``/etc/burp/burpui.cfg``.
By default ``Burp-UI`` ships with a default file located in
``$BURPUIDIR/../share/burpui/etc/burpui.cfg``.
Then you can run ``burp-ui``: ``python burp-ui.py``
Then you can run ``burp-ui``: ``burp-ui``
By default, ``burp-ui`` listens on all interfaces (including IPv6) on port 5000.