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

From EPrints Documentation
Jump to: navigation, search
m
(Amended warning, do not install from tarball source)
 
(23 intermediate revisions by the same user not shown)
Line 3: Line 3:
  
 
== Requirements ==
 
== Requirements ==
* Ubuntu 14.04 LTS or 16.04 LTS (non-LTS versions not recommended) or Debian 7 (Wheezy) or 8 (Jessie).
+
* Ubuntu 16.04 LTS or 18.04 LTS (non-LTS versions not recommended) or Debian 8 (Jessie) or 9 (Stretch).
  
== Installing from EPrints 3.3.x DEB ==
+
== Installing from DEB ==
 
+
1. As the root user create a file at /etc/apt/sources.list.d/eprints.list.
=== For Ubuntu 14.04 and Debian 7.0 ===
+
* The latest version of EPrints 3.3 is 3.3.16.  To install add the following line to eprints.list:
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 ./
 
+
* The latest version of EPrints 3.4 is 3.4.1.  To install add the following line to eprints.list:
  deb http://deb.eprints.org/ stable/
+
deb http://deb.eprints-hosting.org/stable/3.4 ./
 
+
Now to install EPrints and all its dependencies execute the following command, again as the root user:
+
  
 +
2. Now to install EPrints and all its dependencies execute the following command, again as the root user (the keyFile on deb.eprints.org and deb.eprints-hosting.org):
 +
wget -O - http://deb.eprints.org/keyFile | apt-key add -
 
  apt-get update
 
  apt-get update
 
  apt-get install eprints
 
  apt-get install eprints
  
At present the latest Deb for EPrints (3.3.15) is not signed, therefore you will not to accept that it is unauthenticatedThe next Deb package release of EPrints (3.3.16) should be signed.
+
EPrints 3.3 will be installed to /usr/share/eprints3/. EPrints 3.4 will be installed to /usr/share/eprints/.  However, you will not yet have a running archiveFollow the [[Getting Started with EPrints 3]] instructions to set this up. Below are some caveats for particular version of Debian and Ubuntu.
  
EPrints will now be installed at /usr/share/eprints3However, you will not yet have a running archive.  Follow the [[Getting Started with EPrints 3]] instructions to set this up.
+
'''N.B. If you are installing EPrints 3.4 from the DEB package then you will only get the zero flavour.  If you want the publications flavour you will need to download the [https://files.eprints.org/2401/8/eprints-3.4.1-flavours.tar.gz flavours tarball] (see "Downloading and Deploying EPrints Source" below) and copy the ''pub_lib'' subdirectory into /usr/share/eprints/flavours/It is planned that future versions of EPrints 3.4 will have their own publication flavours DEB package.'''
  
=== For Ubuntu 16.04 and Debian 8 ===
+
== Installing EPrints from Source ==
The current Debian package (Deb) for EPrints 3.3.15 will not install on Ubuntu 16.04 and Debian 8 due to unmet dependencies, as certain other Deb packages have been removed between versions.  The Deb for the next version of EPrints (3.3.16) will have amended dependencies, so the same method for Ubuntu 14.04 and Debian 7.0 can be used.  ([[Issues with Installing EPrints on Ubuntu 16.04|See here for more details]]).
+
  
