Add development to 2.0 from 1.6
[working/Evergreen.git] / 2.0 / development / directoriesandFiles.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <chapter xml:id="filesandvdirectories" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
3     xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
4         <info>\r
5                 <title>Evergreen File Structure and Configuration Files</title>\r
6                 <abstract><para>This section will describe the basic file structure and cover key configuration files. Understanding the directory and file structure of Evergreen will allow you \r
7                 to be able to customize your Evergreen software and take full advantage of many features.</para></abstract>\r
8         </info>\r
9         \r
10         <section xml:id="EvergreenDirectoryStructure">  \r
11                 <title>Evergreen Directory Structure</title>\r
12                 <para>This is the top level directory structure of Evergreen located in the default installation directory <filename class="directory">/openils</filename>:</para>\r
13                 <table>\r
14                         <title xml:id="EvergreenDirectoryStructureTable">Evergreen Directory Structure</title>\r
15                         <tgroup align="left" cols="2" colsep="1" rowsep="1">\r
16                                 <colspec colnum="1" colwidth="1.0*"/>\r
17                                 <colspec colnum="2" colwidth="3.0*"/>\r
18                                 <thead>\r
19                                         <row>\r
20                                                 <entry>Directory</entry>\r
21                                                 <entry>Description</entry>\r
22                                         </row>\r
23                                 </thead>\r
24                                 <tbody>\r
25                                         <row>\r
26                                                 <entry><filename class="directory">bin</filename></entry>\r
27                                                 <entry>Contains many critical Perl and shell scripts such as <filename class="directory">autogen.sh</filename> and \r
28                                                 <filename class="directory">oils.ctl</filename>. </entry>\r
29                                         </row>\r
30                                         <row>\r
31                                                 <entry><filename class="directory">conf</filename></entry>\r
32                                                 <entry>Contains the configuration scripts including the two most important base configuration files <filename>opensrf_core.xml</filename> and                                                   <filename>opensrf.xml</filename>.</entry>\r
33                                         </row>\r
34                                         <row>\r
35                                                 <entry><filename class="directory">include</filename></entry>\r
36                                                 <entry>Contains the header files used by the scripts written in C.</entry>\r
37                                         </row>\r
38                                         <row>\r
39                                                 <entry><filename class="directory">lib</filename></entry>\r
40                                                 <entry>Contains the core code of Evergreen including the C code and perl modules. In particular, the perl modules in the \r
41                                                 subdirectory<filename class="directory">perl5/OpenILS</filename>  \r
42                                                 are of particular interest to developers. </entry>\r
43                                         </row>\r
44                                         <row>\r
45                                                 <entry><filename class="directory">var</filename></entry>\r
46                                                 <entry>Largest directory and includes the web directories (<filename class="directory">web</filename>), lock pid fies \r
47                                                 (<filename class="directory">run</filename>), circ setting files (<filename class="directory">circ</filename>) templates \r
48                                                 (<filename class="directory">templates</filename>) and log (<filename class="directory">templates</filename> and \r
49                                                 <filename class="directory">data</filename>) files.</entry>\r
50                                         </row>\r
51                                 </tbody>\r
52                         </tgroup>\r
53                 </table>\r
54                 <section xml:id="EvergreenFiles">       \r
55                         <title>Evergreen Configuration Files</title>\r
56                         \r
57                         <table>\r
58                         <title xml:id="EvergreenConfigurationFilesTable">Key Evergreen Configuration Files</title>\r
59                         <tgroup align="left" cols="2" colsep="1" rowsep="1">\r
60                                 <colspec colnum="1" colwidth="1.0*"/>\r
61                                 <colspec colnum="2" colwidth="3.0*"/>\r
62                                 <thead>\r
63                                         <row>\r
64                                                 <entry>File</entry>\r
65                                                 <entry>Description</entry>\r
66                                         </row>\r
67                                 </thead>\r
68                                 <tbody>\r
69                                         <row>\r
70                                                 <entry><filename>/openils/conf/opensrf_core.xml</filename><indexterm><primary>configuration files</primary>\r
71                                                 <secondary>opensrf_core.xml</secondary></indexterm></entry>\r
72                                                 \r
73                                                 <entry>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.</entry>\r
74                                         </row>\r
75                                         <row>\r
76                                                 <entry><filename>/openils/conf/opensrf.xml</filename><indexterm><primary>configuration files</primary><secondary>opensrf.xml</secondary></indexterm></entry>\r
77                                                 <entry>Use this file to set directory locations, the default locale, default notice settings and settings for all Evergreen services. \r
78                                                 It is critical for any administrator to understand the settings in this file. An Evergreen restart is required for changes to take effect.</entry>\r
79                                         </row>\r
80                                         <row>\r
81                                                 <entry><filename>/openils/conf/fm_IDL.xml</filename> <indexterm><primary>configuration files</primary><secondary>fm_IDL.xml</secondary></indexterm></entry>\r
82                                                 \r
83                                                 <entry>Used for linking the OpenSRF/Evergreen services to the Evergreen database tables. An Evergreen restart is required for changes to take \r
84                                                 effect. Running autogen.sh is also required.</entry>\r
85                                         </row>\r
86                                         <row>\r
87                                                 <entry><filename>/etc/apache2/eg_vhost.conf</filename><indexterm><primary>configuration files</primary><secondary>Apache</secondary></indexterm></entry>\r
88                                                 <entry>Controls the Evergreen virtual site. Allows to configure the skin for the OPAC or configure  various directories within the Apache web server. \r
89                                                 An Apache restart is required for changes to this file to take effect.</entry>\r
90                                         </row>\r
91                                 </tbody>\r
92                         </tgroup>\r
93                 </table>\r
94                 <table>\r
95                         <title xml:id="EvergreenScriptsTable">Useful Evergreen Scripts</title>\r
96                         <tgroup align="left" cols="2" colsep="1" rowsep="1">\r
97                                 <colspec colnum="1" colwidth="1.0*"/>\r
98                                 <colspec colnum="2" colwidth="2.0*"/>\r
99                                 <thead>\r
100                                         <row>\r
101                                                 <entry>File</entry>\r
102                                                 <entry>Description</entry>\r
103                                         </row>\r
104                                 </thead>\r
105                                 <tbody>\r
106                                         <row>\r
107                                                 <entry><filename>/openils/bin/autogen.sh</filename><indexterm><primary>autogen</primary></indexterm></entry>\r
108                                                 <entry>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 \r
109                                                 Evergreen database entries.</entry>\r
110                                         </row>\r
111                                         <row>\r
112                                                 <entry><filename>/openils/bin/clark-kent.pl</filename><indexterm><primary>reports</primary><secondary>starting</secondary></indexterm></entry>\r
113                                                 \r
114                                                 <entry>Perl script for starting the reporter.</entry>\r
115                                         </row>\r
116                                         <row>\r
117                                                 <entry><filename>/openils/bin/action_trigger_runner.pl</filename><indexterm><primary>action triggers</primary>\r
118                                                 <secondary>runner</secondary></indexterm></entry>\r
119                                                 <entry>Perl script used to trigger the actions set up in the action trigger tool in the staff client.</entry>\r
120                                         </row>\r
121                                         <row>\r
122                                                 <entry><filename>/openils/bin/osrf_ctl.sh</filename></entry>\r
123                                                 <entry>The start up script for OpenSRF and Evergreen. </entry>\r
124                                         </row>\r
125                                         <row>\r
126                                                 <entry><filename>/openils/bin/reshelving_ complete.srfsh</filename></entry>\r
127                                                 <entry>Change status from <quote>reshelving</quote> to <quote>available</quote> for items which have been in reshelving for a certain amount of time.</entry>\r
128                                         </row>\r
129                                         <row>\r
130                                                 <entry><filename>/openils/bin/srfsh</filename><indexterm><primary>srfsh</primary></indexterm></entry>\r
131                                                 \r
132                                                 <entry>Used to start the OpenSRF shell.</entry>\r
133                                         </row>\r
134                                         \r
135                                 </tbody>\r
136                         </tgroup>\r
137                 </table>\r
138                 </section>\r
139         </section>\r
140 </chapter>\r