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

From EPrints Documentation
Jump to: navigation, search
m
(recommend new host, because all current versions available)
 
(35 intermediate revisions by 2 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 16.04 LTS or 18.04 LTS (non-LTS versions not recommended) or Debian 8 (Jessie) or 9 (Stretch).
  
== Installing from EPrints 3.3.x DEB ==
+
== Installing from DEB ==
 +
<ol><li>As the root user create a file at <code>/etc/apt/sources.list.d/eprints.list</code> containing</li>
 +
<!--- http://deb.eprints.org/stable is the location of the 3.3 branch ... -->
 +
deb http://deb.eprints-hosting.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 - http://deb.eprints-hosting.org/keyFile | apt-key add -
 +
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.1
 +
</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>.
  
deb http://deb.eprints.org/ stable/
+
However, '''you will not yet have a running archive'''. Follow the [[Getting Started with EPrints 3]] instructions to set this up.
  
Installing Eprints via apt-get
+
Below are some [[Installing_EPrints_3_via_apt_(Debian/Ubuntu)#Operating_System_Version_Specific_Requirements | caveats for particular versions of Debian and Ubuntu]].
  
To install Eprints and all its dependencies execute the following (as root):
+
'''N.B. If you are installing EPrints ''3.4'' from the DEB package then you will ''only'' get the ''zero flavour''. If you want the publications flavour you will need to download the [https://files.eprints.org/2401/8/eprints-3.4.1-flavours.tar.gz flavours tarball] (see [[Installing_EPrints_3_via_apt_(Debian/Ubuntu)#Downloading_and_Deploying_EPrints_Source | Downloading and Deploying EPrints Source]] below) and copy the <code>./pub_lib</code> subdirectory into <code>/usr/share/eprints/flavours/</code>.  It is planned that future versions of EPrints 3.4 will have their own publication flavours DEB package.'''
  
apt-get update
+
== Installing EPrints from Source ==
  apt-get install eprints
+
 
 +
=== Dependencies and Pre-configuration ===
 +
 
 +
'''N.B. Installing from a source tarball 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 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:
 +
 
 +
  apt-get install perl libncurses5 libselinux1 libsepol1 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 lynx wget ghostscript xpdf antiword elinks texlive-base texlive-base-bin \
 +
  psutils imagemagick adduser tar gzip mysql-server mysql-client unzip libsearch-xapian-perl libtex-encode-perl
 +
 
 +
Next, create the eprints user
 +
 
 +
adduser eprints
 +
 
 +
 
 +
Next, as the eprints user copy /opt/eprints3/perl_lib/EPrints/SystemSettings.pm.tmpl to /opt/eprints3/perl_lib/EPrints/SystemSettings.pm
 +
 
 +
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
  
=== Setting up a Repository ===
+
=== Downloading and Deploying EPrints Source ===
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.3.x for GitHub ====
  
'''For more information about setting up an EPrints repository take a look at [[Getting Started with EPrints 3]]'''
+
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 .
  
<b>Read First: Known issues with the Debian/Ubuntu package can be found at [[Debian Known Issues]].</b>
+
==== EPrints 3.4.x for GitHub ====
  
  su eprints
+
  apt-get install git
cd
+
  git clone https://github.com/eprints/eprints3.4.git /opt/eprints3
  ./bin/epadmin create
+
  cd /opt/eprints3/
  logout
+
  git checkout tags/v3.4.1
  a2ensite eprints3
+
  chown -R eprints:eprints .
  apache2ctl restart
+
  
 +
==== EPrints 3.4.x from files.eprints.org ====
  
If you have any problems getting set up you can get free help and support from the EP-Tech mailing list. {{EPrintsTech}}
+
cd /tmp/
 +
wget https://files.eprints.org/2401/7/eprints-3.4.1.tar.gz
 +
tar -xzvf eprints-3.4.1.tar.gz
 +
 +
Then put in the source code in place:
  
== Installing EPrints 3.3.x from Source ==
+
mv eprints-3.4.1 /opt/eprints3
'''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].'''
+
  chmod 2775 /opt/eprints3
 +
chown -R eprints:eprints /opt/eprints3
  
...
+
If you want a publications flavoured repository, then also:
  
== Getting Started ==
+
wget https://files.eprints.org/2401/8/eprints-3.4.1-flavours.tar.gz
 +
tar -xzvf eprints-3.4.1-flavours.tar.gz
 +
mv eprints-3.4.1/flavours/pub_lib/ /opt/eprints3/flavours/
 +
chmod -R g+w /opt/eprints3/flavours/pub_lib
 +
chown -R eprints:eprints /opt/eprints3/flavours/pub_lib/
  
See [[Getting Started with EPrints 3]].
+
=== Configuration ===
 +
Next, as the eprints user copy /opt/eprints3/perl_lib/EPrints/SystemSettings.pm.tmpl to /opt/eprints3/perl_lib/Eprints/SystemSettings.pm
  
 +
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.
  
== Troubleshooting ==
+
=== Post-configuration ===
 +
Next, add the file /etc/apache2/sites-available/eprints.conf with the following line:
  
===Issues with Ubuntu 14.04 (Apache 2.3/2.4)===
+
Include EPRINTS_PATH/cfg/apache.conf
  
Apache 2.3+ and PERL v5.16+ introduce a few changes which break EPrints.
+
EPRINTS_PATH will be either /opt/eprints3/ or /usr/share/eprints depending on which instructions you followed above.
  
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]
+
To enable this as root run the command:
  
Current patches on github are:
+
a2ensite eprints
  
* See last comment on https://github.com/eprints/eprints/issues/214  [ use of remote_ip ]
+
Finally, restart Apache:
* 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 ]
+
  
 +
apachectl restart
  
Ensure that mpm_prefork module is enabled in /etc/apache2/mods-enabled (among others).
+
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.
  
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)
+
== Operating System Version Specific Requirements ==
  
*access_compat.load                   
+
=== Ubuntu 18.04 LTS ===
*alias.conf                                   
+
{{:Issues with Installing EPrints on Ubuntu 18.04}}
*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 15:59, 2 August 2019


Requirements

  • Ubuntu 16.04 LTS or 18.04 LTS (non-LTS versions not recommended) or Debian 8 (Jessie) or 9 (Stretch).

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-hosting.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 - http://deb.eprints-hosting.org/keyFile | apt-key add -
    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.1
    

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.

N.B. If you are installing EPrints 3.4 from the DEB package then you will only get the zero flavour. If you want the publications flavour you will need to download the flavours tarball (see Downloading and Deploying EPrints Source below) and copy the ./pub_lib subdirectory into /usr/share/eprints/flavours/. It is planned that future versions of EPrints 3.4 will have their own publication flavours DEB package.

Installing EPrints from Source

Dependencies and Pre-configuration

N.B. Installing from a source tarball 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 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 libsepol1 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 lynx wget ghostscript xpdf antiword elinks texlive-base texlive-base-bin \
  psutils imagemagick adduser tar gzip mysql-server mysql-client unzip libsearch-xapian-perl libtex-encode-perl

Next, create the eprints user

adduser eprints


Next, as the eprints user copy /opt/eprints3/perl_lib/EPrints/SystemSettings.pm.tmpl to /opt/eprints3/perl_lib/EPrints/SystemSettings.pm

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

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

apt-get install git
git clone https://github.com/eprints/eprints3.4.git /opt/eprints3
cd /opt/eprints3/
git checkout tags/v3.4.1
chown -R eprints:eprints .

EPrints 3.4.x from files.eprints.org

cd /tmp/
wget https://files.eprints.org/2401/7/eprints-3.4.1.tar.gz
tar -xzvf eprints-3.4.1.tar.gz

Then put in the source code in place:

mv eprints-3.4.1 /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/2401/8/eprints-3.4.1-flavours.tar.gz
tar -xzvf eprints-3.4.1-flavours.tar.gz
mv eprints-3.4.1/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 /opt/eprints3/perl_lib/EPrints/SystemSettings.pm.tmpl to /opt/eprints3/perl_lib/Eprints/SystemSettings.pm

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.

Post-configuration

Next, add the file /etc/apache2/sites-available/eprints.conf with the following line:

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:

a2ensite eprints

Finally, restart Apache:

apachectl 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 18.04 LTS

N.B. It is assumed that you are installing the latest version of 3.4 (currently 3.4.1). 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. 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;