Skip to content

Commit 9b7e6c0

Browse files
committed
Update documentation for web key directory support
1 parent 9f5e3f6 commit 9b7e6c0

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,36 @@ The HKP APIs are not documented here. Please refer to the [HKP specification](ht
5050

5151
#### Accepted `options` parameters
5252
* mr
53+
* wkd
5354

55+
### Web Key Directory support
56+
57+
Web Key Directory support can be enabled by adding a rewrite rule to web server
58+
configured as a reverse proxy.
59+
60+
Example configuration for caddy webserver (for example.com domain),
61+
62+
```
63+
openpgpkey.example.com {
64+
route /.well-known/openpgpkey/example.com/hu/* {
65+
uri strip_prefix /.well-known/openpgpkey/example.com/hu/
66+
rewrite * /pks/lookup?op=get&search={uri}%40example.com&options=wkd
67+
reverse_proxy localhost:3000
68+
}
69+
}
70+
71+
openpgpkey.example.com DNS records should be pointing to the mailvelope keyserver.
72+
```
5473
#### Usage example with GnuPG
5574

5675
```
5776
gpg --keyserver hkps://keys.mailvelope.com --search info@mailvelope.com
5877
```
5978

79+
If Web Key Directory is enabled,
80+
```
81+
gpg --locate-keys info@mailvelope.com
82+
```
6083
## REST API
6184

6285
### Lookup a key

0 commit comments

Comments
 (0)