summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorStef Walter <stef@memberwebs.com>2009-08-19 18:25:16 +0000
committerStef Walter <stef@memberwebs.com>2009-08-19 18:25:16 +0000
commit70ccf1622c31ae7b925510735a16425592813cfe (patch)
tree166bf25c2e3d7f5e7b5783cf1e278180431e75b1 /README
parent561272e63ff0cf9dc7e38d492a531a386dcdf8c1 (diff)
Fill in the README file
Diffstat (limited to 'README')
-rw-r--r--README32
1 files changed, 31 insertions, 1 deletions
diff --git a/README b/README
index f9a31cf..b4d9145 100644
--- a/README
+++ b/README
@@ -1,3 +1,33 @@
-=================================================================
+======================================================================
MOD_AUTH_SINGLEID README
+This is an apache 2.x module for authenticating users against a single
+OpenID 2.0 provider. Users are automatically redirected to the
+identity provider when they first access the authenticated area.
+
+REQUIREMENTS:
+
+ The following software must be installed on your system. For certain
+ OS's development headers must be included:
+
+ * libopkele (and dependencies)
+ * apache 2.x
+
+BUILDING:
+
+ Building is a standard affair:
+
+ $ ./configure
+ $ make
+ # make install
+
+ You may want to use the --prefix and/or --enable-debug options to
+ ./configure. See the INSTALL file for more options.
+
+
+DOCUMENTATION:
+
+ For more documentation see:
+ http://memberwebs.com/stef/software/mod_auth_singleid
+
+