Bug 17851: Add elasticsearch config to koha-conf.xml
[koha-equinox.git] / debian / templates / koha-conf-site.xml.in
1 <yazgfs>
2
3 <listen id="biblioserver" >unix:/var/run/koha/__KOHASITE__/bibliosocket</listen>
4 <listen id="authorityserver" >unix:/var/run/koha/__KOHASITE__/authoritysocket</listen>
5
6 <!-- Uncomment the following entry if you want to run the public Z39.50 server.
7     Also uncomment the <server> and <serverinfo> sections for id 'publicserver'
8     under PUBLICSERVER'S BIBLIOGRAPHIC RECORDS title-->
9 __START_SRU_PUBLICSERVER__
10 <listen id="publicserver" >tcp:@:__SRU_BIBLIOS_PORT__</listen>
11 __END_SRU_PUBLICSERVER__
12
13 <!-- Settings for special biblio server instance for PazPar2.
14      Because PazPar2 only connects to a Z39.50 server using TCP/IP,
15      it cannot use the Unix-domain socket that biblioserver uses.
16      Therefore, a custom server is defined. -->
17 <!--
18 <listen id="mergeserver">tcp:@:__MERGE_SERVER_PORT__</listen>
19 <server id="mergeserver"  listenref="mergeserver">
20     <directory>/var/lib/koha/__KOHASITE__/biblios</directory>
21     <config>/etc/koha/sites/__KOHASITE__/zebra-biblios-dom.cfg</config>
22     <cql2rpn>/var/lib/koha/__KOHASITE__/pqf.properties</cql2rpn>
23 </server>
24 -->
25
26 <!-- BIBLIOGRAPHIC RECORDS -->
27 <server id="biblioserver"  listenref="biblioserver">
28     <directory>/var/lib/koha/__KOHASITE__/biblios</directory>
29     <config>/etc/koha/sites/__KOHASITE__/zebra-biblios-dom.cfg</config>
30     <cql2rpn>/etc/koha/zebradb/pqf.properties</cql2rpn>
31
32   <xi:include href="/etc/koha/__ZEBRA_MARC_FORMAT__-retrieval-info-bib-dom.xml"
33               xmlns:xi="http://www.w3.org/2001/XInclude">
34     <xi:fallback>
35       <retrievalinfo>
36        <retrieval syntax="__ZEBRA_MARC_FORMAT__" name="F"/>
37        <retrieval syntax="__ZEBRA_MARC_FORMAT__" name="B"/>
38        <retrieval syntax="xml" name="F"/>
39        <retrieval syntax="xml" name="B"/>
40        <retrieval syntax="xml" name="marcxml"
41                   identifier="info:srw/schema/1/marcxml-v1.1">
42          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
43            <marc inputformat="marc" outputformat="marcxml"
44                  inputcharset="utf-8"/>
45          </backend>
46        </retrieval>
47        <retrieval syntax="xml" name="dc">
48          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
49            <marc inputformat="marc" outputformat="marcxml"
50                  inputcharset="utf-8"/>
51            <xslt stylesheet="/usr/share/koha/intranet/htdocs/intranet-tmpl/prog/en/xslt/MARC21slim2DC.xsl"/>
52          </backend>
53        </retrieval>
54        <retrieval syntax="xml" name="mods">
55          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
56            <marc inputformat="marc" outputformat="marcxml"
57                  inputcharset="utf-8"/>
58            <xslt stylesheet="/usr/share/koha/intranet/htdocs/intranet-tmpl/prog/en/xslt/MARC21slim2MODS.xsl"/>
59          </backend>
60        </retrieval>
61        <retrieval syntax="xml" name="rdfdc">
62          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
63            <marc inputformat="marc" outputformat="marcxml"
64                  inputcharset="utf-8"/>
65            <xslt stylesheet="/usr/share/koha/intranet/htdocs/intranet-tmpl/prog/en/xslt/MARC21slim2RDFDC.xsl"/>
66          </backend>
67        </retrieval>
68        <retrieval syntax="xml" name="rss2">
69          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
70            <marc inputformat="marc" outputformat="marcxml"
71                  inputcharset="utf-8"/>
72            <xslt stylesheet="/usr/share/koha/intranet/htdocs/intranet-tmpl/prog/en/xslt/MARC21slim2RSS2.xsl"/>
73          </backend>
74        </retrieval>
75        <retrieval syntax="xml" name="utils">
76          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
77            <marc inputformat="marc" outputformat="marcxml"
78                  inputcharset="utf-8"/>
79            <xslt stylesheet="/usr/share/koha/intranet/htdocs/intranet-tmpl/prog/en/xslt/MARC21slimUtils.xsl"/>
80          </backend>
81        </retrieval>
82       </retrievalinfo>
83     </xi:fallback>
84   </xi:include>
85
86     <!-- The stuff below is used to enable SRU. It's currently disabled
87          until we come up with a good way to make it get magically set up by
88          the packaging system. If you need it, uncomment and set it up
89          manually.
90     <xi:include href="/etc/koha/zebradb/explain-biblios.xml"
91                 xmlns:xi="http://www.w3.org/2001/XInclude">
92       <xi:fallback>
93       <explain xmlns="http://explain.z3950.org/dtd/2.0/">
94           <serverInfo>
95             <host>__ZEBRA_SRU_HOST__</host>
96             <port>__ZEBRA_SRU_BIBLIOS_PORT__</port>
97             <database>biblios</database>
98           </serverInfo>
99         </explain>
100       </xi:fallback>
101     </xi:include> -->
102 </server>
103 <serverinfo id="biblioserver">
104         <ccl2rpn>/etc/koha/zebradb/ccl.properties</ccl2rpn>
105         <user>kohauser</user>
106         <password>__ZEBRA_PASS__</password>
107 </serverinfo>
108
109 <!-- AUTHORITY RECORDS -->
110 <server id="authorityserver"  listenref="authorityserver" >
111     <directory>/var/lib/koha/__KOHASITE__/authorities</directory>
112     <config>/etc/koha/sites/__KOHASITE__/zebra-authorities-dom.cfg</config>
113     <cql2rpn>/etc/koha/zebradb/pqf.properties</cql2rpn>
114
115   <xi:include href="/etc/koha/__ZEBRA_MARC_FORMAT__-retrieval-info-auth-dom.xml"
116               xmlns:xi="http://www.w3.org/2001/XInclude">
117     <xi:fallback>
118       <retrievalinfo>
119        <retrieval syntax="__ZEBRA_MARC_FORMAT__" name="F"/>
120        <retrieval syntax="__ZEBRA_MARC_FORMAT__" name="B"/>
121        <retrieval syntax="xml" name="marcxml"
122                   identifier="info:srw/schema/1/marcxml-v1.1">
123          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
124            <marc inputformat="marc" outputformat="marcxml"
125                  inputcharset="utf-8"/>
126          </backend>
127        </retrieval>
128        <retrieval syntax="xml" name="dc">
129          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
130            <marc inputformat="marc" outputformat="marcxml"
131                  inputcharset="utf-8"/>
132            <xslt stylesheet="/usr/share/koha/intranet/htdocs/intranet-tmpl/prog/en/xslt/MARC21slim2DC.xsl"/>
133          </backend>
134        </retrieval>
135        <retrieval syntax="xml" name="mods">
136          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
137            <marc inputformat="marc" outputformat="marcxml"
138                  inputcharset="utf-8"/>
139            <xslt stylesheet="/usr/share/koha/intranet/htdocs/intranet-tmpl/prog/en/xslt/MARC21slim2MODS.xsl"/>
140          </backend>
141        </retrieval>
142        <retrieval syntax="xml" name="rdfdc">
143          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
144            <marc inputformat="marc" outputformat="marcxml"
145                  inputcharset="utf-8"/>
146            <xslt stylesheet="/usr/share/koha/intranet/htdocs/intranet-tmpl/prog/en/xslt/MARC21slim2RDFDC.xsl"/>
147          </backend>
148        </retrieval>
149        <retrieval syntax="xml" name="utils">
150          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
151            <marc inputformat="marc" outputformat="marcxml"
152                  inputcharset="utf-8"/>
153            <xslt stylesheet="/usr/share/koha/intranet/htdocs/intranet-tmpl/prog/en/xslt/MARC21slimUtils.xsl"/>
154          </backend>
155        </retrieval>
156       </retrievalinfo>
157     </xi:fallback>
158   </xi:include>
159
160     <!-- The stuff below is used to enable SRU. It's currently disabled
161          until we come up with a good way to make it get magically set up by
162          the packaging system. If you need it, uncomment and set it up
163          manually.
164     <xi:include href="/etc/koha/zebradb/explain-authorities.xml"
165                 xmlns:xi="http://www.w3.org/2001/XInclude">
166     <xi:fallback>
167       <explain xmlns="http://explain.z3950.org/dtd/2.0/">
168           <serverInfo>
169             <host>__ZEBRA_SRU_HOST__</host>
170             <port>__ZEBRA_SRU_AUTHORITIES_PORT__</port>
171             <database>authorities</database>
172           </serverInfo>
173         </explain>
174       </xi:fallback>
175   </xi:include> -->
176 </server>
177 <serverinfo id="authorityserver">
178     <ccl2rpn>/etc/koha/zebradb/ccl.properties</ccl2rpn>
179     <user>kohauser</user>
180     <password>__ZEBRA_PASS__</password>
181 </serverinfo>
182
183 <!-- PUBLICSERVER'S BIBLIOGRAPHIC RECORDS -->
184 <!-- This can be used to set up a public Z39.50/SRU server. -->
185 __START_SRU_PUBLICSERVER__
186 <server id="publicserver"  listenref="publicserver">
187     <directory>/var/lib/koha/__KOHASITE__/biblios</directory>
188     <config>/etc/koha/sites/__KOHASITE__/zebra-biblios-dom.cfg</config>
189     <cql2rpn>/etc/koha/zebradb/pqf.properties</cql2rpn>
190
191   <xi:include href="/etc/koha/__ZEBRA_MARC_FORMAT__-retrieval-info-bib-dom.xml"
192               xmlns:xi="http://www.w3.org/2001/XInclude">
193     <xi:fallback>
194       <retrievalinfo>
195        <retrieval syntax="__ZEBRA_MARC_FORMAT__" name="F"/>
196        <retrieval syntax="__ZEBRA_MARC_FORMAT__" name="B"/>
197        <retrieval syntax="xml" name="F"/>
198        <retrieval syntax="xml" name="B"/>
199        <retrieval syntax="xml" name="marcxml"
200                   identifier="info:srw/schema/1/marcxml-v1.1">
201          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
202            <marc inputformat="marc" outputformat="marcxml"
203                  inputcharset="utf-8"/>
204          </backend>
205        </retrieval>
206        <retrieval syntax="xml" name="dc">
207          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
208            <marc inputformat="marc" outputformat="marcxml"
209                  inputcharset="utf-8"/>
210            <xslt stylesheet="/usr/share/koha/intranet/htdocs/intranet-tmpl/prog/en/xslt/MARC21slim2DC.xsl"/>
211          </backend>
212        </retrieval>
213        <retrieval syntax="xml" name="mods">
214          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
215            <marc inputformat="marc" outputformat="marcxml"
216                  inputcharset="utf-8"/>
217            <xslt stylesheet="/usr/share/koha/intranet/htdocs/intranet-tmpl/prog/en/xslt/MARC21slim2MODS.xsl"/>
218          </backend>
219        </retrieval>
220        <retrieval syntax="xml" name="rdfdc">
221          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
222            <marc inputformat="marc" outputformat="marcxml"
223                  inputcharset="utf-8"/>
224            <xslt stylesheet="/usr/share/koha/intranet/htdocs/intranet-tmpl/prog/en/xslt/MARC21slim2RDFDC.xsl"/>
225          </backend>
226        </retrieval>
227        <retrieval syntax="xml" name="rss2">
228          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
229            <marc inputformat="marc" outputformat="marcxml"
230                  inputcharset="utf-8"/>
231            <xslt stylesheet="/usr/share/koha/intranet/htdocs/intranet-tmpl/prog/en/xslt/MARC21slim2RSS2.xsl"/>
232          </backend>
233        </retrieval>
234        <retrieval syntax="xml" name="utils">
235          <backend syntax="__ZEBRA_MARC_FORMAT__" name="F">
236            <marc inputformat="marc" outputformat="marcxml"
237                  inputcharset="utf-8"/>
238            <xslt stylesheet="/usr/share/koha/intranet/htdocs/intranet-tmpl/prog/en/xslt/MARC21slimUtils.xsl"/>
239          </backend>
240        </retrieval>
241       </retrievalinfo>
242     </xi:fallback>
243   </xi:include>
244
245     <xi:include href="/etc/koha/zebradb/explain-biblios.xml"
246                 xmlns:xi="http://www.w3.org/2001/XInclude">
247       <xi:fallback>
248       <explain xmlns="http://explain.z3950.org/dtd/2.0/">
249           <serverInfo>
250             <host>__ZEBRA_SRU_HOST__</host>
251             <port>__ZEBRA_SRU_BIBLIOS_PORT__</port>
252             <database>biblios</database>
253           </serverInfo>
254         </explain>
255       </xi:fallback>
256     </xi:include>
257 </server>
258 <serverinfo id="publicserver">
259         <ccl2rpn>/etc/koha/zebradb/ccl.properties</ccl2rpn>
260         <user>kohauser</user>
261         <password>__ZEBRA_PASS__</password>
262 </serverinfo>
263 __END_SRU_PUBLICSERVER__
264
265 <config>
266  <db_scheme>mysql</db_scheme>
267  <database>__DB_NAME__</database>
268  <hostname>__DB_HOST__</hostname>
269  <port>3306</port>
270  <user>__DB_USER__</user>
271  <pass>__DB_PASS__</pass>
272  <biblioserver>biblios</biblioserver>
273  <biblioservershadow>1</biblioservershadow>
274  <authorityserver>authorities</authorityserver>
275  <authorityservershadow>1</authorityservershadow>
276  <pluginsdir>__PLUGINS_DIR__</pluginsdir> <!-- This entry can be repeated to use multiple directories -->
277  <enable_plugins>0</enable_plugins>
278  <upload_path>__UPLOAD_PATH__</upload_path>
279  <tmp_path>__TMP_PATH__</tmp_path>
280  <intranetdir>/usr/share/koha/intranet/cgi-bin</intranetdir>
281  <opacdir>/usr/share/koha/opac/cgi-bin/opac</opacdir>
282  <opachtdocs>/usr/share/koha/opac/htdocs/opac-tmpl</opachtdocs>
283  <intrahtdocs>/usr/share/koha/intranet/htdocs/intranet-tmpl</intrahtdocs>
284  <includes>/usr/share/koha/intranet/htdocs/intranet-tmpl/prog/en/includes/</includes>
285  <logdir>__LOG_DIR__</logdir>
286  <docdir>/usr/share/doc/koha-common</docdir>
287  <backupdir>/var/spool/koha/__KOHASITE__</backupdir>
288  <!-- URL of the mana KB server -->
289  <!-- alternative value http://mana-test.koha-community.org to query the test server -->
290  <mana_config>https://mana-kb.koha-community.org</mana_config>
291  <!-- Enable the two following to allow superlibrarians to download
292       database and configuration dumps (respectively) from the Export
293       tool -->
294  <backup_db_via_tools>0</backup_db_via_tools>
295  <backup_conf_via_tools>0</backup_conf_via_tools>
296  <!-- <pazpar2url>http://__PAZPAR2_HOST__:__PAZPAR2_PORT__/search.pz2</pazpar2url> -->
297  <install_log>/usr/share/koha/misc/koha-install-log</install_log>
298  <useldapserver>0</useldapserver><!-- see C4::Auth_with_ldap for extra configs you must add if you want to turn this on -->
299  <useshibboleth>0</useshibboleth><!-- see C4::Auth_with_shibboleth for extra configs you must do to turn this on -->
300  <zebra_lockdir>/var/lock/koha/__KOHASITE__</zebra_lockdir>
301  <use_zebra_facets>1</use_zebra_facets>
302  <zebra_max_record_size>1024</zebra_max_record_size>
303  <queryparser_config>/etc/koha/searchengine/queryparser.yaml</queryparser_config>
304  <log4perl_conf>__KOHA_CONF_DIR__/log4perl.conf</log4perl_conf>
305  <!-- Uncomment/edit next setting if you want to adjust zebra log levels.
306       Default is: none,fatal,warn.
307       You can also include: debug,log,malloc,all,request.
308       Use a comma-separated list of levels to include. -->
309  <!-- <zebra_loglevels>none,fatal,warn</zebra_loglevels> -->
310  <memcached_servers>__MEMCACHED_SERVERS__</memcached_servers>
311  <memcached_namespace>__MEMCACHED_NAMESPACE__</memcached_namespace>
312  <template_cache_dir>__TEMPLATE_CACHE_DIR__</template_cache_dir>
313
314  <!-- Secret passphrase used by Mojolicious for signed cookies -->
315  <api_secret_passphrase>__API_SECRET__</api_secret_passphrase>
316
317  <!-- Accessible directory from the staff client, uncomment the following line and define a valid path to let the intranet user access it-->
318  <!--
319  <access_dirs>
320      <access_dir></access_dir>
321      <access_dir></access_dir>
322  </access_dirs>
323  -->
324
325  <!-- true type font mapping according to type from $font_types in C4/Creators/Lib.pm -->
326  <ttf>
327     <font type="TR" >/usr/share/fonts/truetype/ttf-dejavu/DejaVuSerif.ttf</font>
328     <font type="TB" >/usr/share/fonts/truetype/ttf-dejavu/DejaVuSerif-Bold.ttf</font>
329     <font type="TI" >/usr/share/fonts/truetype/ttf-dejavu/DejaVuSerif-Italic.ttf</font>
330     <font type="TBI">/usr/share/fonts/truetype/ttf-dejavu/DejaVuSerif-BoldItalic.ttf</font>
331     <font type="C"  >/usr/share/fonts/truetype/ttf-dejavu/DejaVuSansMono.ttf</font>
332     <font type="CB" >/usr/share/fonts/truetype/ttf-dejavu/DejaVuSansMono-Bold.ttf</font>
333     <font type="CO" >/usr/share/fonts/truetype/ttf-dejavu/DejaVuSansMono-Oblique.ttf</font>
334     <font type="CBO">/usr/share/fonts/truetype/ttf-dejavu/DejaVuSansMono-BoldOblique.ttf</font>
335     <font type="H"  >/usr/share/fonts/truetype/ttf-dejavu/DejaVuSans.ttf</font>
336     <font type="HO" >/usr/share/fonts/truetype/ttf-dejavu/DejaVuSans-Oblique.ttf</font>
337     <font type="HB" >/usr/share/fonts/truetype/ttf-dejavu/DejaVuSans-Bold.ttf</font>
338     <font type="HBO">/usr/share/fonts/truetype/ttf-dejavu/DejaVuSans-BoldOblique.ttf</font>
339  </ttf>
340
341  <!-- Path to the config file for SMS::Send -->
342  <sms_send_config>__KOHA_CONF_DIR__/sms_send/</sms_send_config>
343
344  <!-- Configuration for Plack -->
345  <plack_max_requests>50</plack_max_requests>
346  <plack_workers>2</plack_workers>
347
348  <!-- Elasticsearch Configuration -->
349  <elasticsearch>
350      <server>localhost:9200</server> <!-- may be repeated to include all servers on your cluster -->
351      <index_name>koha___KOHASITE__</index_name> <!-- should be unique amongst all the indices on your cluster. _biblios and _authorities will be appended. -->
352  </elasticsearch>
353  <!-- Uncomment the following line if you want to override the Elasticsearch default index settings -->
354  <!-- <elasticsearch_index_config>__KOHA_CONF_DIR__/searchengine/elasticsearch/index_config.yaml</elasticsearch_index_config> -->
355  <!-- Uncomment the following line if you want to override the Elasticsearch default field settings -->
356  <!-- <elasticsearch_field_config>__KOHA_CONF_DIR__/searchengine/elasticsearch/field_config.yaml</elasticsearch_field_config> -->
357  <!-- Uncomment the following line if you want to override the Elasticsearch index default settings.
358       Note that any changes made to the mappings file only take effect if you reset the mappings in
359       by visiting /cgi-bin/koha/admin/searchengine/elasticsearch/mappings.pl?op=reset&i_know_what_i_am_doing=1&reset_fields=1.
360       Resetting mappings will override any changes made in the Search engine configuration UI.
361  -->
362  <!-- <elasticsearch_index_mappings>__KOHA_CONF_DIR__/searchengine/elasticsearch/mappings.yaml</elasticsearch_index_mappings> -->
363
364  <interlibrary_loans>
365      <!-- Path to where Illbackends are located on the system
366           - This setting should normally not be touched -->
367      <backend_directory>/usr/share/koha/lib/Koha/Illbackends</backend_directory>
368      <!-- At least one <branch> block is required. -->
369      <branch>
370          <!-- The code of this branch -->
371          <code>CPL</code>
372          <!-- An optional prefix for all ILL request IDs for this branch -->
373          <prefix>ILL</prefix>
374      </branch>
375      <!-- How should we treat staff comments?
376           - hide: don't show in OPAC
377           - show: show in OPAC -->
378      <staff_request_comments>hide</staff_request_comments>
379      <!-- How should we treat the reply_date field?
380           - hide: don't show this field in the UI
381           - any other string: show, with this label -->
382      <reply_date>hide</reply_date>
383      <!-- Where should digital ILLs be sent?
384           - borrower: send it straight to the borrower email
385           - branch: send the ILL to the branch email -->
386      <digital_recipient>branch</digital_recipient>
387      <!-- What patron category should we use for p2p ILL requests?
388           - By default this is set to 'ILLLIBS' -->
389      <partner_code>ILLLIBS</partner_code>
390  </interlibrary_loans>
391
392  <!-- The timezone setting can let you force the timezone for this
393       instance to be something other then the local timezone of the
394       server. e.g. Antarctica/South_Pole -->
395  <timezone>__TIMEZONE__</timezone>
396
397 </config>
398 </yazgfs>