Metadata-Version: 2.0
Name: burp-ui
Version: 0.4.4
Summary: Burp-UI is a web-ui for burp backup written in python with Flask and jQuery/Bootstrap
Home-page: https://git.ziirish.me/ziirish/burp-ui
Author: Benjamin SANS (Ziirish)
Author-email: hi+burpui@ziirish.me
License: BSD 3-clause LICENSE
Keywords: burp web ui backup monitoring
Platform: UNKNOWN
Classifier: Framework :: Flask
Classifier: Intended Audience :: System Administrators
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: System :: Archiving :: Backup
Classifier: Topic :: System :: Monitoring
Requires-Dist: Flask (==0.11.1)
Requires-Dist: Flask-Babel (==0.11.1)
Requires-Dist: Flask-Bower (==1.2.1)
Requires-Dist: Flask-Cache (==0.13.1)
Requires-Dist: Flask-Login (==0.3.2)
Requires-Dist: Flask-Script (==2.0.5)
Requires-Dist: Flask-WTF (==0.13.1)
Requires-Dist: WTForms (==2.0.2)
Requires-Dist: arrow (==0.7.0)
Requires-Dist: cffi (==1.7.0)
Requires-Dist: configobj (==5.0.6)
Requires-Dist: flask-restplus (==0.9.2)
Requires-Dist: pyOpenSSL (==16.0.0)
Requires-Dist: pyasn1 (==0.1.9)
Requires-Dist: six (==1.10.0)
Requires-Dist: tzlocal (==1.2)
Provides-Extra: agent
Requires-Dist: gevent; extra == 'agent'
Provides-Extra: celery
Requires-Dist: Celery; extra == 'celery'
Requires-Dist: redis; extra == 'celery'
Provides-Extra: debian_wheezy
Requires-Dist: functools32; extra == 'debian_wheezy'
Provides-Extra: dev
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: pylint; extra == 'dev'
Provides-Extra: extra
Requires-Dist: ujson; extra == 'extra'
Provides-Extra: gunicorn
Requires-Dist: gevent; extra == 'gunicorn'
Requires-Dist: gunicorn; extra == 'gunicorn'
Provides-Extra: gunicorn-extra
Requires-Dist: Flask-Session (==0.3.0); extra == 'gunicorn-extra'
Requires-Dist: redis; extra == 'gunicorn-extra'
Provides-Extra: ldap_authentication
Requires-Dist: ldap3; extra == 'ldap_authentication'
Provides-Extra: local_authentication
Requires-Dist: pam; extra == 'local_authentication'
Provides-Extra: sql
Requires-Dist: Flask-Migrate (>=2.0.1); extra == 'sql'
Requires-Dist: Flask-SQLAlchemy; extra == 'sql'
Requires-Dist: sqlalchemy-utils; extra == 'sql'
Provides-Extra: ssl
Requires-Dist: pyOpenSSL; extra == 'ssl'
Provides-Extra: test
Requires-Dist: Celery; extra == 'test'
Requires-Dist: Flask-Migrate; extra == 'test'
Requires-Dist: Flask-SQLAlchemy; extra == 'test'
Requires-Dist: Flask-Session; extra == 'test'
Requires-Dist: Flask-Testing (==0.5.0); extra == 'test'
Requires-Dist: coverage; extra == 'test'
Requires-Dist: mock; extra == 'test'
Requires-Dist: mockredispy; extra == 'test'
Requires-Dist: nose; extra == 'test'
Requires-Dist: redis; extra == 'test'
Requires-Dist: sqlalchemy-utils; extra == 'test'

Badges
======

.. image:: https://git.ziirish.me/ci/projects/1/status.png?ref=stable
    :target: https://git.ziirish.me/ziirish/burp-ui/pipelines
    :alt: Build Status

.. image:: https://git.ziirish.me/ziirish/burp-ui/badges/stable/coverage.svg
    :target: https://git.ziirish.me/ziirish/burp-ui/pipelines
    :alt: Test coverage

.. image:: https://readthedocs.org/projects/burp-ui/badge/?version=stable
    :target: https://readthedocs.org/projects/burp-ui/?badge=stable
    :alt: Documentation Status

Introduction
============

Demo
----

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

Credentials:

- *admin / admin* to play with ``Burp-UI`` as an administrator
- *demo / demo* to play with ``Burp-UI`` as a regular user


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 *online* restorations and to edit/manage
your burp-server's configuration files.


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

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.
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 <http://ziirish.info>`__


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

The documentation is hosted on `readthedocs <https://readthedocs.org>`_ at the
following address: `burp-ui.readthedocs.io
<https://burp-ui.readthedocs.io/en/stable/>`_


FAQ
===

A `FAQ <https://burp-ui.readthedocs.io/en/stable/faq.html>`_ is available with
the documentation.


Community
=========

Please refer to the `Contributing
<https://burp-ui.readthedocs.io/en/stable/contributing.html>`_ page.


Notes
=====

Feel free to report any issues on my `gitlab
<https://git.ziirish.me/ziirish/burp-ui/issues>`_.

I have closed the *github tracker* to have a unique tracker system.

Also please, read the `Contributing
<https://burp-ui.readthedocs.io/en/stable/contributing.html>`_
page before reporting any issue to make sure we have all the informations to
help you.


Licenses
========

``Burp-UI`` is released under the BSD 3-clause `License`_.

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/>`_
- Home-made `favicon <https://git.ziirish.me/ziirish/burp-ui/blob/stable/burpui/static/images/favicon.ico>`_ based on pictures from `simpsoncrazy <http://www.simpsoncrazy.com/pictures/homer>`_

Also note that this project is made with the Awesome `Flask`_ micro-framework.


Thanks
======

Thank you all for your feedbacks and bug reports. Those are making the project
moving forward.

Thank you to the `Flask`_ developers and community.

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


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


