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

From EPrints Documentation
Jump to: navigation, search
(Updated structure of page to be similar to RHEL installation guide.)
(→‎Requirements: user adduser rather than useradd)
 
(120 intermediate revisions by 5 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 22.04 LTS and Ubuntu 24.04 LTS (non-LTS versions not recommended)
 +
* Debian 11 (Bullseye) or Debian 12 (Bookworm) - These are not as comprehensively tested as Ubuntu LTS versions.
  
−
== Installing form 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.'''
  
−
  deb http://deb.eprints.org/ stable/
+
'''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.'''
  
−
Installing Eprints via apt-get
+
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):
  
−
To install Eprints and all its dependencies execute the following (as root):
+
apt 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-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
 
  
−
=Setting up a Repository=
+
  apt install mysql-server mysql-client libmysqlclient-dev
−
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):
 
  
−
'''For more information about setting up an EPrints repository take a look at [[Getting Started with EPrints 3]]'''
+
If you are installing on Debian, install MariaDB server and client:
  
−
<b>Read First: Known issues with the Debian/Ubuntu package can be found at [[Debian Known Issues]].</b>
+
  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 ===
 +
 +
==== EPrints 3.4.x for GitHub ====
 +
 +
apt install git
 +
mkdir /opt/eprints3
 +
chown eprints:eprints /opt/eprints3
 +
chmod 2775 /opt/eprints3
 
  su eprints
 
  su eprints
−
  cd
+
git clone https://github.com/eprints/eprints3.4.git /opt/eprints3
−
  ./bin/epadmin create
+
  cd /opt/eprints3/
−
  logout
+
  git checkout tags/v3.4.6
−
  a2ensite eprints3
+
 
−
  apache2ctl restart
+
==== 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 /opt/eprints3
 +
  chmod 2775 /opt/eprints3
 +
chown -R eprints:eprints /opt/eprints3
 +
 
 +
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 /opt/eprints3/flavours
 +
chmod -R g+w /opt/eprints3/flavours/pub_lib
 +
chown -R eprints:eprints /opt/eprints3/flavours/pub_lib
  
−
If you have any problems getting set up you can get free help and support from the EP-Tech mailing list. {{EPrintsTech}}
+
== 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.
  
−
== Installing EPrints 3.3.x from Source ==
+
<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.
−
'''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].'''
 
  
−
...
+
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.
  
−
==Getting Started==
+
=== Post-configuration ===
 +
Next, add the file <code>/etc/apache2/sites-available/eprints.conf</code> with the following line:
  
−
See [[Getting Started with EPrints 3]].
+
Include EPRINTS_PATH/cfg/apache.conf
  
 +
To enable this as root run the command:
  
−
== Troubleshooting ==
+
root> a2ensite eprints
  
−
===Issues with Ubuntu 14.04 (Apache 2.3/2.4)===
+
Also it may be necessary to disable the default site otherwise the default Apache page will still be shown:
  
−
Apache 2.3+ and PERL v5.16+ introduce a few changes which break EPrints.
+
a2dissite 000-default
  
−
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]
+
Finally, restart Apache:
  
−
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 11:06, 29 August 2025


Requirements

  • Ubuntu 22.04 LTS and Ubuntu 24.04 LTS (non-LTS versions not recommended)
  • Debian 11 (Bullseye) or Debian 12 (Bookworm) - 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 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-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

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.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 /opt/eprints3
chmod 2775 /opt/eprints3
chown -R eprints:eprints /opt/eprints3

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 /opt/eprints3/flavours
chmod -R g+w /opt/eprints3/flavours/pub_lib
chown -R eprints:eprints /opt/eprints3/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, 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.

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=16960’