Difference between revisions of "Installation"

From EPrints Documentation
Jump to: navigation, search
m (formatting, apache.conf needs to be generated first)
(Added info about downloading EPrints.)
 
(10 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{development}}
 
 
{{manual}}
 
{{manual}}
 +
[[Category:Installation]]
 +
'''Below describes installing EPrints on a generic Linux distribution.  It is recommended that EPrints is installed on either [[Installing EPrints on RHEL/Fedora/CentOS|Red Hat based]] or [[Installing EPrints on Debian/Ubuntu|Debian based]] Linux.'''
 +
 +
==Download==
 +
EPrints can be downloaded from https://files.eprints.org/
 +
 
==Installation==
 
==Installation==
(If you are upgrading an existing installation of eprints please see the section on upgrading elsewhere in this manual.)
+
''If you are upgrading an existing installation of eprints please see the section on [[Upgrading]] section of this manual.''
  
 
EPrints needs to be installed as the same user as the apache webserver runs as. We suggest you install it as user "eprints" and group "eprints". Under some UNIX platforms, creating a user and group can be done using the "adduser" command. Otherwise refer to your operating system documentation.
 
EPrints needs to be installed as the same user as the apache webserver runs as. We suggest you install it as user "eprints" and group "eprints". Under some UNIX platforms, creating a user and group can be done using the "adduser" command. Otherwise refer to your operating system documentation.
Line 18: Line 23:
 
By default the system installs as user and group "eprints". You will need to change this if you are not installing as either "root" or "eprints".
 
By default the system installs as user and group "eprints". You will need to change this if you are not installing as either "root" or "eprints".
  
The configure script accepts a number of options. All are optional. The most important are:
+
The configure script accepts a number of options.  
  
 
; --help : List all the options (many are intended for compiled software and are ignored).
 
; --help : List all the options (many are intended for compiled software and are ignored).
; --prefix=PREFIX : Where to install EPrints (or look for a version to upgrade). By default /opt/eprints3/
+
 
