Difference between revisions of "Installing EPrints on Debian/Ubuntu"

From EPrints Documentation
Jump to: navigation, search
(Setting up a Repository)
m (Upped to 3.3.16 for GitHUb checkout)
 
(33 intermediate revisions by 9 users not shown)
Line 1: Line 1:
 
[[Category:Debian and Ubuntu]]
 
[[Category:Debian and Ubuntu]]
 +
[[Category:Installation]]
  
David Tarrant has built a Debian/Ubuntu package for Eprints.
+
== Requirements ==
 +
* Ubuntu 14.04 LTS, 16.04 LTS or 18.04 LTS (non-LTS versions not recommended) or Debian 7 (Wheezy) or 8 (Jessie).
  
=APT Mirrors=
+
== Installing from EPrints 3.3.x DEB ==
 +
The latest version of EPrints 3.3 is 3.3.16.  This version can be installed as follows
  
<b>Add one of the following mirrors (2 lines) to your /etc/apt/sources.list file as the root user. Please ensure that there is only one set in the file or you may not experience the correct behaviour.</b>
+
1. As the root user create a file at /etc/apt/sources.list.d/eprints.list and add the following line:
 +
deb http://deb.eprints.org/stable ./
 +
2. Now to install EPrints and all its dependencies execute the following command, again as the root user:
 +
wget -O - http://deb.eprints.org/keyFile | apt-key add -
 +
apt-get update
 +
apt-get install eprints
  
==EPrints 3.1==
+
EPrints will now be installed at /usr/share/eprints3/.  However, you will not yet have a running archive.  Follow the [[Getting Started with EPrints 3]] instructions to set this up.  Below are some caveats for particular version of Debian and Ubuntu.
===Stable Release===
+
  
Add the following to /etc/apt/sources.list:
+
== Installing EPrints 3.3.x or 3.4.x from Source ==
  
deb http://deb.eprints.org/3.1/ stable/
+
=== Dependencies and Pre-configuration ===
deb-src http://deb.eprints.org/3.1/ source/
+
  
===Unstable Release===
+
'''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].'''
  
To install the latest '''unstable''' release add the following to /etc/apt/sources.list:
+
First, as the root user install all the dependencies for EPrints:
  
  deb http://deb.eprints.org/3.1/ unstable/
+
  apt-get install perl libncurses5 libselinux1 libsepol1 apache2 libapache2-mod-perl2 libxml-libxml-perl libunicode-string-perl \
deb-src http://deb.eprints.org/3.1/ source/
+
  libterm-readkey-perl libmime-lite-perl libmime-types-perl libdigest-sha-perl libdbd-mysql-perl libxml-parser-perl libxml2-dev \
 +
  libxml-twig-perl libarchive-any-perl libjson-perl lynx wget ghostscript xpdf antiword elinks texlive-base texlive-base-bin \
 +
  psutils imagemagick adduser tar gzip mysql-server mysql-client unzip libsearch-xapian-perl
  
===Nightly Build===
+
Next, create the eprints user
  
To install the nightly build add the following to /etc/apt/sources.list:
+
useradd eprints
  
deb http://deb.eprints.org/3.1/ nightly/
 
deb-src http://deb.eprints.org/3.1/ source/
 
  
==EPrints 3.0==
 
To install the old 3.0 branch follow the same instructions as above replacing 3.1 with 3.0 in all instances.
 
  
==EPrints 3.2 (Current Trunk Build)==
+
Next, as the eprints user copy /opt/eprints3/perl_lib/EPrints/SystemSettings.pm.tmpl to /opt/eprints3/perl_lib/EPrints/SystemSettings.pm
  
This is available as a nightly build only and offers no guarantees.
+
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.
  
To install the nightly build add the following to /etc/apt/sources.list:
+
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/apache2/envvars:
  
  deb http://deb.eprints.org/3.2/ nightly/
+
  export APACHE_RUN_USER=eprints
  deb-src http://deb.eprints.org/3.2/ source/
+
  export APACHE_RUN_GROUP=eprints
  
 +
=== Downloading and Deploying EPrints Source ===
 +
==== EPrints 3.3.x for GitHub ====
  
=Installing Eprints via apt-get=
+
apt-get install git
 +
git clone https://github.com/eprints/eprints.git /opt/eprints3
 +
cd /opt/eprints3/
 +
git checkout tags/v3.3.16
 +
chown -R eprints:eprints .
  
To install Eprints and all its dependencies execute the following (as root):
+
==== EPrints 3.4.x for GitHub ====
  
  apt-get update
+
  apt-get install git
  apt-get install eprints
+
  git clone https://github.com/eprints/eprints3.4.git /opt/eprints3
 +
cd /opt/eprints3/
 +
git checkout tags/v3.4.0
 +
chown -R eprints:eprints .
  
=Setting up a Repository=
+
==== EPrints 3.4.x from files.eprints.org ====
You should now have a working installation of eprints in /usr/share/eprints3/. Please follow the on-screen instructions to set up an eprints repository. You probably want to start with (as root):
+
  
'''For more information about setting up an EPrints repository take a look at [[Getting Started with EPrints 3]]'''
+
cd /tmp/
 +
wget https://files.eprints.org/2305/4/eprints-3.4.0.tar.gz
 +
tar -xzvf eprints-3.4.0.tar.gz
 +
 +
If you want a publications flavoured repository, then also:
  
<b>Read First: Known issues with the Debian/Ubuntu package can be found at [[Debian Known Issues]].</b>
+
wget https://files.eprints.org/2305/5/eprints-3.4.0-flavours.tar.gz
 +
tar -xzvf eprints-3.4.0-flavours.tar.gz
  
su eprints
+
Then put in the source code in place:
cd
+
./bin/epadmin create
+
logout
+
a2ensite eprints3
+
apache2ctl restart
+
  
 +
mv eprints-3.4.0 /usr/share/eprints
 +
chmod 2775 /usr/share/eprints
 +
chown -R eprints:eprints /usr/share/eprints
  
If you have any problems getting set up you can get free help and support from the EP-Tech mailing list. {{EPrintsTech}}
 
  
=Getting and Compiling from Source (not required)=
+
=== Post-configuration ===
 +
Next, add the file /etc/apache2/sites-available/eprints.conf with the following line:
  
To install dependencies and retrieve the Eprints source execute the following:
+
Include EPRINTS_PATH/cfg/apache.conf
  
  apt-get update
+
EPRINTS_PATH will be either /opt/eprints3/ or /usr/share/eprints depending on which instructions you followed above.
  apt-get build-dep eprints
+
 
  apt-get source eprints
+
To enable this as root run the command:
 +
 
 +
  a2ensite eprints
 +
 
 +
Finally, restart Apache:
 +
 
 +
apachectl 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.
 +
 
 +
== Operating System Version Specific Requirements ==
 +
 
 +
 
 +
=== Ubuntu 18.04 LTS ===
 +
==== epadmin script errors with Perl version ====
 +
When trying to run epadmin you will may see a couple of error messages that prevents you from creating an archive, especially if you are using the 3.4.0 tarball from files.eprints.org:
 +
 
 +
Experimental keys on scalar is now forbidden at EPRINTS_PATH/bin/epadmin line 384
 +
 
 +
To fix this add the following line at the top of the epadmin file just after the ''use'' lines:
 +
 
 +
no if $] >= 5.017011, warnings => 'experimental::smartmatch';
 +
 
 +
A second error message you may see is:
 +
 
 +
Type of arg 1 to keys must be hash or array (not single ref constructor) at /usr/share/eprints/bin/epadmin line 384, near "};"
 +
 
 +
Go to the line number reported and change it to:
 +
 
 +
  my @flavours = keys %{$conf->{flavours}};
 +
 
 +
You should now be able to run "epadmin create" without issue.
 +
 
 +
==== MySQL root user cannot be used ====
 +
On Ubuntu 18.04 LTS rather than prompting you to set a password for MySQL server when installing this as a dependency, it just installs it without.  However, this means on the root user can login to MySQL to add a database.  As "epadmin create" runs at the eprints user, this will not be able to create a database for EPrints.  The get round this as the root user connect to MySQL (just type "mysql" at the command line) and type the following two commands.  You will want to set your own password (i.e. not 'changeme') , you may also want to restrict which databases the eprints user has control over.  If you know the "Archive ID" you are going to use.
 +
  CREATE USER 'eprints'@'localhost' IDENTIFIED by 'changeme';
 +
