Installation guide for Joomla 1.5 authentication plugin OpenID by Scouting Nederland
====================================================================================

Contents
--------
1. Purpose of the plugin
2. Configuration settings
3. Database storage
4. File storage

1. Purpose of the plugin
------------------------

The plugin is a replacement plugin for the default authentication plugin in Joomla 1.5.
The default authentication plugin uses the PHP4 OpenID library provided by Janrain. This
library is incompatible with PHP5 and only uses file storage.

This plugin uses the PHP5 library provided by Janrain (http://www.janrain.com/openid-enabled)
and supports both file and database storage. Furthermore it allows the user to hide part of
the OpenID identity by entering an Identity URL.

2. Configuration settings
-------------------------

a. Store (store_database)
There are 2 options for storing the OpenID associations and nonces: file or database.
These options are explained in chapter 3 and 4 of this guide.

b. Identity URL (prefix_url)
An OpenID identity is always an URI and may look like https://username.myopenid.net. To allow
for easy login to one OpenID provider by just providing the username instead of the complete identity,
the plugin supports an identity URL. For the example it would be: https://%s.myopenid.net.
In the plugin the '%s' is replaced using the PHP sprintf function with the provided username.

c. Endpoint URL (endpoint_url)
URL that points to the default OpenID provider that should be used when nu username is entered.
The provider must support OpenID 2.0 Identifier Selection.

3. Database storage
-------------------

The database storage creates 2 tables: #__oid_associations and #__oid_nonces (#__ is replaced by the Joomla table prefix)
that store associations with providers and nonces that are used in OpenID requests.
The class 'openidDatabaseConnection' uses the JDatabase class provided by Joomla to map SQL queries
from the OpenID library to Joomla.

4. File storage
---------------

If you don't want to use database storage, file storage is also possible. The plugin creates folders in the '/tmp' folder of
your webserver to store the associations and nonces.