Difference between revisions of "Installing EPrints on RHEL/Fedora/CentOS"

From EPrints Documentation
Jump to: navigation, search
m (add section on putting apache in eprints group)
(Installing from EPrints 3.3.x RPM: Clarification on rpm versions available from rpm.eprints.org)
(18 intermediate revisions by 3 users not shown)
Line 12: Line 12:
  
 
== Installing from EPrints 3.3.x RPM ==
 
== Installing from EPrints 3.3.x RPM ==
 +
 +
'''Please note that rpm.eprints.org is no longer fully supported.  The below instructions should still work for installing EPrints up to v3.3.15 on RHEL/CentOS 6 and 7 and comparable versions of Fedora.'''
 +
 +
'''The latest releases (3.3.16+) are not available from rpm.eprints.org, but can be downloaded as an RPM from http://files.eprints.org/'''
  
 
Add the rpm.eprints.org repository key:
 
Add the rpm.eprints.org repository key:
Line 20: Line 24:
  
 
  rpm -ivh http://rpm.eprints.org/eprints/noarch/rpm-eprints-org-1-1.noarch.rpm
 
  rpm -ivh http://rpm.eprints.org/eprints/noarch/rpm-eprints-org-1-1.noarch.rpm
 +
 +
Note: if these fail to connect to the repository and you have a proxy server, try adding the parameter "--httpproxy http://your.proxy.address" (export http_proxy doesn't affect rpm call)
  
 
Install required XML libraries (Use ''yum upgrade'' if these are already installed):
 
Install required XML libraries (Use ''yum upgrade'' if these are already installed):
Line 27: Line 33:
 
Finally, install EPrints 3:
 
Finally, install EPrints 3:
  
  yum install eprints  
+
  yum install eprints
 
 
=== Other Non-critical Dependencies ===
 
Some of EPrints non-core functionality may not work out of the box as these dependencies are not included as part of the RPM.  Here is a list of known additional packages (and the YUM repositories in which they can be found) or CPAN modules than can be installed. 
 
 
 
Some of these known additional packages are only available through the Extra Packages for Enterprise Linux (EPEL) YUM repository, which can be installed as the root user as follows:
 
 
 
yum -y install epel-release
 
yum repolist
 
 
 
CPAN modules should be installed using the ''cpan'' command as the root user.
 
 
* '''perl-Geo-IP (epel)''' - Allows IRstats2 to determine the location of views/downloads for publications.]
 
* '''perl-Spreadsheet-WriteExcel (epel)''' - To allow Multiline Excel export.
 
* '''CPAN module Text::Refer''' - Required for EndNote import.
 
* '''perl-Image-ExifTool (epel)''' - Sometimes needed to support generation of thumbnails for uploaded documents/images.
 
* '''perl-LWP-Protocol-https (base)''' - Needed by DataCite plugin to register repository DOIs.
 
  
== Installing EPrints 3.3.x from Source ==
+
== Installing EPrints 3.4.x from Source ==
'''N.B. Installing from source is generally discouraged particularly for production repositories.  However, if want to develop the EPrints code or a plugin or Bazaar package it may be useful to install from source, ideally from [https://github.com/eprints/eprints EPrints Core Git repository].'''
+
'''N.B. Installing from source is generally discouraged particularly for production repositories.  However, if want to develop the EPrints code or a plugin or Bazaar package it may be useful to install from source, ideally from [https://github.com/eprints/eprints3.4 EPrints Core Git repository].'''
  
 
First, install the EPEL YUM package repository and run yum repolist to ensure the GPG key is installed:
 
First, install the EPEL YUM package repository and run yum repolist to ensure the GPG key is installed:
Line 55: Line 45:
 
Now, install all the dependencies that would be installed through the eprints RPM.
 
Now, install all the dependencies that would be installed through the eprints RPM.
  
  yum install libxml2 libxslt httpd mod_perl perl-DBI perl-DBD-MySQL perl-IO-Socket-SSL perl-Time-HiRes perl-CGI \
