doc/cfg/general.texi

   1 @node CfgGeneral
   2 @cindex general configuration options
   3 @section Configuration general options
   4
   5 Those options are in the root of configuration dictionary.
   6
   7 @verbatim
   8 spool: /var/spool/nncp
   9 log: /var/spool/nncp/log
  10
  11 # All of options below are optional
  12 umask: "022"
  13 noprogress: true
  14 nohdr: true
  15
  16 # MultiCast Discovery
  17 mcd-listen: ["em[0-3]", "igb_.*"]
  18 mcd-send: {"em[0-3]": 60, igb_.*: 5}
  19
  20 # Yggdrasil aliases
  21 yggdrasil-aliases: {
  22   myprv: 60bb...27aa
  23   bob-pub: 98de...ac19d
  24   alice-endpoint: tcp://example.com:1234?key=689c...13fb
  25   default-endpoints: tcp://[::1]:2345,alice-endpoint
  26 }
  27 @end verbatim
  28
  29 @table @code
  30
  31 @vindex spool
  32 @item spool
  33 Absolute path to the @ref{Spool, spool} directory.
  34
  35 @vindex log
  36 @vindex FD log file descriptor
  37 @item log
  38 Either:
  39     @itemize
  40     @item absolute path to the @ref{Log, log} file
  41     @item @code{FD:XXX}, where @code{XXX} is a decimal file descriptor
  42         to write records too
  43     @end itemize
  44
  45 @vindex umask
  46 @item umask
  47 Will force all invoked commands to override their umask to specified
  48 octal mask. Useful for using with @ref{Shared spool, shared spool directories}.
  49
  50 @vindex noprogress
  51 @item noprogress
  52 When enabled, disables progress showing for many commands by default.
  53 You can always force its showing with @option{-progress} command line
  54 option anyway.
  55
  56 @vindex nohdr
  57 @anchor{CfgNoHdr}
  58 @item nohdr
  59 @strong{nohdr} option disables @ref{HdrFile, @file{hdr/}} files usage.
  60
  61 @end table
  62
  63 And optional @ref{MCD, MultiCast Discovery} options:
  64
  65 @table @code
  66
  67 @vindex mcd-listen
  68 @anchor{CfgMCDListen}
  69 @item mcd-listen
  70 Specifies list of network interfaces regular expression
  71 @ref{nncp-caller} will listen for incoming @ref{MCD} announcements.
  72
  73 @vindex mcd-send
  74 @anchor{CfgMCDSend}
  75 @item mcd-send
  76 Specifies list of network interfaces regular expressions, and intervals
  77 in seconds, where @ref{nncp-daemon} will send @ref{MCD} announcements.
  78 @end table
  79
  80 @cindex yggdrasil aliases
  81 @anchor{CfgYggdrasilAliases}
  82 Optional @ref{Yggdrasil}-related aliases are used for convenience and
  83 keeping private keys away being used directly in command line. Each
  84 @code{PUB}, @code{PRV}, @code{PEER}, @code{BIND} value in
  85 @ref{nncp-daemon}'s @option{-yggdrasil} and in @code{yggdrasil:}
  86 addresses is replaced with alias value. Moreover each entry in list of
  87 @code{PUB}s, @code{PEER}s and @code{BIND} can be an alias too. Pay
  88 attention, that all aliases ending with @code{prv} will be saved with
  89 600 permissions when converting to @ref{Configuration directory,
  90 directory layout}.