Actually close the socket in keyd/the keyd backend

[onak.git] / README

diff --git a/README b/README
index e82da12e5aba6d9809c9adbd62d8be72345013b3..276dea485e655bec2ca33940580ad9a715631b21 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
-onak 0.1.2
-Copyright 2003 Project Purple. Written by Jonathan McDowell
+onak 0.3.8
+Copyright 2003-2009 Jonathan McDowell

 http://www.earth.li/projectpurple/progs/onak.html
 
 
 http://www.earth.li/projectpurple/progs/onak.html
 
 


@@ -12,18 +12,19 @@ these is probably the pathfinder. This takes two keys, a & b, and
 attempts to find a path of trust from a to b in the key database. I
 started work on it because at the time there was no DFSG compliant
 server that supported multiple subkeys and could act as a drop in
 attempts to find a path of trust from a to b in the key database. I
 started work on it because at the time there was no DFSG compliant
 server that supported multiple subkeys and could act as a drop in

-replacement for pksd, which I was running (and still am).
+replacement for pksd, which I was running at the time.

 
 
 Installation:
 
 onak has been mainly developed under Linux with a bit of work on FreeBSD
 
 
 Installation:
 
 onak has been mainly developed under Linux with a bit of work on FreeBSD

-at times also. It's i386 specific at present thanks to the bit of
-assembly in bithelp.h. Feel free to submit a patch for your arch. :)
+at times also. It should run on all architectures, but has only been
+tested on i386, AMD64 and PowerPC so far.

 
 

-Typing "make" should produce a version of onak with support for the DB3
-backend. If you want to choose a different backend (see below for a
-discussion about the options) you'll need to edit the Makefile first.
+Typing "./configure && make" should produce a version of onak with
+support for the DB4 backend. If you want to choose a different backend
+(see below for a discussion about the options) you'll need to pass the
+appropriate option to ./configure.

 
 Once make has completed you'll end up with various binaries:
 
 
 Once make has completed you'll end up with various binaries:
 


@@ -36,7 +37,7 @@ Once make has completed you'll end up with various binaries:
   The mail processor. Takes incoming mail (usually to
   pgp-public-keys@host) and calls onak to do the necessary work.
   Currently only supports INCREMENTAL mails for syncing with other
   The mail processor. Takes incoming mail (usually to
   pgp-public-keys@host) and calls onak to do the necessary work.
   Currently only supports INCREMENTAL mails for syncing with other

-  keyservers.
+  keyservers and INDEX mails from users.

 
 * add, lookup & gpgwww
   The CGI programs. add & lookup are common to all PGP keyservers while
 
 * add, lookup & gpgwww
   The CGI programs. add & lookup are common to all PGP keyservers while


@@ -46,21 +47,22 @@ Once make has completed you'll end up with various binaries:
   mathopd.conf file provided that I used for testing, but I'm now using
   Apache for the public test rig as it's already present on the host
   running it.
   mathopd.conf file provided that I used for testing, but I'm now using
   Apache for the public test rig as it's already present on the host
   running it.

+ 
+* splitkeys
+  Utility to take a keyring and split it up into a bunch of smaller ones.

 
 
 Config:
 
 I've finally added config file support. onak.conf is an example config;
 the main thing to change is the db_dir to whereever you want to put your
 
 
 Config:
 
 I've finally added config file support. onak.conf is an example config;
 the main thing to change is the db_dir to whereever you want to put your

-database files. You can change CONFIGFILE in onak-conf.h to specify
-where onak should look for this file. By default it's
-"/home/noodles/projects/onak/onak.conf" as this suits my development. No
-doubt it'll become a compile option at some point.
+database files. The configure script allows you to specific where it
+should live; by default it'll be PREFIX/etc/onak.conf.

 
 
 Backends:
 
 
 
 Backends:
 

-Currently there is support for 4 different database backends:
+Currently there is support for 5 different database backends:

 
 * file
   The original backend. Very simple and ideal for testing. Stores each
 
 * file
   The original backend. Very simple and ideal for testing. Stores each


@@ -79,12 +81,18 @@ Currently there is support for 4 different database backends:
   keyid - no key updating or searching by key test. Found to be
   tempramental and prone to deadlock in the db2 library.
 
   keyid - no key updating or searching by key test. Found to be
   tempramental and prone to deadlock in the db2 library.
 

-* db3 (Berkeley libdb3)
+* db4 (Berkeley libdb4)

   The currently preferred backend. Supports the full range of functions
   like the pg backend but is considerably faster. Also easier to setup
   The currently preferred backend. Supports the full range of functions
   like the pg backend but is considerably faster. Also easier to setup

-  assuming you have libdb3 installed; there's no need to have an SQL
+  assuming you have libdb4 installed; there's no need to have an SQL

   database running and configured.
 
   database running and configured.
 

+* fs (file backend)
+  A fuller featured file based backend. Doesn't need any external
+  libraries and supports the full range of operations (such as text and
+  subkey searching). Needs a good filesystem to get good performance
+  though as it creates many, many files and links.
+

 
 Other keyservers:
 
 
 Other keyservers:
 


@@ -93,12 +101,11 @@ please let me know and I'll add them.
 
 * pks
   http://sf.net/projects/pks/
 
 * pks
   http://sf.net/projects/pks/

-  The prodominant keyserver I believe; certainly what I run on
-  wwwkeys.uk.pgp.net. Recently development restarted on this (when I
-  started writing onak it had been dormant for some time) so it should
-  hopefully get its problems sorted out soon. The main issue with pks is
-  that it lacks support for keys with multiple subkeys bound to them and
-  unfortunately mangles them.
+  The prodominant keyserver I believe; what I used to run on
+  wwwkeys.uk.pgp.net. Had a spurt of activity a year or two ago, but
+  seems to have died off again. The main issue with pks is that it lacks
+  support for keys with multiple subkeys bound to them and older
+  versions unfortunately mangle them.

 
 * CryptNET Keyserver
   http://www.cryptnet.net/fsp/cks/
 
 * CryptNET Keyserver
   http://www.cryptnet.net/fsp/cks/


@@ -114,7 +121,7 @@ please let me know and I'll add them.
 * SKS
   http://sks.sourceforge.net/
   A reasonably new keyserver concentrating more on the whole issue of
 * SKS
   http://sks.sourceforge.net/
   A reasonably new keyserver concentrating more on the whole issue of

-  syncronization between keyservers.
+  syncronization between keyservers. Seems to be gaining in popularity.

 
 
 Contacting the author:
 
 
 Contacting the author:


@@ -125,9 +132,21 @@ OFTC (irc.oftc.net) as Noodles.
 All constructive criticism, bugs reports, patches and ideas are welcome.
 
 
 All constructive criticism, bugs reports, patches and ideas are welcome.
 
 

-License:
+Obtaining later versions:
+
+onak lives at:
+
+http://www.earth.li/projectpurple/progs/onak.html

 
 

-onak is distributed under the GNU Public License, a copy of which should
-have been provided with this archive as LICENSE.
+Development is carried out using arch; you can access the repository
+with something like:
+
+tla register-archive noodles@earth.li--2004-laptop \
+       http://www.earth.li/~noodles/arch/
+tla get -A noodles@earth.li--2004-laptop onak--mainline--0.3
+
+
+License:

 
 

-$Id: README,v 1.4 2003/06/04 20:57:06 noodles Exp $
+onak is distributed under the GNU Public License version 2, a copy of
+which should have been provided with this archive as LICENSE.