GRANT ALL PRIVILEGES ON *.* TO 'eprints'@'localhost' WITH GRANT OPTION;
 +
 
 +
 
 +
=== Ubuntu 14.04 LTS and Debian 8 onwards ===
 +
This operating system versions use Apache 2.3+ and PERL v5.16+ introduce a few changes which break older 3.3.x versions EPrints.  The current versions of EPrints 3.3.16 and 3.4.0 should not suffer from the same issues.
 +
 
 +
A complete HOW-TO guide to install EPrints3 on Ubuntu 14.04 is available [http://wiki.unimas.my/unimaswiki//bin/view/HOW-TO,+Tutorial+&+User+Manual/HOW-TO+:+Install+Eprints+v3.3.12++on+Ubuntu+14.04+With+LDAP+Authentication here]
 +
 
 +
Current patches on github are:
 +
 
 +
* See last comment on https://github.com/eprints/eprints/issues/214  [ use of remote_ip ]
 +
* https://github.com/eprints/eprints/issues/237 [ NameVirtualHost deprecated ]
 +
* https://github.com/eprints/eprints/issues/236 [ Order allow,deny deprecated ]
 +
* https://github.com/eprints/eprints/commit/157db0d27d423d38f9c0fc31ce47e519cd861d45 [ utf8::decode and URI parameters ]
 +
 
 +
Ensure that mpm_prefork module is enabled in /etc/apache2/mods-enabled (among others).
 +
 
 +
Complete list of modules for a working repository include the following (although some may be surplus to requirements e.g. php5 is not strictly necessary)
  
The source will be saved to a tarball in the current directory.
+
*access_compat.load                   
 +
*alias.conf                                   
 +
*alias.load                             
 +
*auth_basic.load                           
 +
*authn_core.load
 +
*authn_file.load
 +
*authz_core.load
 +
*authz_host.load
 +
*authz_user.load
 +
*autoindex.conf
 +
*autoindex.load
 +
*deflate.conf
 +
*deflate.load
 +
*dir.conf
 +
*dir.load
 +
*env.load
 +
*filter.load
 +
*mime.conf
 +
*mime.load
 +
*mpm_prefork.conf
 +
*mpm_prefork.load
 +
*negotiation.conf
 +
*negotiation.load
 +
*perl.load
 +
*php5.conf
 +
*php5.load
 +
*setenvif.conf
 +
*setenvif.load
 +
*status.conf
 +
*status.load

Latest revision as of 08:46, 11 September 2018


Requirements

  • Ubuntu 14.04 LTS, 16.04 LTS or 18.04 LTS (non-LTS versions not recommended) or Debian 7 (Wheezy) or 8 (Jessie).

Installing from EPrints 3.3.x DEB

The latest version of EPrints 3.3 is 3.3.16. This version can be installed as follows

1. As the root user create a file at /etc/apt/sources.list.d/eprints.list and add the following line:

deb http://deb.eprints.org/stable ./

2. Now to install EPrints and all its dependencies execute the following command, again as the root user:

wget -O - http://deb.eprints.org/keyFile | apt-key add -
apt-get update
apt-get install eprints

EPrints will now be installed at /usr/share/eprints3/. However, you will not yet have a running archive. Follow the Getting Started with EPrints 3 instructions to set this up. Below are some caveats for particular version of Debian and Ubuntu.

Installing EPrints 3.3.x or 3.4.x from Source

Dependencies and Pre-configuration

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, as the root user install all the dependencies for EPrints:

apt-get install perl libncurses5 libselinux1 libsepol1 apache2 libapache2-mod-perl2 libxml-libxml-perl libunicode-string-perl \
  libterm-readkey-perl libmime-lite-perl libmime-types-perl libdigest-sha-perl libdbd-mysql-perl libxml-parser-perl libxml2-dev \
  libxml-twig-perl libarchive-any-perl libjson-perl lynx wget ghostscript xpdf antiword elinks texlive-base texlive-base-bin \
  psutils imagemagick adduser tar gzip mysql-server mysql-client unzip libsearch-xapian-perl

Next, create the eprints user

useradd 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/apache2/envvars:

export APACHE_RUN_USER=eprints
export APACHE_RUN_GROUP=eprints

Downloading and Deploying EPrints Source

EPrints 3.3.x for GitHub

apt-get install git
git clone https://github.com/eprints/eprints.git /opt/eprints3
cd /opt/eprints3/
git checkout tags/v3.3.16
chown -R eprints:eprints .

EPrints 3.4.x for GitHub

apt-get install git
git clone https://github.com/eprints/eprints3.4.git /opt/eprints3
cd /opt/eprints3/
git checkout tags/v3.4.0
chown -R eprints:eprints .

EPrints 3.4.x from files.eprints.org

cd /tmp/
wget https://files.eprints.org/2305/4/eprints-3.4.0.tar.gz
tar -xzvf eprints-3.4.0.tar.gz

If you want a publications flavoured repository, then also:

wget https://files.eprints.org/2305/5/eprints-3.4.0-flavours.tar.gz
tar -xzvf eprints-3.4.0-flavours.tar.gz

Then put in the source code in place:

mv eprints-3.4.0 /usr/share/eprints
chmod 2775 /usr/share/eprints
chown -R eprints:eprints /usr/share/eprints


Post-configuration

Next, add the file /etc/apache2/sites-available/eprints.conf with the following line:

Include EPRINTS_PATH/cfg/apache.conf

EPRINTS_PATH will be either /opt/eprints3/ or /usr/share/eprints depending on which instructions you followed above.

To enable this as root run the command:

a2ensite eprints

Finally, restart Apache:

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

Operating System Version Specific Requirements

Ubuntu 18.04 LTS

epadmin script errors with Perl version

When trying to run epadmin you will may see a couple of error messages that prevents you from creating an archive, especially if you are using the 3.4.0 tarball from files.eprints.org:

Experimental keys on scalar is now forbidden at EPRINTS_PATH/bin/epadmin line 384

To fix this add the following line at the top of the epadmin file just after the use lines:

no if $] >= 5.017011, warnings => 'experimental::smartmatch';

