aboutsummaryrefslogtreecommitdiffstats
path: root/doc/afb-overview.md
diff options
context:
space:
mode:
authorJosé Bollo <jose.bollo@iot.bzh>2017-01-12 17:34:02 +0100
committerJosé Bollo <jose.bollo@iot.bzh>2017-01-12 17:34:02 +0100
commit0686ada403014fa7a27ca3e01a6b025a27fe8c16 (patch)
tree150d39db70f856e0cdaf69b1e82ba3a8079f8bd6 /doc/afb-overview.md
parenta76eb15251a08240e91fbffd96eb178bddd82330 (diff)
Improves documentation and directory management
Change-Id: I21c102f7439343476765c65011664feece2d2c18 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'doc/afb-overview.md')
-rw-r--r--doc/afb-overview.md55
1 files changed, 50 insertions, 5 deletions
diff --git a/doc/afb-overview.md b/doc/afb-overview.md
index 6272b5d2..78ef8c34 100644
--- a/doc/afb-overview.md
+++ b/doc/afb-overview.md
@@ -116,13 +116,31 @@ The launch options for binder **afb-daemon** are:
Increases the verbosity, can be repeated
+ --quiet
+
+ Decreases the verbosity, can be repeated
+
--port=xxxx
HTTP listening TCP port [default 1234]
+ --workdir=xxxx
+
+ Directory where the daemon must run [default: $PWD if defined
+ or the current working directory]
+
+ --uploaddir=xxxx
+
+ Directory where uploaded files are temporarily stored [default: workdir]
+
--rootdir=xxxx
- HTTP Root Directory [default $AFBDIR or else $HOME/.AFB]
+ Root directory of the application to serve [default: workdir]
+
+ --roothttp=xxxx
+
+ Directory of HTTP served files. If not set, files are not served
+ but apis are still accessibles.
--rootbase=xxxx
@@ -149,6 +167,10 @@ The launch options for binder **afb-daemon** are:
This option can be repeated.
+ --no-httpd
+
+ Tells to not start the HTTP server.
+
--apitimeout=xxxx
binding API timeout in seconds [default 20]
@@ -164,10 +186,6 @@ The launch options for binder **afb-daemon** are:
Client cache end of live [default 100000 that is 27,7 hours]
- --sessiondir=xxxx
-
- Sessions file path [default rootdir/sessions]
-
--session-max=xxxx
Maximum count of simultaneous sessions [default 10]
@@ -196,6 +214,10 @@ The launch options for binder **afb-daemon** are:
If set to the empty string, then any initial token is accepted.
+ --random-token
+
+ Generate a random starting token. See option --exec.
+
--mode=xxxx
Set the mode: either local, remote or global.
@@ -224,6 +246,20 @@ The launch options for binder **afb-daemon** are:
The name xxxx must be the name of an API defined by a binding.
This API is exported through DBUS.
+ --ws-client=xxxx
+
+ Transparent binding to a binder afb-daemon service through a WebSocket.
+
+ The value of xxxx is either a unix naming socket, of the form "unix:path/api",
+ or an internet socket, of the form "host:port/api".
+
+ --ws-server=xxxx
+
+ Provides a binder afb-daemon service through WebSocket.
+
+ The value of xxxx is either a unix naming socket, of the form "unix:path/api",
+ or an internet socket, of the form "host:port/api".
+
--foreground
Get all in foreground mode (default)
@@ -243,6 +279,15 @@ The launch options for binder **afb-daemon** are:
The sequences @p, @t and @@ of the arguments are replaced
with the port, the token and @.
+ --tracereq=xxxx
+
+ Trace the processing of requests in the log file.
+
+ Valid values are 'no' (default), 'common', 'extra' or 'all'.
+
+
+
+
Future development of afb-daemon
--------------------------------