improve overall documentation

parent 698d2d76
......@@ -41,11 +41,6 @@ You can view different reports about burp-servers, burp-clients, backups, etc.
``Burp-UI`` allows you to perform *online* restorations and to edit/manage
your burp-server's configuration files.
In order to work properly, you must be running ``Burp-UI`` on the same host that
runs your burp-server (because the burp status port only listen on *localhost*).
If you don't want to, I developed a ``bui-agent`` that allows you to *proxify*
external commands to your burp status port.
Who are you?
......@@ -122,8 +117,8 @@ Also note that this project is made with the Awesome `Flask`_ micro-framework.
Thank you all for your fedbacks and bug reports that make the project moving
Thank you all for your feedbacks and bug reports those are making the project
moving forward.
Special Thanks to Graham Keeling for its great piece of software! This project
would not exist without `Burp`_.
......@@ -333,12 +333,16 @@ class BUIbackend(BUIlogging):
"last": "2015-10-02 08:20:03",
"name": "client1",
"state": "idle"
"state": "idle",
"percent": null,
"phase": null,
"last": "2015-01-25 13:32:00",
"name": "client2",
"state": "idle"
"percent": null,
"phase": null,
......@@ -112,8 +112,6 @@ mkdir -p /tmp/burp2/CA-client
chgrp -R burpui /tmp/burp2
chmod -R g+w /tmp/burp2
sed -i "s/^max_status_children.*$/max_status_children = 100/" /etc/burp/burp-server.conf
/usr/sbin/burp -g -c /etc/burp/burp-server.conf
# cleanup
......@@ -4,6 +4,10 @@ bui-agent
The `bui-agent`_ is a kind of proxy between a `Burp`_ server and your `Burp-UI`_
It is useful when you have several servers to monitor and/or when you don't want
(or can't) install the full `Burp-UI`_ on your server.
......@@ -44,8 +44,8 @@ Optionally your python version and your OS might be useful as well.
Ask question in the `discussion forum <>`__. Do not
use the issue tracker.
Ask questions in the `discussion forum <>`__. Do not
use the issue tracker for this purpose.
``Burp-UI`` has extensive online documentation please read the `doc
......@@ -54,6 +54,8 @@ Burp2
The `burp2 backend <usage.html#burp2>`__ supports only burp 2.0.18 and above.
Some versions are known to contain critical issues resulting in a non-functional
`Burp-UI`_: 2.0.24, 2.0.26 and 2.0.30
If you are using an older version of burp2 `Burp-UI`_ will fail to start.
.. _Burp-UI:
......@@ -151,7 +151,141 @@ documentation.
Burp2 server
In this scenario, we are going to install a `Burp`_ server version 2.0.28.
We assume you are using the user *root* to run the following commands.
We begin with the installation of `Burp`_ itself.
First, we need some system requirements in order to compile `Burp`_ and to
install `Burp-UI`_:
apt-get update
apt-get install uthash-dev g++ make libssl-dev librsync-dev python2.7-dev \
git python-pip libffi-dev libyajl-dev libz-dev
Now we retrieve the `Burp`_ sources and then we compile and install it:
cd /usr/src
git clone
cd burp
git checkout tags/2.0.28
make install
# we also install init scripts
cp debian/init /etc/init.d/burp
cat >/etc/default/burp<<EOF
DAEMON_ARGS="-c /etc/burp/burp-server.conf"
chmod +x /etc/init.d/burp
update-rc.d burp defaults
It is now time to install `Burp-UI`_:
pip install --upgrade burp-ui
Now that everything is installed, let's configure our tools!
In order to perform online restorations, `Burp-UI`_ relies on a classical
`Burp`_ client.
We need to define our client, and we also need to allow it to perform
restorations for other clients. We will set it up globally. Our client will be
named *bui*:
# burp-ui client's definition
cat >/etc/burp/clientconfdir/bui<<EOF
password = abcdefgh
# grant our client to perform restorations for others
echo "restore_client = bui" >>/etc/burp/burp-server.conf
# Burp 2 is able to cache the manifests for better performances
echo "monitor_browse_cache = 1" >>/etc/burp/burp-server.conf
# now we generate ou client configuration
cat >/etc/burp/burp.conf<<EOF
mode = client
port = 4971
status_port = 4972
server = ::1
password = abcdefgh
cname = bui
pidfile = /var/run/
syslog = 0
stdout = 1
progress_counter = 1
network_timeout = 72000
ca_burp_ca = /usr/sbin/burp_ca
ca_csr_dir = /etc/burp/CA-client
# SSL certificate authority - same file on both server and client
ssl_cert_ca = /etc/burp/ssl_cert_ca.pem
# Client SSL certificate
ssl_cert = /etc/burp/ssl_cert-client.pem
# Client SSL key
ssl_key = /etc/burp/ssl_cert-client.key
# SSL key password
ssl_key_password = password
# Common name in the certificate that the server gives us
ssl_peer_cn = burpserver
# The following options specify exactly what to backup.
include = /home
Our `Burp`_ server is now set up, we can start it:
/etc/init.d/burp start
Now we can configure `Burp-UI`_. The package comes with a default configuration
and init scripts. We copy them at the right place:
cp /usr/local/share/burpui/contrib/debian/ /etc/init.d/burp-ui
chmod +x /etc/init.d/burp-ui
update-rc.d burp-ui defaults
cp /usr/local/share/burpui/etc/burpui.sample.cfg /etc/burp/burpui.cfg
We have to edit the default configuration in order to work with a `Burp`_-2
sed -i "s/^version: .*/version: 2/" /etc/burp/burpui.cfg
That's it, the other default parameter should be able to handle such a setup.
We can start `Burp-UI`_:
/etc/init.d/burp-ui start
Your server is now fully set-up, you can access `Burp-UI`_ by pointing your
browser to: http://server_ip:5000/
The default user / password is: admin / admin
For further customization, you can refer to the `usage`_ page of this
Multiple servers
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment