]> the.earth.li Git - onak.git/blob - README.md
Bump debhelper compat level to 13
[onak.git] / README.md
1 # onak
2
3 onak is an OpenPGP compatible keyserver. It was originally written
4 concentrating on providing real time path finding between 2 keys, but
5 over time has moved to concentrating on providing standard keyserver
6 storage and retrieval functionality.
7
8 Features include:
9
10  * Multiple backend key storage options (DB4, PostgreSQL, flat file,
11    read-only PGP keyring)
12  * Command-line tool for interacting with key store
13  * Forwarding capability to other key servers
14  * Experimental full verification of signatures
15  * Experimental OpenPGP v5 support
16
17 It does not (yet) support the SKS Gossip keyserver synchronisation
18 protocol.
19
20 See the doc/ subdirectory for more complete documentation.
21
22 ### License
23
24 onak is released under the GPLv2.
25
26 ### Requirements
27
28 onak is written in C and has no hard external dependencies. The
29 recommended backend key-store requires Berkeley DB (tested with versions
30 4 + 5). [Nettle](https://www.lysator.liu.se/~nisse/nettle/) is
31 recommended for full cryptographic functionality. onak can also make use
32 of [curl](https://curl.haxx.se/) if available.
33
34 ### Downloads
35
36 onak can always be found at
37 [https://the.earth.li/gitweb/?p=onak.git;a=summary](http://the.earth.li/gitweb/?p=onak.git;a=summary)
38 and there is a [GitHub](https://github.com/) mirror at
39 [https://github.com/u1f35c/onak](https://github.com/u1f35c/onak)
40
41 Contributions are welcome via emailed patches to
42 [noodles@earth.li](noodles@earth.li) or pull requests on GitHub.