Bug 20612: koha-conf.xml cleanup
[koha-equinox.git] / etc / koha-conf.xml
1
2 <yazgfs>
3 <!-- [scheme:]host[:port][/databaseName] -->
4 <!-- scheme: tcp, ssl, unix, http, sru -->
5 <!-- can run all servers on tcp, but the unix socket is faster -->
6
7 <listen id="biblioserver" >unix:__ZEBRA_RUN_DIR__/bibliosocket</listen>
8 <listen id="authorityserver" >unix:__ZEBRA_RUN_DIR__/authoritysocket</listen>
9
10 <!-- Uncomment the following entry if you want to run the public Z39.50 server.
11     Also uncomment the <server> and <serverinfo> sections for id 'publicserver' 
12     under PUBLICSERVER'S BIBLIOGRAPHIC RECORDS title-->
13 <!--
14 <listen id="publicserver" >tcp:@:__ZEBRA_SRU_BIBLIOS_PORT__</listen>
15 -->
16
17 <!-- Settings for special biblio server instance for PazPar2.
18      Because PazPar2 only connects to a Z39.50 server using TCP/IP,
19      it cannot use the Unix-domain socket that biblioserver uses.
20      Therefore, a custom server is defined. -->
21 __PAZPAR2_TOGGLE_XML_PRE__
22 <listen id="mergeserver">tcp:@:__MERGE_SERVER_PORT__</listen>
23 <server id="mergeserver"  listenref="mergeserver"> 
24     <directory>__ZEBRA_DATA_DIR__/biblios</directory>
25     <config>__ZEBRA_CONF_DIR__/__ZEBRA_BIB_CFG__</config>
26     <cql2rpn>__ZEBRA_CONF_DIR__/pqf.properties</cql2rpn>
27 </server>
28 __PAZPAR2_TOGGLE_XML_POST__
29
30 <!-- BIBLIOGRAPHIC RECORDS -->
31 <server id="biblioserver"  listenref="biblioserver"> 
32     <directory>__ZEBRA_DATA_DIR__/biblios</directory>
33     <config>__ZEBRA_CONF_DIR__/__ZEBRA_BIB_CFG__</config>
34     <cql2rpn>__ZEBRA_CONF_DIR__/pqf.properties</cql2rpn>
35     <xi:include href="__KOHA_CONF_DIR__/zebradb/__BIB_RETRIEVAL_CFG__" xmlns:xi="http://www.w3.org/2001/XInclude"/>
36     <xi:include href="__KOHA_CONF_DIR__/zebradb/explain-biblios.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
37 </server>
38 <serverinfo id="biblioserver">
39         <ccl2rpn>__ZEBRA_CONF_DIR__/ccl.properties</ccl2rpn>
40         <user>__ZEBRA_USER__</user>    
41         <password>__ZEBRA_PASS__</password>
42 </serverinfo>
43
44 <!-- AUTHORITY RECORDS -->
45 <server id="authorityserver"  listenref="authorityserver" >
46     <directory>__ZEBRA_DATA_DIR__/authorities</directory>
47     <config>__ZEBRA_CONF_DIR__/__ZEBRA_AUTH_CFG__</config>
48     <cql2rpn>__ZEBRA_CONF_DIR__/pqf.properties</cql2rpn>
49     <xi:include href="__KOHA_CONF_DIR__/zebradb/__AUTH_RETRIEVAL_CFG__" xmlns:xi="http://www.w3.org/2001/XInclude"/>
50     <xi:include href="__KOHA_CONF_DIR__/zebradb/explain-authorities.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
51 </server>
52 <serverinfo id="authorityserver">
53     <ccl2rpn>__ZEBRA_CONF_DIR__/ccl.properties</ccl2rpn>
54     <user>__ZEBRA_USER__</user>
55     <password>__ZEBRA_PASS__</password>
56 </serverinfo>
57
58 <!-- PUBLICSERVER'S BIBLIOGRAPHIC RECORDS -->
59 <!--
60 <server id="publicserver"  listenref="publicserver"> 
61     <directory>__ZEBRA_DATA_DIR__/biblios</directory>
62     <config>__ZEBRA_CONF_DIR__/__ZEBRA_BIB_CFG__</config>
63     <cql2rpn>__ZEBRA_CONF_DIR__/pqf.properties</cql2rpn>
64     <xi:include href="__KOHA_CONF_DIR__/zebradb/__BIB_RETRIEVAL_CFG__" xmlns:xi="http://www.w3.org/2001/XInclude"/>
65     <xi:include href="__KOHA_CONF_DIR__/zebradb/explain-biblios.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
66 </server>
67 <serverinfo id="publicserver">
68         <ccl2rpn>__ZEBRA_CONF_DIR__/ccl.properties</ccl2rpn>
69         <user>__ZEBRA_USER__</user>    
70         <password>__ZEBRA_PASS__</password>
71 </serverinfo>
72 -->
73
74 <!-- ADDITIONAL KOHA CONFIGURATION DIRECTIVE -->
75 <!-- db_scheme should follow the DBD driver name --> 
76 <!-- the DBD drivers supported by Koha are mysql and Pg -->
77 <!-- port info: mysql:3306 Pg:5432 (5433 on Debian) -->
78 <config>
79  <db_scheme>__DB_TYPE__</db_scheme>
80  <database>__DB_NAME__</database>
81  <hostname>__DB_HOST__</hostname>
82  <port>__DB_PORT__</port>
83  <user>__DB_USER__</user>
84  <pass>__DB_PASS__</pass>
85  <tls>__DB_USE_TLS__</tls>
86  <ca>__DB_TLS_CA_CERTIFICATE__</ca>
87  <cert>__DB_TLS_CLIENT_CERTIFICATE__</cert>
88  <key>__DB_TLS_CLIENT_KEY__</key>
89  <biblioserver>biblios</biblioserver>
90  <biblioservershadow>1</biblioservershadow>
91  <authorityserver>authorities</authorityserver>
92  <authorityservershadow>1</authorityservershadow>
93  <pluginsdir>__PLUGINS_DIR__</pluginsdir> <!-- This entry can be repeated to use multiple directories -->
94  <enable_plugins>0</enable_plugins>
95  <upload_path></upload_path>
96  <intranetdir>__INTRANET_CGI_DIR__</intranetdir>
97  <opacdir>__OPAC_CGI_DIR__/opac</opacdir>
98  <opachtdocs>__OPAC_TMPL_DIR__</opachtdocs>
99  <intrahtdocs>__INTRANET_TMPL_DIR__</intrahtdocs>
100  <includes>__INTRANET_TMPL_DIR__/prog/en/includes/</includes>
101  <logdir>__LOG_DIR__</logdir>
102  <docdir>__DOC_DIR__</docdir>
103  <backupdir>__BACKUP_DIR__</backupdir>
104  <!-- Enable the two following to allow superlibrarians to download
105       database and configuration dumps (respectively) from the Export
106       tool -->
107  <backup_db_via_tools>0</backup_db_via_tools>
108  <backup_conf_via_tools>0</backup_conf_via_tools>
109  <!-- Uncomment the following line if you are not using packages and need to schedule reports through the web interface. supportdir should contain cronjobs/runreport.pl -->
110  <!--
111  <supportdir>__SCRIPT_NONDEV_DIR__</supportdir>
112  -->
113  <pazpar2url>http://__PAZPAR2_HOST__:__PAZPAR2_PORT__/search.pz2</pazpar2url>
114  <install_log>__MISC_DIR__/koha-install-log</install_log>
115  <useldapserver>0</useldapserver><!-- see C4::Auth_with_ldap for extra configs you must add if you want to turn this on -->
116  <useshibboleth>0</useshibboleth><!-- see C4::Auth_with_shibboleth for extra configs you must do to turn this on -->
117  <zebra_bib_index_mode>__BIB_INDEX_MODE__</zebra_bib_index_mode>
118  <zebra_auth_index_mode>__AUTH_INDEX_MODE__</zebra_auth_index_mode>
119  <zebra_lockdir>__ZEBRA_LOCK_DIR__</zebra_lockdir>
120  <use_zebra_facets>1</use_zebra_facets>
121  <queryparser_config>__KOHA_CONF_DIR__/searchengine/queryparser.yaml</queryparser_config>
122  <log4perl_conf>__KOHA_CONF_DIR__/log4perl.conf</log4perl_conf>
123  <memcached_servers>__MEMCACHED_SERVERS__</memcached_servers>
124  <memcached_namespace>__MEMCACHED_NAMESPACE__</memcached_namespace>
125  <template_cache_dir>__TEMPLATE_CACHE_DIR__</template_cache_dir>
126
127  <!-- Secret passphrase used by Mojolicious for signed cookies -->
128  <api_secret_passphrase>CHANGEME</api_secret_passphrase>
129
130  <!-- Accessible directory from the staff client, uncomment the following line and define a valid path to let the intranet user access it-->
131  <!--
132  <access_dirs>
133      <access_dir></access_dir>
134      <access_dir></access_dir>
135  </access_dirs>
136  -->
137
138  <!-- true type font mapping accoding to type from $font_types in C4/Creators/Lib.pm -->
139  <ttf>
140     <font type="TR" >__FONT_DIR__/DejaVuSerif.ttf</font>
141     <font type="TB" >__FONT_DIR__/DejaVuSerif-Bold.ttf</font>
142     <font type="TI" >__FONT_DIR__/DejaVuSerif-Italic.ttf</font>
143     <font type="TBI">__FONT_DIR__/DejaVuSerif-BoldItalic.ttf</font>
144     <font type="C"  >__FONT_DIR__/DejaVuSansMono.ttf</font>
145     <font type="CB" >__FONT_DIR__/DejaVuSansMono-Bold.ttf</font>
146     <font type="CO" >__FONT_DIR__/DejaVuSansMono-Oblique.ttf</font>
147     <font type="CBO">__FONT_DIR__/DejaVuSansMono-BoldOblique.ttf</font>
148     <font type="H"  >__FONT_DIR__/DejaVuSans.ttf</font>
149     <font type="HO" >__FONT_DIR__/DejaVuSans-Oblique.ttf</font>
150     <font type="HB" >__FONT_DIR__/DejaVuSans-Bold.ttf</font>
151     <font type="HBO">__FONT_DIR__/DejaVuSans-BoldOblique.ttf</font>
152  </ttf>
153
154  <!-- Path to the config file for SMS::Send -->
155  <sms_send_config>__KOHA_CONF_DIR__/sms_send/</sms_send_config>
156
157  <!-- Configuration for Plack -->
158  <plack_max_requests>50</plack_max_requests>
159  <plack_workers>2</plack_workers>
160
161  <!-- Elasticsearch Configuration -->
162  <elasticsearch>
163      <server>localhost:9200</server>
164      <index_name>koha___DB_NAME__</index_name>
165  </elasticsearch>
166  <!-- Uncomment the following line if you want to override the Elasticsearch default index settings -->
167  <!-- <elasticsearch_index_config>__KOHA_CONF_DIR__/searchengine/elasticsearch/index_config.yaml</elasticsearch_index_config> -->
168  <!-- Uncomment the following line if you want to override the Elasticsearch default field settings -->
169  <!-- <elasticsearch_field_config>__KOHA_CONF_DIR__/searchengine/elasticsearch/field_config.yaml</elasticsearch_field_config> -->
170  <!-- Uncomment the following line if you want to override the Elasticsearch index default settings.
171       Note that any changes made to the mappings file only take effect if you reset the mappings in
172       by visiting /cgi-bin/koha/admin/searchengine/elasticsearch/mappings.pl?op=reset&i_know_what_i_am_doing=1&reset_fields=1.
173       Resetting mappings will override any changes made in the Search engine configuration UI.
174  -->
175  <!-- <elasticsearch_index_mappings>__KOHA_CONF_DIR__/searchengine/elasticsearch/mappings.yaml</elasticsearch_index_mappings> -->
176
177  <interlibrary_loans>
178      <!-- Path to where Illbackends are located on the system
179           - This setting should normally not be touched -->
180      <backend_directory>__PERL_MODULE_DIR__/Koha/Illbackends</backend_directory>
181      <!-- How should we treat staff comments?
182           - hide: don't show in OPAC
183           - show: show in OPAC -->
184      <staff_request_comments>hide</staff_request_comments>
185      <!-- How should we treat the reply_date field?
186           - hide: don't show this field in the UI
187           - any other string: show, with this label -->
188      <reply_date>hide</reply_date>
189      <!-- Where should digital ILLs be sent?
190           - borrower: send it straight to the borrower email
191           - branch: send the ILL to the branch email -->
192      <digital_recipient>branch</digital_recipient>
193      <!-- What patron category should we use for p2p ILL requests?
194           - By default this is set to 'ILLLIBS' -->
195      <partner_code>ILLLIBS</partner_code>
196  </interlibrary_loans>
197
198  <!-- The timezone setting can let you force the timezone for this
199       instance to be something other then the local timezone of the
200       server. e.g. Antarctica/South_Pole -->
201  <timezone></timezone>
202
203 </config>
204 </yazgfs>