Badges ====== .. image:: https://ci.ziirish.me/projects/1/status.png?ref=master :target: https://ci.ziirish.me/projects/1?ref=master :alt: Build Status .. image:: https://readthedocs.org/projects/burp-ui/badge/?version=latest :target: https://readthedocs.org/projects/burp-ui/?badge=latest :alt: Documentation Status Introduction ============ Screenshots ----------- .. image:: https://raw.githubusercontent.com/ziirish/burp-ui/master/pictures/burp-ui.gif :target: https://git.ziirish.me/ziirish/burp-ui/blob/master/pictures/burp-ui.gif 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. ``Burp-UI`` allows you to perform *on-the-fly* restorations and to edit/manage your burp-server's configuration files. It is actually an improvement of the burp status monitor (``burp -c /etc/burp/burp-server.conf -a s``). 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? ------------ I'm `Ziirish `__, a French sysadmin who loves `Burp`_ and who'd like to help its adoption by providing it a nice and powerful interface. If you like my work, you can: * 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 `__ Documentation ============= The documentation is hosted on `readthedocs `_ at the following address: `burp-ui.readthedocs.org `_ Community ========= Please refer to the `Contributing `_ page. Notes ===== Please feel free to report any issues on my `gitlab `_. I have closed the *github tracker* to have a unique tracker system. TODO ==== `Here `_ is a non-exhaustive list of things I'd like to add. Licenses ======== ``Burp-UI`` is released under the BSD 3-clause `License`_. But this project is built on top of other tools listed here: - `d3.js `_ (`BSD `__) - `nvd3.js `_ (`Apache `__) - `jQuery `_ (`MIT `__) - `jQuery-UI `_ (`MIT `__) - `fancytree `_ (`MIT `__) - `bootstrap `_ (`MIT `__) - `typeahead `_ (`MIT `__) - `bootswatch `_ theme ``Slate`` (`MIT `__) - `angular-bootstrap-switch `_ (`Apache `__) - `angular.js `_ (`MIT `__) - `angular-ui-select `_ (`MIT `__) - `AngularStrap `_ (`MIT `__) - `lodash `_ (`MIT `__) - `DataTables `_ (`MIT `__) - Home-made `favicon `_ based on pictures from `simpsoncrazy `_ Also note that this project is made with the Awesome `Flask`_ micro-framework. Thanks ====== Special Thanks to Graham Keeling for its great software! This project would not exist without `Burp`_. .. _Flask: http://flask.pocoo.org/ .. _License: https://git.ziirish.me/ziirish/burp-ui/blob/master/LICENSE .. _Burp: http://burp.grke.org/ .. _burpui.cfg: https://git.ziirish.me/ziirish/burp-ui/blob/master/share/burpui/etc/burpui.sample.cfg