EPrints 2.2 Documentation - Required Software
In brief, EPrints requires Apache (with mod_perl), MySQL and Perl with some extra modules. Ideally you also want wget, tar and unzip.
EPrints bundles some perl modules which it uses, to save you installing them.
It's up to you. We have had best results with installing MySQL from RPM and apache from source.
The best place to get a software tool is the official site, but we've put a mirror of versions known to work at: http://www.eprints.org/files/tools/ - you don't need to install everything in the tools directory - just those described below.
Tested on: 3.23.29a-gamma
Install a recent version of MySQL 3. You will need the .h and library files later to install the MySQL perl module. MySQL 4 is due soon, but we are not making plans to support it yet (if you try EPrints with MySQL 4 and it works, please let us know)
If installing from RPM you require: mysql-server, mysql-devel and mysql RPMs.
Tested on: apache 1.3.14 with mod_perl 1.25
Apache is the most commonly used webserver in the world, and it's free! EPrints requires Apache to be configured with mod_perl, as this allows Apache modules that are entirely written in perl, hence providing much improved efficiency.
Get Apache from http://httpd.apache.org/dist/httpd/
EPrints requires that the apache modules mod_perl and mod_rewrite be enabled.
% perl Makefile.PL APACHE_PREFIX=/usr/local/apache \ APACHE_SRC=../apache-1.3.14/src DO_HTTPD=1 USE_APACI=1 \ PERL_AUTHEN=1 PERL_AUTHZ=1 ADD_MODULE=rewrite
Remeber to change
../apache-1.3.14/src to wherever your apache source is relative to this directory. The back slashes at the end of the line allow a single command to be split over multiple lines.
% make % make install
( mod perl should have already run the apache ./configure script for us. )
EPrints is currently begin developed with perl 5.6.1, there are currently no plans for to make EPrints run under perl 6 on the theory of if-it-ain't-broke-don't-fix-it.
Some perl modules are bundled with the EPrints2 package, others must be installed by you.
This describes the way to simple perl module, some require a bit more effort. We will use the non-existant FOO module as an example.
% gunzip FOO-5.23.tar.gz % tar xf FOO-5.23.tar
% cd FOO-5.23
% perl Makefile.PL % make % make test % make install
You don't have to install these. They are included as part of the EPrints distribution.
Please note that these modules are not part of the EPrints system and are only included to make things easier. Please note that XML::DOM has has a few lines commented out to prevent it requiring additional modules.
This modules are not built into EPrints - you must install them yourself. We recommend installing them in the order they are listed.
MySQL Interface Module requires this.
This one can be tricky. It requires access to .h and library files from MySQL. I install MySQL from source first, but some installs of MySQL don't put the lib and include dirs where this module expects. The answer to the first question is that you only need MySQL support.
Under Red Hat's GNU/Linux distribution, the zlib-devel RPM should be installed before you install this module.
Unicode::String requires this.
Used to parse XML files. Requres the expat library. A .tar.gz and an RPM are available in the tools dir on eprints.org.
Most PERL 5.6 or later systems should already include the following modules, but you may have to install some by hand on certain platforms.
Since EPrints 2.2 you may use either XML::DOM or XML::GDOME. XML::GDOME is recommended as it's faster and uses much less RAM, but it does require you to install a whole lot of extra libraries and perl modules. If you are running a pilot or demonstration service then XML::DOM is fine, and you can always switch over later by installing the required tools and setting the GDOME flag in perl_lib/EPrints/SystemSettings.pm
either get the tarball from: ftp://ftp.gnome.org/pub/GNOME/sources/libxml2/
or the RPMs (but we have had problems with complex RPM dependencies):
Obtain this from
You may either use the RPMs (gdome2 and gdome2-devel) or the tarball.
XML-LibXML-Common XML-NamespaceSupport XML-GDOME
All of which are in http://www.cpan.org/modules/by-module/XML/ =head1 Other Tools
wget, tar, gunzip and unzip are required to allow users to upload files as .tar.gz or .zip or to captures them from a URL.
These all come installed with most modern versions of linux. If you can get them working, you can remove the option by edditing ``archive_formats'' in SystemSettings.pm
Tested with wget 1.6.
If there are problems you may need to tweak how these are invoked in SystemSettings.pm
There is an optional feature which allows you to set eprints to look in certain fields (eg. title and abstract) for stuff which looks like latex equations and display it as an image of that equation instead. These tools are only required if you want to use this feature.
latex, dvips and convert (convert is part of ``imagemagick''). (These all ship with Red Hat's GNU/Linux distribution but you may have to install them yourself on other systems.)
This is a ``cosmetic'' feature, it only affects the rendering of information, so you can always add it later if you want to save time initially.
EPrints 2.2 Documentation - Required Software