Burp-UI
=======
.. image:: https://git.ziirish.me/ziirish/burp-ui/badges/master/pipeline.svg
:target: https://git.ziirish.me/ziirish/burp-ui/pipelines
:alt: Build Status
.. image:: https://git.ziirish.me/ziirish/burp-ui/badges/master/coverage.svg
:target: https://git.ziirish.me/ziirish/burp-ui/pipelines
:alt: Test coverage
.. image:: https://readthedocs.org/projects/burp-ui/badge/?version=latest
:target: https://readthedocs.org/projects/burp-ui/?badge=latest
:alt: Documentation Status
.. contents::
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.burp-ui.org <https://demo.burp-ui.org/>`_
Credentials:
- *admin* / *admin* to play with ``Burp-UI`` as an administrator
- *moderator* / *moderator* to play with ``Burp-UI`` as a moderator
- *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 *DevOps* 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`_
FAQ
---
A `FAQ`_ is available with the documentation.
Community
---------
Please refer to the `Contributing`_ 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`_ page before reporting any issue to make
sure we have all the informations to help you.
Bug report that don't comply with the rules will likely be **ignored** because
my spare time is quite limited.
See also
--------
Starting with burp-ui v0.3.0, I introduced you `burp_server_report
<https://github.com/pablodav/burp_server_reports>`_
a project lead by Pablo Estigarribia.
Pablo also contributed to other interesting projects to automate burp and burp-ui
deployments through Ansible:
- `burpui_server <https://galaxy.ansible.com/CoffeeITWorks/burpui_server/>`_
- `burp2_server <https://galaxy.ansible.com/CoffeeITWorks/burp2_server/>`_
@qm2k contributed some scripts/config to tweak your setup. You can found them here:
- `burp-ui_integration <https://github.com/qm2k/burp-ui_integration>`_
- `burp_integration <https://github.com/qm2k/burp_integration>`_
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/master/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 his 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/master/LICENSE
.. _Burp: http://burp.grke.org/
.. _burpui.cfg: https://git.ziirish.me/ziirish/burp-ui/blob/master/share/burpui/etc/burpui.sample.cfg
.. _burp-ui.readthedocs.io: https://burp-ui.readthedocs.io/en/latest/
.. _FAQ: https://burp-ui.readthedocs.io/en/latest/faq.html
.. _Contributing: https://burp-ui.readthedocs.io/en/latest/contributing.html
Raw data
{
"_id": null,
"home_page": "https://git.ziirish.me/ziirish/burp-ui",
"name": "burp-ui",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "burp web ui backup monitoring",
"author": "Benjamin SANS (Ziirish)",
"author_email": "hi+burpui@ziirish.me",
"download_url": "https://files.pythonhosted.org/packages/ef/9a/dd46dce3304742fe71e784d7267b2497ebeba70c70f7d81776082a8fe914/burp-ui-1.1.1.tar.gz",
"platform": null,
"description": "Burp-UI\n=======\n\n.. image:: https://git.ziirish.me/ziirish/burp-ui/badges/master/pipeline.svg\n :target: https://git.ziirish.me/ziirish/burp-ui/pipelines\n :alt: Build Status\n\n.. image:: https://git.ziirish.me/ziirish/burp-ui/badges/master/coverage.svg\n :target: https://git.ziirish.me/ziirish/burp-ui/pipelines\n :alt: Test coverage\n\n.. image:: https://readthedocs.org/projects/burp-ui/badge/?version=latest\n :target: https://readthedocs.org/projects/burp-ui/?badge=latest\n :alt: Documentation Status\n\n.. contents::\n\nIntroduction\n------------\n\nDemo\n^^^^\n\nA screenshot is worth a thousand words, but a Demo is worth a thousand\nscreenshots.\nYou can now play with ``Burp-UI`` at\n`demo.burp-ui.org <https://demo.burp-ui.org/>`_\n\nCredentials:\n\n- *admin* / *admin* to play with ``Burp-UI`` as an administrator\n- *moderator* / *moderator* to play with ``Burp-UI`` as a moderator\n- *demo* / *demo* to play with ``Burp-UI`` as a regular user\n\nWhat's that?\n^^^^^^^^^^^^\n\nLet me introduce you ``Burp-UI``. It is a web-based UI to manage your\nburp-servers.\nYou can view different reports about burp-servers, burp-clients, backups, etc.\n``Burp-UI`` allows you to perform *online* restorations and to edit/manage\nyour burp-server's configuration files.\n\nWho are you?\n^^^^^^^^^^^^\n\nI'm `Ziirish <http://ziirish.info>`__, a French *DevOps* who loves `Burp`_ and\nwho'd like to help its adoption by providing it a nice and powerful interface.\nIf you like my work, you can:\n\n* Thank me by sending me an email or writing nice comments\n* Buy me a beer or some fries (or both!)\n* Make a donation on my `Paypal <http://ziirish.info>`__\n\nDocumentation\n-------------\n\nThe documentation is hosted on `readthedocs <https://readthedocs.org>`_ at the\nfollowing address: `burp-ui.readthedocs.io`_\n\nFAQ\n---\n\nA `FAQ`_ is available with the documentation.\n\nCommunity\n---------\n\nPlease refer to the `Contributing`_ page.\n\nNotes\n-----\n\nFeel free to report any issues on my `gitlab\n<https://git.ziirish.me/ziirish/burp-ui/issues>`_.\n\nI have closed the *github tracker* to have a unique tracker system.\n\nAlso please, read the `Contributing`_ page before reporting any issue to make\nsure we have all the informations to help you.\nBug report that don't comply with the rules will likely be **ignored** because\nmy spare time is quite limited.\n\nSee also\n--------\n\nStarting with burp-ui v0.3.0, I introduced you `burp_server_report\n<https://github.com/pablodav/burp_server_reports>`_\na project lead by Pablo Estigarribia.\n\nPablo also contributed to other interesting projects to automate burp and burp-ui\ndeployments through Ansible:\n\n- `burpui_server <https://galaxy.ansible.com/CoffeeITWorks/burpui_server/>`_\n- `burp2_server <https://galaxy.ansible.com/CoffeeITWorks/burp2_server/>`_\n\n@qm2k contributed some scripts/config to tweak your setup. You can found them here:\n\n- `burp-ui_integration <https://github.com/qm2k/burp-ui_integration>`_\n- `burp_integration <https://github.com/qm2k/burp_integration>`_\n\nLicenses\n--------\n\n``Burp-UI`` is released under the BSD 3-clause `License`_.\n\nBut this project is built on top of other tools. Here is a non exhaustive list:\n\n- `d3.js <http://d3js.org/>`_\n- `nvd3.js <http://nvd3.org/>`_\n- `jQuery <http://jquery.com/>`_\n- `jQuery-UI <http://jqueryui.com/>`_\n- `fancytree <https://github.com/mar10/fancytree>`_\n- `bootstrap <http://getbootstrap.com/>`_\n- `typeahead <http://twitter.github.io/typeahead.js/>`_\n- `bootswatch <http://bootswatch.com/>`_ theme ``Slate``\n- `angular-bootstrap-switch <https://github.com/frapontillo/angular-bootstrap-switch>`_\n- `angular.js <https://angularjs.org/>`_\n- `angular-ui-select <https://github.com/angular-ui/ui-select>`_\n- `AngularStrap <http://mgcrea.github.io/angular-strap/>`_\n- `lodash <https://github.com/lodash/lodash>`_\n- `DataTables <http://datatables.net/>`_\n- 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>`_\n\nAlso note that this project is made with the Awesome `Flask`_ micro-framework.\n\nThanks\n------\n\nThank you all for your feedbacks and bug reports. Those are making the project\nmoving forward.\n\nThank you to the `Flask`_ developers and community.\n\nSpecial Thanks to Graham Keeling for his great piece of software! This project\nwould not exist without `Burp`_.\n\n\n.. _Flask: http://flask.pocoo.org/\n.. _License: https://git.ziirish.me/ziirish/burp-ui/blob/master/LICENSE\n.. _Burp: http://burp.grke.org/\n.. _burpui.cfg: https://git.ziirish.me/ziirish/burp-ui/blob/master/share/burpui/etc/burpui.sample.cfg\n.. _burp-ui.readthedocs.io: https://burp-ui.readthedocs.io/en/latest/\n.. _FAQ: https://burp-ui.readthedocs.io/en/latest/faq.html\n.. _Contributing: https://burp-ui.readthedocs.io/en/latest/contributing.html\n\n\n",
"bugtrack_url": null,
"license": "BSD 3-clause License",
"summary": "Burp-UI is a web-ui for burp backup written in python with Flask and jQuery/Bootstrap",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://git.ziirish.me/ziirish/burp-ui"
},
"split_keywords": [
"burp",
"web",
"ui",
"backup",
"monitoring"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d26c26a2953d10bdb0ff0f4cf799286c43a238bbe242542577fc8627decabffe",
"md5": "471c8ad2464520cfe799bfc59debab4c",
"sha256": "fa58ce2aa65604de5049fc04f5e8dd8969062192ffc40f60dbeec790d48b805c"
},
"downloads": -1,
"filename": "burp_ui-1.1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "471c8ad2464520cfe799bfc59debab4c",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 3631439,
"upload_time": "2023-07-07T18:25:55",
"upload_time_iso_8601": "2023-07-07T18:25:55.797327Z",
"url": "https://files.pythonhosted.org/packages/d2/6c/26a2953d10bdb0ff0f4cf799286c43a238bbe242542577fc8627decabffe/burp_ui-1.1.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ef9add46dce3304742fe71e784d7267b2497ebeba70c70f7d81776082a8fe914",
"md5": "1b9900dc8a5897851c27c567490d94e0",
"sha256": "3d0469d0069c268d7ade2f17bb7f8882e085fad64d7b0391d4fe44b187f69c79"
},
"downloads": -1,
"filename": "burp-ui-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "1b9900dc8a5897851c27c567490d94e0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 1995693,
"upload_time": "2023-07-07T18:25:59",
"upload_time_iso_8601": "2023-07-07T18:25:59.078942Z",
"url": "https://files.pythonhosted.org/packages/ef/9a/dd46dce3304742fe71e784d7267b2497ebeba70c70f7d81776082a8fe914/burp-ui-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-07 18:25:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "burp-ui"
}
JSON