EZproxy administration

Use EZproxy Administration to manage your EZproxy.

EZproxy servers have an administrative URL of one of the following forms:

Self-hosted - https://ezproxy.yourlib.org/admin

Hosted - https://yourlib.idm.oclc.org/admin

To access your admin page, self-hosted libraries replace ezproxy.yourlib.org with your library's EZproxy server name or hosted libraries replace yourlib with the domain name you selected during implementation. Use the admin credentials you created in your user.txt to log in as an administrator. If you have not added admin credentials, follow the steps in the Admin Users tab.

The following table provides a brief overview of what can be done using each hyperlink on the /admin page. The path can be appended to your server's URL for quick access to any of these pages.

Administrative Actions

Hyperlink Path Relates to Overview
Current activity
View server status /status
  • Provides a snapshot of who is currently logged in to EZproxy, the databases configured on your server, the login ports being used, and the hosts being accessed.
  • Allows you to perform maintenance on your server.
View and clear intrusion attempts /intrusion

(Based on IntruderIPAttempts and IntruderUserAttempts directives.)

  • Displays failed logins that have occurred recently.
  • Allows admin to reinstate access for suspended users.
View usage limits and clear suspensions /usagelimits

(Based on UsageLimit directive.)

  • Displays UsageLimit settings.
  • Displays any users who have exceeded limits if UsageLimit has been set to enforce.
  • Allows admin to reinstate access to suspended users.
View audit events /audit

(Based on Audit directive.)

  • Displays viewable list of days with available Audit Events recorded.
  • Allows admin to search for users, events, IP addresses, locations, and other fields.
View security rules /security
  • Security rules
  • Security exceptions
  • Tripped security rules
  • Tripped security rules evidence
  • Provides status for each defined security rule.
  • Manage and list users excepted from all rule processing.
  • Provides status for all tripped rules with links to detailed evidence for each tripped rule.
  • Provides detailed evidence about events that caused a rule to be tripped.
View identifiers /identifier
  • Pseudonymous identifiers
  • Provides matching between the pseudonymous identifier and EZproxy username.
View messages.txt /messages?last=#
  • Displays server events logged in messages.txt for the preceding number of lines selected. 
View ezproxy.log /usage?last=#
  • Displays events logged in ezproxy.log for the preceding number of lines selected.
View messages.txt lines containing /messages?find=
  • Allows admin to search for specific events that could have been recorded in messages.txt. The log file search depends on how these logs have been configured in your config.txt file.
View ezproxy.log lines containing /usage?find=
  • Allows admin to search for specific events that could have been recorded in ezproxy.log. The log file search depends on how these logs have been configured in config.txt.
Restart EZproxy /restart Allows admin to quickly restart EZproxy after changes have been made to config.txt or to address other issues.

Your Status

(These pages can be viewed by any user who has logged in to EZproxy)

View your IP address /ip
  • Displays the IP address you are using to connect to EZproxy.
  • Admins can ask users to visit the /ip URL to confirm the IP address they are using to connect to EZproxy and troubleshoot access issues.
Logout /logout
  • Logs you out of EZproxy.
  • Admins can ask users to visit the /logout URL to confirm that they have terminated an EZproxy session before further troubleshooting.
View your group memberships /mygroups

(Based on Group directive in config.txt and user.txt)

  • Displays the resource groups that can be accessed during the current session.
  • Admins can ask users to visit the /mygroups page to confirm the groups they are part of during a given session and troubleshoot resource-group access.
Miscellaneous

Manage SSL (https) certificates

(For more details about this page see SSL Configuration.)

/ssl
  • Displays the SSL certificates currently available on your EZproxy server. Active Certificate is annotated.
  • Begin creating or adding new SSL Certificates on this page. 

View database group assignments

(For more details about this page see the testing information for Groups.)

/groups
  • Displays the resource groups you can access using the current session’s credentials.
  • Allows admin to test group configurations by turning off access to certain groups for current session.
Test user.txt configuration /user
  • Test user.txt authentication configuration.
  • Debug configurations that are not working and identify potential problems.
Test network connectivity /network
  • Test connectivity from IP address.
  • Identify your IP address for remote hosts.
Check for database definition conflicts /conflicts
  • Identify any duplicate hosts in database stanzas in your config.txt.
Test LDAP /ldap
Decrypt variable /decryptvar
  • Decrypt variables sent as part of stanzas that include EncryptVar.
Manage Shibboleth /shibboleth