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>
149 <!-- no apps are enabled globally by default -->
153 <!-- memcache servers -->
156 <server>localhost:11211</server>
158 <max_cache_time>86400</max_cache_time>
163 <!-- Authentication server -->
166 <!-- how long to wait between stateful requests before the child process re-joins the pool -->
167 <keepalive>5</keepalive>
169 <!-- true if this service support stateless requests -->
170 <stateless>1</stateless>
172 <!-- implementation language -->
173 <language>c</language>
175 <!-- library to plugin -->
176 <implementation>oils_auth.so</implementation>
178 <!-- maximum required opensrf requests within a stateful connection -->
179 <max_requests>93</max_requests>
182 <!-- maximum number of top level requests coming to
183 this child before the child is recycled -->
184 <max_requests>1000</max_requests>
185 <!-- min children to fork -->
186 <min_children>1</min_children>
187 <!-- max possible children to fork -->
188 <max_children>15</max_children>
190 <!-- C forking implementation does not support
191 min/max idle children, but may in the future -->
193 <!-- min idle children -->
194 <min_spare_children>1</min_spare_children>
195 <!-- max idle children -->
196 <max_spare_children>5</max_spare_children>
201 <!-- defined app-specific settings here -->
203 <!-- default login timeouts based on login type -->
212 <!-- Generic search server -->
214 <keepalive>5</keepalive>
215 <stateless>1</stateless>
216 <language>perl</language>
217 <implementation>OpenILS::Application::Search</implementation>
218 <max_requests>93</max_requests>
221 <!-- the following 3 settings are currently used by Perl services only -->
222 <unix_sock>open-ils.search_unix.sock</unix_sock>
223 <unix_pid>open-ils.search_unix.pid</unix_pid>
224 <unix_log>open-ils.search_unix.log</unix_log>
226 <max_requests>1000</max_requests>
227 <min_children>1</min_children>
228 <max_children>15</max_children>
229 <min_spare_children>1</min_spare_children>
230 <max_spare_children>5</max_spare_children>
233 <marc_html_xsl>oilsMARC21slim2HTML.xsl</marc_html_xsl>
234 <!-- zip code database file -->
235 <!--<zips_file>/openils/var/data/zips.txt</zips_file>-->
239 <!-- server for accessing user info -->
241 <keepalive>5</keepalive>
242 <stateless>1</stateless>
243 <language>perl</language>
244 <implementation>OpenILS::Application::Actor</implementation>
245 <max_requests>93</max_requests>
247 <unix_sock>open-ils.actor_unix.sock</unix_sock>
248 <unix_pid>open-ils.actor_unix.pid</unix_pid>
249 <max_requests>1000</max_requests>
250 <unix_log>open-ils.actor_unix.log</unix_log>
251 <min_children>1</min_children>
252 <max_children>15</max_children>
253 <min_spare_children>1</min_spare_children>
254 <max_spare_children>5</max_spare_children>
260 <keepalive>5</keepalive>
261 <stateless>1</stateless>
262 <language>perl</language>
263 <implementation>OpenILS::Application::Cat</implementation>
264 <max_requests>199</max_requests>
266 <unix_sock>open-ils.cat_unix.sock</unix_sock>
267 <unix_pid>open-ils.cat_unix.pid</unix_pid>
268 <max_requests>1000</max_requests>
269 <unix_log>open-ils.cat_unix.log</unix_log>
270 <min_children>1</min_children>
271 <max_children>15</max_children>
272 <min_spare_children>1</min_spare_children>
273 <max_spare_children>5</max_spare_children>
277 <K_book>/openils/var/templates/marc/k_book.xml</K_book>
283 <keepalive>5</keepalive>
284 <stateless>1</stateless>
285 <language>perl</language>
286 <implementation>OpenILS::Application::SuperCat</implementation>
287 <max_requests>199</max_requests>
289 <unix_sock>open-ils.supercat_unix.sock</unix_sock>
290 <unix_pid>open-ils.supercat_unix.pid</unix_pid>
291 <max_requests>1000</max_requests>
292 <unix_log>open-ils.supercat_unix.log</unix_log>
293 <min_children>1</min_children>
294 <max_children>15</max_children>
295 <min_spare_children>1</min_spare_children>
296 <max_spare_children>5</max_spare_children>
302 <keepalive>3</keepalive>
303 <stateless>1</stateless>
304 <language>c</language>
305 <implementation>osrf_math.so</implementation>
306 <max_requests>97</max_requests>
308 <unix_sock>opensrf.math_unix.sock</unix_sock>
309 <unix_pid>opensrf.math_unix.pid</unix_pid>
310 <max_requests>1000</max_requests>
311 <unix_log>opensrf.math_unix.log</unix_log>
312 <min_children>1</min_children>
313 <max_children>15</max_children>
314 <min_spare_children>1</min_spare_children>
315 <max_spare_children>5</max_spare_children>
320 <keepalive>3</keepalive>
321 <stateless>1</stateless>
322 <language>c</language>
323 <implementation>osrf_dbmath.so</implementation>
324 <max_requests>99</max_requests>
326 <max_requests>1000</max_requests>
327 <unix_log>opensrf.dbmath_unix.log</unix_log>
328 <unix_sock>opensrf.dbmath_unix.sock</unix_sock>
329 <unix_pid>opensrf.dbmath_unix.pid</unix_pid>
330 <min_children>1</min_children>
331 <max_children>15</max_children>
332 <min_spare_children>1</min_spare_children>
333 <max_spare_children>5</max_spare_children>
338 <keepalive>3</keepalive>
339 <stateless>1</stateless>
340 <language>perl</language>
341 <implementation>OpenILS::Application::Penalty</implementation>
342 <max_requests>99</max_requests>
344 <max_requests>1000</max_requests>
345 <unix_log>open-ils.penalty_unix.log</unix_log>
346 <unix_sock>open-ils.penalty_unix.sock</unix_sock>
347 <unix_pid>open-ils.penalty_unix.pid</unix_pid>
348 <min_children>1</min_children>
349 <max_children>15</max_children>
350 <min_spare_children>1</min_spare_children>
351 <max_spare_children>5</max_spare_children>
354 <patron_penalty>penalty/patron_penalty.js</patron_penalty>
355 <script_path>/openils/var</script_path>
356 <script_path>/openils/var/catalog</script_path>
361 <keepalive>3</keepalive>
362 <stateless>1</stateless>
363 <language>perl</language>
364 <implementation>OpenILS::Application::Circ</implementation>
365 <max_requests>99</max_requests>
367 <max_requests>1000</max_requests>
368 <unix_log>open-ils.circ_unix.log</unix_log>
369 <unix_sock>open-ils.circ_unix.sock</unix_sock>
370 <unix_pid>open-ils.circ_unix.pid</unix_pid>
371 <min_children>1</min_children>
372 <max_children>15</max_children>
373 <min_spare_children>1</min_spare_children>
374 <max_spare_children>5</max_spare_children>
378 <email>false</email> <!-- set to true for hold notice emails -->
381 <!-- circulation policy scripts -->
382 <script_path>/openils/var</script_path>
383 <script_path>/openils/var/catalog</script_path>
385 <circ_permit_patron>circ/circ_permit_patron.js</circ_permit_patron>
386 <circ_permit_copy>circ/circ_permit_copy.js</circ_permit_copy>
387 <circ_duration>circ/circ_duration.js</circ_duration>
388 <circ_recurring_fines>circ/circ_recurring_fines.js</circ_recurring_fines>
389 <circ_max_fines>circ/circ_max_fines.js</circ_max_fines>
390 <circ_permit_renew>circ/circ_permit_renew.js</circ_permit_renew>
391 <circ_permit_hold>circ/circ_permit_hold.js</circ_permit_hold>
400 <mod>bestseller</mod>
401 <mod>bestsellernh</mod>
416 <mod>softwrlong</mod>
417 <mod>equip-long</mod>
418 <mod>talking book</mod>
421 <mod>video-long</mod>
425 <type>Miscellaneous</type>
426 <type>Overdue materials</type>
427 <type>Fee for placing a hold</type>
428 <type>Fee for checking out a book</type>
429 <type>Fee for library card</type>
430 <type>Miscellaneous charges</type>
431 <type>Lost materials</type>
432 <type>Damaged material</type>
433 <type>Overdue Reserves charge</type>
434 <type>Recall overdue</type>
435 <type>Fee for processing lost library materials</type>
436 <type>Fee for sending patron bills to collection agency</type>
437 <type>Fee for interlibrary loan</type>
438 <type>Fee for copies</type>
439 <type>Money advanced to pay for telephone use</type>
440 <type>Deposit fee</type>
441 <type>Fee for disk</type>
442 <type>Fee for faxing</type>
443 <type>Fee for laminating</type>
444 <type>Fee for room cleaning</type>
445 <type>Deposit returned; fee refund</type>
446 <type>Sale items</type>
447 <type>Fee for lost card</type>
448 <type>Long overdue items</type>
449 <type>Lost/Replacement Cassette</type>
450 <type>Returned Check</type>
456 <keepalive>3</keepalive>
457 <stateless>1</stateless>
458 <implementation>OpenILS::Application::Ingest</implementation>
459 <language>perl</language>
460 <max_requests>1000000</max_requests>
462 <max_requests>1000000</max_requests>
463 <unix_log>open-ils.ingest-unix.log</unix_log>
464 <unix_sock>open-ils.ingest-unix.sock</unix_sock>
465 <unix_pid>open-ils.ingest-unix.pid</unix_pid>
466 <min_children>5</min_children>
467 <max_children>20</max_children>
468 <min_spare_children>2</min_spare_children>
469 <max_spare_children>5</max_spare_children>
472 <script_path>/openils/var/catalog/</script_path>
473 <script_path>/openils/var/web/opac/common/js/</script_path>
475 <biblio_fingerprint>biblio_fingerprint.js</biblio_fingerprint>
476 <biblio_descriptor>biblio_descriptor.js</biblio_descriptor>
482 <keepalive>10</keepalive>
483 <stateless>1</stateless>
484 <language>perl</language>
485 <implementation>OpenILS::Application::Storage</implementation>
487 <max_requests>1000</max_requests>
488 <unix_log>openils.storage_unix.log</unix_log>
489 <unix_sock>openils.storage_unix.sock</unix_sock>
490 <unix_pid>openils.storage_unix.pid</unix_pid>
491 <min_children>1</min_children>
492 <max_children>10</max_children>
493 <min_spare_children>1</min_spare_children>
494 <max_spare_children>5</max_spare_children>
497 <script_path>/openils/var/catalog/</script_path>
499 <biblio_fingerprint>biblio_fingerprint.js</biblio_fingerprint>
506 <user>postgres</user>
507 <host>localhost</host>
511 <client_encoding>UTF-8</client_encoding>
519 <keepalive>6</keepalive>
520 <stateless>1</stateless>
521 <language>C</language>
522 <implementation>oils_cstore.so</implementation>
523 <max_requests>95</max_requests>
525 <max_requests>400</max_requests>
526 <min_children>1</min_children>
527 <max_children>15</max_children>
528 <min_spare_children>1</min_spare_children>
529 <max_spare_children>5</max_spare_children>
532 <max_query_recursion>100</max_query_recursion>
533 <driver>pgsql</driver>
537 <user>postgres</user>
538 <host>localhost</host>
542 <client_encoding>UTF-8</client_encoding>
550 <keepalive>1</keepalive>
551 <stateless>1</stateless>
552 <language>perl</language>
553 <implementation>OpenSRF::Application::Settings</implementation>
554 <max_requests>17</max_requests>
556 <unix_sock>opensrf.settings_unix.sock</unix_sock>
557 <unix_pid>opensrf.settings_unix.pid</unix_pid>
558 <max_requests>300</max_requests>
559 <unix_log>opensrf.settings_unix.log</unix_log>
560 <min_children>5</min_children>
561 <max_children>15</max_children>
562 <min_spare_children>3</min_spare_children>
563 <max_spare_children>5</max_spare_children>
567 <open-ils.collections>
568 <keepalive>3</keepalive>
569 <stateless>1</stateless>
570 <language>perl</language>
571 <implementation>OpenILS::Application::Collections</implementation>
572 <max_requests>17</max_requests>
574 <unix_sock>openils.collections_unix.sock</unix_sock>
575 <unix_pid>openils.collections_unix.pid</unix_pid>
576 <max_requests>1000</max_requests>
577 <unix_log>openils.collections_unix.log</unix_log>
578 <min_children>1</min_children>
579 <max_children>10</max_children>
580 <min_spare_children>1</min_spare_children>
581 <max_spare_children>5</max_spare_children>
583 </open-ils.collections>
586 <keepalive>3</keepalive>
587 <stateless>1</stateless>
588 <language>perl</language>
589 <implementation>OpenILS::Application::Reporter</implementation>
590 <max_requests>99</max_requests>
592 <unix_sock>openils.reporter_unix.sock</unix_sock>
593 <unix_pid>openils.reporter_unix.pid</unix_pid>
594 <max_requests>1000</max_requests>
595 <unix_log>openils.reporter_unix.log</unix_log>
596 <min_children>1</min_children>
597 <max_children>10</max_children>
598 <min_spare_children>1</min_spare_children>
599 <max_spare_children>5</max_spare_children>
604 <open-ils.reporter-store>
605 <keepalive>6</keepalive>
606 <stateless>1</stateless>
607 <language>C</language>
608 <implementation>oils_rstore.so</implementation>
609 <max_requests>95</max_requests>
611 <max_requests>400</max_requests>
612 <min_children>1</min_children>
613 <max_children>10</max_children>
614 <min_spare_children>1</min_spare_children>
615 <max_spare_children>5</max_spare_children>
618 <driver>pgsql</driver>
622 <user>postgres</user>
623 <host>localhost</host>
627 <client_encoding>UTF-8</client_encoding>
630 </open-ils.reporter-store>
638 <evergreen.example.org>
640 must match the fully qualified domain name of the host.
641 on Linux, this is usually the output of "hostname -f"
642 'localhost' won't work here
646 <!-- services hosted on this machine -->
647 <appname>opensrf.settings</appname>
648 <appname>opensrf.math</appname>
649 <appname>opensrf.dbmath</appname>
650 <appname>open-ils.cat</appname>
651 <appname>open-ils.supercat</appname>
652 <appname>open-ils.search</appname>
653 <appname>open-ils.circ</appname>
654 <appname>open-ils.actor</appname>
655 <appname>open-ils.auth</appname>
656 <appname>open-ils.storage</appname>
657 <appname>open-ils.penalty</appname>
658 <appname>open-ils.cstore</appname>
659 <appname>open-ils.collections</appname>
660 <appname>open-ils.ingest</appname>
661 <appname>open-ils.reporter</appname>
662 <appname>open-ils.reporter-store</appname>
664 </evergreen.example.org>