modules/ezproxy/README.txt

Requirements
------------

This module requires Drupal 5 or higher and EZproxy installed


Installation
------------

1. Place the ezproxy module into your modules directory (sites/all/modules)

2. Enable the module in admin >> site configuration >> modules

3. Set up access permissions in admin >> user >> permissions for both 'administer ezproxy'
   and 'access exproxy content'.


Configuration
-------------
There are two ways this module can be used:

1. External script authentication
   In this mode, EZproxy will present the login screen, but the usernames and passwords will be checked
   by Drupal in the Drupal database.

   http://www.oclc.org/support/documentation/ezproxy/usr/external.htm

2. CGI Authentication (recommended)
   In this mode, EZproxy will get Drupal to the authentication itself.  The standard Drupal login form
   will be used if needed.  If a user is already logged into Drupal when they request an EZproxy database
   they will be taken there directly.  Use this mode for transparent login between Drupal and EZproxy.

   http://www.oclc.org/support/documentation/ezproxy/usr/cgi.htm


External script authentication
------------------------------

1. Configure EZproxy to use Drupal as the external script for authentication.
   Copy the following line into the ezproxy user.txt file (/usr/local/ezproxy/user.txt), replacing 'someuser'
   and 'somepass' with a username and password that Drupal will use for
   its communication.  Also replace example.com with the domain name for your Drupal site.
  
   ::external=http://example.com/ezproxyauth,post=someuser=^u&somepass=^p,valid=+OK

2. Go to the configuration page for ezproxy (admin >> site configuration >> ezproxy) and enter the hostname
   for your ezproxy server.  If you have this installed in the same machine as Drupal this is probably the
   same domain name as your Drupal site.

   Note: you do not need to enter any username or password, they are not used for this authentication method


CGI Authentication (recommended)
--------------------------------

1. Configure ezproxy to use Drupal for authentication.
   Copy the following line into the ezproxy user.txt file (/usr/local/ezproxy/user.txt), replacing 'someuser'
   and 'somepass' with a username and password that Drupal will use for
   its communication.  Also replace example.com with the domain name for your Drupal site.
  
   someuser:somepass:cgi=http://example.com/ezproxylogin?

2. Go to the configuration page for ezproxy (admin >> site configuration >> ezproxy) and enter the hostname
   for your ezproxy server.  If you have this installed in the same machine as Drupal this is probably the
   same domain name as your Drupal site.

   Enter the username and password specified in step 1 above.


Usage
-----
1. External script authentication
   When you click on a link to go to an EZproxy database, EZproxy will ask you to login.  The username and 
   password entered will be sent to Drupal and Drupal will check if the user exists in the system and has 
   the 'access ezproxy content' permission.  If the user does have permission, Drupal will report back to
   EZproxy with a successful logon attempt.

2. CGI authentication
   When you click on a link to go to an EZproxy database, EZproxy will first ask Drupal if you are authenticated.
   If the user is currently logged in as has the 'access ezproxy content' permission then Drupal will report back
   to EZproxy with the successful logon attempt and the user will be taken to the database they requested.
   If the user is not logged in, Drupal will prompt them to login.  When successful Drupal will report back
   to EZproxy with the successful logon attempt and the user will be taken to the database they requested.


Notes
-----
1. The list of databases set up in EZprozy can be viewed at admin >> settings >> ezproxy >> list
2. A logout from EZproxy can be forced by going to http://example.com/ezproxylogout


Author/Maintainer
-----------------

Aaron Fulton aaron@webtolife.org

1	Requirements
2	------------
3
4	This module requires Drupal 5 or higher and EZproxy installed
5
6
7	Installation
8	------------
9
10	1. Place the ezproxy module into your modules directory (sites/all/modules)
11
12	2. Enable the module in admin >> site configuration >> modules
13
14	3. Set up access permissions in admin >> user >> permissions for both 'administer ezproxy'
15	and 'access exproxy content'.
16
17
18
19	Configuration
20	-------------
21	There are two ways this module can be used:
22
23	1. External script authentication
24	In this mode, EZproxy will present the login screen, but the usernames and passwords will be checked
25	by Drupal in the Drupal database.
26
27	http://www.oclc.org/support/documentation/ezproxy/usr/external.htm
28
29	2. CGI Authentication (recommended)
30	In this mode, EZproxy will get Drupal to the authentication itself. The standard Drupal login form
31	will be used if needed. If a user is already logged into Drupal when they request an EZproxy database
32	they will be taken there directly. Use this mode for transparent login between Drupal and EZproxy.
33
34	http://www.oclc.org/support/documentation/ezproxy/usr/cgi.htm
35
36
37
38	External script authentication
39	------------------------------
40
41	1. Configure EZproxy to use Drupal as the external script for authentication.
42	Copy the following line into the ezproxy user.txt file (/usr/local/ezproxy/user.txt), replacing 'someuser'
43	and 'somepass' with a username and password that Drupal will use for
44	its communication. Also replace example.com with the domain name for your Drupal site.
45
46	::external=http://example.com/ezproxyauth,post=someuser=^u&somepass=^p,valid=+OK
47
48	2. Go to the configuration page for ezproxy (admin >> site configuration >> ezproxy) and enter the hostname
49	for your ezproxy server. If you have this installed in the same machine as Drupal this is probably the
50	same domain name as your Drupal site.
51
52	Note: you do not need to enter any username or password, they are not used for this authentication method
53
54
55
56	CGI Authentication (recommended)
57	--------------------------------
58
59	1. Configure ezproxy to use Drupal for authentication.
60	Copy the following line into the ezproxy user.txt file (/usr/local/ezproxy/user.txt), replacing 'someuser'
61	and 'somepass' with a username and password that Drupal will use for
62	its communication. Also replace example.com with the domain name for your Drupal site.
63
64	someuser:somepass:cgi=http://example.com/ezproxylogin?
65
66	2. Go to the configuration page for ezproxy (admin >> site configuration >> ezproxy) and enter the hostname
67	for your ezproxy server. If you have this installed in the same machine as Drupal this is probably the
68	same domain name as your Drupal site.
69
70	Enter the username and password specified in step 1 above.
71
72
73	Usage
74	-----
75	1. External script authentication
76	When you click on a link to go to an EZproxy database, EZproxy will ask you to login. The username and
77	password entered will be sent to Drupal and Drupal will check if the user exists in the system and has
78	the 'access ezproxy content' permission. If the user does have permission, Drupal will report back to
79	EZproxy with a successful logon attempt.
80
81	2. CGI authentication
82	When you click on a link to go to an EZproxy database, EZproxy will first ask Drupal if you are authenticated.
83	If the user is currently logged in as has the 'access ezproxy content' permission then Drupal will report back
84	to EZproxy with the successful logon attempt and the user will be taken to the database they requested.
85	If the user is not logged in, Drupal will prompt them to login. When successful Drupal will report back
86	to EZproxy with the successful logon attempt and the user will be taken to the database they requested.
87
88
89	Notes
90	-----
91	1. The list of databases set up in EZprozy can be viewed at admin >> settings >> ezproxy >> list
92	2. A logout from EZproxy can be forced by going to http://example.com/ezproxylogout
93
94
95
96	Author/Maintainer
97	-----------------
98
99	Aaron Fulton aaron@webtolife.org
100