Difference between revisions of "Required software"

From EPrints Documentation
Jump to: navigation, search
Line 2: Line 2:
  
 
==What Additional Software does EPrints Require?==
 
==What Additional Software does EPrints Require?==
 +
 
In brief, EPrints requires Apache (with mod_perl), MySQL and Perl with some extra modules. Ideally you also want wget, tar and unzip.
 
In brief, EPrints requires Apache (with mod_perl), MySQL and Perl with some extra modules. Ideally you also want wget, tar and unzip.
  
Line 7: Line 8:
  
 
===Where to get the Required Software===
 
===Where to get the Required Software===
−
It's up to you. We have had best results with installing MySQL from RPM and apache from source.
+
 
 +
Almost all of the required software can be obtained through the [http://fedora.redhat.com/docs/yum/ yum] (Fedora Core) or up2date (Red Hat Enterprise Linux) software management tools.
 +
 
 +
Fedora Core 5 also has a ''Package Manager'' tool under the ''Applications->Add/Remove Software'' menu.
 +
 
 +
Apache, MySQL, Perl and mod_perl can be installed during the installation of Fedora Core/RHEL (see [[Recommended Platforms]]).
 +
 
 +
===Apache===
 +
 
 +
FC% yum install httpd
 +
 
 +
To make Apache start automatically when the machine is rebooted:
 +
 
 +
root% /sbin/chkconfig httpd on
 +
 
 +
===MySQL===
 +
 
 +
FC% yum install mysql mysql-server
 +
 
 +
To make MySQL start automatically when the machine is rebooted:
 +
 
 +
root% /sbin/chkconfig mysqld on
 +
 
 +
===Perl===
 +
 
 +
FC% yum install perl
 +
 
 +
===mod_perl===
 +
 
 +
FC% yum install mod_perl
  
 
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.
 
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.
Line 16: Line 46:
 
* [[Installing GDOME]] (optional but recommended)
 
* [[Installing GDOME]] (optional but recommended)
  
 +
===Additonal Perl Modules===
 +
 +
===GDOME===
 +
 +
FC% yum install gdome2 gdome2-devel
  
 
==Other Tools==
 
==Other Tools==
 +
 
===File uploads===
 
===File uploads===
 
'''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.
 
'''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
+
These all come installed with most modern versions of linux. If you can get them working, you can remove the option by editing "archive_formats" in SystemSettings.pm
  
 
Tested with wget 1.6.
 
Tested with wget 1.6.
Line 28: Line 64:
  
 
===Full Text Indexing===
 
===Full Text Indexing===
 +
 +
The EPrints indexer requires various tools to extract plain (UTF-8) text from different types of document for indexing.
 +
 
The full text indexer requires various tools to index each kind of document. These tools may or may not be already installed in your system. EPrints uses these tools to build a "words" file for each document (which contains the text of the document in UTF-8). If it can't run the tool, the "words" file will be empty and EPrints will not retry creating it unless you manually remove it.
 
The full text indexer requires various tools to index each kind of document. These tools may or may not be already installed in your system. EPrints uses these tools to build a "words" file for each document (which contains the text of the document in UTF-8). If it can't run the tool, the "words" file will be empty and EPrints will not retry creating it unless you manually remove it.
  
−
; PDF : To index pdfs you need "pdftotext" which is part of the "xpdf" package. RPM's are available.
+
====PDF====
−
; ASCII : To index ASCII files you don't need anything. That's easy.
 
−
; Microsoft Word : To index MS Word files you need a package called "wvware". It can be a bit of a bit of a pain to install.
 
−
; HTML : To index HTML files you need a tool called "lynx". It's a text-based web-browser.
 
  
−
===Latex Tools===
+
Requires <tt>pdftotext</tt> which is part of the [http://www.foolabs.com/xpdf/ xpdf] package.
−
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.)
+
FC% yum install xpdf
 +
 
 +
====Microsoft Word====
 +
 
 +
Requires <tt>wvText</tt> which is part of the [http://wvware.sourceforge.net/ wvWare] package.
 +
 
 +
FC% yum install wv
 +
 
 +
====HTML====
 +
 
 +
Requires the <tt>lynx</tt> tool (a text based browser)
 +
 
 +
FC% yum install lynx
 +
 
 +
===LaTeX Tools===
 +
 
 +
There is an optional feature which allows you to instruct EPrints to look in certain fields (e.g. title and abstract) for strings that look like LaTeX equations and render them as images. These tools are only required if you want to use this feature.
 +
 
 +
<tt>latex</tt> and <tt>dvips</tt> should already be available on Fedora Core and RHEL; if not:
 +
 
 +
FC% yum install tetex-latex
 +
 
 +
<tt>convert</tt> (part of the [ ImageMagick] package) should already be available on Fedora Core and RHEL; if not:
 +
 
 +
FC% yum install ImageMagick
  
 
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.
 
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.
 +
 +
'''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.)

Revision as of 10:39, 26 April 2006

Manual Sections

What Additional Software does EPrints Require?

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.

Where to get the Required Software

Almost all of the required software can be obtained through the yum (Fedora Core) or up2date (Red Hat Enterprise Linux) software management tools.

Fedora Core 5 also has a Package Manager tool under the Applications->Add/Remove Software menu.

Apache, MySQL, Perl and mod_perl can be installed during the installation of Fedora Core/RHEL (see Recommended Platforms).

Apache

FC% yum install httpd

To make Apache start automatically when the machine is rebooted: 

root% /sbin/chkconfig httpd on

MySQL

FC% yum install mysql mysql-server

To make MySQL start automatically when the machine is rebooted: 

root% /sbin/chkconfig mysqld on

Perl

FC% yum install perl

mod_perl

FC% yum install mod_perl

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.

Additonal Perl Modules

GDOME

FC% yum install gdome2 gdome2-devel

Other Tools

File uploads

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 editing "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

Full Text Indexing

The EPrints indexer requires various tools to extract plain (UTF-8) text from different types of document for indexing.

The full text indexer requires various tools to index each kind of document. These tools may or may not be already installed in your system. EPrints uses these tools to build a "words" file for each document (which contains the text of the document in UTF-8). If it can't run the tool, the "words" file will be empty and EPrints will not retry creating it unless you manually remove it.

PDF

Requires pdftotext which is part of the xpdf package. 

FC% yum install xpdf

Microsoft Word

Requires wvText which is part of the wvWare package. 

FC% yum install wv

HTML

Requires the lynx tool (a text based browser) 

FC% yum install lynx

LaTeX Tools

There is an optional feature which allows you to instruct EPrints to look in certain fields (e.g. title and abstract) for strings that look like LaTeX equations and render them as images. These tools are only required if you want to use this feature.

latex and dvips should already be available on Fedora Core and RHEL; if not: 

FC% yum install tetex-latex

convert (part of the [ ImageMagick] package) should already be available on Fedora Core and RHEL; if not: 

FC% yum install ImageMagick

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.

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.)

Retrieved from ‘https://wiki.eprints.org/w/index.php?title=Required_software&oldid=1999’