A second error message you may see is:

Type of arg 1 to keys must be hash or array (not single ref constructor) at /usr/share/eprints/bin/epadmin line 384, near "};"

Go to the line number reported and change it to:

my @flavours = keys %{$conf->{flavours}};

You should now be able to run "epadmin create" without issue.

MySQL root user cannot be used

On Ubuntu 18.04 LTS rather than prompting you to set a password for MySQL server when installing this as a dependency, it just installs it without. However, this means on the root user can login to MySQL to add a database. As "epadmin create" runs at the eprints user, this will not be able to create a database for EPrints. The get round this as the root user connect to MySQL (just type "mysql" at the command line) and type the following two commands. You will want to set your own password (i.e. not 'changeme') , you may also want to restrict which databases the eprints user has control over. If you know the "Archive ID" you are going to use.

CREATE USER 'eprints'@'localhost' IDENTIFIED by 'changeme';
GRANT ALL PRIVILEGES ON *.* TO 'eprints'@'localhost' WITH GRANT OPTION;


Ubuntu 14.04 LTS and Debian 8 onwards

This operating system versions use Apache 2.3+ and PERL v5.16+ introduce a few changes which break older 3.3.x versions EPrints. The current versions of EPrints 3.3.16 and 3.4.0 should not suffer from the same issues.

A complete HOW-TO guide to install EPrints3 on Ubuntu 14.04 is available here

Current patches on github are:

Ensure that mpm_prefork module is enabled in /etc/apache2/mods-enabled (among others).

Complete list of modules for a working repository include the following (although some may be surplus to requirements e.g. php5 is not strictly necessary)

  • access_compat.load
  • alias.conf
  • alias.load
  • auth_basic.load
  • authn_core.load
  • authn_file.load
  • authz_core.load
  • authz_host.load
  • authz_user.load
  • autoindex.conf
  • autoindex.load
  • deflate.conf
  • deflate.load
  • dir.conf
  • dir.load
  • env.load
  • filter.load
  • mime.conf
  • mime.load
  • mpm_prefork.conf
  • mpm_prefork.load
  • negotiation.conf
  • negotiation.load
  • perl.load
  • php5.conf
  • php5.load
  • setenvif.conf
  • setenvif.load
  • status.conf
  • status.load