1 files changed, 36 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..9a4db96
--- a/dev/null
+++ b/README
@@ -0,0 +1,36 @@
+PHKP: A PHP implementation for a HKP keyserver.
+http://el-tramo.be/software/phkp
+(c) 2006 Remko Troncon
+--------------------------------------------------------------------------------
+WARNING: THIS SOFTWARE IS NOT PRODUCTION-READY. IT PROBABLY CONTAINS
+BUGS AND SECURITY LEAKS. USE AT YOUR OWN RISK !!!
+INSTALL:
+- Copy the phkp.php script to your webserver directory. If you can put it
+  in the root directory of your web dir, you can rename it to 'index.php'.
+  If you don't do this, you will need to redirect every request to /pks
+  to this script. For example, using Apache rewrite rules:
+                RewriteRule ^/pks/(.*)   /phkp.php?/pks/$1
+- Modify the values in index.php to reflect your settings and create the
+  necessary directories
+USING:
+- Simply point your gpg to the right keyserver and port. For example:
+        gpg --keyserver hkp://example.com:80 --search-keys Remko
+        gpg --keyserver hkp://example.com:80 --send-keys 8E041080
+        gpg --keyserver hkp://example.com:80 --recv-keys 8E041080
+        
+KNOWN ISSUES:
+- Expiration and revocation is only detected with the english version
+  of GnuPG. Other languages will omit this information.
+TODO: 
+- Provide more information for uids in searches
+- Return human readable output if 'mr' option is not set
+- Make more robust, fool proof and secure
+- Better logging
+- More graceful calls to GnuPG
+- Fine-tune GnuPG options (try to avoid creation of trustdb etc. if possible)
+- Look at expiration date computation. Currently has a workaround to avoid
+  being one day off.

diff --git a/README b/README new file mode 100644 index 0000000..9a4db96 --- a/dev/null +++ b/README
@@ -0,0 +1,36 @@
	1	PHKP: A PHP implementation for a HKP keyserver.
	2	http://el-tramo.be/software/phkp
	3	(c) 2006 Remko Troncon
	4	--------------------------------------------------------------------------------
	5
	6	WARNING: THIS SOFTWARE IS NOT PRODUCTION-READY. IT PROBABLY CONTAINS
	7	BUGS AND SECURITY LEAKS. USE AT YOUR OWN RISK !!!
	8
	9	INSTALL:
	10	- Copy the phkp.php script to your webserver directory. If you can put it
	11	in the root directory of your web dir, you can rename it to 'index.php'.
	12	If you don't do this, you will need to redirect every request to /pks
	13	to this script. For example, using Apache rewrite rules:
	14	RewriteRule ^/pks/(.*) /phkp.php?/pks/$1
	15	- Modify the values in index.php to reflect your settings and create the
	16	necessary directories
	17
	18	USING:
	19	- Simply point your gpg to the right keyserver and port. For example:
	20	gpg --keyserver hkp://example.com:80 --search-keys Remko
	21	gpg --keyserver hkp://example.com:80 --send-keys 8E041080
	22	gpg --keyserver hkp://example.com:80 --recv-keys 8E041080
	23
	24	KNOWN ISSUES:
	25	- Expiration and revocation is only detected with the english version
	26	of GnuPG. Other languages will omit this information.
	27
	28	TODO:
	29	- Provide more information for uids in searches
	30	- Return human readable output if 'mr' option is not set
	31	- Make more robust, fool proof and secure
	32	- Better logging
	33	- More graceful calls to GnuPG
	34	- Fine-tune GnuPG options (try to avoid creation of trustdb etc. if possible)
	35	- Look at expiration date computation. Currently has a workaround to avoid
	36	being one day off.