diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..961eee5 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# WKD + +This repository tracks data (PGP public key certificates) and scripts to create +a WKD setup for a domain. + +## Requirements + +* [just](https://github.com/casey/just) +* [rsync](https://rsync.samba.org/) +* [sequoia-sq](https://sequoia-pgp.org/) + +## Usage + +To use the default `fqdn`, `remote` and `location` to deploy for, use + +```bash +just +``` + +To set the `fqdn` and `remote` use: + +```bash +just --set fqdn example.com --set remote user@example.com --set location /some/location/on/remote +``` + +The above assumes that PGP public key certificates are available in the +[certs](certs) directory for the given fqdn. + +## License + +WKD is licensed under the terms of the **GPL-3.0-or-later** (see +[LICENSE](LICENSE)). |