Evergreen File Structure and Configuration Files
This section will describe the basic file structure and cover key configuration files. Understanding the directory and file structure of Evergreen will allow you
to be able to customize your Evergreen software and take full advantage of many features.
Evergreen Directory Structure
This is the top level directory structure of Evergreen located in the default installation directory /openils:
Evergreen Directory Structure
Directory
Description
bin
Contains many critical Perl and shell scripts such as autogen.sh and
oils.ctl.
conf
Contains the configuration scripts including the two most important base configuration files opensrf_core.xml and opensrf.xml.
include
Contains the header files used by the scripts written in C.
lib
Contains the core code of Evergreen including the C code and perl modules. In particular, the perl modules in the
subdirectoryperl5/OpenILS
are of particular interest to developers.
var
Largest directory and includes the web directories (web), lock pid fies
(run), circ setting files (circ) templates
(templates) and log (templates and
data) files.
Evergreen Configuration Files
Key Evergreen Configuration Files
File
Description
/openils/conf/opensrf_core.xmlconfiguration files
opensrf_core.xml
Files which controls which Evergreen services are run on the public and private routers. For a service to run, it must be registered in this file. This file also controls the loglevel and points to the log file for the services. An Evergreen restart is required for changes to take effect.
/openils/conf/opensrf.xmlconfiguration filesopensrf.xml
Use this file to set directory locations, the default locale, default notice settings and settings for all Evergreen services.
It is critical for any administrator to understand the settings in this file. An Evergreen restart is required for changes to take effect.
/openils/conf/fm_IDL.xml configuration filesfm_IDL.xml
Used for linking the OpenSRF/Evergreen services to the Evergreen database tables. An Evergreen restart is required for changes to take
effect. Running autogen.sh is also required.
/etc/apache2/eg_vhost.confconfiguration filesApache
Controls the Evergreen virtual site. Allows to configure the skin for the OPAC or configure various directories within the Apache web server.
An Apache restart is required for changes to this file to take effect.
Useful Evergreen Scripts
File
Description
/openils/bin/autogen.shautogen
Used to update changes to org units and the fm_IDL.xml file. Will generate web and staff client pages based on contents of files and
Evergreen database entries.
/openils/bin/clark-kent.plreportsstarting
Perl script for starting the reporter.
/openils/bin/action_trigger_runner.plaction triggers
runner
Perl script used to trigger the actions set up in the action trigger tool in the staff client.
/openils/bin/osrf_ctl.sh
The start up script for OpenSRF and Evergreen.
/openils/bin/reshelving_ complete.srfsh
Change status from reshelving
to available
for items which have been in reshelving for a certain amount of time.
/openils/bin/srfshsrfsh
Used to start the OpenSRF shell.