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

From EPrints Documentation
Jump to: navigation, search
(Added start of instructions for install LibXSLT.so from source.)
(Updated supported versions)
 
(83 intermediate revisions by 3 users 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 20.04 LTS or 22.04 LTS and (non-LTS versions not recommended)
 +
* Debian 10 (Buster), Debian 11 (Bullseye) or Debian 12 (Bookworm) - These are not as comprehensively tested as Ubuntu LTS versions.
  
== Installing from EPrints 3.3.x DEB ==
+
== Installing EPrints from Source ==
  
 +
=== Dependencies and Pre-configuration ===
 +
'''The ideal way to install from source is via git using the Core Git repositories [https://github.com/eprints/eprints3.4 EPrints 3.4] or [https://github.com/eprints/eprints EPrints 3.3], and installing from a source tarball is generally discouraged.'''
  
=== For Ubuntu 14.04 and Debian 7.0 ===
+
'''Installing from source via git is now the recommended  way to install EPrints for production repositories, after having proved to be a useful installation method to those seeking to develop the EPrints code, develop a plugin or develop a Bazaar package too.'''
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/
+
First, as the root user install all the dependencies for EPrints:
  
Now to install EPrints and all its dependencies execute the following command, again as the root user:
+
apt-get install perl libncurses5 libselinux1 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 \
 +
  liblwp-protocol-https-perl libtext-unidecode-perl lynx wget ghostscript poppler-utils antiword elinks \
 +
  texlive-base texlive-base-bin psutils imagemagick adduser tar gzip unzip libsearch-xapian-perl \
 +
  libtex-encode-perl libio-string-perl libdbd-mysql-perl python3-html2text make
  
apt-get update
+
If you are installing on Ubuntu, install MySQL server and client:
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 unauthenticated.  The next Deb package release of EPrints (3.3.16) should be signed.
+
  apt-get install mysql-server mysql-client
  
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.
+
If you are installing on Debian, install MariaDB server and client:
  
=== For Ubuntu 16.04 and Debian 8 ===
+
  apt-get install mariadb-server mariadb-client
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.
 
  
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:
+
Next, create the eprints user
  
  apt-get install ./eprints_3.3.15_all-xenial.deb
+
  adduser 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.
+
Now, update Apache configuration to set it up to use the eprints user and group, by ensuring the following lines are set thus in <code>/etc/apache2/envvars</code>:
  
 +
export APACHE_RUN_USER=eprints
 +
export APACHE_RUN_GROUP=eprints
  
== Installing EPrints 3.3.x from Source ==
+
=== Downloading and Deploying EPrints 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:
+
==== EPrints 3.4.x for GitHub ====
  
  apt-get install perl libncurses5 libselinux1 libsepol1 apache2 libapache2-mod-perl2 libxml-libxml-perl libunicode-string-perl \
+
  apt install git
  libterm-readkey-perl libmime-lite-perl libmime-types-perl libdigest-sha-perl libdbd-mysql-perl libxml-parser-perl libxml2-dev \
+
mkdir /opt/eprints3
  libxml-twig-perl libarchive-any-perl libjson-perl lynx wget ghostscript xpdf antiword elinks pdftk texlive-base texlive-base-bin \
+
chown eprints:eprints /opt/eprints3
  psutils imagemagick adduser tar gzip mysql-server mysql-client unzip libsearch-xapian-perl
+
chmod 2775 /opt/eprints3
 +
su eprints
 +
git clone https://github.com/eprints/eprints3.4.git /opt/eprints3
 +
cd /opt/eprints3/
 +
git checkout tags/v3.4.5
  
Next, create the eprints user
+
==== EPrints 3.3.x for GitHub ====
  
  useradd eprints
+
  apt install git
 
+
mkdir /opt/eprints3
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:
+
chown eprints:eprints /opt/eprints3
 
+
chmod 2775 /opt/eprints3
  apt-get install git
+
  su eprints
 
  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.3.16
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 3.4.x from files.eprints.org ====
  
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.
+
cd /tmp/
 +
wget https://files.eprints.org/2789/7/eprints-3.4.5.tar.gz
 +
tar -xzvf eprints-3.4.5.tar.gz
  
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:
+
Then put in the source code in place:
  
  export APACHE_RUN_USER=eprints
+
  mv eprints-3.4.5 /usr/share/eprints
  export APACHE_RUN_GROUP=eprints
+
chmod 2775 /usr/share/eprints
 +
  chown -R eprints:eprints /usr/share/eprints
  
Next, add the file /etc/apache2/sites-available/eprints.conf with the following line:
+
If you want a publications flavoured repository, then also:
  
  Include /opt/eprints3/cfg/apache.conf
+
  wget https://files.eprints.org/2789/2/eprints-3.4.5-flavours.tar.gz
 +
tar -xzvf eprints-3.4.5-flavours.tar.gz
 +
mv eprints-3.4.5/flavours/pub_lib /usr/share/eprints/flavours
 +
chmod -R g+w /usr/share/eprints/flavours/pub_lib
 +
chown -R eprints:eprints /usr/share/eprints/flavours/pub_lib
  
To enable this as root run the command:
+
== Installing from Debian package ==
 +
As of EPrints 3.4.5 Debian (.deb) packages will no longer be produced.  Due to the complexity of the installation process there are a number of inherent problems with installing using a Deb package. As new operating systems (e.g. Debian and Ubuntu) are released the available packages have changed.  This often leads to packages upon which that EPrints depends ceasing to be available.  This makes it very difficult or impossible to install the Debian package, as well as requiring retrospective effort to install packages using other sources, (e.g. additional APT repositories or using CPAN).  However, the main concern of installation the Debian package, particularly through EPrints' APT repository, is that it can lead to EPrints being upgraded automatically to a new version.  Upgrading EPrints using a Debian package is likely to lead to EPrints producing errors, as configuration changes are often required as part of the upgrade process.  Automating these changes within the Debian package would be all but impossible due to EPrints' high level of customisability.
  
  a2ensite eprints
+
=== Installing publications flavour ===
 +
EPrints 3.4 DEBs only come with the in-built 'zero' flavour and not the typical publications flavour. Before trying to set up you archive you will need to (as the eprints user) download the latest publications flavour tarball from https://files.eprints.org/ and unpack it into /usr/share/eprints/:
 +
wget https://files.eprints.org/2789/2/eprints-3.4.5-flavours.tar.gz
 +
tar -xzvf eprints-3.4.5-flavours.tar.gz -C /usr/share/eprints/
 +
mv /usr/share/eprints/eprints-3.4.5/flavours /usr/share/eprints/
 +
rmdir /usr/share/eprints/eprints-3.4.5/
  
Finally, restart Apache:
+
== Configuration ==
 +
Next, as the eprints user copy <code>EPRINTS_PATH/perl_lib/EPrints/SystemSettings.pm.tmpl</code> to <code>EPRINTS_PATH/perl_lib/EPrints/SystemSettings.pm</code>
  
apachectl restart
+
<code>EPRINTS_PATH</code> will be either <code>/usr/share/eprints3/</code> or <code>/usr/share/eprints</code> depending on which instructions you followed above.
  
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.
+
EPrints is now fully installed at <code>EPRINTS_PATH/</code>. 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 <code>/etc/apache2/sites-available/eprints.conf</code> with the following line:
  
== Troubleshooting ==
+
Include EPRINTS_PATH/cfg/apache.conf
  
===Issues with Ubuntu 14.04 (Apache 2.3/2.4)===
+
To enable this as root run the command:
  
Apache 2.3+ and PERL v5.16+ introduce a few changes which break EPrints.
+
a2ensite eprints
  
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]
+
Also it may be necessary to disable the default site otherwise the default Apache page will still be shown:
  
