1 # Launching options of afb-daemon
3 The launch options for binder **afb-daemon** are:
7 Prints help with available options
11 Display version and copyright
15 Increases the verbosity, can be repeated
19 Decreases the verbosity, can be repeated
23 HTTP listening TCP port [default 1234]
27 Directory where the daemon must run [default: $PWD if defined
28 or the current working directory]
32 Directory where uploaded files are temporarily stored [default: workdir]
36 Root directory of the application to serve [default: workdir]
40 Directory of HTTP served files. If not set, files are not served
41 but apis are still accessible.
45 Angular Base Root URL [default /opa]
47 This is used for any application of kind OPA (one page application).
48 When set, any missing document whose url has the form /opa/zzz
49 is translated to /opa/#!zzz
53 HTML Root API URL [default /api]
55 The bindings are available within that url.
59 Maps a path located anywhere in the file system to the
60 a subdirectory. The syntax for mapping a PATH to the
61 subdirectory NAME is: --alias=/NAME:PATH.
63 Example: --alias=/icons:/usr/share/icons maps the
64 content of /usr/share/icons within the subpath /icons.
66 This option can be repeated.
70 binding API timeout in seconds [default 20]
72 Defines how many seconds maximum a method is allowed to run.
77 Client Session Timeout in seconds [default 3600]
81 Client cache end of live [default 100000 that is 27,7 hours]
85 Maximum count of simultaneous sessions [default 10]
89 Load bindings from given paths separated by colons
90 as for dir1:dir2:binding1.so:... [default = $libdir/afb]
92 You can mix path to directories and to bindings.
93 The sub-directories of the given directories are searched
96 The bindings are the files terminated by '.so' (the extension
97 so denotes shared object) that contain the public entry symbol.
101 Load the binding of given path.
105 Initial Secret token to authenticate.
107 If not set, no client can authenticate.
109 If set to the empty string, then any initial token is accepted.
113 Generate a random starting token. See option --exec.
117 Set the mode: either local, remote or global.
119 The mode indicate if the application is run locally on the host
120 or remotely through network.
124 Transparent binding to a binder afb-daemon service through dbus.
126 It creates an API of name xxxx that is implemented remotely
127 and queried via DBUS.
131 Provides a binder afb-daemon service through dbus.
133 The name xxxx must be the name of an API defined by a binding.
134 This API is exported through DBUS.
138 Transparent binding to a binder afb-daemon service through a WebSocket.
140 The value of xxxx is either a unix naming socket, of the form "unix:path/api",
141 or an internet socket, of the form "host:port/api".
145 Provides a binder afb-daemon service through WebSocket.
147 The value of xxxx is either a unix naming socket, of the form "unix:path/api",
148 or an internet socket, of the form "host:port/api".
152 Get all in foreground mode (default)
156 Get all in background mode
164 Must be the last option for afb-daemon. The remaining
165 arguments define a command that afb-daemon will launch.
166 The sequences @p, @t and @@ of the arguments are replaced
167 with the port, the token and @.
171 Trace the processing of requests in the log file.
173 Valid values are 'no' (default), 'common', 'extra' or 'all'.
177 Trace the accesses to functions of class daemon.
179 Valid values are 'no' (default), 'common', 'extra' or 'all'.
183 Trace the accesses to functions of class service.
185 Valid values are 'no' (default) or 'all'.
189 Trace the accesses to functions of class event.
191 Valid values are 'no' (default), 'common', 'extra' or 'all'.
195 Call a binding at start (can be be repeated).
196 The values are given in the form API/VERB:json-args.
198 Example: --call 'monitor/set:{"verbosity":{"api":"debug"}}'