docs/afb-daemon-options.md

   1
   2 Launching options of afb-daemon
   3 ---------------------
   4
   5 The launch options for binder **afb-daemon** are:
   6
   7           --help
   8
   9                 Prints help with available options
  10
  11           --version
  12
  13                 Display version and copyright
  14
  15           --verbose
  16
  17                 Increases the verbosity, can be repeated
  18
  19           --quiet
  20
  21                 Decreases the verbosity, can be repeated
  22
  23           --port=xxxx
  24
  25                 HTTP listening TCP port  [default 1234]
  26
  27           --workdir=xxxx
  28
  29                 Directory where the daemon must run [default: $PWD if defined
  30                 or the current working directory]
  31
  32           --uploaddir=xxxx
  33
  34                 Directory where uploaded files are temporarily stored [default: workdir]
  35
  36           --rootdir=xxxx
  37
  38                 Root directory of the application to serve [default: workdir]
  39
  40           --roothttp=xxxx
  41
  42                 Directory of HTTP served files. If not set, files are not served
  43                 but apis are still accessible.
  44
  45           --rootbase=xxxx
  46
  47                 Angular Base Root URL [default /opa]
  48
  49                 This is used for any application of kind OPA (one page application).
  50                 When set, any missing document whose url has the form /opa/zzz
  51                 is translated to /opa/#!zzz
  52
  53           --rootapi=xxxx
  54
  55                 HTML Root API URL [default /api]
  56
  57                 The bindings are available within that url.
  58
  59           --alias=xxxx
  60
  61                 Maps a path located anywhere in the file system to the
  62                 a subdirectory. The syntax for mapping a PATH to the
  63                 subdirectory NAME is: --alias=/NAME:PATH.
  64
  65                 Example: --alias=/icons:/usr/share/icons maps the
  66                 content of /usr/share/icons within the subpath /icons.
  67
  68                 This option can be repeated.
  69
  70           --apitimeout=xxxx
  71
  72                 binding API timeout in seconds [default 20]
  73
  74                 Defines how many seconds maximum a method is allowed to run.
  75                 0 means no limit.
  76
  77           --cntxtimeout=xxxx
  78
  79                 Client Session Timeout in seconds [default 3600]
  80
  81           --cache-eol=xxxx
  82
  83                 Client cache end of live [default 100000 that is 27,7 hours]
  84
  85           --session-max=xxxx
  86
  87                 Maximum count of simultaneous sessions [default 10]
  88
  89           --ldpaths=xxxx
  90
  91                 Load bindings from given paths separated by colons
  92                 as for dir1:dir2:binding1.so:... [default = $libdir/afb]
  93
  94                 You can mix path to directories and to bindings.
  95                 The sub-directories of the given directories are searched
  96                 recursively.
  97
  98                 The bindings are the files terminated by '.so' (the extension
  99                 so denotes shared object) that contain the public entry symbol.
 100
 101           --binding=xxxx
 102
 103                 Load the binding of given path.
 104
 105           --token=xxxx
 106
 107                 Initial Secret token to authenticate.
 108
 109                 If not set, no client can authenticate.
 110
 111                 If set to the empty string, then any initial token is accepted.
 112
 113           --random-token
 114
 115                 Generate a random starting token. See option --exec.
 116
 117           --mode=xxxx
 118
 119                 Set the mode: either local, remote or global.
 120
 121                 The mode indicate if the application is run locally on the host
 122                 or remotely through network.
 123
 124           --dbus-client=xxxx
 125
 126                 Transparent binding to a binder afb-daemon service through dbus.
 127
 128                 It creates an API of name xxxx that is implemented remotely
 129                 and queried via DBUS.
 130
 131           --dbus-server=xxxx
 132
 133                 Provides a binder afb-daemon service through dbus.
 134
 135                 The name xxxx must be the name of an API defined by a binding.
 136                 This API is exported through DBUS.
 137
 138           --ws-client=xxxx
 139
 140                 Transparent binding to a binder afb-daemon service through a WebSocket.
 141
 142                 The value of xxxx is either a unix naming socket, of the form "unix:path/api",
 143                 or an internet socket, of the form "host:port/api".
 144
 145           --ws-server=xxxx
 146
 147                 Provides a binder afb-daemon service through WebSocket.
 148
 149                 The value of xxxx is either a unix naming socket, of the form "unix:path/api",
 150                 or an internet socket, of the form "host:port/api".
 151
 152           --foreground
 153
 154                 Get all in foreground mode (default)
 155
 156           --daemon
 157
 158                 Get all in background mode
 159
 160           --no-httpd
 161
 162                 Forbids HTTP serve
 163
 164           --exec
 165
 166                 Must be the last option for afb-daemon. The remaining
 167                 arguments define a command that afb-daemon will launch.
 168                 The sequences @p, @t and @@ of the arguments are replaced
 169                 with the port, the token and @.
 170
 171           --tracereq=xxxx
 172
 173                 Trace the processing of requests in the log file.
 174
 175                 Valid values are 'no' (default), 'common', 'extra' or 'all'.
 176
 177           --traceditf=xxxx
 178
 179                 Trace the accesses to functions of class daemon.
 180
 181                 Valid values are 'no' (default), 'common', 'extra' or 'all'.
 182
 183           --tracesvc=xxxx
 184
 185                 Trace the accesses to functions of class service.
 186
 187                 Valid values are 'no' (default) or 'all'.
 188
 189           --traceevt=xxxx
 190
 191                 Trace the accesses to functions of class event.
 192
 193                 Valid values are 'no' (default), 'common', 'extra' or 'all'.
 194
 195     --call=xxx
 196
 197                 Call a binding at start (can be be repeated).
 198                 The values are given in the form API/VERB:json-args.
 199
 200                 Example: --call 'monitor/set:{"verbosity":{"api":"debug"}}'