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.

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
    • The Username and Password can be gotten from Scott, Kat, Jaime, or Jack
  • 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)
    • Allow it to overwrite or change the existing filename. SAVE A BACKUP JUST IN CASE!
  • 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 #
      • To add new comments, begin the line of text with 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.
    • To make edits (like an HTTPS update) add information to existing stanzas.
  • Save the Local copy
    • Drag the local file back into the Proxy Server and allow it to overwrite the existing config.txt file
  • Go to the EZProxy Admin and login with the same credentials as the Server
    • Restart the Server AFTER you've updated the file
  • Test the resource in Opera.

Sample Stanza configuration entry without javascript:

  • T Journal Title
  • U URL
  • HJ Host Source: Other hosts at resource? e.g. otherserver.publisher.com
  • DJ Direct Source: Top level domain e.g. publisher.com or publisher.ac.uk
    • Do not use colons
    • Some resources store information on different servers, so for instance, you might have access to the text but not the images if the server housing the image is not in the proxy config file.
    • Not every stanza will look the same

Sample configuration with javascript:

  • T Journal Title
  • U URL
  • HJ otherserver.publisher.com
  • DJ publisher.com

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.

Weekly Maintenance

  • Removing unused host log entries
    • Go to http://silk.library.umass.edu/status [Admin Login required]
    • In the section entitled Host Maintenance select the radio button for “Remove XXX hosts that have not been used in over 30 days
    • Select the Process button
    • Select the Administration link at the top of the page to go to the Admin page.
    • Select Restart Proxy from the Admin page menu.
  • If time permits, review message log (available via Admin page also) for problems. Restarting no longer yields syntax error messages for configuration file as it did in the past, you must look in the message.txt log file.

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.

License Violation Incidents through proxy

Includes Files

Publishers provide config files for EZProxy which may be found at OCLC or on publisher sites.

Create a .cfg or .txt file, depending upon publisher instructions, and FTP it to the EZProxy server. If you have trouble adding a .cfg extension, go to Windows explorer>Tools>Folder options>Deselect “Hide extensions for known file types.”

To edit and backup the config.txt file, FTP the file to R/S:Acquisitions/Electronic Resources/EZProxy. OCLC instructions for setting up the entry in the EZProxy config are here. FTP the corrected file back to the proxy server.

We use includes files for Oxford, Sage.

ezproxy_maintenance.1644957330.txt.gz · Last modified: 2022/02/15 20:35 by jmulvaney
www.chimeric.de Creative Commons License Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0