X-Git-Url: https://ruderich.org/simon/gitweb/?a=blobdiff_plain;f=README;h=278f5a149ddb780ba44839a27a850f7b7b4b807a;hb=34ca14b7fa7fb88adab60356d18f94790ffe19a6;hp=f559110f4669b88277f42e4e5002307f8627753c;hpb=1416d64c367cb29c3ca459b66ac9ffd57413fb43;p=nsscash%2Fnsscash.git

diff --git a/README b/README
index f559110..278f5a1 100644
--- 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
@@ -56,8 +57,8 @@ nsscash is licensed under AGPL version 3 or later.
 - C compiler, for `libnss_cash.so.2`
 
 Tested on Debian Stretch and Buster, but should work on any GNU/Linux system.
-With adapations to the NSS module it should work on any UNIX-like system which
-uses NSS.
+With adaptations to the NSS module it should work on any UNIX-like system
+which uses NSS.
 
 
 == USAGE
@@ -147,6 +148,14 @@ keys are available:
 
 - `url`: URL to fetch the file from; HTTP and HTTPS are supported
 
+- `ca`: Path to a custom CA in PEM format. Restricts HTTPS requests to accept
+  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