Drupal: Difference between revisions
(turned into a page about all Drupal solutions for Raven) |
(Added ucamraven 7.x, restructured ucamraven section to make the different versions clearer) |
||
| Line 1: | Line 1: | ||
There are two solutions for adding Raven authentication to the [http://www.drupal.org/ Drupal] content management system: | There are two solutions for adding Raven authentication to the [http://www.drupal.org/ Drupal] content management system: | ||
* Shawn Tan wrote the '''ucamraven''' Drupal module, which was later updated by David Newgas, Aidan Hobson Sayers, and Peter Cowan | * Shawn Tan wrote the '''ucamraven''' Drupal module, which was later updated by David Newgas, Aidan Hobson Sayers, and Peter Cowan. It adds [[Raven/Webauth]] authentication to Drupal 6 and 7 (although in separate module archives). | ||
* Drupal's [http://drupal.org/project/shib_auth '''shib_auth''' module] can be used with [[Raven/Shibboleth]] and is also supported for Drupal 7. | * Drupal's [http://drupal.org/project/shib_auth '''shib_auth''' module] can be used with [[Raven/Shibboleth]] and is also supported for Drupal 7. Note that this [https://wiki.aai.niif.hu/index.php?title=DrupalShibbolethReadmeDev#Installation_and_bootstrapping requires Shibboleth SP] to be installed on the Drupal host. | ||
== ucamraven == | == ucamraven == | ||
=== Objective === | === Objective === | ||
=== Installation === | This Drupal module was created to allow any website that uses Drupal, to authenticate via Raven. | ||
=== License === | |||
This module is released under GPLv2. A copy of the license is included in the module package. | |||
=== Author === | |||
Author's contact information is available in the module source file. | |||
---- | |||
=== ucamraven 7.x === | |||
==== Compatibility ==== | |||
The module was adapted from the 6.x-1.3b version and is deigned to run on 7.x versions of Drupal (tested up to 7.0). | |||
==== Installation, Configuration and Use ==== | |||
See the INSTALL.txt file in the downloaded archive. Available [http://people.pwf.cam.ac.uk/aph40/ucamraven-7.x-0.1-beta-INSTALL.txt here] for convenience. | |||
==== Features ==== | |||
In addition to porting the Ucamraven-6.x-1.3b to Drupal 7, a lot of work was put into make the module easier to use - it now comes with a configuration page to allow all the features of 6.x-1.3b to be set up without having to touch any php code, as well as an explanation for each option and sane defaults. No preparatory steps need to be taken before installing the module (unlike with 6.x-1.3b). | |||
Additionally, support for manually overriding the institution check for specific users has been added. | |||
==== Download ==== | |||
[http://people.pwf.cam.ac.uk/aph40/ucamraven-7.x-0.1-beta.tar.gz Ucamraven-7.x-0.1-beta.tar.gz] - Off-wiki link | |||
Note that while testing has been performed on this module and it is currently in use on a live site, there is no guarantee it will work for all Drupal installations. | |||
---- | |||
=== ucamraven 6.x === | |||
==== Compatibility ==== | |||
The module runs fine on 6.x versions of Drupal (tested up to 6.16). | |||
==== Installation ==== | |||
'''Update: See the readme file contained in version 1.2 for updated instructions.''' | '''Update: See the readme file contained in version 1.2 for updated instructions.''' | ||
| Line 24: | Line 65: | ||
* Click on admin => menus => navigation. Uncheck the "Log out" item to disable non-raven authentication· | * Click on admin => menus => navigation. Uncheck the "Log out" item to disable non-raven authentication· | ||
=== User login === | ==== User login ==== | ||
Any user that clicks on the "raven login" link in the main menu will be redirected to the standard Raven login page. Once the user has authenticated with Raven, the user will be redirected back to the original website. | Any user that clicks on the "raven login" link in the main menu will be redirected to the standard Raven login page. Once the user has authenticated with Raven, the user will be redirected back to the original website. | ||
| Line 30: | Line 71: | ||
If no user account exists for that CRSID, one will be created. | If no user account exists for that CRSID, one will be created. | ||
=== Admin login === | ==== Admin login ==== | ||
The admin account must be a CRSID to log in using the raven system. Administrators with non CRSID account names can only by-pass the Raven login if either: this module is disabled, or the function that overrides "user/login" is disabled (comment out in the .module file). | The admin account must be a CRSID to log in using the raven system. Administrators with non CRSID account names can only by-pass the Raven login if either: this module is disabled, or the function that overrides "user/login" is disabled (comment out in the .module file). | ||
(The override only appears to be available in 1.2, and is opt-in (i.e. it needs uncommenting) - see new install.txt) | (The override only appears to be available in 1.2, and is opt-in (i.e. it needs uncommenting) - see new install.txt) | ||
=== | ==== Download ==== | ||
== | |||
The UCam Raven Drupal module can be downloaded here: | The UCam Raven Drupal module can be downloaded here: | ||
| Line 53: | Line 90: | ||
[http://people.pwf.cam.ac.uk/pc410/ucamraven-6.x-1.3b.tar Ucamraven-6.x-1.3b.tar] - Off-wiki link | [http://people.pwf.cam.ac.uk/pc410/ucamraven-6.x-1.3b.tar Ucamraven-6.x-1.3b.tar] - Off-wiki link | ||
Revision as of 15:40, 16 May 2011
There are two solutions for adding Raven authentication to the Drupal content management system:
- Shawn Tan wrote the ucamraven Drupal module, which was later updated by David Newgas, Aidan Hobson Sayers, and Peter Cowan. It adds Raven/Webauth authentication to Drupal 6 and 7 (although in separate module archives).
- Drupal's shib_auth module can be used with Raven/Shibboleth and is also supported for Drupal 7. Note that this requires Shibboleth SP to be installed on the Drupal host.
ucamraven
Objective
This Drupal module was created to allow any website that uses Drupal, to authenticate via Raven.
License
This module is released under GPLv2. A copy of the license is included in the module package.
Author
Author's contact information is available in the module source file.
ucamraven 7.x
Compatibility
The module was adapted from the 6.x-1.3b version and is deigned to run on 7.x versions of Drupal (tested up to 7.0).
Installation, Configuration and Use
See the INSTALL.txt file in the downloaded archive. Available here for convenience.
Features
In addition to porting the Ucamraven-6.x-1.3b to Drupal 7, a lot of work was put into make the module easier to use - it now comes with a configuration page to allow all the features of 6.x-1.3b to be set up without having to touch any php code, as well as an explanation for each option and sane defaults. No preparatory steps need to be taken before installing the module (unlike with 6.x-1.3b).
Additionally, support for manually overriding the institution check for specific users has been added.
Download
Ucamraven-7.x-0.1-beta.tar.gz - Off-wiki link
Note that while testing has been performed on this module and it is currently in use on a live site, there is no guarantee it will work for all Drupal installations.
ucamraven 6.x
Compatibility
The module runs fine on 6.x versions of Drupal (tested up to 6.16).
Installation
Update: See the readme file contained in version 1.2 for updated instructions.
Un-tar the module into your Drupal's "module" directory. It will be placed in a "ucamraven" sub-directory.
Login as the administrator for your Drupal based site.
- Go to /user/1/edit and ensure the admin account is a CRSID.
- Click on admin => modules. Enable the "ucamraven" module.
- Click on admin => menus => navigation. Uncheck the "Log out" item to disable non-raven authentication·
User login
Any user that clicks on the "raven login" link in the main menu will be redirected to the standard Raven login page. Once the user has authenticated with Raven, the user will be redirected back to the original website.
If no user account exists for that CRSID, one will be created.
Admin login
The admin account must be a CRSID to log in using the raven system. Administrators with non CRSID account names can only by-pass the Raven login if either: this module is disabled, or the function that overrides "user/login" is disabled (comment out in the .module file). (The override only appears to be available in 1.2, and is opt-in (i.e. it needs uncommenting) - see new install.txt)
Download
The UCam Raven Drupal module can be downloaded here: http://raven.cam.ac.uk/project/drupal/files/. The current version is 1.1 (an updated version 1.2 is also available - see below).
An old version for drual 4.6 and 4.7 is also available, however it may suffer from a security vulnerability that was fixed by the 1.0 to 1.1 upgrade of the 6.x version. Use with considerable care.
An updated module with an improved readme, user college checking, redirection for unrecognised colleges and the overriding for the standard login (which did not seem to be implemented?) is also available. Note that college checking cannot check postgraduates as they are a member of their department, not their college. The install.txt file contains some important instructions, so do read it.
Ucamraven-6.x-1.2.tar.gz - Off-wiki link
A slightly modified version of the above plugin sets the Drupal username to be the user's real name from an LDAP search, note that this is optional (See instructions). Instructions are provided but the plugin should be considered a beta at this time as bugs may not have been completely ironed out. Recode at your desire!
Ucamraven-6.x-1.3b.tar - Off-wiki link
