From d3e09a178b96b9eede2e6611c835ba531e76e729 Mon Sep 17 00:00:00 2001 From: Christophe Courtois Date: Wed, 3 May 2017 14:58:33 +0200 Subject: [PATCH] Example for powa-web server options + typos --- docs/components/powa-web/index.rst | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/docs/components/powa-web/index.rst b/docs/components/powa-web/index.rst index d2b5af5..db62e78 100644 --- a/docs/components/powa-web/index.rst +++ b/docs/components/powa-web/index.rst @@ -170,20 +170,35 @@ servers (dict): cookie_secret (str): A secret key used to secure cookies transiting between the web browser and the - server. + server. - .. code-block:: python - - cookie_secret="SECRET_STRING" The following options are optional: port (int): - The port on which the UI will be available (default 8888) + The port on which the UI will be available (default 8888). address (str): - The IP address on which the UI will be available (default 0.0.0.0) + The IP address on which the UI will be available. This must be one of the IP addresses of the powa-web server. Default is 0.0.0.0 and means that the UI is available from the outside. Set to '127.0.0.1' or '::1' to restrict access to the current computer. If you have a firewall, do not forget to add a rule to grant access. + +Example: + + .. code-block:: python + + servers={ + 'main': { + 'host': 'localhost', + 'port': '5432', + 'database': 'powa' + } + } + cookie_secret="ed2xoow8shet3eiyai4Odo2OTama2y" + port=8887 + address='127.0.0.1' + + + See also: