From 2ffd76faf82d8d0a671faa21b1382a0cf24ed89c Mon Sep 17 00:00:00 2001 From: ziirish Date: Wed, 17 Jun 2015 17:50:05 +0200 Subject: [PATCH] fix: links in documentation --- docs/contributing.rst | 11 +++++++---- docs/development.rst | 5 ++++- docs/gunicorn.rst | 13 +++++++------ docs/index.rst | 3 ++- docs/installation.rst | 11 ++++++----- docs/requirements.rst | 5 ++++- docs/usage.rst | 27 ++++++++++++++------------- 7 files changed, 44 insertions(+), 31 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 1185aaee..257033d8 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -2,9 +2,12 @@ Contributing ============ Contributions are welcome. You can help in any way you want, for instance by -opening issues on the `bug tracker `__, -sending patches, etc. -There is also a dedicated website. Currently it only hosts a `Discourse `__ -instance where you ca discuss with each other. +opening issues on the `bug tracker +`__, sending patches, etc. + +There is also a dedicated website. Currently it only hosts a `Discourse +`__ instance where you ca discuss with each other. + Feel free to use it and post your tips and remarks. + The address is: `http://burpui.ziirish.me/ `__ diff --git a/docs/development.rst b/docs/development.rst index 2c1457ec..46ab7cf6 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -16,5 +16,8 @@ To do so, run the following commands: pip install git+https://git.ziirish.me/ziirish/burp-ui.git -You can uninstall/disable this ``Burp-UI`` setup by typing ``deactivate`` and +You can uninstall/disable this `Burp-UI` setup by typing ``deactivate`` and removing the ``/opt/bui-venv`` directory. + + +.. _Burp-UI: https://git.ziirish.me/ziirish/burp-ui diff --git a/docs/gunicorn.rst b/docs/gunicorn.rst index 12dcd93d..dbb8f1de 100644 --- a/docs/gunicorn.rst +++ b/docs/gunicorn.rst @@ -1,7 +1,7 @@ Gunicorn ======== -Starting from v0.0.6, ``Burp-UI`` supports `Gunicorn`_ in +Starting from v0.0.6, `Burp-UI`_ supports `Gunicorn`_ in order to handle multiple users simultaneously. You need to install ``gunicorn`` and ``eventlet``: @@ -11,19 +11,20 @@ You need to install ``gunicorn`` and ``eventlet``: pip install eventlet pip install gunicorn -You will then be able to launch ``Burp-UI`` this way: +You will then be able to launch `Burp-UI`_ this way: :: gunicorn -k eventlet -w 4 'burpui:init(conf="/path/to/burpui.cfg")' When using ``gunicorn``, the command line options are not available. Instead, -run the ``Burp-UI`` ``init`` method directly. Here are the parameters you can +run the `Burp-UI`_ ``init`` method directly. Here are the parameters you can play with: -- conf: Path to the ``Burp-UI`` configuration file -- debug: Whether to run ``Burp-UI`` in debug mode or not to get some extra logging -- logfile: Path to a logfile in order to log ``Burp-UI`` internal messages +- conf: Path to the `Burp-UI`_ configuration file +- debug: Whether to run `Burp-UI`_ in debug mode or not to get some extra logging +- logfile: Path to a logfile in order to log `Burp-UI`_ internal messages .. _Gunicorn: http://gunicorn.org/ +.. _Burp-UI: https://git.ziirish.me/ziirish/burp-ui diff --git a/docs/index.rst b/docs/index.rst index cff18fdc..d94984c0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,7 +6,7 @@ Burp-UI ======= -Burp-UI is a web-ui for burp backup written in python with Flask and jQuery/Bootstrap. +`Burp-UI`_ is a web-ui for `Burp`_ backup written in python with Flask and jQuery/Bootstrap. Documentation @@ -33,4 +33,5 @@ Indices and tables .. _Flask: http://flask.pocoo.org/ .. _License: https://git.ziirish.me/ziirish/burp-ui/blob/master/LICENSE .. _Burp: http://burp.grke.org/ +.. _Burp-UI: https://git.ziirish.me/ziirish/burp-ui .. _burpui.cfg: https://git.ziirish.me/ziirish/burp-ui/blob/master/share/burpui/etc/burpui.sample.cfg diff --git a/docs/installation.rst b/docs/installation.rst index 25363c96..1c11ef17 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,8 +1,8 @@ Installation ============ -``Burp-UI`` is written in Python with the `Flask`_ micro-framework. -The easiest way to install Flask is to use ``pip``. +`Burp-UI`_ is written in Python with the `Flask`_ micro-framework. +The easiest way to install `Burp-UI`_ is to use ``pip``. On Debian, you can install ``pip`` with the following command: @@ -21,7 +21,7 @@ Once ``pip`` is installed, you can install ``Burp-UI`` this way: You can setup various parameters in the `burpui.cfg`_ file. This file can be specified with the ``-c`` flag or should be present in ``/etc/burp/burpui.cfg``. -By default ``Burp-UI`` ships with a default file located in +By default `Burp-UI`_ ships with a default file located in ``$BURPUIDIR/../share/burpui/etc/burpui.sample.cfg``. Then you can run ``burp-ui``: ``burp-ui`` @@ -40,9 +40,9 @@ need to check a few things: 2. Provide the full path of an empty directory where a temporary restoration will be made. This involves you have enough space left on that location on the server that runs ``Burp-UI`` -3. Launch ``Burp-UI`` with a user that can proceed restorations and that can +3. Launch `Burp-UI`_ with a user that can proceed restorations and that can write in the directory above -4. Make sure to configure a client on the server that runs ``Burp-UI`` that can +4. Make sure to configure a client on the server that runs `Burp-UI`_ that can restore files of other clients (option *restore_client* in burp-server configuration) @@ -66,3 +66,4 @@ Options .. _Flask: http://flask.pocoo.org/ .. _burpui.cfg: https://git.ziirish.me/ziirish/burp-ui/blob/master/share/burpui/etc/burpui.sample.cfg +.. _Burp-UI: https://git.ziirish.me/ziirish/burp-ui diff --git a/docs/requirements.rst b/docs/requirements.rst index 9217076f..3d4a58a0 100644 --- a/docs/requirements.rst +++ b/docs/requirements.rst @@ -1,7 +1,7 @@ Requirements ============ -Please note that currently, ``Burp-UI`` must be running on the same server that +Please note that currently, `Burp-UI`_ must be running on the same server that runs the burp-server. @@ -18,3 +18,6 @@ On Debian: :: aptitude install python-openssl + + +.. _Burp-UI: https://git.ziirish.me/ziirish/burp-ui diff --git a/docs/usage.rst b/docs/usage.rst index 451d4018..74f2db7a 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -1,24 +1,24 @@ Usage ===== -``Burp-UI`` has been written with modularity in mind. The aim is to support +`Burp-UI`_ has been written with modularity in mind. The aim is to support `Burp`_ from the stable to the latest versions. `Burp`_ exists in two major versions: 1.x.x and 2.x.x. The version 2.x.x 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``. +`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 every bodies needs. There are also different modules to support `Authentication`_ and `ACL`_ support within the web-interface. -``Burp-UI`` tries to be the less intrusive possible, nevertheless it ships with +`Burp-UI`_ tries to be the less intrusive possible, nevertheless it ships with the ability to manage `Burp`_'s configuration files. This feature requires -``Burp-UI`` to be launched on the same server that hosts your `Burp`_ instance. -You also have to make sure the user that runs ``Burp-UI`` has enough privileges +`Burp-UI`_ to be launched on the same server that hosts your `Burp`_ instance. +You also have to make sure the user that runs `Burp-UI`_ has enough privileges to edit those files. @@ -59,22 +59,22 @@ The configuration file contains a *Global* section as follow: Each option is commented, but here is a more detailed documentation: -- *port*: On which port is ``Burp-UI`` listening. This option is ignored when +- *port*: On which port is `Burp-UI`_ listening. This option is ignored when using `Gunicorn`_. -- *bind*: On which address is ``Burp-UI`` listening. This option is ignored when +- *bind*: On which address is `Burp-UI`_ listening. This option is ignored when using `Gunicorn`_. - *ssl*: Whether to enable SSL or not. This option is ignored when using `Gunicorn`_. - *sslcert*: SSL certificate to use when SSL support is enabled. - *sslkey*: SSL key to use when SSL support is enabled. -- *version*: What version of `Burp`_ this ``Burp-UI`` instance manages. Can +- *version*: What version of `Burp`_ this `Burp-UI`_ instance manages. Can either be *1* or *2*. This parameter determines which backend is loaded at runtime. -- *standalone*: ``Burp-UI`` can run in two different modes. If it runs in +- *standalone*: `Burp-UI`_ can run in two different modes. If it runs in standalone mode (meaning you set this parameter to *true*), you can only address **one** `Burp`_ server of the version specified by the previous parameter. - If this option is set to *false*, ``Burp-UI`` will run as a *proxy* allowing + If this option is set to *false*, `Burp-UI`_ will run as a *proxy* allowing you to address multiple `Burp`_ servers. In this mode, you need to configure **at least one** *Agent* section in your configuration file. You also need to run one ``bui-agent`` per server. @@ -170,7 +170,7 @@ Each option is commented, but here is a more detailed documentation: Authentication -------------- -``Burp-UI`` provides some authentication backends in order to restrict access +`Burp-UI`_ provides some authentication backends in order to restrict access only to granted users. There are currently two different backends: @@ -261,7 +261,7 @@ Now you can add *basic* specific options: ACL --- -``Burp-UI`` implements some mechanisms to restrict access on some resources only +`Burp-UI`_ implements some mechanisms to restrict access on some resources only for some users. There is currently only one backend: @@ -314,3 +314,4 @@ Now you can add *basic acl* specific options: .. _Burp: http://burp.grke.org/ .. _Gunicorn: http://gunicorn.org/ +.. _Burp-UI: https://git.ziirish.me/ziirish/burp-ui