doc/cfg.texi

   1 @node Configuration
   2 @unnumbered Configuration file
   3
   4 Example YAML configuration file:
   5
   6 @verbatim
   7 spool: /var/spool/nncp
   8 log: /var/spool/nncp/log
   9 notify:
  10   file:
  11     from: nncp@localhost
  12     to: user+file@example.com
  13   freq:
  14     from: nncp@localhost
  15     to: user+freq@example.com
  16 self:
  17   id: TIJQL...2NGIA
  18   exchpub: CYVGQ...PSEWQ
  19   exchprv: 65PUY...MPZ3Q
  20   signpub: 2NMVC...CMH5Q
  21   signprv: 555JD...RGD6Y
  22   noiseprv: D62XU...NKYPA
  23   noisepub: KIBKK...ESM7Q
  24 neigh:
  25   self:
  26     id: TIJQL...2NGIA
  27     exchpub: CYVGQ...PSEWQ
  28     signpub: 2NMVC...CMH5Q
  29     noisepub: KIBKK...ESM7Q
  30     sendmail: [/usr/sbin/sendmail]
  31   alice:
  32     id: XJZBK...65IJQ
  33     exchpub: MJACJ...FAI6A
  34     signpub: T4AFC...N2FRQ
  35     noisepub: UBM5K...VI42A
  36     sendmail: ["/bin/sh", "-c", "false"]
  37     incoming: /home/alice/incoming
  38     onlinedeadline: 3600
  39     addrs:
  40       lan: "[fe80::1234%igb0]:5400"
  41       internet: alice.com:3389
  42     calls:
  43       -
  44         cron: "*/2 * * * *"
  45   bob:
  46     id: 2IZNP...UYGYA
  47     exchpub: WFLMZ...B7NHA
  48     signpub: GTGXG...IE3OA
  49     sendmail: [/usr/sbin/sendmail]
  50     freq: /home/bob/pub
  51     via: [alice]
  52 @end verbatim
  53
  54 @strong{spool} field contains an absolute path to @ref{Spool, spool}
  55 directory. @strong{log} field contains an absolute path to @ref{Log,
  56 log} file.
  57
  58 @anchor{CfgNotify}
  59 @strong{notify} section contains notification settings for successfully
  60 tossed file and freq packets. Corresponding @strong{from} and
  61 @strong{to} fields will substituted in notification email message.
  62 @emph{neigh/self/sendmail} will be used as a local mailer. You can omit
  63 either of those two @emph{from}/@emph{to} sections to omit corresponding
  64 notifications, or the whole section at once.
  65
  66 @strong{self} section contains our node's private keypairs.
  67 @strong{exch*} and @strong{sign*} are used during @ref{Encrypted,
  68 encrypted} packet creation. @strong{noise*} are used during @ref{Sync,
  69 synchronization protocol} working in @ref{nncp-call}/@ref{nncp-daemon}.
  70
  71 @strong{neigh} section contains all known neighbours information. It
  72 always has @strong{self} neighbour that is copy of our node's public
  73 data (public keys). It is useful for copy-paste sharing with your
  74 friends. Each section's key is a human-readable name of the neighbour.
  75
  76 Except for @emph{id}, @emph{exchpub} and @emph{signpub} each neighbour
  77 node has the following fields:
  78
  79 @table @strong
  80
  81 @item noisepub
  82 If present, then node can be online called using @ref{Sync,
  83 synchronization protocol}. Contains authentication public key.
  84
  85 @anchor{CfgSendmail}
  86 @item sendmail
  87 An array containing path to executable and its command line arguments
  88 that is called for mail sending. If it is empty, then no mail processing
  89 will be performed from that node.
  90
  91 @anchor{CfgIncoming}
  92 @item incoming
  93 Full path to directory where all file uploads will be saved. May be
  94 omitted to forbid file uploading on that node.
  95
  96 @anchor{CfgFreq}
  97 @item freq
  98 Full path to directory from where file requests will queue files for
  99 transmission. May be omitted to forbid freqing from that node.
 100
 101 @item via
 102 An array of node identifiers that will be used as a relay to that node.
 103 For example @verb{|[foo,bar]|} means that packet can reach current node
 104 by transitioning through @emph{foo} and then @emph{bar} nodes. May be
 105 omitted if direct connection exists and no relaying is required.
 106
 107 @anchor{CfgAddrs}
 108 @item addrs
 109 Dictionary containing known network addresses of the node. Each key is
 110 human-readable name of the link/address. Values are @verb{|addr:port|}
 111 pairs pointing to @ref{nncp-daemon}'s listening instance. May be omitted
 112 if either no direct connection exists, or @ref{nncp-call} is used with
 113 forced address specifying.
 114
 115 @anchor{CfgOnlineDeadline}
 116 @item onlinedeadline
 117 Online connection deadline of node inactivity in seconds. It is the time
 118 connection considered dead after not receiving/sending any packets and
 119 node must disconnect. By default it is set to 10 seconds -- that means
 120 that disconnecting after 10 seconds when no packets received and
 121 transmitted. This can be set to rather high values to keep connection
 122 alive (to reduce handshake overhead and delays), wait for appearing
 123 packets ready to send and notifying remote side about their appearance.
 124
 125 @anchor{CfgCalls}
 126 @item calls
 127 List of @ref{Call, call configuration}s. Can be omitted if
 128 @ref{nncp-caller} won't be used to call that node.
 129
 130 @end table