Difference between revisions of "Installing EPrints on Debian/Ubuntu"
m |
(→Installing from Debian package: Removed section) |
||
| (107 intermediate revisions by 5 users not shown) | |||
| Line 3: | Line 3: | ||
== Requirements == | == Requirements == | ||
| − | * Ubuntu | + | * 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 [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.''' | ||
| + | '''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|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 | ||
| − | EPrints | + | == 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. | ||
| − | + | <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. | |
| − | + | 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. | |
| − | |||
| − | Next, add the file /etc/apache2/sites-available/eprints.conf with the following line: | + | === Post-configuration === |
| + | Next, add the file <code>/etc/apache2/sites-available/eprints.conf</code> with the following line: | ||
| − | Include | + | Include EPRINTS_PATH/cfg/apache.conf |
To enable this as root run the command: | To enable this as root run the command: | ||
| − | a2ensite eprints | + | 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: | Finally, restart Apache: | ||
| Line 75: | Line 94: | ||
service apache2 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 == | |
| − | + | === 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 PRIVILEGEScommand 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.
