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

From EPrints Documentation
Jump to: navigation, search
(Fixed errors in installation from source instructions.)
m (Dependencies and Pre-configuration)
(73 intermediate revisions by 2 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 18.04 LTS, 20.04 LTS or 22.04 LTS and (non-LTS versions not recommended)  
 +
* Debian 9 (Stretch), 10 (Buster) or Debian 11 (Bullseye) - These are not as comprehensively tested as Ubuntu LTS versions.
  
== Installing from EPrints 3.3.x DEB ==
+
== Installing from DEB ==
 +
<ol><li>As the root user create a file at <code>/etc/apt/sources.list.d/eprints.list</code> containing</li>
 +
deb http://deb.eprints.org/3.4/stable/ ./
 +
<li>To allow the installation of EPrints and all its dependencies execute the following commands, again as the root user</li>
 +
wget -O /etc/apt/trusted.gpg.d/eprints.gpg http://deb.eprints.org/keyFile.gpg
 +
apt-get update
 +
<li>Select the appropriate current [http://files.eprints.org/view/type/release.html release] depending on output of</li>
 +
apt-cache show eprints
 +
<li>Finally install the selected version, e.g.</li>
 +
apt-get install eprints=3.4.4
 +
</ol>
 +
EPrints ''3.3'' will be installed to <code>/usr/share/eprints3/</code>. EPrints ''3.4'' will be installed to <code>/usr/share/eprints/</code>.
 +
 
 +
However, '''you will not yet have a running archive'''.  Follow the [[Getting Started with EPrints 3]] instructions to set this up.
 +
 
 +
Below are some [[Installing_EPrints_3_via_apt_(Debian/Ubuntu)#Operating_System_Version_Specific_Requirements | caveats for particular versions of Debian and Ubuntu]].
  
 +
=== 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/2715/2/eprints-3.4.4-flavours.tar.gz
 +
tar -xzvf eprints-3.4.4-flavours.tar.gz -C /usr/share/eprints/
 +
mv /usr/share/eprints/eprints-3.4.4/flavours /usr/share/eprints/
 +
rmdir /usr/share/eprints/eprints-3.4.4/
  
=== For Ubuntu 14.04 and Debian 7.0 ===
+
== Installing EPrints from Source ==
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/
+
=== Dependencies and Pre-configuration ===
 +
'''N.B. Installing from a source tarball is generally discouraged particularly for production repositories. However, if you 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.'''
  
Now to install EPrints and all its dependencies execute the following command, again as the root user:
+
First, as the root user install all the dependencies for EPrints:
  
  apt-get update
+
  apt-get install perl libncurses5 libselinux1 apache2 libapache2-mod-perl2 libxml-libxml-perl \
apt-get install eprints
+
  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
  
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.
+
If you are installing on Ubuntu, install MySQL server and 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.
+
  apt-get install mysql-server mysql-client
  
=== For Ubuntu 16.04 and Debian 8 ===
+
If you are installing on Debian, install MariaDB server and 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:
+
  apt-get install mariadb-server mariadb-client
  
apt-get install ./eprints_3.3.15_all-xenial.deb
+
Next, create the eprints user
  
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.
+
  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 <code>/etc/apache2/envvars</code>:
  
== Installing EPrints 3.3.x from Source ==
+
export APACHE_RUN_USER=eprints
'''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].'''
+
  export APACHE_RUN_GROUP=eprints
  
First, as theroot users install all the dependencies for EPrints:
+
=== Downloading and Deploying EPrints Source ===
 +
==== EPrints 3.3.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/eprints.git /opt/eprints3
 +
git checkout tags/v3.3.16
  
Next, create the eprints user
+
==== EPrints 3.4.x for GitHub ====
  
  useradd eprints
+
  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
 +
git checkout tags/v3.4.4
  
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:
+
==== EPrints 3.4.x from files.eprints.org ====
  
  apt-get install git
+
  cd /tmp/
  git clone https://github.com/eprints/eprints.git /opt/eprints3
+
  wget https://files.eprints.org/2715/7/eprints-3.4.4.tar.gz
cd /opt/eprints3/
+
  tar -xzvf eprints-3.4.4.tar.gz
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
+
Then put in the source code in place:
  
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.
+
mv eprints-3.4.4 /usr/share/eprints
 +
chmod 2775 /usr/share/eprints
 +
chown -R eprints:eprints /usr/share/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/httpd/conf/httpd.conf:
+
If you want a publications flavoured repository, then also:
  
  User eprints
+
  wget https://files.eprints.org/2715/2/eprints-3.4.4-flavours.tar.gz
  Group eprints
+
tar -xzvf eprints-3.4.4-flavours.tar.gz
 +
mv eprints-3.4.4/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
  
Next, add the file /etc/apache2/sites-available/eprints.conf with the following line:
+
=== 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>
  
Include /opt/eprints3/cfg/apache.conf
+
<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.
  
To enable this as root run the command:
+
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.
  
a2ensite eprints
+
=== Post-configuration ===
 +
Next, add the file <code>/etc/apache2/sites-available/eprints.conf</code> with the following line:
  
Finally, restart Apache:
+
Include EPRINTS_PATH/cfg/apache.conf
  
service apache2 restart
+
To enable this as root run the command:
  
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.
+
a2ensite eprints
  
 +
Also it may be necessary to disable the default site otherwise the default Apache page will still be shown:
  
== Troubleshooting ==
+
a2dissite 000-default
  
===Issues with Ubuntu 14.04 (Apache 2.3/2.4)===
+
Finally, restart Apache:
  
Apache 2.3+ and PERL v5.16+ introduce a few changes which break EPrints.
+
service apache2 restart
  
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]
+
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.
  
Current patches on github are:
+
=== Useful commands for source development and testing ===
 +
The following commands may be useful for those developing or testing EPrints by 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.
  
* See last comment on https://github.com/eprints/eprints/issues/214  [ use of remote_ip ]
+
This will build you a .deb in the directory above your current location, which can then be installed usinging dpkg:
* https://github.com/eprints/eprints/issues/237 [ NameVirtualHost deprecated ]
+
dpkg -i ../eprints-X.X.X_all.deb
* https://github.com/eprints/eprints/issues/236 [ Order allow,deny deprecated ]
 
* https://github.com/eprints/eprints/commit/157db0d27d423d38f9c0fc31ce47e519cd861d45 [ utf8::decode and URI parameters ]
 
  
 +
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
  
Ensure that mpm_prefork module is enabled in /etc/apache2/mods-enabled (among others).
+
== Operating System Version Specific Requirements ==
  
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 18.04 LTS ===
 +
{{:Issues with Installing EPrints on Ubuntu 18.04}}
  
*access_compat.load                   
+
=== Ubuntu 20.04 LTS ===
*alias.conf                                   
+
{{:Issues with Installing EPrints on Ubuntu 20.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
 
  
=== Installing LibXSLT.so from CPAN ===
+
=== Ubuntu 22.04 LTS ===
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.
+
{{:Issues with Installing EPrints on Ubuntu 22.04}}
  
'''Instructions to be written'''
+
=== Debian Known Issues ===
 +
See [[Debian Known Issues]]

Revision as of 10:15, 12 May 2023


Requirements

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

Installing from DEB

  1. As the root user create a file at /etc/apt/sources.list.d/eprints.list containing
  2. deb http://deb.eprints.org/3.4/stable/ ./
    
  3. To allow the installation of EPrints and all its dependencies execute the following commands, again as the root user
  4. wget -O /etc/apt/trusted.gpg.d/eprints.gpg http://deb.eprints.org/keyFile.gpg
    apt-get update
    
  5. Select the appropriate current release depending on output of
  6. apt-cache show eprints
    
  7. Finally install the selected version, e.g.
  8. apt-get install eprints=3.4.4
    

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 versions of Debian and Ubuntu.

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/2715/2/eprints-3.4.4-flavours.tar.gz
tar -xzvf eprints-3.4.4-flavours.tar.gz -C /usr/share/eprints/
mv /usr/share/eprints/eprints-3.4.4/flavours /usr/share/eprints/
rmdir /usr/share/eprints/eprints-3.4.4/

Installing EPrints from Source

Dependencies and Pre-configuration

N.B. Installing from a source tarball is generally discouraged particularly for production repositories. However, if you 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 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

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.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
git checkout tags/v3.3.16

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
git checkout tags/v3.4.4

EPrints 3.4.x from files.eprints.org

cd /tmp/
wget https://files.eprints.org/2715/7/eprints-3.4.4.tar.gz
tar -xzvf eprints-3.4.4.tar.gz

Then put in the source code in place:

mv eprints-3.4.4 /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/2715/2/eprints-3.4.4-flavours.tar.gz
tar -xzvf eprints-3.4.4-flavours.tar.gz
mv eprints-3.4.4/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

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