1 # Launching options of afb-daemon
3 The launch options for binder **afb-daemon** are:
6 -v, --verbose Verbose Mode, repeat to increase verbosity
7 -q, --quiet Quiet Mode, repeat to decrease verbosity
8 -l, --log=xxxx Tune log level
9 --foreground Get all in foreground mode
10 --daemon Get all in background mode
11 -n, --name=xxxx Set the visible name
12 -p, --port=xxxx HTTP listening TCP port [default 1234]
13 --roothttp=xxxx HTTP Root Directory [default no root http (files not served but apis still available)]
14 --rootbase=xxxx Angular Base Root URL [default /opa]
15 --rootapi=xxxx HTML Root API URL [default /api]
16 --alias=xxxx Multiple url map outside of rootdir [eg: --alias=/icons:/usr/share/icons]
17 --apitimeout=xxxx Binding API timeout in seconds [default 20]
18 --cntxtimeout=xxxx Client Session Context Timeout [default 32000000]
19 --cache-eol=xxxx Client cache end of live [default 100000]
20 -w, --workdir=xxxx Set the working directory [default: $PWD or current working directory]
21 -u, --uploaddir=xxxx Directory for uploading files [default: workdir]
22 --rootdir=xxxx Root Directory of the application [default: workdir]
23 --ldpaths=xxxx Load bindings from dir1:dir2:... [default = /opt/jobol/lib64/afb]
24 -b, --binding=xxxx Load the binding of path
25 --weak-ldpaths=xxxx Same as --ldpaths but ignore errors
26 --no-ldpaths Discard default ldpaths loading
27 -t, --token=xxxx Initial Secret [default=random, use --token= to allow any token]
28 -r, --random-token Enforce a random token
29 -V, --version Display version and copyright
30 -h, --help Display this help
31 --ws-client=xxxx Bind to an afb service through websocket
32 --ws-server=xxxx Provide an afb service through websockets
33 -A, --auto-api=xxxx Automatic load of api of the given directory
34 --session-max=xxxx Max count of session simultaneously [default 200]
35 --tracereq=xxxx Log the requests: no, common, extra, all
36 --traceditf=xxxx Log the daemons: no, common, all
37 --tracesvc=xxxx Log the services: no, all
38 --traceevt=xxxx Log the events: no, common, extra, all
39 --traceses=xxxx Log the sessions: no, all
40 --traceapi=xxxx Log the apis: no, common, api, event, all
41 -c, --call=xxxx call at start format of val: API/VERB:json-args
42 --no-httpd Forbid HTTP service
43 -e, --exec Execute the remaining arguments
44 -M, --monitoring Enable HTTP monitoring at <ROOT>/monitoring/
49 Prints help with available options
53 Display version and copyright
57 Increases the verbosity, can be repeated
61 Decreases the verbosity, can be repeated
65 Tune the log level mask. The levels are:
73 The level can be set using + or -.
75 | Examples | descritpion
76 |-----------------|-------------------
77 | error,warning | selects only the levels error and warning
78 | +debug | adds level debug to the current verbosity
79 | -warning | remove the level warning from the current verbosity
80 | +warning-debug,info | Adds error and remove errors and warnings
84 HTTP listening TCP port [default 1234]
88 Directory where the daemon must run [default: $PWD if defined
89 or the current working directory]
93 Directory where uploaded files are temporarily stored [default: workdir]
97 Root directory of the application to serve [default: workdir]
101 Directory of HTTP served files. If not set, files are not served
102 but apis are still accessible.
106 Angular Base Root URL [default /opa]
108 This is used for any application of kind OPA (one page application).
109 When set, any missing document whose url has the form /opa/zzz
110 is translated to /opa/#!zzz
114 HTML Root API URL [default /api]
116 The bindings are available within that url.
120 Maps a path located anywhere in the file system to the
121 a subdirectory. The syntax for mapping a PATH to the
122 subdirectory NAME is: --alias=/NAME:PATH.
124 Example: --alias=/icons:/usr/share/icons maps the
125 content of /usr/share/icons within the subpath /icons.
127 This option can be repeated.
131 binding API timeout in seconds [default 20]
133 Defines how many seconds maximum a method is allowed to run.
138 Client Session Timeout in seconds [default 32000000 that is 1 year]
142 Client cache end of live [default 100000 that is 27,7 hours]
146 Maximum count of simultaneous sessions [default 200]
150 Load bindings from given paths separated by colons
151 as for dir1:dir2:binding1.so:... [default = $libdir/afb]
153 You can mix path to directories and to bindings.
154 The sub-directories of the given directories are searched
157 The bindings are the files terminated by '.so' (the extension
158 so denotes shared object) that contain the public entry symbol.
162 Same as --ldpaths but instead of stopping on error, ignore errors and continue.
166 Load the binding of given path.
170 Initial Secret token to authenticate.
172 If not set, no client can authenticate.
174 If set to the empty string, then any initial token is accepted.
178 Generate a random starting token. See option --exec.
182 Transparent binding to a binder afb-daemon service through a WebSocket.
184 The value of xxxx is either a unix naming socket, of the form "unix:path/api",
185 or an internet socket, of the form "host:port/api".
189 Provides a binder afb-daemon service through WebSocket.
191 The value of xxxx is either a unix naming socket, of the form "unix:path/api",
192 or an internet socket, of the form "host:port/api".
196 Get all in foreground mode (default)
200 Get all in background mode
208 Must be the last option for afb-daemon. The remaining
209 arguments define a command that afb-daemon will launch.
210 The sequences @p, @t and @@ of the arguments are replaced
211 with the port, the token and @.
215 Trace the processing of requests in the log file.
217 Valid values are 'no' (default), 'common', 'extra' or 'all'.
221 Trace the accesses to functions of class api.
223 Valid values are 'no' (default), 'common', 'api', 'event' or 'all'.
227 Trace the accesses to functions of class event.
229 Valid values are 'no' (default), 'common', 'extra' or 'all'.
233 Call a binding at start (can be be repeated).
234 The values are given in the form API/VERB:json-args.
236 Example: --call 'monitor/set:{"verbosity":{"api":"debug"}}'
240 Enable HTTP monitoring at <ROOT>/monitoring/
248 Automatic activation of api of the given directory when the api is missing.