summaryrefslogtreecommitdiffstats
path: root/doc/afb-daemon.html
blob: 85b24980903af1c945bcc5200f6b845072203b0d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
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>