+
  yum install libxml2 libxslt httpd mod_perl perl-DBI perl-DBD-MySQL perl-IO-Socket-SSL perl-Time-HiRes \
    perl-Digest-MD5 perl-Digest-SHA perl-XML-LibXML perl-XML-LibXSLT perl-XML-SAX perl-MIME-Lite tetex-latex wget \
+
    perl-CGI perl-Digest-MD5 perl-Digest-SHA perl-JSON perl-XML-LibXML perl-XML-LibXSLT perl-XML-SAX \
    gzip tar ImageMagick unzip elinks poppler-utils chkconfig
+
    perl-MIME-Lite perl-Text-Unidecode perl-JSON perl-Unicode-Collate perl-Pod-LaTeX perl-LWP-Protocol-https \
 +
    tetex-latex wget gzip tar ImageMagick elinks poppler-utils chkconfig unzip cpan
  
 
Next, create the eprints user
 
Next, create the eprints user
Line 68: Line 59:
 
  git clone https://github.com/eprints/eprints.git /opt/eprints3
 
  git clone https://github.com/eprints/eprints.git /opt/eprints3
 
  cd /opt/eprints3/
 
  cd /opt/eprints3/
  git checkout tags/v3.3.15
+
  git checkout tags/v3.4.1
 
  chown -R eprints:eprints .  
 
  chown -R eprints:eprints .  
  
Line 90: Line 81:
 
   service httpd restart
 
   service httpd restart
  
You should now be able to access your vanilla repository at the hostname you specified when running '''epadmin create''' from the [[Getting Started with EPrints 3]] instructions.
+
You should now be able to access your vanilla repository at the hostname you specified when running '''epadmin create''' from the [[Getting Started with EPrints 3]] instructions.  You should then login as the admin user you created during this process and turn on the indexer.  This can be done by clicking on the '''Admin''' link under the Logged in menu, then clicking on the '''System Tools''' tab and finally the '''Start Indexer''' button.
  
== Next steps ==
+
== Non-critical Dependencies ==
 +
Some of EPrints non-core functionality may not work out of the box as these dependencies are not included as part of the RPM.  Here is a list of known additional packages (and the YUM repositories in which they can be found) or CPAN modules than can be installed. 
  
Configure eprints per [[Getting_Started_with_EPrints_3]].
+
Some of these known additional packages are only available through the Extra Packages for Enterprise Linux (EPEL) YUM repository, which can be installed as the root user as follows:
  
 +
yum -y install epel-release
 +
yum repolist
  
== Troubleshooting ==
+
CPAN modules should be installed using the ''cpan'' command as the root user.
 +
 +
* '''perl-Geo-IP (epel)''' - Allows IRstats2 to determine the location of views/downloads for publications.]
 +
* '''perl-Spreadsheet-WriteExcel (epel)''' - To allow Multiline Excel export.
 +
* '''CPAN module Text::Refer''' - Required for EndNote import.
 +
* '''CPAN module TeX::Encode''' Required for BibTex export.
 +
* '''perl-Image-ExifTool (epel)''' - Sometimes needed to support generation of thumbnails for uploaded documents/images.
 +
* '''perl-LWP-Protocol-https (base)''' - Needed by DataCite plugin to register repository DOIs.
  
=== Starting database and webserver at boot ===
+
== Next steps ==
As with any database-backed web application, if you have not already done so you should ensure the database and webserver start up automatically after booting.  For Redhat  and Fedora use the following commands as root:
 
  
chkconfig httpd on
+
Configure eprints per [[Getting_Started_with_EPrints_3]].
chkconfig mysqld on
 
  
For CentOS it will instead be:
+
== Operating System Version Specific Requirements ==
  
chkconfig httpd on
+
=== RHEL / CentOS 6 ===
chkconfig mariadb on
+
{{:Issues with installing EPrints on RHEL 6}}
  
 +
