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. Initially it is created with @ref{nncp-cfgnew} command
   6 and at minimum it can look like this:
   7
   8 @verbatim
   9 spool: /var/spool/nncp
  10 log: /var/spool/nncp/log
  11
  12 self: {
  13   id: RKOLY...KAMXQ
  14   exchpub: 2NZKH...CMI7A
  15   exchprv: KETPP...2OJZA
  16   signpub: EXD7M...YAOFA
  17   signprv: B3EMS..XMAHCQ
  18   noiseprv: 3TJDF...2D7DQ
  19   noisepub: MIXYN...BGNDQ
  20 }
  21
  22 neigh: {
  23   self: {
  24     id: RKOLY...KAMXQ
  25     exchpub: 2NZKH...CMI7A
  26     signpub: EXD7M...YAOFA
  27     noisepub: MIXYN...BGNDQ
  28   }
  29 }
  30 @end verbatim
  31
  32 And for being able to communicate with at least one other node, you just
  33 need to add single key to the @code{neigh} section similar to the "self".
  34
  35 All configuration file can be separated on five sections:
  36
  37 @menu
  38 * General options: CfgGeneral.
  39 * Self-node keypairs: CfgSelf.
  40 * Notifications: CfgNotify.
  41 * Neighbours: CfgNeigh.
  42 * Areas: CfgAreas.
  43 @end menu
  44
  45 @include cfg/general.texi
  46 @include cfg/self.texi
  47 @include cfg/notify.texi
  48 @include cfg/neigh.texi
  49 @include cfg/areas.texi