doc/cfg/index.texi

   1 @node Configuration
   2 @unnumbered Configuration file
   3
   4 NNCP uses single file configuration file in @url{https://hjson.org/,
   5 Hjson} format (see also section about @ref{Configuration directory,
   6 directory layout}) . Initially it is created with @ref{nncp-cfgnew}
   7 command and at minimum it can look like this:
   8
   9 @verbatim
  10 spool: /var/spool/nncp
  11 log: /var/spool/nncp/log
  12
  13 self: {
  14   id: RKOLY...KAMXQ
  15   exchpub: 2NZKH...CMI7A
  16   exchprv: KETPP...2OJZA
  17   signpub: EXD7M...YAOFA
  18   signprv: B3EMS..XMAHCQ
  19   noiseprv: 3TJDF...2D7DQ
  20   noisepub: MIXYN...BGNDQ
  21 }
  22
  23 neigh: {
  24   self: {
  25     id: RKOLY...KAMXQ
  26     exchpub: 2NZKH...CMI7A
  27     signpub: EXD7M...YAOFA
  28     noisepub: MIXYN...BGNDQ
  29   }
  30 }
  31 @end verbatim
  32
  33 And for being able to communicate with at least one other node, you just
  34 need to add single key to the @code{neigh} section similar to the "self".
  35
  36 Whole configuration file can be separated on five sections:
  37
  38 @menu
  39 * General options: CfgGeneral.
  40 * Self-node keypairs: CfgSelf.
  41 * Notifications: CfgNotify.
  42 * Neighbours: CfgNeigh.
  43 * Areas: CfgAreas.
  44
  45 You can optionally convert it to directory layout
  46 * Configuration directory::
  47 @end menu
  48
  49 @include cfg/general.texi
  50 @include cfg/self.texi
  51 @include cfg/notify.texi
  52 @include cfg/neigh.texi
  53 @include cfg/areas.texi
  54 @include cfg/dir.texi