Current patches on github are:
+
a2dissite 000-default
  
* See last comment on https://github.com/eprints/eprints/issues/214  [ use of remote_ip ]
+
Finally, restart Apache:
* 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)
+
service apache2 restart
  
*access_compat.load                   
+
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.
*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
 
  
=== Installing LibXSLT.so from CPAN ===
+
=== Useful commands for source development and testing ===
There are some issues with the LibXSLT.so that is installed by the Deb package libxml-libxslt-perl, which causes the Apache webserver to generate a segmentation fault. libxml-libxslt-perl will be removed as a dependency from the next eprints Deb package (3.3.16) but is you want to integrate EPrints with third party applications (e.g. Symplectic Elements) then you will need this installed.  A version that does not suffer this segmentation fault can be installed using CPAN.
+
The following commands may be useful for those developing or testing EPrints but are not necessary for installing EPrints.
 +
==== Install EPrints build dependencies ====
 +
apt-get build-dep eprints
 +
==== Get EPrints source ====
 +
  apt-get source eprints
 +
==== Rebuilding ====
 +
To change the way the eprints builds you can edit the debian/rules file (the only line you will want is the configure one). Once done you can then type <code>dpkg-buildpackage -rfakeroot</code> from the root dir of the extracted tarball.  
  
First, as root install the following Deb packages:
+
This will build you a .deb in the directory above your current location, which can then be installed usinging dpkg:
 +
