]> Cypherpunks.ru repositories - nncp.git/blobdiff - doc/cfg/general.texi
Yggdrasil overlay transport
[nncp.git] / doc / cfg / general.texi
index 63d0757692af0fb347684426567be94ad68c2f92..69551a280e85521acb0a16979d14db16c2e5554a 100644 (file)
@@ -15,13 +15,26 @@ nohdr: true
 # MultiCast Discovery
 mcd-listen: ["em0", "igb1"]
 mcd-send: {em0: 60, igb1: 5}
+
+# Yggdrasil aliases
+yggdrasil-aliases: {
+  myprv: 60bb...27aa
+  bob-pub: 98de...ac19d
+  alice-endpoint: tcp://example.com:1234?key=689c...13fb
+  default-endpoints: tcp://[::1]:2345,alice-endpoint
+}
 @end verbatim
 
 @table @code
 @item spool
 Absolute path to the @ref{Spool, spool} directory.
 @item log
-Absolute path to the @ref{Log, log} file.
+Either:
+    @itemize
+    @item absolute path to the @ref{Log, log} file
+    @item @code{FD:XXX}, where @code{XXX} is a decimal file descriptor
+        to write records too
+    @end itemize
 @item umask
 Will force all invoked commands to override their umask to specified
 octal mask. Useful for using with @ref{Shared spool, shared spool directories}.
@@ -31,7 +44,7 @@ You can always force its showing with @option{-progress} command line
 option anyway.
 @anchor{CfgNoHdr}
 @item nohdr
-@strong{nohdr} option disables @ref{HdrFile, .hdr} files usage.
+@strong{nohdr} option disables @ref{HdrFile, @file{hdr/}} files usage.
 @end table
 
 And optional @ref{MCD, MultiCast Discovery} options:
@@ -46,3 +59,14 @@ incoming @ref{MCD} announcements.
 Specifies list of network interfaces, and intervals in seconds, where
 @ref{nncp-daemon} will send @ref{MCD} announcements.
 @end table
+
+@anchor{CfgYggdrasilAliases}
+Optional @ref{Yggdrasil}-related aliases are used for convenience and
+keeping private keys away being used directly in command line. Each
+@code{PUB}, @code{PRV}, @code{PEER}, @code{BIND} value in
+@ref{nncp-daemon}'s @option{-yggdrasil} and in @code{yggdrasil:}
+addresses is replaced with alias value. Moreover each entry in list of
+@code{PUB}s, @code{PEER}s and @code{BIND} can be an alias too. Pay
+attention, that all aliases ending with @code{prv} will be saved with
+600 permissions when converting to @ref{Configuration directory,
+directory layout}.