aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 961eee52d09bbecea4ee901f377e794b0d7fbe28 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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)).