documentation

docs/faq.rst

@@ -6,8 +6,8 @@ Is there a demo somewhere?
 
 Yes, you can play with `Burp-UI`_ at `demo.ziirish.me`_. Credentials are:
 
-- admin / admin to play with `Burp-UI`_ as an administrator
-- demo / demo to play with `Burp-UI`_ as a regular user
+- *admin* / *admin* to play with `Burp-UI`_ as an administrator
+- *demo* / *demo* to play with `Burp-UI`_ as a regular user
 
 How to start using Burp-UI?
 ---------------------------
@@ -22,7 +22,9 @@ How to configure my *firewall*?
 When running `Burp-UI`_ in standalone `mode <usage.html#versions>`__, the
 embedded webserver listens on port **5000** on all interfaces.
 
-The `Burp-UI`_ agents listens on port **10000** by default.
+The `Burp-UI`_ agents listen on port **10000** by default.
+
+Of course those are configurable.
 
 What are the default credentials?
 ---------------------------------
@@ -30,8 +32,8 @@ What are the default credentials?
 The default login / password is *admin* / *admin* with the
 `basic <usage.html#basic>`__ authentication backend.
 
-How does the online restoration feature works?
-----------------------------------------------
+How does the online restoration feature work?
+---------------------------------------------
 
 The online restoration feature works the same way as if you were running the
 burp client yourself.

docs/gunicorn.rst

@@ -60,7 +60,7 @@ If you are using this sample configuration file, make sure to create the
     # copy the gunicorn sample configuration
     cp /usr/local/share/burpui/contrib/gunicorn.d/burp-ui /etc/gunicorn.d/
     # create the burpui user
-    useradd -r -d /var/lib/burpui -c 'Burp-UI daemon user' burpui
+    useradd -m -r -d /var/lib/burpui -c 'Burp-UI daemon user' burpui
     mkdir /etc/burp
     # copy the burp-ui sample configuration file
     cp /usr/local/share/burpui/etc/burpui.sample.cfg /etc/burp/burpui.cfg

docs/requirements.rst

@@ -17,6 +17,15 @@ removed since it is not supported anymore by the CPython core team.
 Unit tests are ran against python 2.7 and python 3.4. If you encounter
 compilation errors with one of these version, feel free to report them.
 
+Libraries
+---------
+
+Some libraries are required to be able to compile some requirements:
+
+::
+
+    apt-get install libffi-dev python-dev
+
 Debian Wheezy
 -------------
 

docs/requirements.txt

@@ -11,4 +11,5 @@ six==1.10.0
 pyOpenSSL==16.0.0
 configobj==5.0.6
 pyasn1==0.1.9
+cffi==1.7.0
 sphinxcontrib-httpdomain==1.3.0

requirements.txt

@@ -11,3 +11,4 @@ six==1.10.0
 pyOpenSSL==16.0.0
 configobj==5.0.6
 pyasn1==0.1.9
+cffi==1.7.0