diff --git a/docs/installation.rst b/docs/installation.rst index c835e94d..c79a1255 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -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 `Burp-UI`_. 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 @@ -117,6 +118,11 @@ Options 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 `_ + section of the documentation for further details. + Developer options ----------------- diff --git a/docs/upgrading.rst b/docs/upgrading.rst index 27fd060a..dd3afb4b 100644 --- a/docs/upgrading.rst +++ b/docs/upgrading.rst @@ -14,6 +14,7 @@ v0.4.0 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 purpose such as `gunicorn `_ 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 **SHOULD** be backward compatible (but note that no further support will be diff --git a/docs/usage.rst b/docs/usage.rst index afbae8cf..b6fb54ef 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -5,12 +5,6 @@ Usage `Burp`_ from the stable to the latest versions. `Burp`_ exists in two major 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. The consequence is you have various options in the configuration file to suite everybody needs.