doc/afb-daemon.html

   1 <html>
   2 <head>
   3   <link rel="stylesheet" type="text/css" href="doc.css">
   4   <meta charset="UTF-8">
   5 </head>
   6 <body>
   7 <a name="The.binder.AFB-DAEMON"></a>
   8 <h1>The binder AFB-DAEMON</h1>
   9
  10 <pre><code>version: 1
  11 Date:    30 mai 2016
  12 Author:  José Bollo
  13 </code></pre>
  14
  15 <p><ul>
  16  <li><a href="#The.binder.AFB-DAEMON">The binder AFB-DAEMON</a>
  17  <ul>
  18   <li><a href="#Launching.the.binder.afb-daemon">Launching the binder afb-daemon</a></li>
  19   <li><a href="#Working.with.afb-daemon">Working with afb-daemon</a></li>
  20   <li><a href="#Future.of.afb-daemon">Future of afb-daemon</a></li>
  21  </ul>
  22  </li>
  23 </ul></p>
  24
  25 <a name="Launching.the.binder.afb-daemon"></a>
  26 <h2>Launching the binder afb-daemon</h2>
  27
  28 <p>The launch options for binder <strong>afb-daemon</strong> are:</p>
  29
  30 <pre><code>  --help
  31
  32         Prints help with available options
  33
  34   --version
  35
  36         Display version and copyright
  37
  38   --verbose
  39
  40         Increases the verbosity, can be repeated
  41
  42   --port=xxxx
  43
  44         HTTP listening TCP port  [default 1234]
  45
  46   --rootdir=xxxx
  47
  48         HTTP Root Directory [default $AFBDIR or else $HOME/.AFB]
  49
  50   --rootbase=xxxx
  51
  52         Angular Base Root URL [default /opa]
  53
  54         This is used for any application of kind OPA (one page application).
  55         When set, any missing document whose url has the form /opa/zzz
  56         is translated to /opa/#!zzz
  57
  58   --rootapi=xxxx
  59
  60         HTML Root API URL [default /api]
  61
  62         The plugins are available within that url.
  63
  64   --alias=xxxx
  65
  66         Maps a path located anywhere in the file system to the
  67         a subdirectory. The syntax for mapping a PATH to the
  68         subdirectory NAME is: --alias=/NAME:PATH.
  69
  70         Example: --alias=/icons:/usr/share/icons maps the
  71         content of /usr/share/icons within the subpath /icons.
  72
  73         This option can be repeated.
  74
  75   --apitimeout=xxxx
  76
  77         Plugin API timeout in seconds [default 20]
  78
  79         Defines how many seconds maximum a method is allowed to run.
  80         0 means no limit.
  81
  82   --cntxtimeout=xxxx
  83
  84         Client Session Timeout in seconds [default 3600]
  85
  86   --cache-eol=xxxx
  87
  88         Client cache end of live [default 100000 that is 27,7 hours]
  89
  90   --sessiondir=xxxx
  91
  92         Sessions file path [default rootdir/sessions]
  93
  94   --ldpaths=xxxx
  95
  96         Load Plugins from given paths separated by colons
  97         as for dir1:dir2:plugin1.so:... [default = $libdir/afb]
  98
  99         You can mix path to directories and to plugins.
 100         The sub-directories of the given directories are searched
 101         recursively.
 102
 103         The plugins are the files terminated by '.so' (the extension
 104         so denotes shared object) that contain the public entry symbol.
 105
 106   --plugin=xxxx
 107
 108         Load the plugin of given path.
 109
 110   --token=xxxx
 111
 112         Initial Secret token to authenticate.
 113
 114         If not set, no client can authenticate.
 115
 116         If set to the empty string, then any initial token is accepted.
 117
 118   --mode=xxxx
 119
 120         Set the mode: either local, remote or global.
 121
 122         The mode indicate if the application is run locally on the host
 123         or remotely through network.
 124
 125   --readyfd=xxxx
 126
 127         Set the #fd to signal when ready
 128
 129         If set, the binder afb-daemon will write "READY=1\n" on the file
 130         descriptor whose number if given (/proc/self/fd/xxx).
 131
 132   --dbus-client=xxxx
 133
 134         Transparent binding to a binder afb-daemon service through dbus.
 135
 136         It creates an API of name xxxx that is implemented remotely
 137         and queried via DBUS.
 138
 139   --dbus-server=xxxx
 140
 141         Provides a binder afb-daemon service through dbus.
 142
 143         The name xxxx must be the name of an API defined by a plugin.
 144         This API is exported through DBUS.
 145
 146   --foreground
 147
 148         Get all in foreground mode (default)
 149
 150   --daemon
 151
 152         Get all in background mode
 153 </code></pre>
 154
 155 <a name="Working.with.afb-daemon"></a>
 156 <h2>Working with afb-daemon</h2>
 157
 158 <a name="Future.of.afb-daemon"></a>
 159 <h2>Future of afb-daemon</h2>
 160
 161 <ul>
 162 <li><p>Integration of the protocol JSON-RPC for the websockets.</p></li>
 163 <li><p>The binder afb-daemon would launch the applications directly.</p></li>
 164 <li><p>The current setting of mode (local/remote/global) might be reworked to a
 165 mechanism for querying configuration variables.</p></li>
 166 <li><p>Implements &ldquo;one-shot&rdquo; initial token. It means that after its first
 167 authenticated use, the initial token is removed and no client can connect
 168 anymore.</p></li>
 169 </ul>
 170 </body>
 171 </html>