diff --git a/docs/step-by-step.rst b/docs/step-by-step.rst new file mode 100644 index 00000000..c2b76e26 --- /dev/null +++ b/docs/step-by-step.rst @@ -0,0 +1,165 @@ +Step By Step +============ + +Although `Burp-UI`_ tries to make `Burp`_ accessible to everyone, both products +have their complexity. + +In this *Step by Step*, I would like to introduce you different use-cases with +there associated configurations, descriptions and comments. +In every case, we will consider neither `Burp`_ or `Burp-UI`_ are installed and +describe the steps to setup your server from Scratch. + +.. note:: + Again, this part of the doc is mostly debian-centric. If some users are + willing to adapt these examples with other distros I would be very thankful. + + +1. Burp1 server with `Burp-UI`_ +2. Burp2 server with `Burp-UI`_ +3. Multiple servers with `bui-agents `_ + + +Burp1 server +------------ + +In this scenario, we are going to install a `Burp`_ server version 1.4.40 which +is the current stable version. 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 + + +Now we retrieve the `Burp`_ sources and then we compile and install it: + +:: + + cd /usr/src + git clone https://github.com/grke/burp.git + cd burp + git checkout tags/1.4.40 + ./configure --disable-ipv6 + make + make install + # we also install init scripts + cp debian/init /etc/init.d/burp + cat >/etc/default/burp</etc/burp/clientconfdir/bui<>/etc/burp/burp-server.conf + + # now we generate ou client configuration + cat >/etc/burp/burp.conf<:5000/ + +The default user / password is: admin / admin + +For further customization, you can refer to the `usage`_ page of this +documentation. + + +Burp2 server +------------ + +[TODO] + + +Multiple servers +---------------- + +[TODO] + + +.. _Burp-UI: https://git.ziirish.me/ziirish/burp-ui +.. _Burp: http://burp.grke.net/ +.. _usage: usage.html