; --with-perl=[PATH] : Path of perl interpreter (in case configure can't find it, or you have more than one and want to use a specific one).
+
Recommended:
 +
 
 +
; --prefix=PREFIX : Where to install EPrints (or look for a version to upgrade). By default <tt>/opt/eprints3/</tt>
 +
; --with-smtp-server=[HOST] : Use HOST to deliver mail. If the server running EPrints has an MTA such as <tt>exim</tt> or <tt>sendmail</tt>, you can specify '''localhost'''. If you do not specify this option, you will get a warning to configure it later.
 
; --with-user=[USER] : Install eprints to run as USER. By default "eprints".
 
; --with-user=[USER] : Install eprints to run as USER. By default "eprints".
 
; --with-group=[GROUP] : Install eprints to run as GROUP. By default "eprints".
 
; --with-group=[GROUP] : Install eprints to run as GROUP. By default "eprints".
 +
 +
Optional:
 +
 +
; --with-perl=[PATH] : Path of perl interpreter (in case configure can't find it, or you have more than one and want to use a specific one).
 
; --with-virtualhost=[VIRTUALHOST] : Use VIRTUALHOST rather than * for apache VirtualHost directives.
 
; --with-virtualhost=[VIRTUALHOST] : Use VIRTUALHOST rather than * for apache VirtualHost directives.
; --disable-diskfree : Disable disk free space calls. This will be automatically set if configure fails its tests for the df call.
 
 
; --with-toolpath=[PATH] : An alternate path to search for the required binaries.
 
; --with-toolpath=[PATH] : An alternate path to search for the required binaries.
 +
; --disable-diskfree : Disable disk free space calls. These can cause problems on some platforms, notably 64-bit.
 +
 +
Deprecated:
 +
 +
; --with-apache=1 : Use Apache 1.x.x instead of 2.x.x, but EPrints 3 does not support this.
  
 
Once you are happy with your configuration you may install eprints by running install.pl:
 
Once you are happy with your configuration you may install eprints by running install.pl:
Line 37: Line 53:
 
Add this line: (If you didn't install eprints in <tt>/opt/eprints3/</tt> replace that with the location on your system).
 
Add this line: (If you didn't install eprints in <tt>/opt/eprints3/</tt> replace that with the location on your system).
 
  Include /opt/eprints3/cfg/apache.conf
 
  Include /opt/eprints3/cfg/apache.conf
Note that this file is only available after you created your archive via <tt>epadmin create</tt>.
+
Note that this file is only available after you created your archive via <tt>epadmin create</tt>. See [[Getting_Started_with_EPrints_3#Running_epadmin|Running epadmin]] for more information on creating an archive.
  
You may also wish to change the user and group apache runs as. The user ''must'' be the same as the user you installed eprints as. We recommend:
+
You need to make sure the apache user have read/write access to the installation directory (/opt/eprints3). The user ''must'' be the same as the user you installed eprints as. We recommend to configure your apache to run as:
  
 
  User eprints
 
  User eprints
 
  Group eprints
 
  Group eprints

Latest revision as of 23:46, 23 February 2021

Manual Sections

Below describes installing EPrints on a generic Linux distribution. It is recommended that EPrints is installed on either Red Hat based or Debian based Linux.

Download

EPrints can be downloaded from https://files.eprints.org/

Installation

If you are upgrading an existing installation of eprints please see the section on Upgrading section of this manual.

EPrints needs to be installed as the same user as the apache webserver runs as. We suggest you install it as user "eprints" and group "eprints". Under some UNIX platforms, creating a user and group can be done using the "adduser" command. Otherwise refer to your operating system documentation.

Unpack the eprints tar.gz file:

% gunzip eprints-3.something.tar.gz
% tar xf eprints-3.something.tar

Now run the "configure" script. This is a /bin/sh script which will attempt to locate various parts of your system such as the perl binary. It will also check your system for required components.

% cd eprints-3.something
% ./configure

By default the system installs as user and group "eprints". You will need to change this if you are not installing as either "root" or "eprints".

The configure script accepts a number of options.

--help 
List all the options (many are intended for compiled software and are ignored).

Recommended:

--prefix=PREFIX 
Where to install EPrints (or look for a version to upgrade). By default /opt/eprints3/
--with-smtp-server=[HOST] 
Use HOST to deliver mail. If the server running EPrints has an MTA such as exim or sendmail, you can specify localhost. If you do not specify this option, you will get a warning to configure it later.
--with-user=[USER] 
Install eprints to run as USER. By default "eprints".
--with-group=[GROUP] 
Install eprints to run as GROUP. By default "eprints".

Optional:

--with-perl=[PATH] 
Path of perl interpreter (in case configure can't find it, or you have more than one and want to use a specific one).
--with-virtualhost=[VIRTUALHOST] 
Use VIRTUALHOST rather than * for apache VirtualHost directives.
--with-toolpath=[PATH] 
An alternate path to search for the required binaries.
--disable-diskfree 
Disable disk free space calls. These can cause problems on some platforms, notably 64-bit.

Deprecated:

--with-apache=1 
Use Apache 1.x.x instead of 2.x.x, but EPrints 3 does not support this.

Once you are happy with your configuration you may install eprints by running install.pl:

% ./install.pl

Now you should edit the configuration file for your copy of apache. This is often /usr/local/apache/conf/http.conf or /etc/httpd/conf/httpd.conf

Add this line: (If you didn't install eprints in /opt/eprints3/ replace that with the location on your system).

Include /opt/eprints3/cfg/apache.conf

Note that this file is only available after you created your archive via epadmin create. See Running epadmin for more information on creating an archive.

You need to make sure the apache user have read/write access to the installation directory (/opt/eprints3). The user must be the same as the user you installed eprints as. We recommend to configure your apache to run as:

User eprints
Group eprints