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

From EPrints Documentation
Jump to: navigation, search
(→‎Installing from Debian package: Removed section)
 
(111 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 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 from EPrints 3.3.x DEB ==
+
=== Dependencies and Pre-configuration ===
−
As the root user create a file at /etc/apt/sources.list.d/eprints.list and add the following line
+
'''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.'''
  
−
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 ('''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):
  
−
  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-binaries psutils imagemagick adduser tar gzip unzip libsearch-xapian-perl \
 +
  libtex-encode-perl libio-string-perl python3-html2text make libexpat1-dev libxslt1-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 Ubuntu, install MySQL server and client:
  
 +
  apt-get install mysql-server mysql-client libmysqlclient-dev
  
−
== Installing EPrints 3.3.x from Source ==
+
If you are installing on Debian, install MariaDB server and client:
−
'''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].'''
 
  
−
...
+
  apt-get install mariadb-server mariadb-client libmariadb-dev
  
−
EPrints will now be 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.
+
Next, create the eprints user
  
 +
useradd eprints
  
−
== Troubleshooting ==
+
Now add the eprints user to the www-data group and vice-versa
  
−
===Issues with Ubuntu 14.04 (Apache 2.3/2.4)===
+
usermod -a -G eprints www-data
 +
usermod -a -G www-data eprints
  
−
Apache 2.3+ and PERL v5.16+ introduce a few changes which break EPrints.
+
=== Downloading and Deploying EPrints Source ===
  
−
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]
+
==== EPrints 3.4.x for GitHub ====
  
−
Current patches on github are:
+
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
  
−
* See last comment on https://github.com/eprints/eprints/issues/214  [ use of remote_ip ]
+
==== EPrints 3.4.x from files.eprints.org ====
−
* 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 ]
 
  
 +
cd /tmp/
 +
wget https://files.eprints.org/3097/5/eprints-3.4.6.tar.gz
 +
tar -xzvf eprints-3.4.6.tar.gz
  
−
Ensure that mpm_prefork module is enabled in /etc/apache2/mods-enabled (among others).
+
Then put in the source code in place:
  
−
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)
+
mv eprints-3.4.6 /opt/eprints3
 +
chmod 2775 /opt/eprints3
 +
chown -R eprints:eprints /opt/eprints3
  
−
*access_compat.load                   
+
If you want a publications flavoured repository, then also:
−
*alias.conf                                   
+
 
−
*alias.load                             
+
wget https://files.eprints.org/3097/6/eprints-3.4.6-flavours.tar.gz
−
*auth_basic.load                           
+
tar -xzvf eprints-3.4.6-flavours.tar.gz
−
*authn_core.load
+
mv eprints-3.4.6/flavours/pub_lib /opt/eprints3/flavours
−
*authn_file.load
+
chmod -R g+w /opt/eprints3/flavours/pub_lib
−
*authz_core.load
+
chown -R eprints:eprints /opt/eprints3/flavours/pub_lib
−
*authz_host.load
+
 
−
*authz_user.load
+
== Configuration ==
−
*autoindex.conf
+
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.
−
*autoindex.load
+
 
−
*deflate.conf
+
<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.
−
*deflate.load
+
 
−
*dir.conf
+
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.
−
*dir.load
+
 
−
*env.load
+
=== Post-configuration ===
−
*filter.load
+
Next, add the file <code>/etc/apache2/sites-available/eprints.conf</code> with the following line:
−
*mime.conf
+
 
−
*mime.load
+
Include EPRINTS_PATH/cfg/apache.conf
−
*mpm_prefork.conf
+
 
−
*mpm_prefork.load
+
To enable this as root run the command:
−
*negotiation.conf
+
 
−
*negotiation.load
+
root> a2ensite eprints
−
*perl.load
+
 
−
*php5.conf
+
Also it may be necessary to disable the default site otherwise the default Apache page will still be shown:
−
*php5.load
+
 
−
*setenvif.conf
+
a2dissite 000-default
−
*setenvif.load
+
 
−
*status.conf
+
Finally, restart Apache:
−
*status.load
+
 
 +
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 20.04 LTS ===
 +
{{:Issues with Installing EPrints on Ubuntu 20.04}}
 +
 
 +
=== Ubuntu 22.04 LTS ===
 +
{{:Issues with Installing EPrints on Ubuntu 22.04}}
 +
 
 +
=== Ubuntu 24.04 LTS ===
 +
{{:Issues with Installing EPrints on Ubuntu 24.04}}
 +
 
 +
=== Debian Known Issues ===
 +
See [[Debian Known Issues]]

Latest revision as of 17:00, 31 July 2025


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.

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

useradd 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 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=16908’