doc: add section on security and misc fixes

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-05 18:13:58 +01:00
parent 73ede15929
commit 166c767317
9 changed files with 112 additions and 22 deletions
@@ -0,0 +1,33 @@
+Kapow! HTTP Interfaces
+======================
+
+`kapow server` sets up three HTTP server interfaces, each with a distinct and
+clear purpose.
+
+User Interface
+--------------
+
+The User HTTP interface is used to serve final user requests.
+
+By default it binds to address ``0.0.0.0`` and port ``8080``, but can be changed via
+the ``--bind`` flag.
+
+
+Control Interface
+-----------------
+
+The Control HTTP interface is used by the command `kapow route` to
+administer the list of system routes.
+
+By default it binds to address ``127.0.0.1`` and port ``8081``, but can be changed
+via the ``--control-bind`` flag.
+
+
+Data Interface
+--------------
+
+The Data HTTP interface is used by the commands ``kapow get`` and ``kapow
+set`` to exchange the data for a particular request.
+
+By default it binds to address ``127.0.0.1`` and port ``8082``, but can be changed
+via the ``--data-bind`` flag.