github-starred/burp-ui
2
0
Fork 0
mirror of https://github.com/ziirish/burp-ui.git synced 2026-05-21 06:45:24 -06:00
Code Issues 1 Projects Packages Wiki Activity Actions

update doc

Browse source
This commit is contained in:
ziirish 2017-02-10 08:15:51 +01:00
parent 510fdd0184
commit 7f1e0b5cf6
3 changed files with 8 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/installation.rst
View file

@ -88,7 +88,8 @@ on any machine as long as you can access the burp status port, but you will not
be able to edit the burp server configuration file within the *settings* view of be able to edit the burp server configuration file within the *settings* view of
`Burp-UI`_. `Burp-UI`_.
You also need to configure a *restore_client* on your burp server corresponding You also need to configure a *restore_client* on your burp server corresponding
to the client you will use through `Burp-UI`_ to the client you will use through `Burp-UI`_ (see the `restoration procedure
<#restoration>`_ above)
Options Options
@ -117,6 +118,11 @@ Options
migrations directory migrations directory
.. note:: Since v0.4.0, the *bind* and *port* options are not supported anymore.
You can still force the port and listening address as explained bellow
or you can have a look at the `upgrading <upgrading.html#v0.4.0>`_
section of the documentation for further details.
Developer options Developer options
----------------- -----------------

1
docs/upgrading.rst
View file

@ -14,6 +14,7 @@ v0.4.0
longer possible to serve the application over SSL (HTTPS) anymore from within longer possible to serve the application over SSL (HTTPS) anymore from within
the Flask's server. You'll need to use a dedicated application server for this the Flask's server. You'll need to use a dedicated application server for this
purpose such as `gunicorn <gunicorn.html>`_ or a reverse-proxy. purpose such as `gunicorn <gunicorn.html>`_ or a reverse-proxy.
The *bind* and *port* option have also been removed due to the same reason.
Or you can use the ``python -m burpui -m legacy [--help]`` command that Or you can use the ``python -m burpui -m legacy [--help]`` command that
**SHOULD** be backward compatible (but note that no further support will be **SHOULD** be backward compatible (but note that no further support will be

6
docs/usage.rst
View file

@ -5,12 +5,6 @@ Usage
`Burp`_ from the stable to the latest versions. `Burp`_ exists in two major `Burp`_ from the stable to the latest versions. `Burp`_ exists in two major
versions: 1.x.x and 2.x.x. versions: 1.x.x and 2.x.x.
.. note::
The version 2.x.x of `Burp`_ is currently in heavy development and should
bring a lot of improvements, but also a lot of rework especially regarding
the ``status port`` which is the main communication system between `Burp`_
and `Burp-UI`_.
Both `Versions`_ are supported by `Burp-UI`_ thanks to its modular design. Both `Versions`_ are supported by `Burp-UI`_ thanks to its modular design.
The consequence is you have various options in the configuration file to suite The consequence is you have various options in the configuration file to suite
everybody needs. everybody needs.