summaryrefslogtreecommitdiffstats
path: root/doc/afb-daemon.html
diff options
context:
space:
mode:
authorJosé Bollo <jose.bollo@iot.bzh>2016-05-30 13:22:34 +0200
committerJosé Bollo <jose.bollo@iot.bzh>2016-05-30 13:36:47 +0200
commit0156b1645a201e44d5285c96d32cbfa5a9eb6814 (patch)
treeb249c14ce158161b2100603c7301a55ba8bd3a3d /doc/afb-daemon.html
parentb41ed8f8cbbdf7cff415f69f6f9b4a92cfe1f37d (diff)
Improves the documentation
Change-Id: Iac5ee5c2ca014ced5fe836601e9afc362a9d4fda Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'doc/afb-daemon.html')
-rw-r--r--doc/afb-daemon.html171
1 files changed, 171 insertions, 0 deletions
diff --git a/doc/afb-daemon.html b/doc/afb-daemon.html
new file mode 100644
index 00000000..85b24980
--- /dev/null
+++ b/doc/afb-daemon.html
@@ -0,0 +1,171 @@
+<html>
+<head>
+ <link rel="stylesheet" type="text/css" href="doc.css">
+ <meta charset="UTF-8">
+</head>
+<body>
+<a name="The.binder.AFB-DAEMON"></a>
+<h1>The binder AFB-DAEMON</h1>
+
+<pre><code>version: 1
+Date: 30 mai 2016
+Author: José Bollo
+</code></pre>
+
+<p><ul>
+ <li><a href="#The.binder.AFB-DAEMON">The binder AFB-DAEMON</a>
+ <ul>
+ <li><a href="#Launching.the.binder.afb-daemon">Launching the binder afb-daemon</a></li>
+ <li><a href="#Working.with.afb-daemon">Working with afb-daemon</a></li>
+ <li><a href="#Future.of.afb-daemon">Future of afb-daemon</a></li>
+ </ul>
+ </li>
+</ul></p>
+
+<a name="Launching.the.binder.afb-daemon"></a>
+<h2>Launching the binder afb-daemon</h2>
+
+<p>The launch options for binder <strong>afb-daemon</strong> are:</p>
+
+<pre><code> --help
+
+ Prints help with available options
+
+ --version
+
+ Display version and copyright
+
+ --verbose
+
+ Increases the verbosity, can be repeated
+
+ --port=xxxx
+
+ HTTP listening TCP port [default 1234]
+
+ --rootdir=xxxx
+
+ HTTP Root Directory [default $AFBDIR or else $HOME/.AFB]
+
+ --rootbase=xxxx
+
+ Angular Base Root URL [default /opa]
+
+ This is used for any application of kind OPA (one page application).
+ When set, any missing document whose url has the form /opa/zzz
+ is translated to /opa/#!zzz
+
+ --rootapi=xxxx
+
+ HTML Root API URL [default /api]
+
+ The plugins are available within that url.
+
+ --alias=xxxx
+
+ Maps a path located anywhere in the file system to the
+ a subdirectory. The syntax for mapping a PATH to the
+ subdirectory NAME is: --alias=/NAME:PATH.
+
+ Example: --alias=/icons:/usr/share/icons maps the
+ content of /usr/share/icons within the subpath /icons.
+
+ This option can be repeated.
+
+ --apitimeout=xxxx
+
+ Plugin API timeout in seconds [default 20]
+
+ Defines how many seconds maximum a method is allowed to run.
+ 0 means no limit.
+
+ --cntxtimeout=xxxx
+
+ Client Session Timeout in seconds [default 3600]
+
+ --cache-eol=xxxx
+
+ Client cache end of live [default 100000 that is 27,7 hours]
+
+ --sessiondir=xxxx
+
+ Sessions file path [default rootdir/sessions]
+
+ --ldpaths=xxxx
+
+ Load Plugins from given paths separated by colons
+ as for dir1:dir2:plugin1.so:... [default = $libdir/afb]
+
+ You can mix path to directories and to plugins.
+ The sub-directories of the given directories are searched
+ recursively.
+
+ The plugins are the files terminated by '.so' (the extension
+ so denotes shared object) that contain the public entry symbol.
+
+ --plugin=xxxx
+
+ Load the plugin of given path.
+
+ --token=xxxx
+
+ Initial Secret token to authenticate.
+
+ If not set, no client can authenticate.
+
+ If set to the empty string, then any initial token is accepted.
+
+ --mode=xxxx
+
+ Set the mode: either local, remote or global.
+
+ The mode indicate if the application is run locally on the host
+ or remotely through network.
+
+ --readyfd=xxxx
+
+ Set the #fd to signal when ready
+
+ If set, the binder afb-daemon will write "READY=1\n" on the file
+ descriptor whose number if given (/proc/self/fd/xxx).
+
+ --dbus-client=xxxx
+
+ Transparent binding to a binder afb-daemon service through dbus.
+
+ It creates an API of name xxxx that is implemented remotely
+ and queried via DBUS.
+
+ --dbus-server=xxxx
+
+ Provides a binder afb-daemon service through dbus.
+
+ The name xxxx must be the name of an API defined by a plugin.
+ This API is exported through DBUS.
+
+ --foreground
+
+ Get all in foreground mode (default)
+
+ --daemon
+
+ Get all in background mode
+</code></pre>
+
+<a name="Working.with.afb-daemon"></a>
+<h2>Working with afb-daemon</h2>
+
+<a name="Future.of.afb-daemon"></a>
+<h2>Future of afb-daemon</h2>
+
+<ul>
+<li><p>Integration of the protocol JSON-RPC for the websockets.</p></li>
+<li><p>The binder afb-daemon would launch the applications directly.</p></li>
+<li><p>The current setting of mode (local/remote/global) might be reworked to a
+mechanism for querying configuration variables.</p></li>
+<li><p>Implements &ldquo;one-shot&rdquo; initial token. It means that after its first
+authenticated use, the initial token is removed and no client can connect
+anymore.</p></li>
+</ul>
+</body>
+</html>