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

From EPrints Documentation
Jump to: navigation, search
m
(→‎Downloading and Deploying EPrints Source)
 
(114 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
{{manual}}
 
[[Category:Debian and Ubuntu]]
 
[[Category:Debian and Ubuntu]]
 
[[Category:Installation]]
 
[[Category:Installation]]
  
 
== Requirements ==
 
== Requirements ==
−
* Ubuntu 14.04 LTS or 16.04 LTS (non-LTS versions not recommended) or Debian 7 (Wheezy) or 8 (Jessie).
+
* Ubuntu 22.04 LTS and Ubuntu 24.04 LTS (non-LTS versions not recommended)
 +
* Debian 11 (Bullseye), Debian 12 (Bookworm) or Debian 13 (Trixie) - These are not as comprehensively tested as Ubuntu LTS versions.
  
−
== Installing from EPrints 3.3.x DEB ==
+
=== 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 ('''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):
  
−
Now to install EPrints and all its dependencies execute the following command, again as the root user:
+
apt install perl libncurses6 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-binaries psutils imagemagick adduser tar gzip unzip libsearch-xapian-perl \
 +
  libtex-encode-perl libio-string-perl python3-html2text make libexpat1-dev libxslt1-dev
  
−
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 install mysql-server mysql-client libmysqlclient-dev
  
−
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 install mariadb-server mariadb-client libmariadb-dev
−
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:
+
Next, create the eprints user
−
 
 
−
apt-get install ./eprints_3.3.15_all-xenial.deb
 
−
 
 
−
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
  
−
== Installing EPrints 3.3.x from Source ==
+
Now add the eprints user to the www-data group and vice-versa
−
'''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:
+
usermod -a -G eprints www-data
 +
usermod -a -G www-data eprints
  
−
apt-get install perl libncurses5 libselinux1 libsepol1 apache2 libapache2-mod-perl2 libxml-libxml-perl libunicode-string-perl \
+
=== Downloading and Deploying EPrints 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 pdftk texlive-base texlive-base-bin \
 
−
  psutils imagemagick adduser tar gzip mysql-server mysql-client unzip libsearch-xapian-perl
 
  
−
Next, create the eprints user
+
==== Create initial directory with correct permissions ====
 +
As root:
 +
mkdir /opt/eprints3
 +
chown eprints:eprints /opt/eprints3
 +
chmod 2775 /opt/eprints3
  
−
useradd eprints
+
==== Cloning from Git ====
  
−
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 install git
−
 
+
su eprints
−
  apt-get install git
+
  git clone https://github.com/eprints/eprints3.4.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.4.7
−
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
+
== 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>, if it does not already exist.
  
−
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.
+
<code>EPRINTS_PATH</code> should now always be <code>/opt/eprints3</code>. However, historically other paths have been used when EPrints was available as a Deb package.
  
−
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:
+
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.
  
−
export APACHE_RUN_USER=eprints
+
=== Post-configuration ===
−
export APACHE_RUN_GROUP=eprints
+
Next, add the file <code>/etc/apache2/sites-available/eprints.conf</code> with the following line:
  
−
Next, add the file /etc/apache2/sites-available/eprints.conf with the following line:
+
  Include EPRINTS_PATH/cfg/apache.conf
−
 
 
−
  Include /opt/eprints3/cfg/apache.conf
 
  
 
To enable this as root run the command:
 
To enable this as root run the command:
  
−
  a2ensite eprints
+
  root> a2ensite eprints
  
−
Finally, restart Apache:
+
Also it may be necessary to disable the default site otherwise the default Apache page will still be shown:
  
−
  apachectl restart
+
  a2dissite 000-default
  
−
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.
+
Finally, restart Apache:
−
 
 
−
 
 
−
== Troubleshooting ==
 
−
 
 
−
===Issues with Ubuntu 14.04 (Apache 2.3/2.4)===
 
−
 
 
−
Apache 2.3+ and PERL v5.16+ introduce a few changes which break 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]
 
  
−
Current patches on github are:
+
service apache2 restart
  
−
* See last comment on https://github.com/eprints/eprints/issues/214  [ use of remote_ip ]
+
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.
−
* 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 ]
 
  
 +
== Operating System Version Specific Requirements ==
  
−
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 09:25, 14 September 2026

Manual Sections

Requirements

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

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 install perl libncurses6 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-binaries psutils imagemagick adduser tar gzip unzip libsearch-xapian-perl \
  libtex-encode-perl libio-string-perl python3-html2text make libexpat1-dev libxslt1-dev

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

 apt install mysql-server mysql-client libmysqlclient-dev

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

 apt install mariadb-server mariadb-client libmariadb-dev

Next, create the eprints user 

adduser eprints

Now add the eprints user to the www-data group and vice-versa 

usermod -a -G eprints www-data
usermod -a -G www-data eprints

Downloading and Deploying EPrints Source

Create initial directory with correct permissions

As root: 

mkdir /opt/eprints3
chown eprints:eprints /opt/eprints3
chmod 2775 /opt/eprints3

Cloning from Git

apt install git
su eprints
git clone https://github.com/eprints/eprints3.4.git /opt/eprints3
cd /opt/eprints3/
git checkout tags/v3.4.7

Configuration

Next, as the eprints user copy EPRINTS_PATH/perl_lib/EPrints/SystemSettings.pm.tmpl to EPRINTS_PATH/perl_lib/EPrints/SystemSettings.pm, if it does not already exist.

EPRINTS_PATH should now always be /opt/eprints3. However, historically other paths have been used when EPrints was available as a Deb package.

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: 

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

Operating System Version Specific Requirements

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.

NO CURRENT ISSUES

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.
libncurses6 Deb package not available 
In more recent versions of Ubuntu libncurses6 is the name for the ncurses package but as Ubuntu 22.04 is older you will need to install libncurses5 instead.

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.

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.
libncurses5 APT package dependency no longer exists 
Install libncurses6 instead. However, as both Ubuntu 24.04 and Ubuntu 26.04 only have libncurses6 the general instructions have been updated to use libncurses6, so this is no longer an issue.

Debian Known Issues

See Debian Known Issues

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