This is an old revision of the document!
EZProxy Maintenance
OCLC's EZProxy is a service which allows authorized patrons to access publisher content remotely which would otherwise be behind a paywall on the open web. We provide the IP address to our proxy server to all publishers so that once patrons authenticate into the server, their web traffic is shown as coming from a valid UMass Amherst IP address which grants them full access to our subscribed content. When patrons attempt to access subscribed content on the open web from home (via Google or directly at publisher sites) they are not recognized as an authorized user and see only a paywall. EZProxy is used by the rest of the Five Colleges and is the authentication for the majority of our eResources.
Vendor documentation can be found at EZProxy Support. Questions regarding EZProxy should be directed to Jack or Jaime in DRMS and troubleshooting issues can be submitted via DBHelp.
Maintaining the Configuration File (config.txt)
OCLC Created Stanzas can be found here: https://help.oclc.org/Library_Management/EZproxy/Database_stanzas
During the renewals process, stanzas should be checked against the OCLC documentation to make sure that the most recent version is being used. The best way to tell if the stanza doesn't work is trying to access a resource from off campus (or via Opera w/ VPN installed) which will trigger a Need Host page if the stanza no longer works. If a resource is cancelled or ceased and we do not retain post-cancellation/perpetual access, then the stanza should be removed from the config file.
If you need to create a stanza from scratch, please reference others in the config. or search the EZProxy listserv archives. Consider the following:
Where something is in the file matters. It is read top down. Be sure to stick to alphabetization for easy searching.
When creating a resource configuration stanza, determine whether JavaScript is used.
Leave a note of who created the stanza and when.
Always test whether the stanza you created actually works.
Basic Changes to Stanzas
Using a
FTP client (preferably WinSCP-Put in a SysHelp Ticket to have it installed on your machine) access the Proxy Server
Once logged in, navigate to the config.txt file
There are many old Config files and backups that are not used anymore. Make sure you select the correct one.
Never edit the config file on the server directly to avoid breaking something accidentally without having a backup.
Drag the config.txt file from the right pane into the left pane (a local folder somewhere on your C Drive)
Double click on the file in the local folder to open the text editor. (For more advanced edits, use Notepad++-Put in a SysHelp Ticket to get it on your machine)
The text file has a specific structure. The beginning has administrative information for the Server, UMass IP Addresses, Blocked/Banned IPs, etc.
Different sections are commented out using a #
The Stanzas are roughly alphabetical, and they are hierarchical. Lines that are higher are given priority over lines that are lower.
Trials are always at the end of the file.
To add a new stanza,
Check OCLC or use Google to try and find one that someone else has created.
Save the Local copy
Go to the EZProxy Admin and login with the same credentials as the Server
Test the resource in Opera.
Sample Stanza configuration entry without javascript:
Sample configuration with javascript:
Monthly Maintenance
Upgrades
Notices of available upgrades to the EZProxy software are announced on the Listserv. Do not be hasty in requesting load of upgrades unless a bug fix is urgently needed. Each upgrade contains all previous upgrades. There is no risk in skipping one. LTS manages the EZProxy server and handles the upgrade process as well as the SSL certificate. If you are unsure of the status of either, check the EZProxy web admin - information about both are listed at the top of the page.
Include Files
We are not currently using include files for the config. DRMS wants to explore this further in the future but for now please place all stanzas directly in the config file.
User File
The user file is less complex than the config file and is primarily used to temporary block NetIDs which have become compromised until IT confirms that the patrons password has been reset. For specific instructions on this process see the Licensing Violations document below. When blocking a patron, format as “netid::deny”
To create temporary usernames/passwords for troubleshooting, use the following format:
# Context (Name of user, etc.)
Username:Password
Please always preserve the login for EBSCO, Mount Ida, and the temporary EZproxy troubleshooting password. If publishers ask for credentials try and create a unique login and delete it when they are done.
The username/password for the EZProxy web admin is configured here. DO NOT DELETE IT.
EZProxy Public Pages (Documents)
Patrons primarily experience the EZProxy login page, and may never encounter the various other pages which are mostly reserved for specific EZProxy related errors. These are stored in the “docs” directory of the server. The include the following pages:
login.htm
loginbu.htm
loginback.htm
logout.htm
needhost.htm
When a stanza is missing or no longer works for a specific
URL/platform patrons see this page. It includes information on how to report the error and contains information DRMS needs to update the stanza.
menu.htm
suspend.htm
cookie.htm
https.htm
survey.htm
License Violation Incidents through proxy