Difference between revisions of "Required software"

From EPrints Documentation
Jump to: navigation, search
(links added, formatting harmonized)
 
(20 intermediate revisions by 11 users not shown)
Line 1: Line 1:
 
{{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.
 
  
EPrints bundles some perl modules which it uses, to save you installing them.
+
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.
  
===Where to get the Required Software===
+
EPrints bundles some [https://github.com/eprints/eprints3.4/blob/master/cpan_modules.pl 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.
 
  
* [[Installing MySQL]]
+
==Where to get the Required Software==
* [[Installing mod_perl]]
+
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.
* [[Installing Perl modules]]
 
  
  
==Optional GDOME support==
+
==Other Tools==
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
 
  
===Addional Libraries Required for GDOME support===
+
===File uploads===
 +
<tt>wget</tt>, <tt>tar</tt>, <tt>gunzip</tt> and <tt>unzip</tt> are required to allow users to upload files as <tt>.tar.gz</tt> or <tt>.zip</tt> or to capture them from a URL.
  
<code>
+
These all come installed with most modern versions of linux. If you cannot get them working, you can remove the relevant option by editing "archive_formats" in <tt>SystemSettings.pm</tt>
libxml2
 
libxml2-devel
 
</code>
 
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):
+
If there are problems you may need to tweak how these are invoked in <tt>SystemSettings.pm</tt>.
  
  
<code>
+
===Full Text Indexing===
http://rpmfind.net/linux/rpm2html/search.php?query=libxml2
+
The EPrints indexer requires various tools to extract plain (UTF-8) text from different types of document for indexing.
http://rpmfind.net/linux/rpm2html/search.php?query=libxml2-devel
 
</code>
 
===The GDOME Library===
 
Obtain this from
 
  
 +
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.
  
<code>
+
====PDF====
http://gdome2.cs.unibo.it/#downloads
+
Full text indexing PDF documents requires <tt>pdftotext</tt> application provided by the ''poppler-utils'' Deb or RPM package.
</code>
 
You may either use the RPMs (gdome2 and gdome2-devel) or the tarball.
 
  
===Additional Perl Modules Required for GDOME support===
+
====Microsoft Word====
 +
Full text indexing of Microsoft Word documents is provided by the ''antiword'' Deb or RPM package.  The RPM package is available through the [https://forensics.cert.org/cert-forensics-tools-release-el7.rpm forensics] RPM repository.
  
<code>
+
====HTML====
XML-LibXML-Common
+
Full test indexing of HTML documents requires the <tt>lynx</tt> text-based browser provided by the ''lynx'' Deb or RPM package.
XML-NamespaceSupport
 
XML-GDOME
 
</code>
 
All of which are in http://www.cpan.org/modules/by-module/XML/
 
  
==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 edditing "archive_formats" in SystemSettings.pm
+
===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.
  
Tested with wget 1.6.
+
These are provided by the ''tetex-latex'' and ''ImageMagick'' RPMs or the ''texlive-base'', ''texlive-bin'' and ''imagemagick'' Deb packages.
  
If there are problems you may need to tweak how these are invoked in SystemSettings.pm
+
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.
  
===Full Text 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 : To index pdfs you need "pdftotext" which is part of the "xpdf" package. RPM's are available.
 
; 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===
 
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.)
+
==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:
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.
+
* [https://httpd.apache.org/download.cgi Apache]
 +
* [https://dev.mysql.com/downloads/ MySQL] (or [https://downloads.mariadb.org/ MariaDB]) as well as [https://www.postgresql.org/download/ PostgreSQL] and even [https://www.oracle.com/de/downloads/ ORACLE]
 +
* [https://www.perl.org/get.html Perl]
 +
* [https://perl.apache.org/download/ mod_perl]

Latest revision as of 11:53, 19 February 2024

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 capture them from a URL.

These all come installed with most modern versions of linux. If you cannot get them working, you can remove the relevant 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 text 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: