config: Tidy defaults and move some info to README.config

[hippotat.git] / README.config

diff --git a/README.config b/README.config
index 842573cd6a153ca9d9f1e1f7041a2c066e8ea468..a6db64ee578112bb670a0c2bd0d862e5d0feb9b3 100644 (file)
--- a/README.config
+++ b/README.config
@@ -2,14 +2,43 @@
 
 Sections
 
-  [<servername> - <client>]
+  [<servername> <client>]
   [<client>]
   [<servername>]      often [SERVER]
   [COMMON]
 
 Keys are looked up in that order, unless otherwise specified.
 <client> is the client's virtual address.
-<servername> must be a valid DNS hostname and not look like an address.
+<servername> must be a valid lowercase DNS hostname and not look like 
+an address, or be COMMON, DEFAULT or SERVER.
+
+There are also:
+
+  [<servername> LIMIT]
+  [LIMIT]
+
+Things not in a section are an error.
+
+
+Both client and server read the files
+  /etc/hippotat/main.cfg
+  /etc/hippotat/config.d/*
+  /etc/hippotat/secrets.d/*
+and in each case if it's a directory, all contained files whose
+names consists of only ascii alphanumerics plus '-' and '_'.
+
+The ini file format sections from these files are all unioned.
+Later files (in the list above, or alphabetically later) can
+override settings from earlier ones.
+
+Note that although it is conventional for information for a particular
+server or client to be in a file named after that endpoint, there is
+no semantic link: all the files are always read and the appropriate
+section from each is applied to every endpoint.
+
+(If main.cfg does not exist, master.cfg will be tried for backward
+compatibility reasons.)
+
 
 Exceptional settings:
 
@@ -114,7 +143,8 @@ Ordinary settings, used by both, not client-specific:
      On client: used only to construct default url.
 
   mtu
-     Must match exactly.  (UNCHECKED) [1500 bytes]
+     Of virtual interface.  Must match exactly at each end.
+     (UNCHECKED) [1500 bytes]
 
   ifname_server
      Virtual interface name on the server.  [shippo%d]