Skip to content
README.rst 4.5 KiB
Newer Older
ziirish's avatar
ziirish committed
Badges
======
ziirish's avatar
ziirish committed
.. image:: https://git.ziirish.me/ci/projects/1/status.png?ref=master
ziirish's avatar
ziirish committed
    :target: https://git.ziirish.me/ziirish/burp-ui/pipelines
ziirish's avatar
ziirish committed
    :alt: Build Status

ziirish's avatar
ziirish committed
.. image:: https://git.ziirish.me/ziirish/burp-ui/badges/master/coverage.svg
ziirish's avatar
ziirish committed
    :target: https://git.ziirish.me/ziirish/burp-ui/pipelines
    :alt: Test coverage

ziirish's avatar
ziirish committed
.. image:: https://readthedocs.org/projects/burp-ui/badge/?version=latest
    :target: https://readthedocs.org/projects/burp-ui/?badge=latest
ziirish's avatar
ziirish committed
    :alt: Documentation Status
ziirish's avatar
ziirish committed
Introduction
============

ziirish's avatar
ziirish committed
Screenshots
-----------

ziirish's avatar
ziirish committed
.. image:: https://git.ziirish.me/ziirish/burp-ui/raw/master/docs/_static/burp-ui.gif
    :target: https://git.ziirish.me/ziirish/burp-ui/blob/master/docs/_static/burp-ui.gif
ziirish's avatar
ziirish committed

ziirish's avatar
ziirish committed
Demo
----

A screenshot is worth a thousand words, but a Demo is worth a thousand
screenshots.
ziirish's avatar
ziirish committed
You can now play with ``Burp-UI`` at `demo.ziirish.me <https://demo.ziirish.me>`_
ziirish's avatar
ziirish committed

Credentials:

ziirish's avatar
ziirish committed
- *admin / admin* to play with ``Burp-UI`` as an administrator
- *demo / demo* to play with ``Burp-UI`` as a regular user
ziirish's avatar
ziirish committed

ziirish's avatar
ziirish committed
What's that?
------------

Let me introduce you ``Burp-UI``. It is a web-based UI to manage your
burp-servers.
You can view different reports about burp-servers, burp-clients, backups, etc.
ziirish's avatar
ziirish committed
``Burp-UI`` allows you to perform *online* restorations and to edit/manage
ziirish's avatar
ziirish committed
your burp-server's configuration files.
ziirish's avatar
ziirish committed

Who are you?
------------

ziirish's avatar
ziirish committed
I'm `Ziirish <http://ziirish.info>`__, a French sysadmin who loves `Burp`_ and
who'd like to help its adoption by providing it a nice and powerful interface.
ziirish's avatar
ziirish committed
If you like my work, you can:

ziirish's avatar
ziirish committed
* Thank me by sending me an email or writing nice comments
* Buy me a beer or some fries (or both!)
* Make a donation on my `Paypal <http://ziirish.info>`__
ziirish's avatar
ziirish committed

ziirish's avatar
ziirish committed
Documentation
=============
ziirish's avatar
ziirish committed
The documentation is hosted on `readthedocs <https://readthedocs.org>`_ at the
following address: `burp-ui.readthedocs.io
ziirish's avatar
ziirish committed
<https://burp-ui.readthedocs.io/en/latest/>`_
ziirish's avatar
ziirish committed

ziirish's avatar
ziirish committed
FAQ
===

ziirish's avatar
ziirish committed
A `FAQ <https://burp-ui.readthedocs.io/en/latest/faq.html>`_ is available with
ziirish's avatar
ziirish committed
the documentation.

ziirish's avatar
ziirish committed
Community
=========

ziirish's avatar
ziirish committed
Please refer to the `Contributing
ziirish's avatar
ziirish committed
<https://burp-ui.readthedocs.io/en/latest/contributing.html>`_ page.
Notes
ziirish's avatar
ziirish committed
=====
ziirish's avatar
ziirish committed
Feel free to report any issues on my `gitlab
<https://git.ziirish.me/ziirish/burp-ui/issues>`_.
ziirish's avatar
ziirish committed

I have closed the *github tracker* to have a unique tracker system.
ziirish's avatar
ziirish committed

ziirish's avatar
ziirish committed
Also please, read the `Contributing
ziirish's avatar
ziirish committed
<https://burp-ui.readthedocs.io/en/latest/contributing.html>`_
ziirish's avatar
ziirish committed
page before reporting any issue to make sure we have all the informations to
help you.
ziirish's avatar
ziirish committed
See also
========

ziirish's avatar
ziirish committed
Starting with burp-ui v0.3.0, I introduced you `burp_server_report
<https://github.com/pablodav/burp_server_reports>`_
ziirish's avatar
ziirish committed
a project lead by Pablo Estigarribia.

Pablo also contributed to other interesting projects to automate burp and burp-ui
deployments through Ansible:

ziirish's avatar
ziirish committed
- `burpui_server <https://galaxy.ansible.com/CoffeeITWorks/burpui_server/>`_
- `burp2_server <https://galaxy.ansible.com/CoffeeITWorks/burp2_server/>`_
ziirish's avatar
ziirish committed

Licenses
ziirish's avatar
ziirish committed
========
ziirish's avatar
ziirish committed
``Burp-UI`` is released under the BSD 3-clause `License`_.
ziirish's avatar
ziirish committed
But this project is built on top of other tools. Here is a non exhaustive list:
- `d3.js <http://d3js.org/>`_
- `nvd3.js <http://nvd3.org/>`_
- `jQuery <http://jquery.com/>`_
- `jQuery-UI <http://jqueryui.com/>`_
- `fancytree <https://github.com/mar10/fancytree>`_
- `bootstrap <http://getbootstrap.com/>`_
- `typeahead <http://twitter.github.io/typeahead.js/>`_
- `bootswatch <http://bootswatch.com/>`_ theme ``Slate``
- `angular-bootstrap-switch <https://github.com/frapontillo/angular-bootstrap-switch>`_
- `angular.js <https://angularjs.org/>`_
- `angular-ui-select <https://github.com/angular-ui/ui-select>`_
- `AngularStrap <http://mgcrea.github.io/angular-strap/>`_
- `lodash <https://github.com/lodash/lodash>`_
- `DataTables <http://datatables.net/>`_
ziirish's avatar
ziirish committed
- Home-made `favicon <https://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/images/favicon.ico>`_ based on pictures from `simpsoncrazy <http://www.simpsoncrazy.com/pictures/homer>`_
ziirish's avatar
ziirish committed
Also note that this project is made with the Awesome `Flask`_ micro-framework.
ziirish's avatar
ziirish committed
Thanks
ziirish's avatar
ziirish committed
======
ziirish's avatar
ziirish committed
Thank you all for your feedbacks and bug reports. Those are making the project
ziirish's avatar
ziirish committed
moving forward.
ziirish's avatar
ziirish committed

ziirish's avatar
ziirish committed
Thank you to the `Flask`_ developers and community.
ziirish's avatar
ziirish committed

ziirish's avatar
ziirish committed
Special Thanks to Graham Keeling for its great piece of software! This project
would not exist without `Burp`_.
ziirish's avatar
ziirish committed

.. _Flask: http://flask.pocoo.org/
ziirish's avatar
ziirish committed
.. _License: https://git.ziirish.me/ziirish/burp-ui/blob/master/LICENSE
.. _Burp: http://burp.grke.org/
ziirish's avatar
ziirish committed
.. _burpui.cfg: https://git.ziirish.me/ziirish/burp-ui/blob/master/share/burpui/etc/burpui.sample.cfg