Instead of setting up the deb.eprints.org package repository download this [http://files.eprints.org/1712/1/eprints_3.3.15_all-xenial.deb modified version of the 3.3.15 Deb package] and run the following command as root from the same directory as you downloaded it:
+
=== Dependencies and Pre-configuration ===
  
  apt-get install ./eprints_3.3.15_all-xenial.deb
+
'''N.B. Installing from a source tarball 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 3.3] or [https://github.com/eprints/eprints3.4 EPrints 3.4] Core Git repositories.'''
  
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.
+
First, as the root user install all the dependencies for EPrints:
 
+
 
+
== Installing EPrints 3.3.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].'''
+
 
+
First, as theroot users install all the dependencies for EPrints:
+
  
 
  apt-get install perl libncurses5 libselinux1 libsepol1 apache2 libapache2-mod-perl2 libxml-libxml-perl libunicode-string-perl \
 
  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 \
 
   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 pdftk texlive-base texlive-base-bin \
+
   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
+
   psutils imagemagick adduser tar gzip mysql-server mysql-client unzip libsearch-xapian-perl libtex-encode-perl
  
 
Next, create the eprints user
 
Next, create the eprints user
  
  useradd eprints
+
  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:
 
 
apt-get install git
 
git clone https://github.com/eprints/eprints.git /opt/eprints3
 
cd /opt/eprints3/
 
git checkout tags/v3.3.15
 
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
 
Next, as the eprints user copy /opt/eprints3/perl_lib/EPrints/SystemSettings.pm.tmpl to /opt/eprints3/perl_lib/EPrints/SystemSettings.pm
Line 62: Line 48:
 
  export APACHE_RUN_GROUP=eprints
 
  export APACHE_RUN_GROUP=eprints
  
Next, add the file /etc/apache2/sites-available/eprints.conf with the following line:
+
=== Downloading and Deploying EPrints Source ===
 +
==== EPrints 3.3.x for GitHub ====
  
  Include /opt/eprints3/cfg/apache.conf
+
  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 enable this as root run the command:
+
==== EPrints 3.4.x for GitHub ====
  
  a2ensite eprints
+
  apt-get install git
 +
git clone https://github.com/eprints/eprints3.4.git /opt/eprints3
 +
cd /opt/eprints3/
 +
git checkout tags/v3.4.1
 +
chown -R eprints:eprints .
  
Finally, restart Apache:
+
==== EPrints 3.4.x from files.eprints.org ====
  
  apachectl restart
+
  cd /tmp/
 +
wget https://files.eprints.org/2401/4/eprints-3.4.1.tar.gz
 +
tar -xzvf eprints-3.4.1.tar.gz
 +
 +
If you want a publications flavoured repository, then also:
  
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.
+
wget https://files.eprints.org/2401/5/eprints-3.4.1-flavours.tar.gz
 +
tar -xzvf eprints-3.4.1-flavours.tar.gz
  
 +
Then put in the source code in place:
  
== Troubleshooting ==
+
mv eprints-3.4.1 /opt/eprints3
 +
chmod 2775 /opt/eprints3
 +
chown -R eprints:eprints /opt/eprints3
  
===Issues with Ubuntu 14.04 (Apache 2.3/2.4)===
+
=== Configuration ===
 +
Next, as the eprints user copy /opt/eprints3/perl_lib/EPrints/SystemSettings.pm.tmpl to /opt/eprints3/perl_lib/Eprints/SystemSettings.pm
  
Apache 2.3+ and PERL v5.16+ introduce a few changes which break EPrints.
+
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.
  
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]
+
=== Post-configuration ===
 +
Next, add the file /etc/apache2/sites-available/eprints.conf with the following line:
  
Current patches on github are:
+
Include EPRINTS_PATH/cfg/apache.conf
  
* See last comment on https://github.com/eprints/eprints/issues/214  [ use of remote_ip ]
+
EPRINTS_PATH will be either /opt/eprints3/ or /usr/share/eprints depending on which instructions you followed above.
* 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 ]
+
  
 +
To enable this as root run the command:
 +
 +
a2ensite eprints
 +
 +
Finally, restart Apache:
 +
 +
apachectl restart
  
Ensure that mpm_prefork module is enabled in /etc/apache2/mods-enabled (among others).
+
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.
  
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)
+
== Operating System Version Specific Requirements ==
  
*access_compat.load                   
+
=== Ubuntu 18.04 LTS ===
*alias.conf                                   
+
{{:Issues with Installing EPrints on Ubuntu 18.04}}
*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 16:38, 5 April 2019


Requirements

  • Ubuntu 16.04 LTS or 18.04 LTS (non-LTS versions not recommended) or Debian 8 (Jessie) or 9 (Stretch).

Installing from DEB

1. As the root user create a file at /etc/apt/sources.list.d/eprints.list.

  • The latest version of EPrints 3.3 is 3.3.16. To install add the following line to eprints.list:
deb http://deb.eprints.org/stable ./
  • The latest version of EPrints 3.4 is 3.4.1. To install add the following line to eprints.list:
deb http://deb.eprints-hosting.org/stable/3.4 ./

2. Now to install EPrints and all its dependencies execute the following command, again as the root user (the keyFile on deb.eprints.org and deb.eprints-hosting.org):

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

EPrints 3.3 will be installed to /usr/share/eprints3/. EPrints 3.4 will be installed to /usr/share/eprints/. 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.

N.B. If you are installing EPrints 3.4 from the DEB package then you will only get the zero flavour. If you want the publications flavour you will need to download the flavours tarball (see "Downloading and Deploying EPrints Source" below) and copy the pub_lib subdirectory into /usr/share/eprints/flavours/. It is planned that future versions of EPrints 3.4 will have their own publication flavours DEB package.

Installing EPrints from Source

Dependencies and Pre-configuration

N.B. Installing from a source tarball 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 3.3 or EPrints 3.4 Core Git repositories.

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 libtex-encode-perl

Next, create the eprints user

adduser 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.1
chown -R eprints:eprints .

EPrints 3.4.x from files.eprints.org

cd /tmp/
wget https://files.eprints.org/2401/4/eprints-3.4.1.tar.gz
tar -xzvf eprints-3.4.1.tar.gz

If you want a publications flavoured repository, then also:

wget https://files.eprints.org/2401/5/eprints-3.4.1-flavours.tar.gz
tar -xzvf eprints-3.4.1-flavours.tar.gz

Then put in the source code in place:

mv eprints-3.4.1 /opt/eprints3
chmod 2775 /opt/eprints3
chown -R eprints:eprints /opt/eprints3

Configuration

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.

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

Operating System Version Specific Requirements

Ubuntu 18.04 LTS

N.B. It is assumed that you are installing the latest version of 3.4 (currently 3.4.1). Earlier versions may have issues not listed here.

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;