nsscash: go fmt

[nsscash/nsscash.git] / README

diff --git a/README b/README
index b5a60ab6bb068f9bb1036ea40b3d56f73730c88a..278f5a149ddb780ba44839a27a850f7b7b4b807a 100644 (file)
--- a/README
+++ b/README
@@ -19,7 +19,8 @@ lookups. To support quick lookups, in O(log n), the files utilize indices.
 
 Nsscash is very careful when deploying the changes:
 - All files are updated using the standard "write to temporary file", "sync",
-  "rename" steps which is atomic on UNIX file systems.
+  "rename" steps which is atomic on UNIX file systems. The indices are stored
+  in the same file preventing stale data during the update.
 - All errors cause an immediate abort ("fail fast") with a proper error
   message and a non-zero exit status. This prevents hiding possibly important
   errors. In addition all files are fetched first and then deployed to try to
@@ -151,6 +152,10 @@ keys are available:
   only certificates signed by this CA. Defaults to the system's certificate
   store when omitted.
 
+- `username`/`password`: Username and password sent via HTTP Basic-Auth to the
+  webserver. The configuration file must not be readable by other users when
+  this is used.
+
 - `path`: Path to store the retrieved file