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

From EPrints Documentation
Jump to: navigation, search
(3.1 Beta)
m
 
(109 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{Installation}}
+
[[Category:Debian and Ubuntu]]
 +
[[Category:Installation]]
  
David Tarrant has built a Debian/Ubuntu package for Eprints.
+
== 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.
  
===Stable Release===
+
== 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/
 +
 
 +
== 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 [https://github.com/eprints/eprints EPrints 3.3] or [https://github.com/eprints/eprints3.4 EPrints 3.4] Core Git repositories.'''
 +
 
 +
First, as the root user install all the dependencies for EPrints:
  
Add the following to /etc/apt/sources.list:
+
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 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
  
deb http://deb.eprints.org/ stable/
+
If you are installing on Ubuntu, install MySQL server and client:
deb-src http://deb.eprints.org/ source/
 
  
===Unstable Release===
+
  apt-get install mysql-server mysql-client
  
To install the latest '''unstable''' release add the following to /etc/apt/sources.list:
+
If you are installing on Debian, install MariaDB server and client:
  
deb http://deb.eprints.org/ unstable/
+
  apt-get install mariadb-server mariadb-client
deb-src http://deb.eprints.org/ source/
 
  
===*NEW* 3.1 Beta===
+
Next, create the eprints user
To install the latest 3.1 '''unstable''' release add the following to /etc/apt/sources.list:
 
  
  deb http://deb.eprints.org/3.1/ unstable/
+
  adduser eprints
deb http://deb.eprints.org/3.1/ source/
 
  
Do '''not''' add both the stable and unstable repositories.
+
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 via apt-get===
+
export APACHE_RUN_USER=eprints
 +
export APACHE_RUN_GROUP=eprints
  
To install Eprints and all its dependencies execute the following:
+
=== Downloading and Deploying EPrints Source ===
 +
==== EPrints 3.3.x for GitHub ====
  
  apt-get update
+
  apt install git
  apt-get install eprints
+
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.416
  
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):
+
==== 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
+
git checkout tags/v3.4.4
  logout
+
 
  a2ensite eprints3
+
==== EPrints 3.4.x from files.eprints.org ====
  apache2ctl reload
+
 
 +
  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
  
Known issues with the Debian/Ubuntu package can be found at [[Debian Known Issues]].
+
=== 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>
  
===Getting and Compiling from Source===
+
<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 install dependencies and retrieve the Eprints source execute the following:
+
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.
  
  apt-get update
+
=== Post-configuration ===
 +
Next, add the file <code>/etc/apache2/sites-available/eprints.conf</code> 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
 
  apt-get build-dep eprints
 +
==== Get EPrints source ====
 
  apt-get source eprints
 
  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.
 +
 +
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 ===
 +
{{:Issues with Installing EPrints on Ubuntu 18.04}}
 +
 +
=== Ubuntu 20.04 LTS ===
 +
{{:Issues with Installing EPrints on Ubuntu 20.04}}
 +
 +
=== Ubuntu 22.04 LTS ===
 +
{{:Issues with Installing EPrints on Ubuntu 22.04}}
  
The source will be saved to a tarball in the current directory.
+
=== Debian Known Issues ===
 +
See [[Debian Known Issues]]

Latest revision as of 13:39, 7 August 2022


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

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

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