Difference between revisions of "Required software"

From EPrints Documentation
Jump to: navigation, search
m
 
(12 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{development}}
 
 
{{manual}}
 
{{manual}}
 +
[[Category:Installation]]
  
 
==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 minimally requires Apache (with mod_perl), MySQL and Perl with some extra modules. Various utilities like wget, tar and unzip would also be useful.
  
EPrints bundles some perl modules which it uses, to save you installing them.
+
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 [http://fedora.redhat.com/docs/yum/ yum] (Fedora Core) or up2date (Red Hat Enterprise Linux) software management tools.  
+
==Where to get the Required Software==
 +
Apache, MySQL, Perl and mod_perl are  all provided as operating system level packages that can be installed on EPrints' [[Recommended Platforms]]. If you wish to install on a  platform that is not recommended, then you will need to determine the best way to install these applications. It may be possible to infer comparable packages for your platform by checking the dependencies installed on [[Installing EPrints on RHEL/Fedora/CentOS|Red Hat based]] and [[Installing EPrints on Debian/Ubuntu|Debian based]] Linux.
  
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
 
 
(move to getting started) To make Apache start automatically when the machine is rebooted:
 
 
root% /sbin/chkconfig httpd on
 
 
PLEASE NOTE: EPrints 3.0+ only supports Apache version 2, not version 1.3!
 
 
===MySQL===
 
 
FC% yum install mysql mysql-server
 
 
(move to getting started) 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
 
 
===GDOME===
 
 
FC% yum install gdome2 gdome2-devel
 
 
===Additonal Perl Modules===
 
 
The majority of perl modules need by EPrints are already installed on Fedora Core/RHEL.
 
 
Install Unicode::String:
 
 
% yum install perl-Unicode-String
 
 
Install XML::GDOME from source:
 
 
% wget http://cpan.uwinnipeg.ca/cpan/authors/id/T/TJ/TJMATHER/XML-GDOME-0.86.tar.gz
 
% tar xzvf XML-GDOME-0.86.tar.gz
 
% cd XML-GDOME-0.86/
 
% perl Makefile.PL
 
% make
 
% make install
 
 
Note: Fedora Core 5 needs 2 extra perl modules for XML::GDOME:
 
 
% yum install perl-XML-SAX perl-XML-LibXML-Common
 
  
 
==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't get them working, you can remove the option by editing "archive_formats" in SystemSettings.pm
+
These all come installed with most modern versions of linux. If you cannot 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
 
If there are problems you may need to tweak how these are invoked in SystemSettings.pm
  
===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 EPrints indexer requires various tools to extract plain (UTF-8) text from different types of document for indexing.
  
Line 86: Line 29:
  
 
====PDF====
 
====PDF====
 
+
Full text indexing PDF documents requires <tt>pdftotext</tt> application provided by the '''poppler-utils''' Deb or RPM package.
Requires <tt>pdftotext</tt> which is part of the [http://www.foolabs.com/xpdf/ xpdf] package.
+
 
+
FC% yum install xpdf
+
  
 
====Microsoft Word====
 
====Microsoft Word====
 
+
Full test indexing of Microsoft Word documents is provided by the <tt>antiword</tt> Deb or RPM package.  The RPM package is available through the [https://forensics.cert.org/cert-forensics-tools-release-el7.rpm forensics] RPM repository/
Requires <tt>wvText</tt> which is part of the [http://wvware.sourceforge.net/ wvWare] package.
+
 
+
FC% yum install wv
+
  
 
====HTML====
 
====HTML====
 +
Full test indexing of HTML documents requires the <tt>lynx</tt> text-based browser provided by the '''lynx'' Deb or RPM package.
  
Requires the <tt>lynx</tt> tool (a text based browser)
 
 
FC% yum install lynx
 
  
 
===LaTeX Tools===
 
===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.
 
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:
+
These are provided by the ''tetex-latex'' and ''ImageMagick'' RPMs or the ''texlive-base'', ''texlive-bin'' and ''imagemagick'' Deb packages.
  
FC% yum install tetex-latex
+
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.
  
<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.
 
  
 
==Other Platforms==
 
==Other Platforms==
 
+
Often the best way to find certain packages of other platforms is to use a search engine to look for the package name for Red Hat or Ubuntu Linux along with the name of your platform. (E.g. antiword Arch Linux).  If you platform does not have comparable packages, then the next best option is to download the software tool is the official site.  Below are links to the download pages for the essential components of EPrints:
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.
+
* [https://httpd.apache.org/download.cgi Apache]
 
+
* [https://dev.mysql.com/downloads/ MySQL] (or [https://downloads.mariadb.org/ MariaDB])
* [[Installing MySQL]]
+
* [https://www.perl.org/get.html Perl]
* [[Installing mod_perl]]
+
* [https://perl.apache.org/download/ mod_perl]
* [[Installing Perl modules]]
+
* [[Installing GDOME]] (optional but recommended)
+

Latest revision as of 13:01, 8 September 2017

Manual Sections

What Additional Software does EPrints Require?

In brief, EPrints minimally requires Apache (with mod_perl), MySQL and Perl with some extra modules. Various utilities like wget, tar and unzip would also be useful.

EPrints bundles some Perl modules which it uses, to save you installing them.


Where to get the Required Software

Apache, MySQL, Perl and mod_perl are all provided as operating system level packages that can be installed on EPrints' Recommended Platforms. If you wish to install on a platform that is not recommended, then you will need to determine the best way to install these applications. It may be possible to infer comparable packages for your platform by checking the dependencies installed on Red Hat based and Debian based Linux.


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 cannot get them working, you can remove the option by editing "archive_formats" in SystemSettings.pm

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

Full text indexing PDF documents requires pdftotext application provided by the poppler-utils Deb or RPM package.

Microsoft Word

Full test indexing of Microsoft Word documents is provided by the antiword Deb or RPM package. The RPM package is available through the forensics RPM repository/

HTML

Full test indexing of HTML documents requires the lynx text-based browser provided by the 'lynx Deb or RPM package.


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.

These are provided by the tetex-latex and ImageMagick RPMs or the texlive-base, texlive-bin and imagemagick Deb packages.

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.


Other Platforms

Often the best way to find certain packages of other platforms is to use a search engine to look for the package name for Red Hat or Ubuntu Linux along with the name of your platform. (E.g. antiword Arch Linux). If you platform does not have comparable packages, then the next best option is to download the software tool is the official site. Below are links to the download pages for the essential components of EPrints: