Theory documentation scaffolding

This commit is contained in:
Roberto Abdelkader Martínez Pérez
2019-11-20 11:22:24 +01:00
parent 206aac5747
commit 4c3fe37616
4 changed files with 38 additions and 0 deletions
+27
View File
@@ -0,0 +1,27 @@
Kapow! HTTP Interfaces
======================
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`.
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`.
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`.
View File
@@ -0,0 +1,7 @@
Request Life Cycle
==================
This section describes the sequence of events happening for each request
answered by the User HTTP Interface.
+4
View File
@@ -0,0 +1,4 @@
The Resource Tree
=================