Difference between revisions of "Configuration orientation"

From EPrints Documentation
Jump to: navigation, search
Line 15: Line 15:
 
(you may have chosen a different installation directory when you installed EPrints).
 
(you may have chosen a different installation directory when you installed EPrints).
  
There are several sub-directories at this level, but from a configuration perspective we are interested only in the ''lib'' directory and the ''archives'' directories. Before looking at the contents of these directories, we need to understand the concepts of ''global'' and ''repository-specific'' (or sometimes ''local'') configuration.
+
There are several sub-directories at this level, but this guide covers only those relevant to repository configuration - the ''lib'' and ''archives'' directories. Before looking at the contents of these directories, we need to understand the concepts of ''global'' and ''repository-specific'' (or ''local'') configuration.
 +
 
 +
'''What about everything else?''' The EPrints installation directory contains several other files and directories, which are described in the [[EPrints Directory Structure]] section.
  
 
==Global vs Local configuration==
 
==Global vs Local configuration==
  
A single installation of EPrints on a server can run multiple repositories, which may each be very different in style and functionality. Therefore, EPrints divides its many configuration files into two default sets: global configuration files and repository-specific configuration files. Multiple repositories under the same installation of EPrints share the global configuration files, but each repository has its own set of repository-specific configuration files.
+
A single installation of EPrints can run multiple repositories, each very different in style and functionality. Therefore, EPrints configuration files are divided into two default sets: ''global configuration files'' and ''repository-specific configuration files''. Each repository shares the global configuration settings, whilst keeping its own set of local configuration settings.
  
EPrints strikes a sensible balance between the two. The default global set contains the configuration options that you are probably least likely to need to change (although this is by no means set in stone - you can override a global configuration setting for a specific repository if you need to), whereas the repository-specific sets, on the other hand, contain the most often tweaked configuration settings.
+
EPrints tries to strike a sensible balance between the two sets. The global set contains the configuration options that you are probably least likely to need to change (although they are by no means unchangeable - you can override a global setting for a specific repository if you need to), whereas the repository-specific set, on the other hand, contains the most often tweaked settings.
 
+
'''What about everything else?''' The EPrints installation directory contains several other files and directories, which are described in the [[EPrints Directory Structure]] section of the Technical Reference.
+
  
 
===The ''lib'' directory===
 
===The ''lib'' directory===
Line 29: Line 29:
 
[[Image:Orientation_browse_lib.png]]
 
[[Image:Orientation_browse_lib.png]]
  
The lib directory is where the global configuration files are kept.
+
The lib directory is where the global configuration files are kept. '''This directory should be considered [[Read Only Directories|read only]]''' - to change a global setting for a particular repository, override the setting in the repository-specific configuration rather than edit the global configuration file directly. The configuration files in ''lib'' are organised into subdirectories according to their function, which should make finding a specific configuration file easier.
 
+
The lib directory should be considered a [[Read Only Directories|read only directory]] - to make changes to a configuration setting you should override the setting in the repository-specific configuration rather than editing a configuration file in lib directly.
+
 
+
The files in ''lib'' are organised into subdirectories according to their function, which should make finding a specific configuration file easier.
+
  
[[EPrints_Directory_Structure/eprints3/lib|Explore the subdirectores]]
+
'''Exercise:''' Take a moment to [[EPrints_Directory_Structure/eprints3/lib|explore the contents of the lib directory]].
  
Take note of the ''defaultcfg'' subdirectory, which is the default set of configuration files that get copied into each new repository's local configuration directory, covered in the next section.
+
Note that the ''defaultcfg'' subdirectory contains the default set of configuration files that are copied into each new repository's local configuration directory. These local configuration directories are covered in the next section.
  
 
===The ''archives'' directory===
 
===The ''archives'' directory===
  
 
Each repository under the same installation of EPrints has its own subdirectory (named after the repository ID specified when creating the repository) under the archives directory. Each of these subdirectories contain the repository-specific configuration files (amongst other files) for that particular repository.
 
Each repository under the same installation of EPrints has its own subdirectory (named after the repository ID specified when creating the repository) under the archives directory. Each of these subdirectories contain the repository-specific configuration files (amongst other files) for that particular repository.

Revision as of 16:36, 24 January 2007

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.

You've just installed EPrints 3 and created a repository, and now you're keen to get started on customising it. Before diving into the how-tos, take some time to read through this brief orientation guide and familiarise yourself with the EPrints configuration landscape.

http://www.sxc.hu/pic/m/o/or/orek/17862_landscape.jpg

Where are the configuration files?

The default installation directory for EPrints is:

/opt/eprints3/

(you may have chosen a different installation directory when you installed EPrints).

There are several sub-directories at this level, but this guide covers only those relevant to repository configuration - the lib and archives directories. Before looking at the contents of these directories, we need to understand the concepts of global and repository-specific (or local) configuration.

What about everything else? The EPrints installation directory contains several other files and directories, which are described in the EPrints Directory Structure section.

Global vs Local configuration

A single installation of EPrints can run multiple repositories, each very different in style and functionality. Therefore, EPrints configuration files are divided into two default sets: global configuration files and repository-specific configuration files. Each repository shares the global configuration settings, whilst keeping its own set of local configuration settings.

EPrints tries to strike a sensible balance between the two sets. The global set contains the configuration options that you are probably least likely to need to change (although they are by no means unchangeable - you can override a global setting for a specific repository if you need to), whereas the repository-specific set, on the other hand, contains the most often tweaked settings.

The lib directory

Orientation browse lib.png

The lib directory is where the global configuration files are kept. This directory should be considered read only - to change a global setting for a particular repository, override the setting in the repository-specific configuration rather than edit the global configuration file directly. The configuration files in lib are organised into subdirectories according to their function, which should make finding a specific configuration file easier.

Exercise: Take a moment to explore the contents of the lib directory.

Note that the defaultcfg subdirectory contains the default set of configuration files that are copied into each new repository's local configuration directory. These local configuration directories are covered in the next section.

The archives directory

Each repository under the same installation of EPrints has its own subdirectory (named after the repository ID specified when creating the repository) under the archives directory. Each of these subdirectories contain the repository-specific configuration files (amongst other files) for that particular repository.