Next: Commands, Previous: Installation, Up: Top
Example YAML configuration file:
spool: /var/spool/nncp log: /var/spool/nncp/log notify: file: from: nncp@localhost to: user+file@example.com freq: from: nncp@localhost to: user+freq@example.com self: id: TIJQL...2NGIA exchpub: CYVGQ...PSEWQ exchprv: 65PUY...MPZ3Q signpub: 2NMVC...CMH5Q signprv: 555JD...RGD6Y noiseprv: D62XU...NKYPA noisepub: KIBKK...ESM7Q neigh: self: id: TIJQL...2NGIA exchpub: CYVGQ...PSEWQ signpub: 2NMVC...CMH5Q noisepub: KIBKK...ESM7Q sendmail: [/usr/sbin/sendmail] alice: id: XJZBK...65IJQ exchpub: MJACJ...FAI6A signpub: T4AFC...N2FRQ noisepub: UBM5K...VI42A sendmail: ["/bin/sh", "-c", "false"] incoming: /home/alice/incoming addrs: lan: "[fe80::1234%igb0]:5400" internet: alice.com:3389 bob: id: 2IZNP...UYGYA exchpub: WFLMZ...B7NHA signpub: GTGXG...IE3OA noisepub: EQAZM...J3NBA sendmail: [/usr/sbin/sendmail] freq: /home/bob/pub via: [alice]
spool field contains an absolute path to spool directory. log field contains an absolute path to log file.
notify section contains notification settings for successfully tossed file and freq packets. Corresponding from and to fields will substituted in notification email message. neigh/self/sendmail will be used as a local mailer. If either of from/to fields are omitted, then no notification will be sent.
self section contains our node’s private keypairs. exch* and sign* are used during encrypted packet creation. noise* are used during synchronization protocol working in nncp-call/nncp-daemon.
neigh section contains all known neighbours information. It always has self neighbour that is copy of our node’s public data (public keys). It is useful for copy-paste sharing with your friends. Each section’s key is a human-readable name of the neighbour.
Except for id, exchpub and signpub each neighbour node has the following fields:
Must be present, but can be dummy (only zeros) if no online communication using synchronization protocol will be used.
An array containing path to executable and its command line arguments that is called for mail sending.
Full path to directory where all file uploads will be saved. May be omitted to forbid file uploading on that node.
Full path to directory from where file requests will queue files for transmission. May be omitted to forbid freqing from that node.
An array of node identifiers that will be used as a relay to that node.
For example [foo,bar]
means that packet can reach current node by
transitioning through foo
and then bar
nodes. May be
omitted if direct connection exists and no relaying is required.
Dictionary containing known network addresses of the node. Each key is
human-readable name of the link/address. Values are addr:port
pairs pointing to nncp-daemon’s listening instance. May be omitted
if either no direct connection exists, or nncp-call is used with
forced address specifying.
Next: Commands, Previous: Installation, Up: Top