.. Burp-UI documentation master file, created by
   sphinx-quickstart on Fri May 22 11:01:30 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Burp-UI
=======

`Burp-UI`_ is a web-ui for `Burp`_ backup written in python with Flask and
jQuery/Bootstrap.
You may have a look at the `README`_ file first. There is also a dedicated
`FAQ <faq.html>`_.


Documentation
=============

.. toctree::
   :maxdepth: 2

   introduction
   requirements
   installation
   basic_usage
   running
   upgrading
   advanced_usage
   manage
   celery
   websocket
   gunicorn
   docker
   buiagent
   architecture
   contributing
   changelog
   faq
   step-by-step
   developer


.. _Flask: http://flask.pocoo.org/
.. _License: https://git.ziirish.me/ziirish/burp-ui/blob/master/LICENSE
.. _Burp: http://burp.grke.org/
.. _Burp-UI: https://git.ziirish.me/ziirish/burp-ui
.. _burpui.cfg: https://git.ziirish.me/ziirish/burp-ui/blob/master/share/burpui/etc/burpui.sample.cfg
.. _README: https://git.ziirish.me/ziirish/burp-ui/blob/master/README.rst
