X-Git-Url: https://ruderich.org/simon/gitweb/?p=nsscash%2Fnsscash.git;a=blobdiff_plain;f=README.adoc;h=181d18d1302e11726d5115b142083333e62dcbf2;hp=8918da8fb6746c674f78367b5214768e55ad7363;hb=HEAD;hpb=2b8915e338887724e4ea82a06e206daad49741a8 diff --git a/README.adoc b/README.adoc index 8918da8..181d18d 100644 --- a/README.adoc +++ b/README.adoc @@ -21,6 +21,7 @@ Nsscash can also be used separately from the NSS module to deploy arbitrary files to many hosts and keep them up-to-date. 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. The indices are stored in the same file preventing stale data during the update. @@ -41,6 +42,7 @@ Nsscash is very careful when deploying the changes: and verified on each `nsscash` run. The passwd/group files have the following size restrictions: + - maximum number of entries: '2^64-1' (uint64_t) - maximum passwd entry size: 65543 bytes (including newline) - maximum group entry size: 65535 bytes (including newline, only one member) @@ -66,12 +68,15 @@ Nsscash is licensed under AGPL version 3 or later. == REQUIREMENTS - Go, for `nsscash` - - github.com/pkg/errors - - github.com/BurntSushi/toml + * github.com/BurntSushi/toml + * github.com/google/renameio + * github.com/pkg/errors - C compiler, for `libnss_cash.so.2` - HTTP(S) server to provide the passwd/group/etc. files +- NSS module is only supported on Little-endian systems (for now) + Tested on Debian Buster, but should work on any GNU/Linux system. With adaptations to the NSS module it should work on any UNIX-like system which uses NSS. @@ -184,7 +189,7 @@ Written by Simon Ruderich . This program is licensed under AGPL version 3 or later. -Copyright (C) 2019 Simon Ruderich +Copyright (C) 2019-2021 Simon Ruderich This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by