=== RHEL / CentOS 7 ===
 +
No significant issues.
  
=== Failed to parse XML file ===
+
=== RHEL / CentOS 8 ===
When installing EPrints on RHEL6 (may apply to other versions), If you get the error:
+
{{:Issues with installing EPrints on RHEL 8}}
Failed to parse XML file:
 
/usr/share/eprints/lib/lang/en/phrases/system.xml: Entity: line 396: parser error : Entity 'nbsp' not defined age or title page. If there are more...
 
  
Run
+
== Troubleshooting ==
sed -i 's/'''&'''nbsp;/ /g' /usr/share/eprints/lib/lang/en/phrases/system.xml
+
* [[EPrints and SELinux|Advice for enabling SELinux with EPrints]]
 
 
then navigate to the root of your EPrints install (/opt/eprints or /usr/share/eprints) and run
 
bin/generate_views *repository_id*
 
bin/epadmin reload *repository_id*
 
 
 
 
 
=== Upgrade from previous 3.3 ===
 
After a upgrading from previous 3.3, your existing repository's database may need updating.
 
bin/epadmin update [archive_id]
 
 
 
 
 
=== Apache in eprints group ===
 
 
 
If you choose not to run apache as the eprints user (for example you have another application on the same server) you will need to change https's groups and update the permissions on some directories
 
 
 
Add apache to eprints's group.
 
usermod apache -G eprints
 
 
 
One way to run httpd as 'apache' but still access eprints files is to add httpd to the eprints group.
 
chmod 770 /usr/share/eprints/var
 
chmod 770 /usr/share/eprints/lib/epm/
 
 
 
 
 
=== Using SELinux ===
 
If you're using SELinux on your server you will need to give Apache read/write access to the documents directory for all repositories you create and the eprints var folder (indexer log, ticker files):
 
 
 
chcon -R -h -t httpd_sys_script_rw_t [eprintspath]/archives/[repoid]/documents/
 
chcon -R -h -t httpd_sys_script_rw_t [eprintspath]/var/
 
chcon -R -h -t httpd_sys_script_rw_t /usr/share/eprints/lib/
 
 
 
You may also need to tell SELinux to allow Apache to talk on the network, if you intend to run your database on a separate server.
 
 
 
setsebool -P httpd_can_network_connect=1
 
 
 
=== Using firewalld ===
 
Typically RHEL/Fedora/CentOS run a firewall that will block remote connections to you webserver.  To overcome this run the following commands as root:
 
 
 
firewall-cmd --permanent --add-service=http
 
service firewalld restart
 
 
 
You will need to same https if you intend to set that up as well.  Otherwise, you can just disable the firewall altogether if you have an institutional level firewall:
 
 
 
service firewalld stop
 
chkconfig firewalld off
 

Revision as of 14:46, 10 June 2020


Requirements

  • RedHat Enterprise (RHEL) / CentOS 7 or Fedora 25+. These instructions will more than likely work for RHEL / CentOS 6 but have not been as thoroughly tested.
  • Pre-installed MySQL server and client.
    • RHEL / Fedora:
yum install mysql-server mysql
    • CentOS:
yum install mariadb-server mariadb

Installing from EPrints 3.3.x RPM

Please note that rpm.eprints.org is no longer fully supported. The below instructions should still work for installing EPrints up to v3.3.15 on RHEL/CentOS 6 and 7 and comparable versions of Fedora.

The latest releases (3.3.16+) are not available from rpm.eprints.org, but can be downloaded as an RPM from http://files.eprints.org/

Add the rpm.eprints.org repository key:

rpm -ivh http://rpm.eprints.org/rpm-eprints-org-key-1-1.noarch.rpm

Next, add the rpm.eprints.org EPrints repository:

rpm -ivh http://rpm.eprints.org/eprints/noarch/rpm-eprints-org-1-1.noarch.rpm

Note: if these fail to connect to the repository and you have a proxy server, try adding the parameter "--httpproxy http://your.proxy.address" (export http_proxy doesn't affect rpm call)

Install required XML libraries (Use yum upgrade if these are already installed):

yum install libxml2 libxslt perl-XML-LibXML perl-XML-LibXSLT

Finally, install EPrints 3:

yum install eprints

Installing EPrints 3.4.x from Source

N.B. Installing from source is generally discouraged particularly for production repositories. However, if want to develop the EPrints code or a plugin or Bazaar package it may be useful to install from source, ideally from EPrints Core Git repository.

First, install the EPEL YUM package repository and run yum repolist to ensure the GPG key is installed:

yum install epel-release
yum repolist

Now, install all the dependencies that would be installed through the eprints RPM.

yum install libxml2 libxslt httpd mod_perl perl-DBI perl-DBD-MySQL perl-IO-Socket-SSL perl-Time-HiRes \
    perl-CGI perl-Digest-MD5 perl-Digest-SHA perl-JSON perl-XML-LibXML perl-XML-LibXSLT perl-XML-SAX \
    perl-MIME-Lite perl-Text-Unidecode perl-JSON perl-Unicode-Collate perl-Pod-LaTeX perl-LWP-Protocol-https \ 
    tetex-latex wget gzip tar ImageMagick elinks poppler-utils chkconfig unzip cpan

Next, create the eprints user

adduser eprints

Next, clone the Git repository from GitHub to /opt/ and set the eprints user as the owner. It is probably best to checkout the latest release rather than using HEAD, which may have known issues:

yum install git
git clone https://github.com/eprints/eprints.git /opt/eprints3
cd /opt/eprints3/
git checkout tags/v3.4.1
chown -R eprints:eprints . 

Next, as the eprints user copy /opt/eprints3/perl_lib/EPrints/SystemSettings.pm.tmpl to /opt/eprints3/perl_lib/Eprints/SystemSettings.pm

EPrints is now fully installed at /opt/eprints3. However, you will not yet have a running archive. Follow the Getting Started with EPrints 3 instructions to set this up.

Now update Apache configuration to set it up to use the eprints user and group, by ensuring the following lines are set thus in /etc/httpd/conf/httpd.conf:

User  eprints
Group eprints

Now add the file /etc/httpd/conf.d/eprints.conf with the following line:

Include /opt/eprints3/cfg/apache.conf

There is a good chance your operating system will have SELinux enabled. If so, follow the instructions under Troubleshooting for how to let EPrints do what it needs to do through SELinux.

Finally, restart Apache:

 service httpd restart

You should now be able to access your vanilla repository at the hostname you specified when running epadmin create from the Getting Started with EPrints 3 instructions. You should then login as the admin user you created during this process and turn on the indexer. This can be done by clicking on the Admin link under the Logged in menu, then clicking on the System Tools tab and finally the Start Indexer button.

Non-critical Dependencies

Some of EPrints non-core functionality may not work out of the box as these dependencies are not included as part of the RPM. Here is a list of known additional packages (and the YUM repositories in which they can be found) or CPAN modules than can be installed.

Some of these known additional packages are only available through the Extra Packages for Enterprise Linux (EPEL) YUM repository, which can be installed as the root user as follows:

yum -y install epel-release
yum repolist 

CPAN modules should be installed using the cpan command as the root user.

  • perl-Geo-IP (epel) - Allows IRstats2 to determine the location of views/downloads for publications.]
  • perl-Spreadsheet-WriteExcel (epel) - To allow Multiline Excel export.
  • CPAN module Text::Refer - Required for EndNote import.
  • CPAN module TeX::Encode Required for BibTex export.
  • perl-Image-ExifTool (epel) - Sometimes needed to support generation of thumbnails for uploaded documents/images.
  • perl-LWP-Protocol-https (base) - Needed by DataCite plugin to register repository DOIs.

Next steps

Configure eprints per Getting_Started_with_EPrints_3.

Operating System Version Specific Requirements

RHEL / CentOS 6

Issues when following Installing_EPrints_on_RHEL/Fedora/CentOS#Installing_from_EPrints_3.3.x_RPM.

Error installing eprints:

--> Processing Dependency: perl(Apache::DBI) for package: eprints-3.3.15-1.el6.noarch
--> Finished Dependency Resolution
Error: Package: eprints-3.3.15-1.el6.noarch (rpm-eprints-org)
           Requires: perl(Apache::DBI)
 You could try using --skip-broken to work around the problem
 You could try running: rpm -Va --nofiles --nodigest

Solution is a missing package from EPEL. Add EPEL to yums configuration then installing the missing package.

yum install epel-release
yum install perl-Apache-DBI

RHEL / CentOS 7

No significant issues.

RHEL / CentOS 8

elinks package is no longer available

The RPM package elinks is no longer available in RHEL / CentOS / Rocky 8 even with EPEL package repository. elinks is only needed if are intending to upload web pages or XML files and these need to be indexed by EPrints, so if installing from source use the following DNF command line:

dnf install libxml2 libxslt httpd mod_perl perl-DBI perl-DBD-MySQL perl-IO-Socket-SSL perl-Time-HiRes \
   perl-CGI perl-Digest-MD5 perl-Digest-SHA perl-JSON perl-XML-LibXML perl-XML-LibXSLT perl-XML-SAX \
   perl-MIME-Lite perl-Text-Unidecode perl-JSON perl-Unicode-Collate perl-Pod-LaTeX tetex-latex wget \
   gzip tar ImageMagick poppler-utils chkconfig unzip cpan

Alternatively, for RHEL 8 you can enable the codeready-builder repository, which still has elinks available:

subscription-manager repos --enable "codeready-builder-for-rhel-8-$(arch)-rpms"

If you are running CentOS 8 (or Rocky 8) you can similarly enable the powertools repository:

dnf config-manager --set-enabled powertools

perl-IO-String package is no longer available

The RPM package perl-IO-String is no longer available in RHEL / CentOS / Rocky 8 even with EPEL package repository. You can enable the codeready-builder repository, which still has perl-IO-String available:

subscription-manager repos --enable "codeready-builder-for-rhel-8-$(arch)-rpms"

If you are running CentOS 8 (or Rocky 8) you can similarly enable the powertools repository:

dnf config-manager --set-enabled powertools

Sub-dependency packages perl-MIME-Types and perl-Digest-SHA1 are no longer available

perl-MIME-Lite package requires perl-MIME-Types package and perl-Apache-DBI requires perl-Digest-SHA1 package neither of which available on RHEL / CentOS / Rocky 8, even with EPEL repository enabled. You can enable the codeready-builder repository, which still has these packahes available:

subscription-manager repos --enable "codeready-builder-for-rhel-8-$(arch)-rpms"

If you are running CentOS 8 (or Rocky 8) you can similarly enable the powertools repository:

dnf config-manager --set-enabled powertools

Compatibility issues with XML::LibXSLT

Installing XML::LibXSLT either through the perl-XML-LibXSLT RPM or CPAN causes httpd to generate a segmentation fault when you try to start it. The most straightfarward solution to this is to run httpd in mpm-prefork rather than mpm-event mode. This can be acheived by editing /etc/httpd/conf.modules.d/00-mpm.conf and commenting out the following line:

LoadModule mpm_event_module modules/mod_mpm_event.so

and uncommenting the mpm-prefork line:

LoadModule mpm_prefork_module modules/mod_mpm_prefork.so

The alternative solution is to make sure that XML::LibXSLT is not installed through the perl-XML-LibXSLT RPM or CPAN. EPrints will still run without this but you will not be able to use XSLT-based import plugins. Unless you have installed any additional import plugins, the only ones affected are Atom XML and OpenXML Bibliography.

Troubleshooting