Installing Eprints 3 on Windows

From EPrints Documentation
Revision as of 16:16, 2 March 2007 by Tmb (talk | contribs)
Jump to: navigation, search

We are working to support the Windows platform. This guide describes the process of getting EPrints 3 running on Windows (tested with XP and Vista). Please add bugs and comments to the end of this page.


  • The installation directory is fixed as C:\EPrints\
  • No external commands are supported. This includes compressed files and image thumbnail support.
  • Scheduled tasks, such as generate_static and the full text indexer are not supported.
  • Apache Perl includes an old release of Apache. This is missing subsequent security updates; see for details. This Apache/Perl bundle was chosen because ActiveState Perl's license does not permit redistribution. Alternative versions of Apache, Perl, and mod_perl are untested but may work.

Required Software

Apache Perl

Includes the Perl interpreter, Apache web server, and the mod_perl library. Get the latest version from


Download MySQL Community Server, Windows Essentials (x86) from

EPrints has been tested with MySQL 5.0, but other versions may work.

EPrints 3 for Windows

This is an evaluation release. We do not recommend that it be used in a production environment.

Download the EPrints 3 for Windows components:

  1. EPrints 3 Windows installer
  2. EPrints 3 Windows Customization Script This file is under a proprietary license and is not redistributable. Save this file in the same directory as the installer executable.


Each component of the complete EPrints system will be installed in a subdirectory of C:\EPrints\ for ease of maintenance.

Install Apache Perl

Run the Apache Perl installer, selecting to install into C:\EPrints. This will install Apache in C:\EPrints\Apache2, and Perl in C:\EPrints\Perl.

Configure Apache Perl

When the installation completes, it asks you to configure the binary. Set the following options:

  • Disable configuring
  • Disable building HTML documentation
  • When prompted, choose not to install nmake.

Leave the other options at their defaults, and press Configure.

When the configuration tool is finished, you will need to set some environment variables so EPrints can find Perl and its libraries. To set environment variables, use Control Panel → System → Advanced system settings → Advanced → Environment Variables…

  • Add C:\EPrints\Perl\bin to Path, separated by a semicolon ;
  • Create a new variable PERL5LIB, with the value C:/EPrints/EPrints/perl_lib (note forward slashes).

Install MySQL

Now run the MySQL installer, and choose a Custom installation in C:\EPrints\MySQL. You will need to set the following options:

  • Install the server and client programs
  • Do not install the C files
  • Skip signing up to

Configure MySQL

When the installation completes, you should configure the server as prompted (this tool is also available from the Start Menu afterwards).

Choose Detailed installation. Accept most of the default settings:

  • Choose Best Support for Multilingualism as the character set
  • Choose a secure root password when prompted

When configuration has finished, you need to set an option manually in MySQL's configuration file by editing C:\EPrints\MySQL\my.ini in a text editor.

  • In the sql-mode option, remove NO_AUTO_CREATE_USER from the list

Now restart MySQL so that the new options take effect. In Control Panel → Administrative Tools → Services, find MySQL and choose Restart.

Install EPrints 3

The EPrints installer requires the Windows customization file, First Check that is in the same directory as the EPrints installer .exe file.

Run the EPrints installer. This will install files into C:\EPrints\EPrints.

When the installer has finished, it will open a window to prompt you for site specific information. Follow the instructions to complete the installation.

Configure EPrints 3

Now you can run epadmin to configure the archive. This process is the same on all platforms, so you can follow the standard instructions for the details of this process.

Note: Whenever you need to run an EPrints command line tool, it must be prefixed with perl:

perl bin/generate_static myarchive

First open a command prompt and change directory to C:\EPrints\EPrints. To start the process, run perl bin/epadmin create

Finally you need to add the EPrints configuration file to Apache. Edit C:\EPrints\Apache2\conf\httpd.conf and add at the bottom of the file:

Include C:/EPrints/EPrints/cfg/apache.conf

Starting Apache

Now start Apache from the command line: