4 Example opensrf config file for OpenILS
8 <opensrf version='0.0.3'>
13 <log>/openils/var/log</log> <!-- unix::server log files -->
14 <sock>/openils/var/sock</sock> <!-- unix::server sock files -->
15 <pid>/openils/var/pid</pid>
16 <xsl>/openils/var/xsl</xsl>
17 <script>/openils/var</script>
18 <script_lib>/openils/var</script_lib>
21 <!-- global data visibility settings -->
24 <!-- Set to "true" to require patron opt-in for foreign (non-home_ou) transactions -->
25 <opt_in>false</opt_in>
29 <IDL>/openils/conf/fm_IDL.xml</IDL> <!-- top level IDL file -->
31 <server_type>prefork</server_type> <!-- net::server type -->
33 <ils_events>/openils/var/data/ils_events.xml</ils_events> <!-- ILS events description file -->
35 <email_notify> <!-- this will eventually move into the notifications section below... -->
36 <!-- global email notification settings -->
37 <template>/openils/var/data/hold_notification_template.example</template>
38 <smtp_server>localhost</smtp_server>
41 in most cases, this is overridden by location
42 specific config settings. this is just the default
44 <sender_address>evergreen@localhost</sender_address>
49 <!-- global mail server settings -->
50 <smtp_server>localhost</smtp_server>
51 <sender_address>evergreen@localhost</sender_address>
53 <!-- Overdue notices -->
56 <!-- optionally, you can define a sender address per notice type -->
57 <sender_address>overdue@localhost</sender_address>
59 <!-- The system can generate an XML file of overdue notices. This is the
60 directory where they are stored. Files are named overdue.YYYY-MM-DD.xml -->
61 <notice_dir>/openils/var/data/overdue</notice_dir>
62 <combined_template>/openils/var/data/templates/overdue_combined_xml.example</combined_template>
65 <!-- Notify at 7 days overdue -->
66 <notify_interval>7 days</notify_interval>
67 <!-- Options include always, noemail, and never. 'noemail' means a notice
68 will be appended to the notice file only if the patron has no valid email address. -->
69 <file_append>noemail</file_append>
70 <!-- do we attempt email notification? -->
71 <email_notify>true</email_notify>
72 <!-- notice template file -->
73 <email_template>/openils/var/data/templates/overdue_7day.example</email_template>
77 <!-- Courtesy notices -->
80 <!-- All circulations that circulate between 5 and 13 days -->
84 </circ_duration_range>
85 <!-- notify at 1 day before the due date -->
86 <notify_interval>1 day</notify_interval>
87 <file_append>false</file_append>
88 <email_notify>true</email_notify>
89 <email_template>/openils/var/data/templates/predue_1day.example</email_template>
96 Settings for the reporter daemon process
99 <base_uri>https://localhost/reporter/</base_uri>
102 <host>localhost</host>
105 <user>postgres</user>
109 <!-- successful report outputs go here -->
110 <output_base>/openils/var/web/reporter</output_base>
111 <success_template>/openils/var/data/report-success</success_template>
112 <fail_template>/openils/var/data/report-fail</fail_template>
120 <!-- XML-RPC gateway. Do NOT publish unprotected services here -->
122 <!-- list of published services -->
123 <service>opensrf.math</service>
124 <service>opensrf.dbmath</service>
125 <service>open-ils.cat</service>
126 <service>open-ils.search</service>
127 <service>open-ils.circ</service>
128 <service>open-ils.actor</service>
129 <service>open-ils.auth</service>
130 <service>open-ils.collections</service>
136 <default>oclc</default>
140 <!-- LoC does not require username/password -->
142 <host>z3950.loc.gov</host>
145 <!-- fetch the full record with no holdings. FI is the most common choice -->
146 <record_format>FI</record_format>
148 <!-- Record transmission format from the server. Supported -->
149 <!-- formats include usmarc and xml (for marcxml). -->
150 <transmission_format>usmarc</transmission_format>
153 <tcn><code>12</code><format>1</format></tcn>
154 <isbn><code>7</code><format>6</format></isbn>
155 <lccn><code>9</code><format>1</format></lccn>
156 <author><code>1003</code><format>6</format></author>
157 <title><code>4</code><format>6</format></title>
158 <issn><code>8</code><format>1</format></issn>
159 <publisher><code>1018</code><format>6</format></publisher>
160 <pubdate><code>31</code><format>1</format></pubdate>
161 <item_type><code>1001</code><format>1</format></item_type>
166 <!-- Z3950 settings for OCLC. Note that OCLC requires username/password -->
167 <host>zcat.oclc.org</host>
169 <db>OLUCWorldCat</db>
172 These are directly from the Bib-1 Attribute Set
173 http://www.loc.gov/z3950/agency/defns/bib1.html
174 <code> is the "use attribute", <format> is the "structure attribute"
175 This just puts some friendly names on the data.
177 <tcn><code>12</code><format>1</format></tcn>
178 <isbn><code>7</code><format>6</format></isbn>
179 <lccn><code>9</code><format>1</format></lccn>
180 <author><code>1003</code><format>6</format></author>
181 <title><code>4</code><format>6</format></title>
182 <issn><code>8</code><format>1</format></issn>
183 <publisher><code>1018</code><format>6</format></publisher>
184 <pubdate><code>31</code><format>1</format></pubdate>
185 <item_type><code>1001</code><format>1</format></item_type>
195 <!-- XXX If you use the Amazon plugin, you must link back to Amazon in the OPAC -->
197 <!-- load the Amazon added content module -->
198 <module>OpenILS::WWW::AddedContent::Amazon</module>
200 Base URL for Amazon added content fetching. This URL may
201 need to be shortened when new (read: non-image) content
202 fetching capabilities are added
204 <base_url>http://images.amazon.com/images/P/</base_url>
207 Max number of seconds to wait for an added content request to
208 return data. Data not returned within the timeout is considered
214 After added content lookups have been disabled due to too many
215 lookup failures, this is the amount of time to wait before
218 <retry_timeout>600</retry_timeout>
221 maximum number of consecutive lookup errors a given process can
222 have before added content lookups are disabled for everyone
224 <max_errors>4</max_errors>
226 <!-- If a userid is required to access the added content.. -->
227 <userid>MY_USER_ID</userid>
230 You can add free-form settings here and they will be accessible
231 within the added content module
238 <!-- no apps are enabled globally by default -->
242 <!-- memcache servers -->
245 <server>localhost:11211</server>
247 <max_cache_time>86400</max_cache_time>
252 <!-- Authentication server -->
255 <!-- how long to wait between stateful requests before the child process re-joins the pool -->
256 <keepalive>5</keepalive>
258 <!-- true if this service support stateless requests -->
259 <stateless>1</stateless>
261 <!-- implementation language -->
262 <language>c</language>
264 <!-- library to plugin -->
265 <implementation>oils_auth.so</implementation>
267 <!-- maximum required opensrf requests within a stateful connection -->
268 <max_requests>93</max_requests>
272 maximum number of top level requests coming to
273 this child before the child is recycled
275 <max_requests>1000</max_requests>
276 <!-- min children to fork -->
277 <min_children>1</min_children>
278 <!-- max possible children to fork -->
279 <max_children>15</max_children>
282 C forking implementation does not support
283 min/max idle children, but may in the future
286 <!-- min idle children -->
287 <min_spare_children>1</min_spare_children>
288 <!-- max idle children -->
289 <max_spare_children>5</max_spare_children>
294 <!-- defined app-specific settings here -->
296 <!-- default login timeouts based on login type -->
305 <!-- Generic search server -->
307 <keepalive>5</keepalive>
308 <stateless>1</stateless>
309 <language>perl</language>
310 <implementation>OpenILS::Application::Search</implementation>
311 <max_requests>93</max_requests>
314 <!-- the following 3 settings are currently used by Perl services only -->
315 <unix_sock>open-ils.search_unix.sock</unix_sock>
316 <unix_pid>open-ils.search_unix.pid</unix_pid>
317 <unix_log>open-ils.search_unix.log</unix_log>
319 <max_requests>1000</max_requests>
320 <min_children>1</min_children>
321 <max_children>15</max_children>
322 <min_spare_children>1</min_spare_children>
323 <max_spare_children>5</max_spare_children>
326 <marc_html_xsl>oilsMARC21slim2HTML.xsl</marc_html_xsl>
328 <!-- Default to using staged search -->
329 <use_staged_search>true</use_staged_search>
332 For staged search, we estimate hits based on inclusion or exclusion.
335 inclusion - visible ratio on superpage
336 exclusion - excluded ratio on superpage
337 delete_adjusted_inclusion - included ratio on superpage, ratio adjusted by deleted count
338 delete_adjusted_exclusion - excluded ratio on superpage, ratio adjusted by deleted count
340 Under normal circumstances, inclusion is the best strategy, and both delete_adjusted variants
341 will return the same value +/- 1. The exclusion strategy is the original, and works well
342 when there are few deleted or excluded records, in other words, when the superpage is not
343 sparsely populated with visible records.
345 <estimation_strategy>inclusion</estimation_strategy>
347 <!-- Baseline number of records to check for hit estimation. -->
348 <superpage_size>1000</superpage_size>
350 <!-- How many superpages to consider for searching overall. -->
351 <max_superpages>10</max_superpages>
353 <!-- zip code database file -->
354 <!--<zips_file>/openils/var/data/zips.txt</zips_file>-->
358 <!-- server for accessing user info -->
360 <keepalive>5</keepalive>
361 <stateless>1</stateless>
362 <language>perl</language>
363 <implementation>OpenILS::Application::Actor</implementation>
364 <max_requests>93</max_requests>
366 <unix_sock>open-ils.actor_unix.sock</unix_sock>
367 <unix_pid>open-ils.actor_unix.pid</unix_pid>
368 <max_requests>1000</max_requests>
369 <unix_log>open-ils.actor_unix.log</unix_log>
370 <min_children>1</min_children>
371 <max_children>15</max_children>
372 <min_spare_children>1</min_spare_children>
373 <max_spare_children>5</max_spare_children>
379 <keepalive>5</keepalive>
380 <stateless>1</stateless>
381 <language>perl</language>
382 <implementation>OpenILS::Application::Cat</implementation>
383 <max_requests>199</max_requests>
385 <unix_sock>open-ils.cat_unix.sock</unix_sock>
386 <unix_pid>open-ils.cat_unix.pid</unix_pid>
387 <max_requests>1000</max_requests>
388 <unix_log>open-ils.cat_unix.log</unix_log>
389 <min_children>1</min_children>
390 <max_children>15</max_children>
391 <min_spare_children>1</min_spare_children>
392 <max_spare_children>5</max_spare_children>
396 <K_book>/openils/var/templates/marc/k_book.xml</K_book>
402 <keepalive>5</keepalive>
403 <stateless>1</stateless>
404 <language>perl</language>
405 <implementation>OpenILS::Application::SuperCat</implementation>
406 <max_requests>199</max_requests>
408 <unix_sock>open-ils.supercat_unix.sock</unix_sock>
409 <unix_pid>open-ils.supercat_unix.pid</unix_pid>
410 <max_requests>1000</max_requests>
411 <unix_log>open-ils.supercat_unix.log</unix_log>
412 <min_children>1</min_children>
413 <max_children>15</max_children>
414 <min_spare_children>1</min_spare_children>
415 <max_spare_children>5</max_spare_children>
421 <keepalive>3</keepalive>
422 <stateless>1</stateless>
423 <language>c</language>
424 <implementation>osrf_math.so</implementation>
425 <max_requests>97</max_requests>
427 <unix_sock>opensrf.math_unix.sock</unix_sock>
428 <unix_pid>opensrf.math_unix.pid</unix_pid>
429 <max_requests>1000</max_requests>
430 <unix_log>opensrf.math_unix.log</unix_log>
431 <min_children>1</min_children>
432 <max_children>15</max_children>
433 <min_spare_children>1</min_spare_children>
434 <max_spare_children>5</max_spare_children>
439 <keepalive>3</keepalive>
440 <stateless>1</stateless>
441 <language>c</language>
442 <implementation>osrf_dbmath.so</implementation>
443 <max_requests>99</max_requests>
445 <max_requests>1000</max_requests>
446 <unix_log>opensrf.dbmath_unix.log</unix_log>
447 <unix_sock>opensrf.dbmath_unix.sock</unix_sock>
448 <unix_pid>opensrf.dbmath_unix.pid</unix_pid>
449 <min_children>1</min_children>
450 <max_children>15</max_children>
451 <min_spare_children>1</min_spare_children>
452 <max_spare_children>5</max_spare_children>
457 <keepalive>3</keepalive>
458 <stateless>1</stateless>
459 <language>perl</language>
460 <implementation>OpenILS::Application::Penalty</implementation>
461 <max_requests>99</max_requests>
463 <max_requests>1000</max_requests>
464 <unix_log>open-ils.penalty_unix.log</unix_log>
465 <unix_sock>open-ils.penalty_unix.sock</unix_sock>
466 <unix_pid>open-ils.penalty_unix.pid</unix_pid>
467 <min_children>1</min_children>
468 <max_children>15</max_children>
469 <min_spare_children>1</min_spare_children>
470 <max_spare_children>5</max_spare_children>
473 <patron_penalty>penalty/patron_penalty.js</patron_penalty>
474 <script_path>/openils/lib/javascript</script_path>
475 <script_path>/openils/var</script_path>
476 <script_path>/openils/var/catalog</script_path>
481 <keepalive>3</keepalive>
482 <stateless>1</stateless>
483 <language>perl</language>
484 <implementation>OpenILS::Application::Circ</implementation>
485 <max_requests>99</max_requests>
487 <max_requests>1000</max_requests>
488 <unix_log>open-ils.circ_unix.log</unix_log>
489 <unix_sock>open-ils.circ_unix.sock</unix_sock>
490 <unix_pid>open-ils.circ_unix.pid</unix_pid>
491 <min_children>1</min_children>
492 <max_children>15</max_children>
493 <min_spare_children>1</min_spare_children>
494 <max_spare_children>5</max_spare_children>
498 <email>false</email> <!-- set to true for hold notice emails -->
501 <!-- circulation policy scripts -->
502 <script_path>/openils/lib/javascript</script_path>
503 <script_path>/openils/var</script_path>
504 <script_path>/openils/var/catalog</script_path>
505 <legacy_script_support>false</legacy_script_support>
507 <circ_permit_patron>circ/circ_permit_patron.js</circ_permit_patron>
508 <circ_permit_copy>circ/circ_permit_copy.js</circ_permit_copy>
509 <circ_duration>circ/circ_duration.js</circ_duration>
510 <circ_recurring_fines>circ/circ_recurring_fines.js</circ_recurring_fines>
511 <circ_max_fines>circ/circ_max_fines.js</circ_max_fines>
512 <circ_permit_renew>circ/circ_permit_renew.js</circ_permit_renew>
513 <circ_permit_hold>circ/circ_permit_hold.js</circ_permit_hold>
522 <mod>bestseller</mod>
523 <mod>bestsellernh</mod>
538 <mod>softwrlong</mod>
539 <mod>equip-long</mod>
540 <mod>talking book</mod>
543 <mod>video-long</mod>
547 <type>Miscellaneous</type>
548 <type>Overdue materials</type>
549 <type>Fee for placing a hold</type>
550 <type>Fee for checking out a book</type>
551 <type>Fee for library card</type>
552 <type>Miscellaneous charges</type>
553 <type>Lost materials</type>
554 <type>Damaged material</type>
555 <type>Overdue Reserves charge</type>
556 <type>Recall overdue</type>
557 <type>Fee for processing lost library materials</type>
558 <type>Fee for sending patron bills to collection agency</type>
559 <type>Fee for interlibrary loan</type>
560 <type>Fee for copies</type>
561 <type>Money advanced to pay for telephone use</type>
562 <type>Deposit fee</type>
563 <type>Fee for disk</type>
564 <type>Fee for faxing</type>
565 <type>Fee for laminating</type>
566 <type>Fee for room cleaning</type>
567 <type>Deposit returned; fee refund</type>
568 <type>Sale items</type>
569 <type>Fee for lost card</type>
570 <type>Long overdue items</type>
571 <type>Lost/Replacement Cassette</type>
572 <type>Returned Check</type>
578 <keepalive>3</keepalive>
579 <stateless>1</stateless>
580 <implementation>OpenILS::Application::Ingest</implementation>
581 <language>perl</language>
582 <max_requests>1000000</max_requests>
584 <max_requests>1000000</max_requests>
585 <unix_log>open-ils.ingest-unix.log</unix_log>
586 <unix_sock>open-ils.ingest-unix.sock</unix_sock>
587 <unix_pid>open-ils.ingest-unix.pid</unix_pid>
588 <min_children>5</min_children>
589 <max_children>20</max_children>
590 <min_spare_children>2</min_spare_children>
591 <max_spare_children>5</max_spare_children>
594 <script_path>/openils/lib/javascript/</script_path>
595 <script_path>/openils/var/catalog/</script_path>
596 <script_path>/openils/var/web/opac/common/js/</script_path>
598 <biblio_fingerprint>biblio_fingerprint.js</biblio_fingerprint>
599 <biblio_descriptor>biblio_descriptor.js</biblio_descriptor>
605 <keepalive>10</keepalive>
606 <stateless>1</stateless>
607 <language>perl</language>
608 <implementation>OpenILS::Application::Storage</implementation>
610 <max_requests>1000</max_requests>
611 <unix_log>openils.storage_unix.log</unix_log>
612 <unix_sock>openils.storage_unix.sock</unix_sock>
613 <unix_pid>openils.storage_unix.pid</unix_pid>
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 <script_path>/openils/lib/javascript/</script_path>
621 <script_path>/openils/var/catalog/</script_path>
623 <biblio_fingerprint>biblio_fingerprint.js</biblio_fingerprint>
630 <user>postgres</user>
631 <host>localhost</host>
635 <client_encoding>UTF-8</client_encoding>
643 <keepalive>6</keepalive>
644 <stateless>1</stateless>
645 <language>C</language>
646 <implementation>oils_cstore.so</implementation>
647 <max_requests>95</max_requests>
649 <max_requests>400</max_requests>
650 <min_children>1</min_children>
651 <max_children>15</max_children>
652 <min_spare_children>1</min_spare_children>
653 <max_spare_children>5</max_spare_children>
656 <max_query_recursion>100</max_query_recursion>
657 <driver>pgsql</driver>
661 <user>postgres</user>
662 <host>localhost</host>
666 <client_encoding>UTF-8</client_encoding>
674 <keepalive>1</keepalive>
675 <stateless>1</stateless>
676 <language>perl</language>
677 <implementation>OpenSRF::Application::Settings</implementation>
678 <max_requests>17</max_requests>
680 <unix_sock>opensrf.settings_unix.sock</unix_sock>
681 <unix_pid>opensrf.settings_unix.pid</unix_pid>
682 <max_requests>300</max_requests>
683 <unix_log>opensrf.settings_unix.log</unix_log>
684 <min_children>5</min_children>
685 <max_children>15</max_children>
686 <min_spare_children>3</min_spare_children>
687 <max_spare_children>5</max_spare_children>
691 <open-ils.collections>
692 <keepalive>3</keepalive>
693 <stateless>1</stateless>
694 <language>perl</language>
695 <implementation>OpenILS::Application::Collections</implementation>
696 <max_requests>17</max_requests>
698 <unix_sock>openils.collections_unix.sock</unix_sock>
699 <unix_pid>openils.collections_unix.pid</unix_pid>
700 <max_requests>1000</max_requests>
701 <unix_log>openils.collections_unix.log</unix_log>
702 <min_children>1</min_children>
703 <max_children>10</max_children>
704 <min_spare_children>1</min_spare_children>
705 <max_spare_children>5</max_spare_children>
707 </open-ils.collections>
710 <keepalive>3</keepalive>
711 <stateless>1</stateless>
712 <language>perl</language>
713 <implementation>OpenILS::Application::Reporter</implementation>
714 <max_requests>99</max_requests>
716 <unix_sock>openils.reporter_unix.sock</unix_sock>
717 <unix_pid>openils.reporter_unix.pid</unix_pid>
718 <max_requests>1000</max_requests>
719 <unix_log>openils.reporter_unix.log</unix_log>
720 <min_children>1</min_children>
721 <max_children>10</max_children>
722 <min_spare_children>1</min_spare_children>
723 <max_spare_children>5</max_spare_children>
728 <open-ils.reporter-store>
729 <keepalive>6</keepalive>
730 <stateless>1</stateless>
731 <language>C</language>
732 <implementation>oils_rstore.so</implementation>
733 <max_requests>95</max_requests>
735 <max_requests>400</max_requests>
736 <min_children>1</min_children>
737 <max_children>10</max_children>
738 <min_spare_children>1</min_spare_children>
739 <max_spare_children>5</max_spare_children>
742 <driver>pgsql</driver>
746 <user>postgres</user>
747 <host>localhost</host>
751 <client_encoding>UTF-8</client_encoding>
754 </open-ils.reporter-store>
757 <keepalive>3</keepalive>
758 <stateless>1</stateless>
759 <language>perl</language>
760 <implementation>OpenILS::Application::PermaCrud</implementation>
761 <max_requests>17</max_requests>
763 <unix_sock>open-ils.permacrud_unix.sock</unix_sock>
764 <unix_pid>open-ils.permacrud_unix.pid</unix_pid>
765 <max_requests>1000</max_requests>
766 <unix_log>open-ils.permacrud_unix.log</unix_log>
767 <min_children>5</min_children>
768 <max_children>15</max_children>
769 <min_spare_children>3</min_spare_children>
770 <max_spare_children>5</max_spare_children>
772 </open-ils.permacrud>
775 <keepalive>3</keepalive>
776 <stateless>1</stateless>
777 <language>perl</language>
778 <implementation>OpenILS::Application::Fielder</implementation>
779 <max_requests>17</max_requests>
781 <unix_sock>open-ils.fielder_unix.sock</unix_sock>
782 <unix_pid>open-ils.fielder_unix.pid</unix_pid>
783 <max_requests>1000</max_requests>
784 <unix_log>open-ils.fielder_unix.log</unix_log>
785 <min_children>5</min_children>
786 <max_children>15</max_children>
787 <min_spare_children>3</min_spare_children>
788 <max_spare_children>5</max_spare_children>
799 Should match the fully qualified domain name of the host.
801 On Linux, the output of the following command is authoritative:
802 $ perl -MNet::Domain -e 'print Net::Domain::hostfqdn();'
804 To use 'localhost' instead, run osrf_ctl.sh with the -l flag
808 <!-- services hosted on this machine -->
809 <appname>opensrf.settings</appname>
810 <appname>opensrf.math</appname>
811 <appname>opensrf.dbmath</appname>
812 <appname>open-ils.cat</appname>
813 <appname>open-ils.supercat</appname>
814 <appname>open-ils.search</appname>
815 <appname>open-ils.circ</appname>
816 <appname>open-ils.actor</appname>
817 <appname>open-ils.auth</appname>
818 <appname>open-ils.storage</appname>
819 <appname>open-ils.penalty</appname>
820 <appname>open-ils.cstore</appname>
821 <appname>open-ils.collections</appname>
822 <appname>open-ils.ingest</appname>
823 <appname>open-ils.reporter</appname>
824 <appname>open-ils.reporter-store</appname>
825 <appname>open-ils.permacrud</appname>
826 <appname>open-ils.fielder</appname>