From b5ef55e1eba3486c5499490fea28fbe3e6033459 Mon Sep 17 00:00:00 2001 From: Jonathan McDowell Date: Mon, 16 Sep 2019 19:51:22 +0100 Subject: [PATCH] Add a basic README.md for the top level directory --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5337b4f --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# onak + +onak is an OpenPGP compatible keyserver. It was originally written +concentrating on providing real time path finding between 2 keys, but +over time has moved to concentrating on providing standard keyserver +storage and retrieval functionality. + +Features include: + + * Multiple backend key storage options (DB4, PostgreSQL, flat file, + read-only PGP keyring) + * Command-line tool for interacting with key store + * Forwarding capability to other key servers + * Experimental full verification of signatures + * Experimental OpenPGP v5 support + +It does not (yet) support the SKS Gossip keyserver synchronisation +protocol. + +See the doc/ subdirectory for more complete documentation. + +### License + +onak is released under the GPLv2. + +### Requirements + +onak is written in C and has no hard external dependencies. The +recommended backend key-store requires Berkeley DB (tested with versions +4 + 5). [Nettle](https://www.lysator.liu.se/~nisse/nettle/) is +recommended for full cryptographic functionality. onak can also make use +of [curl](https://curl.haxx.se/) if available. + +### Downloads + +onak can always be found at +[https://the.earth.li/gitweb/?p=onak.git;a=summary](http://the.earth.li/gitweb/?p=onak.git;a=summary) +and there is a [GitHub](https://github.com/) mirror at +[https://github.com/u1f35c/onak](https://github.com/u1f35c/onak) + +Contributions are welcome via emailed patches to +[noodles@earth.li](noodles@earth.li) or pull requests on GitHub. -- 2.39.5