Ability versus right
EZproxy allows you to extend access to your databases beyond your library walls to remote users. However, your licensing agreement with database vendors may not authorize you to provide remote access. As an implementer of remote access, it is your responsibility to verify licensing agreements and only permit remote access as authorized.
Install EZproxy for Linux
EZproxy is a completely standalone application. It does not require nor use any existing web server that is already installed on your server.
If you are already running a web server on the system where EZproxy is running, do not attempt to install EZproxy within directories that are used by that web server.
Before getting started EZproxy 6.4.4 requires users to obtain a WSKey to run the software, as the license keys from previous versions of EZproxy will not work in EZproxy 6.4.4. Before downloading EZproxy, please request your WSKey. To request and obtain a Key, please see Request a WSKey.
Create a directory for EZproxy and make it your current directory with the commands:
mkdir /usr/local/ezproxy cd /user/local/ezproxy
- Download ezproxy-linux.bin into this directory. If you download this file on a different system and use FTP to move it to your EZproxy server, be sure to perform the transfer using binary.
Rename the download file from ezproxy-linux.bin to ezproxy to make it executable with the commands:
mv ezproxy-linux.bin ezproxy chmod 755 ezproxy
- To create the default version of most of the files mentioned above, issue the command:
The -m stands for "missing file replacement," and this command can be used at any time to reconstruct any missing files without overwriting the existing files that you have changed.
If you are installing EZproxy on a 64-bit Linux distribution, you may receive a file not found error. If this occurs, you need to install ia32-libs (Debian), glibc.i686 (RHEL), lib32z1 (Ubuntu 13.04 and later), or ia32-libs (Ubuntu 12.04) to resolve the issue.
If you receive any errors during this step, please contact OCLC Support.
To verify whether EZproxy can automatically detect your host name correctly, as well as to check whether firewalls may interfere with your ability to use EZproxy, issue the command:
This command will make your server connect to an OCLC server. Your server will provide its name and IP address, then the OCLC server will attempt to verify this information. Your server will then display various messages to let you know what changes may be required for EZproxy to function properly.
Note: If you do not like the idea of your server connecting to an OCLC server, you may omit this step.
If you network requires the use of a standard proxy server to connect out to the Internet, this test will fail. In this case, you will need to configure EZproxy to use your outgoing proxy server using the Proxy directive, and then you can complete the network connectivity test by finishing the installation of EZproxy and using a browser installed either on the same server or within your network to log in to the EZproxy Administration page, where you can use the Test network connectivity option. This performs a more thorough network test, including offering the option to incorporate your outgoing proxy server in the test.
Use a text editor to edit the config.txt file. If suggested from the previous step, manually specify your host name in this file.
Use a text editor to edit the user.txt file. To create an administrative user, add the following line to the file, changing someuser to the username you want to use for testing and admin access, and somepass to the password you want to use for testing. In this example, admin should appear literally as shown:
someuser: somepass: admin
- Copy and paste your WSKey (obtained by following the instructions at How to Request a WSKey) after the key command as follows, substituting your WSKey for 123456789101112:
./ezproxy -k 123456789101112
- Start the server with the command:
- Using your web browser, connect to your server on port 2048. If your EZproxy server was named ezproxy.abclib.org, you would use the following URL:
Enter the username and password that you created when you edited the user.txt file. This should bring you to the main server administration page.
If you are not taken to the menu page, and you are taken to a page indicating that the EZproxy cookie was blocked, see EZproxy Cookie Blocked for information on why this happened and how to address it.
Note: The options presented and how effectively they work will depend on how well you customized your config.txt file. As you make additional changes to config.txt, you will need to stop and restart EZproxy to make the changes take effect.
After you have completed your installation and are able to log in to the administration page, you can find the database stanzas necessary to configure resources on the Database Setup page and information about different authentication methods on the Authenticate users page.
EZproxy for Linux requires an x86 or x86_64 distribution of Linux running a 2.2 or later kernel. To verify the version of your Linux kernel, use the command:
If you encounter problems running EZproxy on a specific distribution of Linux, please contact OCLC support for further assistance.
The minimum recommended configuration for a Linux server running EZproxy:
- Pentium II 400 with 256 MB of RAM
- 10 MB of disk space is required for installation
- Additional disk space is required to accommodate user authentication files and server log files
Additional System Considerations
This program can be executed from a non-privileged account, so please consider running it from an account other than root to increase security. For more information about how to configure EZproxy to run on a non-root account, see the RunAs directive.
If your site employs a proxy server for all outgoing connections to the Internet, you will need to enter the host and port information for this proxy server into the config.txt file using the Proxy directive.
If your site is protected by a firewall, external users may be unable to connect to EZproxy unless your firewall administrator allows incoming traffic to ports 2048 and above.
EZproxy can be configured to work with a variety of methods for authenticating users. For more information on these options, see User Authentication.
EZproxy uses a number of files that are automatically created during the installation process. For a list of those files and their purpose, see EZproxy system elements.
When installing EZproxy for Linux, you will download ezproxy-linux.bin. This binary file is the download version of the EZproxy program for Linux. It must be renamed to ezproxy.
Additional technical information can be found in EZproxy technical details.
The following are additional commands that can be used with EZproxy for Linux.
Resetting all files
If you want to reset all of the files to their original distributed contents, you can use the command:
If you want to restore just one or two of the original files, rename or delete the existing file that you want replaced, then issue the command:
To install the system startup script, issue the following command as root:
If you later want to remove the startup script, issue the following command as root:
Update to EZproxy 6.4.4 GA for Linux
These instructions cover how to update existing Linux installations to EZproxy 6.4.4. These instructions are valid to update from any version of EZproxy to this release. This process will preserve all existing configuration files.
Before getting started
EZproxy 6.4.4 requires users to obtain a WSKey to run the software. Before downloading EZproxy, please request your WSKey. To request and obtain a Key, please see Request a WSKey.
If you have already obtained a WSKey for any EZproxy V6.x, you can use this same WSKey to upgrade to the newest version.
- Change your current directory to the directory where EZproxy is installed with a command such as:
Download ezproxy-linux.bin into the directory where EZproxy is installed. If you download this file on different system and use FTP to move it to your EZproxy server, be sure to perform this transfer using binary.
Use the following command to stop the old version of EZproxy:
Rename your existing copy of the program file ezproxy to another name such as ezproxy. yyyymmdd replacing yyyymmdd with the current year, month and day using a command such as:
mv ezproxy ezproxy.yyyymmdd
Rename the program and make it executable with the commands:
mv ezproxy-linux.bin ezproxy chmod 755 ezproxy
During this step, if you are updating from EZproxy 5.0 or earlier, you will be asked to allow ezproxy.cfg to be renamed to config.txt and to allow ezproxy.usr to be renamed to user.txt.
Create any new files required for the updated release with the command:
If you receive any errors during this step, please contact OCLC support.
Optional. If you are updating from a EZproxy 5.0 or earlier, you can choose to rename your existing ezproxy.msg to messages.txt, or you can leave the existing file alone and EZproxy will create a new messages.txt file.
If you would like to rename the existing file, issue the command:
mv ezproxy.msg messages.txt
If you are updating from EZproxy V5.7.44 or earlier, copy your new, full WSKey from the OCLC Developer Network WSKeys screen (obtained by following the instructions at How to Request a WSKey), and paste it into your command prompt window with the key command as follows, substituting your complete key for 123456789101112. If you are updating from EZproxy V6.0.8 or newer, you will not need to re-enter your WSKey to update:
./ezproxy -k 123456789101112
Start EZproxy with the command:
Tags recommended by the template: article:topic