Difference between revisions of "Configuration orientation"

From EPrints Documentation
Jump to: navigation, search
(Global vs Local configuration)
(add more categories for discoverability)
 
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{development}}
+
[[Category:Howto]]
 +
[[Category:Manual]]
 +
[[Category:Configuration]]
  
 
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.
 
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
 
  
 
__TOC__
 
__TOC__
Line 13: Line 13:
 
  /opt/eprints3/
 
  /opt/eprints3/
  
(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 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.
 
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.
Line 19: Line 19:
 
'''What about everything else?''' The EPrints installation directory contains several other files and directories, which are described in the [[EPrints Directory Structure]] section.
 
'''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==
+
==Local vs global configuration==
  
A single installation of EPrints can run multiple repositories, each potentially 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.
+
A single installation of EPrints can run multiple repositories, each potentially very different in style and functionality. Therefore, EPrints configuration files are divided into two default sets: ''global configuration'' and ''repository-specific configuration''. Each repository shares the global configuration settings, whilst keeping its own set of local (private) 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.
+
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). On the other hand, the repository-specific set contains the most often tweaked settings.
  
 
===The ''lib'' directory===
 
===The ''lib'' directory===
  
[[Image:Orientation_browse_lib.png]]
+
[[Image:Orientation_lib.png|right]]
  
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 is where the global configuration files are kept. '''This directory should be considered [[Read Only Directories|read only]]'''. Best practice when changing a global setting for a particular repository is to override the setting at the repository level rather than edit the global configuration files directly. The configuration files in ''lib'' are organised into subdirectories according to their function, which should help make locating a specific configuration setting intuitive.
  
'''Exercise:''' Take a moment to [[EPrints_Directory_Structure/eprints3/lib|explore the contents of the lib directory]].
+
[[EPrints_Directory_Structure/eprints3/lib|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.
 
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.
 +
 +
<br clear="all" />
  
 
===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.
+
[[Image:Orientation_cfg.png|right]]
 +
 
 +
Each repository has its own subdirectory (named according to the repository id) under the ''archives'' directory.  
 +
 
 +
Each repository directory contains several [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID|subdirectories]], including the ''cfg'' directory. This is where the repository-specific configuration files are kept.
 +
 
 +
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|Explore the contents of the cfg directory]].

Latest revision as of 02:48, 22 August 2018


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.

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.

Local vs global configuration

A single installation of EPrints can run multiple repositories, each potentially very different in style and functionality. Therefore, EPrints configuration files are divided into two default sets: global configuration and repository-specific configuration. Each repository shares the global configuration settings, whilst keeping its own set of local (private) 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). On the other hand, the repository-specific set contains the most often tweaked settings.

The lib directory

Orientation lib.png

The lib directory is where the global configuration files are kept. This directory should be considered read only. Best practice when changing a global setting for a particular repository is to override the setting at the repository level rather than edit the global configuration files directly. The configuration files in lib are organised into subdirectories according to their function, which should help make locating a specific configuration setting intuitive.

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

Orientation cfg.png

Each repository has its own subdirectory (named according to the repository id) under the archives directory.

Each repository directory contains several subdirectories, including the cfg directory. This is where the repository-specific configuration files are kept.

Explore the contents of the cfg directory.