4 Example opensrf config file for OpenILS
7 <opensrf version='0.0.2'>
12 <log>/openils/var/log</log> <!-- unix::server log files -->
13 <sock>/openils/var/sock</sock> <!-- unix::server sock files -->
14 <pid>/openils/var/pid</pid>
15 <xsl>/openils/var/xsl</xsl>
16 <script>/openils/var</script>
17 <script_lib>/openils/var</script_lib>
20 <!-- global data visiblity settings -->
23 <!-- Set to "true" to require patron opt-in for foreign (non-home_ou) transactions -->
24 <opt_in>false</opt_in>
28 <IDL>/openils/conf/fm_IDL.xml</IDL> <!-- top level IDL file -->
30 <server_type>prefork</server_type> <!-- net::server type -->
32 <ils_events>/openils/var/data/ils_events.xml</ils_events> <!-- ILS events description file -->
35 <!-- global email notification settings -->
36 <template>/openils/var/data/hold_notification_template.example</template>
37 <smtp_server>localhost</smtp_server>
39 <!-- in most cases, this is overridden by location
40 specific config settings. this is just the default -->
41 <sender_address>evergreen@localhost</sender_address>
47 Settings for the reporter daemon process
50 <base_uri>https://localhost/reporter/</base_uri>
53 <host>localhost</host>
57 <password>postgres</password>
60 <!-- successful report outputs go here -->
61 <output_base>/openils/var/reporter/output</output_base>
62 <success_template>/openils/var/data/report-success</success_template>
63 <fail_template>/openils/var/data/report-fail</fail_template>
71 <!-- XML-RPC gateway. Do NOT publish unprotected services here -->
73 <!-- list of published services -->
74 <service>opensrf.math</service>
75 <service>opensrf.dbmath</service>
76 <service>open-ils.cat</service>
77 <service>open-ils.search</service>
78 <service>open-ils.circ</service>
79 <service>open-ils.actor</service>
80 <service>open-ils.auth</service>
81 <service>open-ils.collections</service>
87 <default>oclc</default>
91 <!-- LoC does not require username/password -->
93 <host>z3950.loc.gov</host>
97 <tcn><code>12</code><format>1</format></tcn>
98 <isbn><code>7</code><format>6</format></isbn>
99 <lccn><code>9</code><format>1</format></lccn>
100 <author><code>1003</code><format>6</format></author>
101 <title><code>4</code><format>6</format></title>
102 <issn><code>8</code><format>1</format></issn>
103 <publisher><code>1018</code><format>6</format></publisher>
104 <pubdate><code>31</code><format>1</format></pubdate>
105 <item_type><code>1001</code><format>1</format></item_type>
110 <!-- Z3950 settings for OCLC. Note that OCLC requires username/password -->
111 <host>zcat.oclc.org</host>
113 <db>OLUCWorldCat</db>
116 These are directly from the Bib-1 Attribute Set
117 http://www.loc.gov/z3950/agency/defns/bib1.html
118 <code> is the "use attribute", <format> is the "structure attribute"
119 This just puts some friendly names on the data.
121 <tcn><code>12</code><format>1</format></tcn>
122 <isbn><code>7</code><format>6</format></isbn>
123 <lccn><code>9</code><format>1</format></lccn>
124 <author><code>1003</code><format>6</format></author>
125 <title><code>4</code><format>6</format></title>
126 <issn><code>8</code><format>1</format></issn>
127 <publisher><code>1018</code><format>6</format></publisher>
128 <pubdate><code>31</code><format>1</format></pubdate>
129 <item_type><code>1001</code><format>1</format></item_type>
138 <!-- configure an added content plugin -->
140 <module>OpenILS::WWW::AddedContent::MY_MODULE</module>
141 <userid>MY_USER_ID</userid>
142 <base_url>MY_BASE_URL</base_url>
144 <retry_timeout>600</retry_timeout>
145 <max_errors>5</max_errors>
151 <!-- no apps are enabled globally by default -->
155 <!-- memcache servers -->
158 <server>localhost:11211</server>
160 <max_cache_time>86400</max_cache_time>
165 <!-- Authentication server -->
168 <!-- how long to wait between stateful requests before the child process re-joins the pool -->
169 <keepalive>5</keepalive>
171 <!-- true if this service support stateless requests -->
172 <stateless>1</stateless>
174 <!-- implementation language -->
175 <language>c</language>
177 <!-- library to plugin -->
178 <implementation>oils_auth.so</implementation>
180 <!-- maximum required opensrf requests within a stateful connection -->
181 <max_requests>93</max_requests>
184 <!-- maximum number of top level requests coming to
185 this child before the child is recycled -->
186 <max_requests>1000</max_requests>
187 <!-- min children to fork -->
188 <min_children>1</min_children>
189 <!-- max possible children to fork -->
190 <max_children>15</max_children>
192 <!-- C forking implementation does not support
193 min/max idle children, but may in the future -->
195 <!-- min idle children -->
196 <min_spare_children>1</min_spare_children>
197 <!-- max idle children -->
198 <max_spare_children>5</max_spare_children>
203 <!-- defined app-specific settings here -->
205 <!-- default login timeouts based on login type -->
214 <!-- Generic search server -->
216 <keepalive>5</keepalive>
217 <stateless>1</stateless>
218 <language>perl</language>
219 <implementation>OpenILS::Application::Search</implementation>
220 <max_requests>93</max_requests>
223 <!-- the following 3 settings are currently used by Perl services only -->
224 <unix_sock>open-ils.search_unix.sock</unix_sock>
225 <unix_pid>open-ils.search_unix.pid</unix_pid>
226 <unix_log>open-ils.search_unix.log</unix_log>
228 <max_requests>1000</max_requests>
229 <min_children>1</min_children>
230 <max_children>15</max_children>
231 <min_spare_children>1</min_spare_children>
232 <max_spare_children>5</max_spare_children>
235 <marc_html_xsl>oilsMARC21slim2HTML.xsl</marc_html_xsl>
236 <!-- zip code database file -->
237 <!--<zips_file>/openils/var/data/zips.txt</zips_file>-->
241 <!-- server for accessing user info -->
243 <keepalive>5</keepalive>
244 <stateless>1</stateless>
245 <language>perl</language>
246 <implementation>OpenILS::Application::Actor</implementation>
247 <max_requests>93</max_requests>
249 <unix_sock>open-ils.actor_unix.sock</unix_sock>
250 <unix_pid>open-ils.actor_unix.pid</unix_pid>
251 <max_requests>1000</max_requests>
252 <unix_log>open-ils.actor_unix.log</unix_log>
253 <min_children>1</min_children>
254 <max_children>15</max_children>
255 <min_spare_children>1</min_spare_children>
256 <max_spare_children>5</max_spare_children>
262 <keepalive>5</keepalive>
263 <stateless>1</stateless>
264 <language>perl</language>
265 <implementation>OpenILS::Application::Cat</implementation>
266 <max_requests>199</max_requests>
268 <unix_sock>open-ils.cat_unix.sock</unix_sock>
269 <unix_pid>open-ils.cat_unix.pid</unix_pid>
270 <max_requests>1000</max_requests>
271 <unix_log>open-ils.cat_unix.log</unix_log>
272 <min_children>1</min_children>
273 <max_children>15</max_children>
274 <min_spare_children>1</min_spare_children>
275 <max_spare_children>5</max_spare_children>
279 <K_book>/openils/var/templates/marc/k_book.xml</K_book>
285 <keepalive>5</keepalive>
286 <stateless>1</stateless>
287 <language>perl</language>
288 <implementation>OpenILS::Application::SuperCat</implementation>
289 <max_requests>199</max_requests>
291 <unix_sock>open-ils.supercat_unix.sock</unix_sock>
292 <unix_pid>open-ils.supercat_unix.pid</unix_pid>
293 <max_requests>1000</max_requests>
294 <unix_log>open-ils.supercat_unix.log</unix_log>
295 <min_children>1</min_children>
296 <max_children>15</max_children>
297 <min_spare_children>1</min_spare_children>
298 <max_spare_children>5</max_spare_children>
304 <keepalive>3</keepalive>
305 <stateless>1</stateless>
306 <language>c</language>
307 <implementation>osrf_math.so</implementation>
308 <max_requests>97</max_requests>
310 <unix_sock>opensrf.math_unix.sock</unix_sock>
311 <unix_pid>opensrf.math_unix.pid</unix_pid>
312 <max_requests>1000</max_requests>
313 <unix_log>opensrf.math_unix.log</unix_log>
314 <min_children>1</min_children>
315 <max_children>15</max_children>
316 <min_spare_children>1</min_spare_children>
317 <max_spare_children>5</max_spare_children>
322 <keepalive>3</keepalive>
323 <stateless>1</stateless>
324 <language>c</language>
325 <implementation>osrf_dbmath.so</implementation>
326 <max_requests>99</max_requests>
328 <max_requests>1000</max_requests>
329 <unix_log>opensrf.dbmath_unix.log</unix_log>
330 <unix_sock>opensrf.dbmath_unix.sock</unix_sock>
331 <unix_pid>opensrf.dbmath_unix.pid</unix_pid>
332 <min_children>1</min_children>
333 <max_children>15</max_children>
334 <min_spare_children>1</min_spare_children>
335 <max_spare_children>5</max_spare_children>
340 <keepalive>3</keepalive>
341 <stateless>1</stateless>
342 <language>perl</language>
343 <implementation>OpenILS::Application::Penalty</implementation>
344 <max_requests>99</max_requests>
346 <max_requests>1000</max_requests>
347 <unix_log>open-ils.penalty_unix.log</unix_log>
348 <unix_sock>open-ils.penalty_unix.sock</unix_sock>
349 <unix_pid>open-ils.penalty_unix.pid</unix_pid>
350 <min_children>1</min_children>
351 <max_children>15</max_children>
352 <min_spare_children>1</min_spare_children>
353 <max_spare_children>5</max_spare_children>
356 <patron_penalty>penalty/patron_penalty.js</patron_penalty>
357 <script_path>/openils/var</script_path>
358 <script_path>/openils/var/catalog</script_path>
363 <keepalive>3</keepalive>
364 <stateless>1</stateless>
365 <language>perl</language>
366 <implementation>OpenILS::Application::Circ</implementation>
367 <max_requests>99</max_requests>
369 <max_requests>1000</max_requests>
370 <unix_log>open-ils.circ_unix.log</unix_log>
371 <unix_sock>open-ils.circ_unix.sock</unix_sock>
372 <unix_pid>open-ils.circ_unix.pid</unix_pid>
373 <min_children>1</min_children>
374 <max_children>15</max_children>
375 <min_spare_children>1</min_spare_children>
376 <max_spare_children>5</max_spare_children>
380 <email>false</email> <!-- set to true for hold notice emails -->
383 <!-- circulation policy scripts -->
384 <script_path>/openils/var</script_path>
385 <script_path>/openils/var/catalog</script_path>
387 <circ_permit_patron>circ/circ_permit_patron.js</circ_permit_patron>
388 <circ_permit_copy>circ/circ_permit_copy.js</circ_permit_copy>
389 <circ_duration>circ/circ_duration.js</circ_duration>
390 <circ_recurring_fines>circ/circ_recurring_fines.js</circ_recurring_fines>
391 <circ_max_fines>circ/circ_max_fines.js</circ_max_fines>
392 <circ_permit_renew>circ/circ_permit_renew.js</circ_permit_renew>
393 <circ_permit_hold>circ/circ_permit_hold.js</circ_permit_hold>
402 <mod>bestseller</mod>
403 <mod>bestsellernh</mod>
418 <mod>softwrlong</mod>
419 <mod>equip-long</mod>
420 <mod>talking book</mod>
423 <mod>video-long</mod>
427 <type>Miscellaneous</type>
428 <type>Overdue materials</type>
429 <type>Fee for placing a hold</type>
430 <type>Fee for checking out a book</type>
431 <type>Fee for library card</type>
432 <type>Miscellaneous charges</type>
433 <type>Lost materials</type>
434 <type>Damaged material</type>
435 <type>Overdue Reserves charge</type>
436 <type>Recall overdue</type>
437 <type>Fee for processing lost library materials</type>
438 <type>Fee for sending patron bills to collection agency</type>
439 <type>Fee for interlibrary loan</type>
440 <type>Fee for copies</type>
441 <type>Money advanced to pay for telephone use</type>
442 <type>Deposit fee</type>
443 <type>Fee for disk</type>
444 <type>Fee for faxing</type>
445 <type>Fee for laminating</type>
446 <type>Fee for room cleaning</type>
447 <type>Deposit returned; fee refund</type>
448 <type>Sale items</type>
449 <type>Fee for lost card</type>
450 <type>Long overdue items</type>
451 <type>Lost/Replacement Cassette</type>
452 <type>Returned Check</type>
458 <keepalive>3</keepalive>
459 <stateless>1</stateless>
460 <implementation>OpenILS::Application::Ingest</implementation>
461 <language>perl</language>
462 <max_requests>1000000</max_requests>
464 <max_requests>1000000</max_requests>
465 <unix_log>open-ils.ingest-unix.log</unix_log>
466 <unix_sock>open-ils.ingest-unix.sock</unix_sock>
467 <unix_pid>open-ils.ingest-unix.pid</unix_pid>
468 <min_children>5</min_children>
469 <max_children>20</max_children>
470 <min_spare_children>2</min_spare_children>
471 <max_spare_children>5</max_spare_children>
474 <script_path>/openils/var/catalog/</script_path>
475 <script_path>/openils/var/web/opac/common/js/</script_path>
477 <biblio_fingerprint>biblio_fingerprint.js</biblio_fingerprint>
478 <biblio_descriptor>biblio_descriptor.js</biblio_descriptor>
484 <keepalive>10</keepalive>
485 <stateless>1</stateless>
486 <language>perl</language>
487 <implementation>OpenILS::Application::Storage</implementation>
489 <max_requests>1000</max_requests>
490 <unix_log>openils.storage_unix.log</unix_log>
491 <unix_sock>openils.storage_unix.sock</unix_sock>
492 <unix_pid>openils.storage_unix.pid</unix_pid>
493 <min_children>1</min_children>
494 <max_children>10</max_children>
495 <min_spare_children>1</min_spare_children>
496 <max_spare_children>5</max_spare_children>
499 <script_path>/openils/var/catalog/</script_path>
501 <biblio_fingerprint>biblio_fingerprint.js</biblio_fingerprint>
508 <user>postgres</user>
509 <host>localhost</host>
513 <client_encoding>UTF-8</client_encoding>
521 <keepalive>6</keepalive>
522 <stateless>1</stateless>
523 <language>C</language>
524 <implementation>oils_cstore.so</implementation>
525 <max_requests>95</max_requests>
527 <max_requests>400</max_requests>
528 <min_children>1</min_children>
529 <max_children>15</max_children>
530 <min_spare_children>1</min_spare_children>
531 <max_spare_children>5</max_spare_children>
534 <max_query_recursion>100</max_query_recursion>
535 <driver>pgsql</driver>
539 <user>postgres</user>
540 <host>localhost</host>
544 <client_encoding>UTF-8</client_encoding>
552 <keepalive>1</keepalive>
553 <stateless>1</stateless>
554 <language>perl</language>
555 <implementation>OpenSRF::Application::Settings</implementation>
556 <max_requests>17</max_requests>
558 <unix_sock>opensrf.settings_unix.sock</unix_sock>
559 <unix_pid>opensrf.settings_unix.pid</unix_pid>
560 <max_requests>300</max_requests>
561 <unix_log>opensrf.settings_unix.log</unix_log>
562 <min_children>5</min_children>
563 <max_children>15</max_children>
564 <min_spare_children>3</min_spare_children>
565 <max_spare_children>5</max_spare_children>
569 <open-ils.collections>
570 <keepalive>3</keepalive>
571 <stateless>1</stateless>
572 <language>perl</language>
573 <implementation>OpenILS::Application::Collections</implementation>
574 <max_requests>17</max_requests>
576 <unix_sock>openils.collections_unix.sock</unix_sock>
577 <unix_pid>openils.collections_unix.pid</unix_pid>
578 <max_requests>1000</max_requests>
579 <unix_log>openils.collections_unix.log</unix_log>
580 <min_children>1</min_children>
581 <max_children>10</max_children>
582 <min_spare_children>1</min_spare_children>
583 <max_spare_children>5</max_spare_children>
585 </open-ils.collections>
588 <keepalive>3</keepalive>
589 <stateless>1</stateless>
590 <language>perl</language>
591 <implementation>OpenILS::Application::Reporter</implementation>
592 <max_requests>99</max_requests>
594 <unix_sock>openils.reporter_unix.sock</unix_sock>
595 <unix_pid>openils.reporter_unix.pid</unix_pid>
596 <max_requests>1000</max_requests>
597 <unix_log>openils.reporter_unix.log</unix_log>
598 <min_children>1</min_children>
599 <max_children>10</max_children>
600 <min_spare_children>1</min_spare_children>
601 <max_spare_children>5</max_spare_children>
606 <open-ils.reporter-store>
607 <keepalive>6</keepalive>
608 <stateless>1</stateless>
609 <language>C</language>
610 <implementation>oils_rstore.so</implementation>
611 <max_requests>95</max_requests>
613 <max_requests>400</max_requests>
614 <min_children>1</min_children>
615 <max_children>10</max_children>
616 <min_spare_children>1</min_spare_children>
617 <max_spare_children>5</max_spare_children>
620 <driver>pgsql</driver>
624 <user>postgres</user>
625 <host>localhost</host>
629 <client_encoding>UTF-8</client_encoding>
632 </open-ils.reporter-store>
640 <evergreen.example.org>
642 must match the fully qualified domain name of the host.
643 on Linux, this is usually the output of "hostname -f"
644 'localhost' won't work here
648 <!-- services hosted on this machine -->
649 <appname>opensrf.settings</appname>
650 <appname>opensrf.math</appname>
651 <appname>opensrf.dbmath</appname>
652 <appname>open-ils.cat</appname>
653 <appname>open-ils.supercat</appname>
654 <appname>open-ils.search</appname>
655 <appname>open-ils.circ</appname>
656 <appname>open-ils.actor</appname>
657 <appname>open-ils.auth</appname>
658 <appname>open-ils.storage</appname>
659 <appname>open-ils.penalty</appname>
660 <appname>open-ils.cstore</appname>
661 <appname>open-ils.collections</appname>
662 <appname>open-ils.ingest</appname>
663 <appname>open-ils.reporter</appname>
664 <appname>open-ils.reporter-store</appname>
666 </evergreen.example.org>