doc/cfg/general.texi

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