X-Git-Url: https://ruderich.org/simon/gitweb/?p=nsscash%2Fnsscash.git;a=blobdiff_plain;f=README;h=d9c255fbefd3b14c9aa95ff17290475ecda62929;hp=510ba33b02e7c51d43e19b8493e576e8a1ab2c24;hb=6383e468f1d5b281159cd46d800204a1aa718cd2;hpb=b8abeed6c7bddb9d9770f3be93dc41400354783b diff --git a/README b/README index 510ba33..d9c255f 100644 --- a/README +++ b/README @@ -24,8 +24,8 @@ Nsscash is very careful when deploying the changes: 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 prevent inconsistent state if only one file can be downloaded. The state - file (containing last file modifications) is only updated when all - operations were successful. + file (containing last file modification and content hash) is only updated + when all operations were successful. - To prevent unexpected permissions, `nsscash` does not create new files. The user must create them first and `nsscash` will then re-use the permissions and owner/group when updating the file (see examples below). @@ -127,9 +127,11 @@ typical configuration looks like this: The following global keys are available: -- `statepath`: Path to a JSON file which stores the last modification time of - each file; automatically updated by `nsscash`. Used to fetch data only when - something has changed to reduce the required traffic. +- `statepath`: Path to a JSON file which stores the last modification time and + hash of each file; automatically updated by `nsscash`. Used to fetch data + only when something has changed to reduce the required traffic, via + `If-Modified-Since`. When the hash of a file has changed the download is + forced. Each `file` block describes a single file to download/write. The following keys are available: