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

From EPrints Documentation
Jump to: navigation, search
(→‎Adding an archive)
(→‎Useful commands for source development and testing)
 
(91 intermediate revisions by 4 users not shown)
Line 3: Line 3:
  
 
== Requirements ==
 
== Requirements ==
−
* Ubuntu 14.04 LTS, 16.04 LTS or 18.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 ==
+
== Installing EPrints from Source ==
−
The latest version of EPrints 3.3 is 3.3.16.  This version can be installed as follows
 
  
−
1. As the root user create a file at /etc/apt/sources.list.d/eprints.list and add the following line:
+
=== Dependencies and Pre-configuration ===
−
deb http://deb.eprints.org/stable ./
+
'''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.'''
−
2. Now to install EPrints and all its dependencies execute the following command, again as the root user:
 
−
wget -O - http://deb.eprints.org/keyFile | apt-key add -
 
−
apt-get update
 
−
apt-get install eprints
 
  
−
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.  Below are some caveats for particular version of Debian and Ubuntu.
+
'''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 3.3.x or 3.4.x from Source ==
+
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):
  
−
=== Dependencies and Pre-configuration ===
+
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:
  
−
'''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 mysql-server mysql-client libmysqlclient-dev
  
−
First, as the root user install all the dependencies for EPrints:
+
If you are installing on Debian, install MariaDB server and client:
  
−
apt-get install perl libncurses5 libselinux1 libsepol1 apache2 libapache2-mod-perl2 libxml-libxml-perl libunicode-string-perl \
+
  apt-get install mariadb-server mariadb-client libmariadb-dev
−
  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 texlive-base texlive-base-bin \
 
−
  psutils imagemagick adduser tar gzip mysql-server mysql-client unzip libsearch-xapian-perl
 
  
 
Next, create the eprints user
 
Next, create the eprints user
Line 34: Line 34:
 
  useradd eprints
 
  useradd eprints
  
 +
Now add the eprints user to the www-data group and vice-versa
  
−
 
+
usermod -a -G eprints www-data
−
Next, as the eprints user copy /opt/eprints3/perl_lib/EPrints/SystemSettings.pm.tmpl to /opt/eprints3/perl_lib/EPrints/SystemSettings.pm
+
  usermod -a -G www-data eprints
−
 
 
−
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.
 
−
 
 
−
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 ===
 
=== Downloading and Deploying EPrints Source ===
−
==== EPrints 3.3.x for GitHub ====
 
−
 
−
apt-get install git
 
−
git clone https://github.com/eprints/eprints.git /opt/eprints3
 
−
cd /opt/eprints3/
 
−
git checkout tags/v3.3.16
 
−
chown -R eprints:eprints .
 
  
 
==== EPrints 3.4.x for GitHub ====
 
==== EPrints 3.4.x for GitHub ====
  
−
  apt-get install git
+
  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 clone https://github.com/eprints/eprints3.4.git /opt/eprints3
 
  cd /opt/eprints3/
 
  cd /opt/eprints3/
−
  git checkout tags/v3.4.0
+
  git checkout tags/v3.4.6
−
chown -R eprints:eprints .
 
  
 
==== EPrints 3.4.x from files.eprints.org ====
 
==== EPrints 3.4.x from files.eprints.org ====
  
 
  cd /tmp/
 
  cd /tmp/
−
  wget https://files.eprints.org/2305/4/eprints-3.4.0.tar.gz
+
  wget https://files.eprints.org/3097/5/eprints-3.4.6.tar.gz
−
  tar -xzvf eprints-3.4.0.tar.gz
+
  tar -xzvf eprints-3.4.6.tar.gz
−
 
−
If you want a publications flavoured repository, then also:
 
  
−
wget https://files.eprints.org/2305/5/eprints-3.4.0-flavours.tar.gz
+
Then put in the source code in place:
−
tar -xzvf eprints-3.4.0-flavours.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
  
−
mv eprints-3.4.0 /opt/eprints3
+
If you want a publications flavoured repository, then also:
−
chmod 2775 /opt/eprints3
 
−
chown -R eprints:eprints /opt/eprints3
 
  
−
=== Adding an archive ===
+
wget https://files.eprints.org/3097/6/eprints-3.4.6-flavours.tar.gz
−
If you have installed from the package you will be provided instructions on how to create a new archive.  For those installing from source, you will need to run the following for 3.3 as the eprints user:
+
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
  
−
  /opt/eprints3/bin/epadmin create
+
== 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.
  
−
If you are running EPrints 3.4 you will need to run the same command with a suffix of '''pub''' or '''zero''' to indicate the flavour (or lack of) repository archive you want. You will then be given guided instructions for setting up your archive.
+
== 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.
  
−
If you already have a repository you want to copy across, as the root user, justcreate a archives directory owned by the eprints user and copy the archive in as a subdirectory:
+
<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.
  
−
mkdir /opt/eprints3/archives/
+
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.
−
mv /PATH_TO/myarchive /opt/eprints3/archives/
 
−
chown -R eprints:eprints /opt/eprints3/archives
 
  
 
=== Post-configuration ===
 
=== Post-configuration ===
−
Next, add the file /etc/apache2/sites-available/eprints.conf with the following line:
+
Next, add the file <code>/etc/apache2/sites-available/eprints.conf</code> with the following line:
  
 
  Include EPRINTS_PATH/cfg/apache.conf
 
  Include EPRINTS_PATH/cfg/apache.conf
−
 
−
EPRINTS_PATH will be either /opt/eprints3/ or /usr/share/eprints depending on which instructions you followed above.
 
  
 
To enable this as root run the command:
 
To enable this as root run the command:
  
 
  a2ensite eprints
 
  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:
 
Finally, restart Apache:
  
−
  apachectl restart
+
  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 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 ==
 
== Operating System Version Specific Requirements ==
  
 +
=== Ubuntu 20.04 LTS ===
 +
{{:Issues with Installing EPrints on Ubuntu 20.04}}
  
−
=== Ubuntu 18.04 LTS ===
+
=== Ubuntu 22.04 LTS ===
−
==== epadmin script errors with Perl version ====
+
{{:Issues with Installing EPrints on Ubuntu 22.04}}
−
When trying to run epadmin you will may see a couple of error messages that prevents you from creating an archive, especially if you are using the 3.4.0 tarball from files.eprints.org:
 
−
 
 
−
Experimental keys on scalar is now forbidden at EPRINTS_PATH/bin/epadmin line 384
 
−
 
 
−
To fix this add the following line at the top of the epadmin file just after the ''use'' lines:
 
−
 
 
−
no if $] >= 5.017011, warnings => 'experimental::smartmatch';
 
−
 
 
−
A second error message you may see is:
 
−
 
 
−
Type of arg 1 to keys must be hash or array (not single ref constructor) at /usr/share/eprints/bin/epadmin line 384, near "};"
 
−
 
 
−
Go to the line number reported and change it to:
 
−
 
 
−
my @flavours = keys %{$conf->{flavours}};
 
−
 
 
−
You should now be able to run "epadmin create" without issue.
 
−
 
 
−
==== 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.  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;
 
−
 
 
−
 
 
−
=== Ubuntu 14.04 LTS and Debian 8 onwards ===
 
−
This operating system versions use Apache 2.3+ and PERL v5.16+ introduce a few changes which break older 3.3.x versions EPrints.  The current versions of EPrints 3.3.16 and 3.4.0 should not suffer from the same issues.
 
−
 
 
−
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:
 
−
 
 
−
* See last comment on https://github.com/eprints/eprints/issues/214  [ use of remote_ip ]
 
−
* 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 ]
 
−
 
 
−
Ensure that mpm_prefork module is enabled in /etc/apache2/mods-enabled (among others).
 
  
−
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 17:26, 10 March 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.

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

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

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