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

From EPrints Documentation
Jump to: navigation, search
(→‎Issues with Ubuntu 13/14 (Apache 2.3/2.4))
m (version update)
 
(109 intermediate revisions by 6 users not shown)
Line 2: Line 2:
 
[[Category:Installation]]
 
[[Category:Installation]]
  
−
David Tarrant has built a Debian/Ubuntu package for Eprints.
+
== Requirements ==
 +
* Ubuntu 20.04 LTS, 22.04 LTS and Ubuntu 24.04 LTS (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.
  
−
=APT Mirrors=
+
== Installing EPrints from Source ==
  
−
<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>
+
=== 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.'''
  
−
==EPrints Latest==
+
'''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.'''
  
−
To install the testing build add *one* the following to /etc/apt/sources.list:
+
First, as the root user install all the dependencies for EPrints ('''N.B.''' Some dependencies may not be able in certain versions of Debian/Ubuntu. See [[#Operating System Version Specific Requirements|Operating System Version Specific Requirements]] towards the end of this page):
  
−
===Stable Builds===
+
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 libexpat1-dev libxslt1-dev
  
−
deb http://deb.eprints.org/ stable/
+
If you are installing on Ubuntu, install MySQL server and client:
−
deb-src http://deb.eprints.org/ source/
 
  
−
===Testing Builds===
+
  apt-get install mysql-server mysql-client libmysqlclient-dev
  
−
deb http://deb.eprints.org/ unstable/
+
If you are installing on Debian, install MariaDB server and client:
−
deb-src http://deb.eprints.org/ source/
 
  
−
===Nightly Build===
+
  apt-get install mariadb-server mariadb-client libmariadb-dev
  
−
Rather than the above add the following to /etc/apt/sources.list (note that this code is in developement and will not neccessarily compile):
+
Next, create the eprints user
  
−
  deb http://deb.eprints.org/ nightly/
+
  adduser eprints
−
deb-src http://deb.eprints.org/ source/
 
  
−
==EPrints 3.X (Specific Version Locking)==
+
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>:
−
===Stable Release===
 
  
−
Add the following to /etc/apt/sources.list:
+
export APACHE_RUN_USER=eprints
 +
export APACHE_RUN_GROUP=eprints
  
−
deb http://deb.eprints.org/3.X/ stable/
+
=== Downloading and Deploying EPrints Source ===
−
deb-src http://deb.eprints.org/3.X/ source/
 
  
−
===Unstable Release===
+
==== EPrints 3.4.x for GitHub ====
  
−
To install the latest '''unstable''' release add the following to /etc/apt/sources.list:
+
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.6
 +
 
 +
==== 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 ====
  
−
  deb http://deb.eprints.org/3.X/ unstable/
+
  cd /tmp/
−
  deb-src http://deb.eprints.org/3.X/ source/
+
wget https://files.eprints.org/3097/5/eprints-3.4.6.tar.gz
 +
  tar -xzvf eprints-3.4.6.tar.gz
  
−
===Nightly Build===
+
Then put in the source code in place:
  
−
To install the nightly build add the following to /etc/apt/sources.list:
+
mv eprints-3.4.6 /usr/share/eprints
 +
chmod 2775 /usr/share/eprints
 +
chown -R eprints:eprints /usr/share/eprints
  
−
deb http://deb.eprints.org/3.X/ nightly/
+
If you want a publications flavoured repository, then also:
−
deb-src http://deb.eprints.org/3.X/ source/
 
  
−
=Installing Eprints via apt-get=
+
wget https://files.eprints.org/3097/6/eprints-3.4.6-flavours.tar.gz
 +
tar -xzvf eprints-3.4.6-flavours.tar.gz
 +
mv eprints-3.4.6/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 install Eprints and all its dependencies execute the following (as root):
+
== 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.
  
−
  apt-get update
+
=== Installing publications flavour ===
−
  apt-get install eprints
+
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/3097/6/eprints-3.4.6-flavours.tar.gz
 +
  tar -xzvf eprints-3.4.6-flavours.tar.gz -C /usr/share/eprints/
 +
mv /usr/share/eprints/eprints-3.4.6/flavours /usr/share/eprints/
 +
rmdir /usr/share/eprints/eprints-3.4.6/
  
−
=Setting up a Repository=
+
== Configuration ==
−
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):
+
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>
  
−
'''For more information about setting up an EPrints repository take a look at [[Getting Started with EPrints 3]]'''
+
<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.
  
−
<b>Read First: Known issues with the Debian/Ubuntu package can be found at [[Debian Known Issues]].</b>
+
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.
  
−
su eprints
+
=== Post-configuration ===
−
cd
+
Next, add the file <code>/etc/apache2/sites-available/eprints.conf</code> with the following line:
−
./bin/epadmin create
 
−
logout
 
−
a2ensite eprints3
 
−
apache2ctl restart
 
  
 +
Include EPRINTS_PATH/cfg/apache.conf
  
−
If you have any problems getting set up you can get free help and support from the EP-Tech mailing list. {{EPrintsTech}}
+
To enable this as root run the command:
  
−
=Getting and Compiling from Source (not required)=
+
a2ensite eprints
  
−
To install dependencies and retrieve the Eprints source execute the following:
+
Also it may be necessary to disable the default site otherwise the default Apache page will still be shown:
  
−
  apt-get update
+
  a2dissite 000-default
−
apt-get build-dep eprints
 
−
apt-get source eprints
 
  
−
The source will be saved to a tarball in the current directory.
+
Finally, restart Apache:
  
 +
service apache2 restart
  
−
=Issues with Ubuntu 13/14 (Apache 2.3/2.4)=
+
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.
  
−
Apache 2.3+ and PERL v5.16+ introduce a few changes which break EPrints.
+
=== 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 <code>dpkg-buildpackage -rfakeroot</code> from the root dir of the extracted tarball.  
  
−
Current patches on github are:
+
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
  
−
* See last comment on https://github.com/eprints/eprints/issues/214  [ use of remote_ip ]
+
Alternatively you can configure and install it yourself (a non debian specific version) by configuring manually and then running install.pl:
−
* https://github.com/eprints/eprints/issues/237 [ NameVirtualHost deprecated ]
+
$ ./configure --with-smtp-server=smtp.yourdomain
−
* https://github.com/eprints/eprints/issues/236 [ Order allow,deny deprecated ]
+
$ sudo ./install.pl
−
* https://github.com/eprints/eprints/commit/157db0d27d423d38f9c0fc31ce47e519cd861d45 [ utf8::decode and URI parameters ]
 
  
 +
== Operating System Version Specific Requirements ==
  
 +
=== Ubuntu 20.04 LTS ===
 +
{{:Issues with Installing EPrints on Ubuntu 20.04}}
  
−
Ensure that mpm_prefork module is enabled in /etc/apache2/mods-enabled (among others).
+
=== Ubuntu 22.04 LTS ===
 +
{{:Issues with Installing EPrints on Ubuntu 22.04}}
  
−
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)
+
=== Ubuntu 24.04 LTS ===
 +
{{:Issues with Installing EPrints on Ubuntu 24.04}}
  
−
*access_compat.load                   
+
=== Debian Known Issues ===
−
*alias.conf                                   
+
See [[Debian Known Issues]]
−
*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 18:17, 30 October 2024


Requirements

  • Ubuntu 20.04 LTS, 22.04 LTS and Ubuntu 24.04 LTS (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 (N.B. Some dependencies may not be able in certain versions of Debian/Ubuntu. See Operating System Version Specific Requirements towards the end of this page): 

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 libexpat1-dev libxslt1-dev

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

 apt-get install mysql-server mysql-client libmysqlclient-dev

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

 apt-get install mariadb-server mariadb-client libmariadb-dev

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

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/3097/5/eprints-3.4.6.tar.gz
tar -xzvf eprints-3.4.6.tar.gz

Then put in the source code in place: 

mv eprints-3.4.6 /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/3097/6/eprints-3.4.6-flavours.tar.gz
tar -xzvf eprints-3.4.6-flavours.tar.gz
mv eprints-3.4.6/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/3097/6/eprints-3.4.6-flavours.tar.gz
tar -xzvf eprints-3.4.6-flavours.tar.gz -C /usr/share/eprints/
mv /usr/share/eprints/eprints-3.4.6/flavours /usr/share/eprints/
rmdir /usr/share/eprints/eprints-3.4.6/

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

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.
MySQL root user cannot be used 
This is now explained under EPrints' Getting Started instructions. as it is typical for most modern Linux operating systems.

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.
MySQL root user cannot be used 
This is now explained under EPrints' Getting Started instructions. as it is typical for most modern Linux operating systems.

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

libncurses5 no longer available

libncurses5 APT package dependency no longer exists in Ubuntu 24.04 LTS, install libncurses6 instead.

Previous Issues

MySQL root user cannot be used 
This is now explained under EPrints' Getting Started instructions. as it is typical for most modern Linux operating systems.

Debian Known Issues

See Debian Known Issues

Retrieved from ‘https://wiki.eprints.org/w/index.php?title=Installing_EPrints_on_Debian/Ubuntu&oldid=16700’