Dark-Alex-17/kapow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

WIP on docs/theory

Browse Source 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
This commit is contained in:
pancho horrillo
2019-11-20 12:54:29 +01:00
parent 850baf95f7
commit 5ee8353cba
3 changed files with 212 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/theory/interfaces.rst
+9 -3
View File
@@ -1,12 +1,16 @@
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 is bind to address `0.0.0.0` and port `8080`.
By default it binds to address `0.0.0.0` and port `8080`, but can be changed via
the ``--bind`` flag.
Control Interface
@@ -15,7 +19,8 @@ Control Interface
The Control HTTP interface is used by the command `kapow route` to
administer the list of system routes.
By default is bind to address `127.0.0.1` and port `8081`.
By default it binds to address `127.0.0.1` and port `8081`, but can be changed
via the ``--control-bind`` flag.
Data Interface
@@ -24,4 +29,5 @@ 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 is bind to address `127.0.0.1` and port `8082`.
By default it binds to address `127.0.0.1` and port `8082`, but can be changed
via the ``--data-bind`` flag.