EPrints configuration

From EPrints Documentation
Revision as of 14:07, 8 February 2010 by Pm705 (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Warning This page is under development as part of the EPrints 3.0 manual. It may still contain content specific to earlier versions. Manuals for previous versions of EPrints are also available.
Manual Sections

This page deals with configuring the software.

See also: repository configuration

EPrints General Configuration

This section describes all the configuration files in the EPrints system which do not relate to any specific archive.

EPrints Configuration Directory

The general EPrints configuration directory is usually /opt/eprints2/cfg/ and contains the following files:

apache.conf 
This file is generated by generate_apacheconf. See the documentation of generate_apacheconf for more information.
auto-apache.conf 
This file is generated and overwritten by generate_apacheconf. Do not edit it directly. See the documentation of generate_apacheconf for more information.
auto-apache-includes.conf 
This file is generated and overwritten by generate_apacheconf. Do not edit it directly. See the documentation of generate_apacheconf for more information.
languages.xml 
This XML file contains an (exhaustive) list of all ISO language ID's and their names.
system-phrases-languageid.xml 
One of these files per language needed for any archive in this system. These files contain the phrases needed to render the website and email in each language, not counting names of things like metadata fields which vary between archives. It should not be edited by hand, but may be overridden. See the instructions on phrase files in the archive config documentation.
SystemSettings.pm 
Described below.

SystemSettings.pm

This is a perl module which is created and edited by the eprints installer script when installing or upgrading EPrints. It's found in perl-lib/EPrints/

SystemSettings contains system specific things:

base_path 
The root directory of your eprints install. Normally /opt/eprints2/
executables 
A hash of the path of various external commands such as sendmail and wget.
invocation 
A hash of how eprints is to invoke various external commands. The variables with uppercase names - $(FOO) - are replaced with parameters from eprints, the lowercase names - $(sendmail) - are replaced with the strings in executables.
archive_formats 
An array of id's of archive formats offered in the upload document page. For each their must be an entry in the archive_extension and invocation, $(DIR) is the where eprints wants the contents of the archive and $(ARC) is the archive file.
version_id  
The id of the current eprints version.
version  
The human readable version number.
user  
The UNIX user eprints will run as. Usually "eprints".
group  
The UNIX user eprints will run as. Usually "eprints".
virtualhost (Since v2.1) 
If this is set, it is used for the VirtualHostName in the Apache configuration files. (By default EPrints uses "*").
disable_df (Since v2.1) 
If this is set to 1 then this disables the parts of EPrints which use the df call (disk free). If the "configure" script tested the "df" command and found that it failed the this function will initially be set to 1, otherwise 0.
enable_gdome (Since v2.2) 
If this is set to 1 then it enables the use of the XML::GDOME module, rather than XML::DOM. XML::GDOME is faster and less memory intensive but depends on a number of other libraries and modules which are not worth installing for a trial system.