2 @cindex neighbour configuration options
3 @section Configuration neighbour options
6 @strong{neigh} section contains all known neighbours information. It
7 always has @strong{self} neighbour that is copy of our node's public
8 data (public keys). It is useful for copy-paste sharing with your
9 friends. Each section's key is a human-readable name of the neighbour.
15 exchpub: 2NZKH...CMI7A
16 signpub: EXD7M...YAOFA
17 noisepub: MIXYN...BGNDQ
18 exec: {sendmail: ["/usr/sbin/sendmail"]}
22 exchpub: MJACJ...FAI6A
23 signpub: T4AFC...N2FRQ
24 noisepub: UBM5K...VI42A
25 exec: {flag: ["/usr/bin/touch", "-t"]}
26 incoming: "/home/alice/incoming"
30 lan: "[fe80::1234%igb0]:5400"
31 internet: alice.com:3389
32 proxied: "|ssh remote.host nncp-daemon -ucspi"
42 exchpub: WFLMZ...B7NHA
43 signpub: GTGXG...IE3OA
45 sendmail: ["/usr/sbin/sendmail"]
46 warcer: ["/path/to/warcer.sh"]
47 wgeter: ["/path/to/wgeter.sh"]
61 Except for @code{id}, @code{exchpub} and @code{signpub} each neighbour
62 node has the following fields:
67 If present, then node can be online called using @ref{Sync,
68 synchronization protocol}. Contains authentication public key.
74 Dictionary consisting of handles and corresponding command line
75 arguments. In example above there are @command{sendmail} handles,
76 @command{warcer}, @command{wgeter} and @command{flag} one. Remote
77 node can queue some handle execution with providing additional
78 command line arguments and the body fed to command's @code{stdin}.
80 @verb{|sendmail: ["/usr/sbin/sendmail", "-t"]|} handle, when called by
81 @verb{|echo hello world | nncp-exec self sendmail ARG0 ARG1 ARG2|}
82 command, will execute:
88 /usr/sbin/sendmail -t ARG0 ARG1 ARG2
91 feeding @verb{|hello world\n|} to that started @command{sendmail}
97 Full path to directory where all file uploads will be saved. May be
98 omitted to forbid file uploading on that node.
105 Full path to directory from where file requests will queue files
106 for transmission. May be omitted to forbid freqing from that node.
109 If set, then enable @ref{Chunked, chunked} file transmission
110 during freqing. This is the desired chunk size in KiBs.
113 If set, then apply @ref{OptMinSize, -minsize} option during file
120 An array of node identifiers that will be used as a relay to that
121 node. For example @verb{|["foo","bar"]|} means that packet can reach
122 current node by transitioning through @code{foo} and then @code{bar}
123 nodes. May be omitted if direct connection exists and no relaying is
129 Dictionary containing known network addresses of the node. Each key
130 is human-readable name of the address. For direct TCP connections
131 use @verb{|host:port|} format, pointing to @ref{nncp-daemon}'s
134 Also you can pipe connection through the external command using
135 @verb{#|some command#} format. @code{/bin/sh -c "some command"} will
136 start and its @code{stdin}/@code{stdout} used as a connection.
138 To use @ref{Yggdrasil} network for connectivity, use
139 @verb{|yggdrasil:PUB;PRV;PEER[,...]|} format, read about
140 @ref{CfgYggdrasilAliases, possible aliases} usage.
142 May be omitted if either no direct connection exists, or
143 @ref{nncp-call} is used with forced address specifying.
149 If greater than zero, then at most *rate packets per second will be
150 sent/received after the handshake. It could be used as crude
151 bandwidth traffic shaper: each packet has at most 64 KiB payload
152 size. If omitted -- no rate limits.
154 @vindex onlinedeadline
155 @anchor{CfgOnlineDeadline}
157 Online connection deadline of nodes inactivity in seconds. It is the
158 time connection considered dead after not receiving/sending any
159 packets (except for PINGs) and connection must be terminated. By
160 default it is set to 10 seconds. This can be set to rather high
161 values to keep connection alive (to reduce handshake overhead and
162 delays), wait for appearing packets ready to send and notifying
163 remote side about their appearance.
165 @vindex maxonlinetime
166 @anchor{CfgMaxOnlineTime}
168 If greater than zero, then it is maximal time of single connection.
169 Forcefully disconnect if it is exceeded.
173 List of @ref{Call, call configuration}s.
174 Can be omitted if @ref{nncp-caller} won't be used to call that node.