]> Cypherpunks.ru repositories - nncp.git/blob - doc/cfg/dir.texi
Add various documentation indices
[nncp.git] / doc / cfg / dir.texi
1 @node Configuration directory
2 @cindex configuration directory
3 @section Configuration directory
4
5 Optionally you can convert configuration file to the directory layout
6 with @ref{nncp-cfgdir} command. And vice versa too, of course loosing
7 the comment lines. Directory layout can looks like that:
8
9 @example
10 nncp-cfg-dir
11 ├── areas
12 │   ├── home
13 │   │   ├── id
14 │   │   ├── incoming
15 │   │   ├── prv
16 │   │   ├── pub
17 │   │   └── subs
18 │   └── homero
19 │       ├── id
20 │       ├── exec
21 │       │   └── sendmail
22 │       ├── prv
23 │       ├── pub
24 │       └── allow-unknown
25 ├── log
26 ├── mcd-listen
27 ├── neigh
28 │   ├── beta
29 │   │   ├── exchpub
30 │   │   ├── exec
31 │   │   │   └── sendmail
32 │   │   ├── id
33 │   │   ├── incoming
34 │   │   ├── noisepub
35 │   │   ├── signpub
36 │   │   └── via
37 │   ├── gw
38 │   │   ├── addrs
39 │   │   │   ├── lan
40 │   │   │   └── main
41 │   │   ├── calls
42 │   │   │   ├── 0
43 │   │   │   │   ├── autotoss
44 │   │   │   │   ├── cron
45 │   │   │   │   ├── nice
46 │   │   │   │   └── rxrate
47 │   │   │   ├── 1
48 │   │   │   │   ├── addr
49 │   │   │   │   ├── autotoss
50 │   │   │   │   ├── cron
51 │   │   │   │   └── onlinedeadline
52 │   │   │   └── 2
53 │   │   │       ├── addr
54 │   │   │       ├── autotoss
55 │   │   │       ├── cron
56 │   │   │       └── onlinedeadline
57 │   │   ├── exchpub
58 │   │   ├── exec
59 │   │   │   └── sendmail
60 │   │   ├── freq
61 │   │   │   └── chunked
62 │   │   ├── id
63 │   │   ├── incoming
64 │   │   ├── noisepub
65 │   │   └── signpub
66 │   └── self
67 │       ├── exchpub
68 │       ├── exec
69 │       │   ├── appender
70 │       │   ├── sendmail
71 │       │   └── slow
72 │       ├── freq
73 │       │   └── path
74 │       ├── id
75 │       ├── incoming
76 │       ├── noisepub
77 │       └── signpub
78 ├── notify
79 │   ├── file
80 │   │   ├── from
81 │   │   └── to
82 │   └── freq
83 │       ├── from
84 │       └── to
85 ├── self
86 │   ├── exchprv
87 │   ├── exchpub
88 │   ├── id
89 │   ├── noiseprv
90 │   ├── noisepub
91 │   ├── signprv
92 │   └── signpub
93 └── spool
94 @end example
95
96 Your @option{-cfg} and @env{$NNCPCFG} could point to that directory,
97 instead of @file{.hjson} file. It will be transparently converted to
98 internal JSON representation. However it can not be encrypted with the
99 @ref{nncp-cfgenc}.
100
101 @cindex private keys
102 That layout should be much more machine friendly and scriptable. Each
103 string parameters is stored as a single line plain text file. String
104 arrays are newline-separated plain text files. Dictionaries are
105 transformed to the subdirectories. Its structure should be
106 self-describing. True booleans are stored as an empty flag-file
107 existence (their absence equals to false). All names starting with "."
108 are skipped. All files ending with @file{prv} are created with 600
109 permissions, instead of the default 666.