2 @unnumbered Configuration file
4 Example YAML configuration file:
8 log: /var/spool/nncp/log
12 to: user+file@example.com
15 to: user+freq@example.com
18 exchpub: CYVGQ...PSEWQ
19 exchprv: 65PUY...MPZ3Q
20 signpub: 2NMVC...CMH5Q
21 signprv: 555JD...RGD6Y
22 noiseprv: D62XU...NKYPA
23 noisepub: KIBKK...ESM7Q
27 exchpub: CYVGQ...PSEWQ
28 signpub: 2NMVC...CMH5Q
29 noisepub: KIBKK...ESM7Q
30 sendmail: [/usr/sbin/sendmail]
33 exchpub: MJACJ...FAI6A
34 signpub: T4AFC...N2FRQ
35 noisepub: UBM5K...VI42A
36 sendmail: ["/bin/sh", "-c", "false"]
37 incoming: /home/alice/incoming
41 lan: "[fe80::1234%igb0]:5400"
42 internet: alice.com:3389
48 exchpub: WFLMZ...B7NHA
49 signpub: GTGXG...IE3OA
50 sendmail: [/usr/sbin/sendmail]
57 @strong{spool} field contains an absolute path to @ref{Spool, spool}
58 directory. @strong{log} field contains an absolute path to @ref{Log,
62 @strong{notify} section contains notification settings for successfully
63 tossed file and freq packets. Corresponding @strong{from} and
64 @strong{to} fields will be substituted in notification email message.
65 @emph{neigh/self/sendmail} will be used as a local mailer. You can omit
66 either of those two @emph{from}/@emph{to} sections to omit corresponding
67 notifications, or the whole section at once.
69 @strong{self} section contains our node's private keypairs.
70 @strong{exch*} and @strong{sign*} are used during @ref{Encrypted,
71 encrypted} packet creation. @strong{noise*} are used during @ref{Sync,
72 synchronization protocol} working in @ref{nncp-call}/@ref{nncp-daemon}.
74 @strong{neigh} section contains all known neighbours information. It
75 always has @strong{self} neighbour that is copy of our node's public
76 data (public keys). It is useful for copy-paste sharing with your
77 friends. Each section's key is a human-readable name of the neighbour.
79 Except for @emph{id}, @emph{exchpub} and @emph{signpub} each neighbour
80 node has the following fields:
85 If present, then node can be online called using @ref{Sync,
86 synchronization protocol}. Contains authentication public key.
90 An array containing path to executable and its command line arguments
91 that is called for mail sending. If it is empty, then no mail processing
92 will be performed from that node. Sendmail command
93 @command{["/bin/foo", "bar"]} called the following way:
94 @command{NNCP_SENDER=NODEID /bin/foo bar RCPT1 RCPT2 ... < MSG}.
98 Full path to directory where all file uploads will be saved. May be
99 omitted to forbid file uploading on that node.
103 Full path to directory from where file requests will queue files for
104 transmission. May be omitted to forbid freqing from that node.
107 If set, then enable @ref{Chunked, chunked} file transmission during
108 freqing. This is the desired chunk size in KiBs.
111 If set, then apply @ref{OptMinSize, -minsize} option during file
115 An array of node identifiers that will be used as a relay to that node.
116 For example @verb{|[foo,bar]|} means that packet can reach current node
117 by transitioning through @emph{foo} and then @emph{bar} nodes. May be
118 omitted if direct connection exists and no relaying is required.
122 Dictionary containing known network addresses of the node. Each key is
123 human-readable name of the link/address. Values are @verb{|addr:port|}
124 pairs pointing to @ref{nncp-daemon}'s listening instance. May be omitted
125 if either no direct connection exists, or @ref{nncp-call} is used with
126 forced address specifying.
128 @anchor{CfgOnlineDeadline}
130 Online connection deadline of node inactivity in seconds. It is the time
131 connection considered dead after not receiving/sending any packets and
132 node must disconnect. By default it is set to 10 seconds -- that means
133 disconnecting after 10 seconds when no packets received and transmitted.
134 This can be set to rather high values to keep connection alive (to
135 reduce handshake overhead and delays), wait for appearing packets ready
136 to send and notifying remote side about their appearance.
138 @anchor{CfgMaxOnlineTime}
140 If greater than zero, then it is maximal amount of time connect could be
141 alive. Forcefully disconnect if it is exceeded.
145 List of @ref{Call, call configuration}s. Can be omitted if
146 @ref{nncp-caller} won't be used to call that node.