Document our test keys

[onak.git] / README

diff --git a/README b/README
index d70059f08b12531198ba5dc1d1b61b4aad2581c8..44989034aa0fec47beb281ab26282ee065bc4361 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
-onak 0.3.0
-Copyright 2003-2004 Project Purple. Written by Jonathan McDowell
+onak 0.3.2
+Copyright 2003-2005 Project Purple. Written by Jonathan McDowell

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


@@ -12,14 +12,14 @@ 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
 at times also. It should run on all architectures, but has only been
 
 
 Installation:
 
 onak has been mainly developed under Linux with a bit of work on FreeBSD
 at times also. It should run on all architectures, but has only been

-tested on i386 and PowerPC so far.
+tested on i386, AMD64 and PowerPC so far.

 
 Typing "./configure && make" should produce a version of onak with
 support for the DB4 backend. If you want to choose a different backend
 
 Typing "./configure && make" should produce a version of onak with
 support for the DB4 backend. If you want to choose a different backend


@@ -37,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


@@ -47,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


@@ -100,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/


@@ -121,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:


@@ -132,6 +132,20 @@ 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.
 
 

+Obtaining later versions:
+
+onak lives at:
+
+http://www.earth.li/projectpurple/progs/onak.html
+
+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:
 
 onak is distributed under the GNU Public License, a copy of which should
 License:
 
 onak is distributed under the GNU Public License, a copy of which should