Default Web Pages

Many of the web pages presented by EZproxy to remote users can be replaced with your own pages. The default text for some of the pages is built into EZproxy whereas other pages have default template files that appears in the docs subdirectory. To customize one of these pages, create or edit a file of the corresponding name in the docs subdirectory.

These files may reference the following variables, although not all of these variables are available or appropriate for use in all of these files.

^^    Send a caret (^)
^B / ^E ^B starts and ^E ends a section of HTML that should be repeated for each database definition from config.txt/ezproxy.cfg, or if Option MenuByGroups is in config.txt/ezproxy.cfg, only the databases that are available to the groups with which the user is associated are presented. If you would like to change the way the links behave, edit the HTML between the ^B/^E tags on the menu.htm page.
^D Send the description of a database as declared by the Description directive in config.txt/ezproxy.cfg
^H Send just the hostname portion of the destination URL
^L Insert the login URL for this server (e.g. http://ezproxy.yourlib.org:2048/login)
^P Insert the URL for this server (e.g. http://ezproxy.yourlib.org:2048)
^T Send the title of a database as declared by the Title directive in config.txt/ezproxy.cfg
^U Destination URL in edited format, suitable to display to the end-user in an HTML page
^V Destination URL in verbatim format, suitable for use in forming a destination URL such as for part of an "href" tag
^W Destination URL prepared to redirect user the Shibboleth WAYF (only available if Shibboleth authentication is enabled)
^0 For limit.htm, send the maximum number of logins allowed for the user
^1 For limit.htm, send "s" if the user limit is not 1, send nothing if the user limit is 1
^2 For limit.htm, send "are" if the user limit is not 1, send "is" if the user limit is 1
^{ expression} Evaluate the Expression that appears within the braces and send the resulting value
badhost.htm
In proxy by hostname, this file is sent if someone uses a name that point at the EZproxy server but that EZproxy does not recognize. If this file does not exist, EZproxy redirects the user to the proper name of the EZproxy server, which is normally the preferred behavior.
cookie.htm
This file is sent if EZproxy is unable to set its cookie in the remote browser.
https.htm
This file is sent if someone tries to connect to an https service using http.
intruder.htm
If this file exists, it is sent when a user has exceeded an IntruderUserAttempts. Using this file to provide feedback simultaneously reveals your policy for number of attempts, which makes it easier for brute force attacks to know when they should try another account. If you choose to use this option, it is best to also enforce a IntruderIPAttempts restriction to increase the difficulty of probing your server.
logout.htm
This file is sent when someone accesses the /logout URL to end an EZproxy session.
limit.htm
This file is sent if the ::Limit option is used in user.txt/ezproxy.usr and a user exceeds his/her login limit. This file may include the special sequence ^0 mentioned above.
login.htm
This file is sent when someone needs to log in to EZproxy.
loginbu.htm
This file is sent when someone has tried to log in to EZproxy but has provided "bad user" information (invalid username or password).
logup.htm
This file is sent if EZproxy is configured to use groups and a user tries to access a databases for which he/she is not authorized.
needhost.htm
This file is sent if someone tries to use a starting point URL for a destination URL unknown to EZproxy.
mv.htm
This file is sent if the MaxVirtualHosts limit has been exceeded and is preventing access to a web page.
reject.htm
If this file exists, it is sent if a RejectIP directive in config.txt/ezproxy.cfg matches the remote user address or if the IP address has exceeded a IntruderIPAttempts -Reject threshold. If an attempt is made from a rejected address and this file does not exist, the connection is simply closed.