dpkg -i ../eprints-X.X.X_all.deb
  
  apt-get install build essential libxslt1-dev zlib1g-dev libgdbm-dev
+
Alternatively you can configure and install it yourself (a non debian specific version) by configuring manually and then running install.pl:
 +
  $ ./configure --with-smtp-server=smtp.yourdomain
 +
$ sudo ./install.pl
  
Then, again as root install the YAML module for CPAN. 
+
== Operating System Version Specific Requirements ==
  
cpan YAML
+
=== Ubuntu 18.04 LTS ===
 +
{{:Issues with Installing EPrints on Ubuntu 18.04}}
  
You will be asked several questions if you have not configured CPAN for the root user before. Just choose the default options. Next, install the XML::LibXSLT:
+
=== Ubuntu 20.04 LTS ===
 +
{{:Issues with Installing EPrints on Ubuntu 20.04}}
  
cpan XML::LibXSLT
+
=== Ubuntu 22.04 LTS ===
 +
{{:Issues with Installing EPrints on Ubuntu 22.04}}
  
'''N.B.''' These instructions are not complete as cpan still has an issue building its own LibXSLT.so.
+
=== Debian Known Issues ===
 +
See [[Debian Known Issues]]

Latest revision as of 11:23, 12 March 2024


Requirements

  • Ubuntu 20.04 LTS or 22.04 LTS and (non-LTS versions not recommended)
  • Debian 10 (Buster), Debian 11 (Bullseye) or Debian 12 (Bookworm) - These are not as comprehensively tested as Ubuntu LTS versions.

Installing EPrints from Source

Dependencies and Pre-configuration

The ideal way to install from source is via git using the Core Git repositories EPrints 3.4 or EPrints 3.3, and installing from a source tarball is generally discouraged.

Installing from source via git is now the recommended way to install EPrints for production repositories, after having proved to be a useful installation method to those seeking to develop the EPrints code, develop a plugin or develop a Bazaar package too.

First, as the root user install all the dependencies for EPrints:

apt-get install perl libncurses5 libselinux1 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 \
  liblwp-protocol-https-perl libtext-unidecode-perl lynx wget ghostscript poppler-utils antiword elinks \
  texlive-base texlive-base-bin psutils imagemagick adduser tar gzip unzip libsearch-xapian-perl \
  libtex-encode-perl libio-string-perl libdbd-mysql-perl python3-html2text make

If you are installing on Ubuntu, install MySQL server and client:

 apt-get install mysql-server mysql-client

If you are installing on Debian, install MariaDB server and client:

 apt-get install mariadb-server mariadb-client

Next, create the eprints user

adduser eprints

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.4.x for GitHub

apt install git
mkdir /opt/eprints3
chown eprints:eprints /opt/eprints3
chmod 2775 /opt/eprints3
su eprints
git clone https://github.com/eprints/eprints3.4.git /opt/eprints3
cd /opt/eprints3/
git checkout tags/v3.4.5

EPrints 3.3.x for GitHub

apt install git
mkdir /opt/eprints3
chown eprints:eprints /opt/eprints3
chmod 2775 /opt/eprints3
su eprints
git clone https://github.com/eprints/eprints.git /opt/eprints3
cd /opt/eprints3/
git checkout tags/v3.3.16

