utils/pservice/README.md

   1 # uci
   2
   3 `disabled`, bool, default `0`
   4
   5 `name`, string, name of the service instance
   6
   7 `command`, file, the service instance executable
   8
   9 `args`, list of args
  10
  11 `stderr`, bool, default `0`, log stderr output of the service instance
  12
  13 `stdout`, bool, default `0`, log stdout output of the service instance
  14
  15 `env`, list of environment variable settings of the form `var=val`
  16
  17 `file`, list of file names.  Service instances will be restarted if content of
  18 these files have changed on service reload event.
  19
  20 `respawn_threshold`, uinteger, default `3600`, time in seconds the instances
  21 have to be in running state to be considered a valid run
  22
  23 `respawn_timeout`, uinteger, default `5`, time in seconds the instance should
  24 be delayed to start again after the last crash
  25
  26 `respawn_maxfail`, uinteger, default `5`, maximum times the instances can
  27 crash/fail in a row and procd will not try to bring it up again after this
  28 limit has been reached
  29
  30 # notes and faq
  31
  32 Initial environment variables presented to service instances may be different
  33 from what was observed on the interactive terminal.  E.g. `HOME=/` may affect
  34 reading `~/.ssh/known_hosts` of dropbear ssh instance.
  35
  36         PATH=/usr/sbin:/usr/bin:/sbin:/bin PWD=/ HOME=/
  37
  38 If `list args xxx` seems to be too long causing pain, consider using `/bin/sh`
  39 as the `command`.  It is also worth noting that uci supports multi-line option
  40 value.
  41
  42 Child processes will keep running when their parent process was killed.  This
  43 is especially the case and should be taken into account with option `command`
  44 being `/bin/sh` and it is recommended to use `exec` as the last shell command.