docs/afb-daemon-options.md

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