EPrints 3.4.x from files.eprints.org

cd /tmp/
wget https://files.eprints.org/2789/7/eprints-3.4.5.tar.gz
tar -xzvf eprints-3.4.5.tar.gz

Then put in the source code in place:

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

If you want a publications flavoured repository, then also:

wget https://files.eprints.org/2789/2/eprints-3.4.5-flavours.tar.gz
tar -xzvf eprints-3.4.5-flavours.tar.gz
mv eprints-3.4.5/flavours/pub_lib /usr/share/eprints/flavours
chmod -R g+w /usr/share/eprints/flavours/pub_lib
chown -R eprints:eprints /usr/share/eprints/flavours/pub_lib

Installing from Debian package

As of EPrints 3.4.5 Debian (.deb) packages will no longer be produced. Due to the complexity of the installation process there are a number of inherent problems with installing using a Deb package. As new operating systems (e.g. Debian and Ubuntu) are released the available packages have changed. This often leads to packages upon which that EPrints depends ceasing to be available. This makes it very difficult or impossible to install the Debian package, as well as requiring retrospective effort to install packages using other sources, (e.g. additional APT repositories or using CPAN). However, the main concern of installation the Debian package, particularly through EPrints' APT repository, is that it can lead to EPrints being upgraded automatically to a new version. Upgrading EPrints using a Debian package is likely to lead to EPrints producing errors, as configuration changes are often required as part of the upgrade process. Automating these changes within the Debian package would be all but impossible due to EPrints' high level of customisability.

Installing publications flavour

EPrints 3.4 DEBs only come with the in-built 'zero' flavour and not the typical publications flavour. Before trying to set up you archive you will need to (as the eprints user) download the latest publications flavour tarball from https://files.eprints.org/ and unpack it into /usr/share/eprints/:

wget https://files.eprints.org/2789/2/eprints-3.4.5-flavours.tar.gz
tar -xzvf eprints-3.4.5-flavours.tar.gz -C /usr/share/eprints/
mv /usr/share/eprints/eprints-3.4.5/flavours /usr/share/eprints/
rmdir /usr/share/eprints/eprints-3.4.5/

Configuration

Next, as the eprints user copy EPRINTS_PATH/perl_lib/EPrints/SystemSettings.pm.tmpl to EPRINTS_PATH/perl_lib/EPrints/SystemSettings.pm

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

EPrints is now fully installed at EPRINTS_PATH/. 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

To enable this as root run the command:

a2ensite eprints

Also it may be necessary to disable the default site otherwise the default Apache page will still be shown:

a2dissite 000-default

Finally, restart Apache:

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

Useful commands for source development and testing

The following commands may be useful for those developing or testing EPrints but are not necessary for installing EPrints.

Install EPrints build dependencies

apt-get build-dep eprints

Get EPrints source

apt-get source eprints

Rebuilding

To change the way the eprints builds you can edit the debian/rules file (the only line you will want is the configure one). Once done you can then type dpkg-buildpackage -rfakeroot from the root dir of the extracted tarball.

This will build you a .deb in the directory above your current location, which can then be installed usinging dpkg:

dpkg -i ../eprints-X.X.X_all.deb

Alternatively you can configure and install it yourself (a non debian specific version) by configuring manually and then running install.pl:

$ ./configure --with-smtp-server=smtp.yourdomain
$ sudo ./install.pl

Operating System Version Specific Requirements

Ubuntu 18.04 LTS

N.B. It is assumed that you are installing the latest version of 3.4. 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. To 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 20.04 LTS

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

MySQL root user cannot be used

On Ubuntu 20.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;

Previous issues

xpdf Deb package no longer exists 
This has been removed as a dependency since EPrints 3.4.3, as it is no longer specifically required by EPrints.
MySQL deprecated syntax 
GRANT PRIVILEGES command used by epadmin has been modified to avoid using deprecated syntax since EPrints 3.4.3.

Ubuntu 22.04 LTS

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

MySQL root user cannot be used

On Ubuntu 22.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;

Previous issues

libsepol1 Deb package no longer exists 
This has been removed as a dependency on 29th May 2022, as it is not specifically required by EPrints.

Debian Known Issues

See Debian Known Issues