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 <IDL>/openils/conf/fm_IDL.xml</IDL> <!-- top level IDL file -->
21 <server_type>prefork</server_type> <!-- net::server type -->
22 <ils_events>/openils/var/data/ils_events.xml</ils_events> <!-- ILS events description file -->
25 <!-- global email notification settings -->
26 <template>/openils/var/data/hold_notification_template.example</template>
27 <smtp_server>localhost</smtp_server>
29 <!-- in most cases, this is overridden by location
30 specific config settings. this is just the default -->
31 <sender_address>evergreen@localhost</sender_address>
37 Settings for the reporter daemon process
40 <base_uri>https://localhost/reporter/</base_uri>
43 <host>localhost</host>
45 <name>evergreen</name>
47 <password>postgres</password>
50 <!-- successful report outputs go here -->
51 <output_base>/openils/var/reporter/output</output_base>
52 <success_template>/openils/var/data/report-success</success_template>
53 <fail_template>/openils/var/data/report-fail</fail_template>
61 <!-- XML-RPC gateway. Do NOT publish unprotected services here -->
63 <!-- list of published services -->
64 <service>opensrf.math</service>
65 <service>opensrf.dbmath</service>
66 <service>open-ils.cat</service>
67 <service>open-ils.search</service>
68 <service>open-ils.circ</service>
69 <service>open-ils.actor</service>
70 <service>open-ils.auth</service>
71 <service>open-ils.collections</service>
77 <default>oclc</default>
81 <!-- LoC does not require username/password -->
83 <host>z3950.loc.gov</host>
87 <tcn><code>12</code><format>1</format></tcn>
88 <isbn><code>7</code><format>6</format></isbn>
89 <lccn><code>9</code><format>1</format></lccn>
90 <author><code>1003</code><format>6</format></author>
91 <title><code>4</code><format>6</format></title>
92 <issn><code>8</code><format>1</format></issn>
93 <publisher><code>1018</code><format>6</format></publisher>
94 <pubdate><code>31</code><format>1</format></pubdate>
95 <item_type><code>1001</code><format>1</format></item_type>
100 <!-- Z3950 settings for OCLC. Note that OCLC requires username/password -->
101 <host>zcat.oclc.org</host>
103 <db>OLUCWorldCat</db>
106 These are directly from the Bib-1 Attribute Set
107 http://www.loc.gov/z3950/agency/defns/bib1.html
108 <code> is the "use attribute", <format> is the "structure attribute"
109 This just puts some friendly names on the data.
111 <tcn><code>12</code><format>1</format></tcn>
112 <isbn><code>7</code><format>6</format></isbn>
113 <lccn><code>9</code><format>1</format></lccn>
114 <author><code>1003</code><format>6</format></author>
115 <title><code>4</code><format>6</format></title>
116 <issn><code>8</code><format>1</format></issn>
117 <publisher><code>1018</code><format>6</format></publisher>
118 <pubdate><code>31</code><format>1</format></pubdate>
119 <item_type><code>1001</code><format>1</format></item_type>
128 <!-- configure an added content plugin -->
129 <module>OpenILS::WWW::AddedContent::Syndetic</module>
130 <userid>MY_USER_ID</userid>
131 <base_url>http://syndetics.com/index.aspx</base_url>
137 <!-- no apps are enabled globally by default -->
141 <!-- memcache servers -->
144 <server>localhost:11211</server>
146 <max_cache_time>86400</max_cache_time>
151 <!-- Authentication server -->
154 <!-- how long to wait between stateful requests before the child process re-joins the pool -->
155 <keepalive>5</keepalive>
157 <!-- true if this service support stateless requests -->
158 <stateless>1</stateless>
160 <!-- implementation language -->
161 <language>c</language>
163 <!-- library to plugin -->
164 <implementation>oils_auth.so</implementation>
166 <!-- maximum required opensrf requests within a stateful connection -->
167 <max_requests>93</max_requests>
170 <!-- maximum number of top level requests coming to
171 this child before the child is recycled -->
172 <max_requests>1000</max_requests>
173 <!-- min children to fork -->
174 <min_children>1</min_children>
175 <!-- max possible children to fork -->
176 <max_children>15</max_children>
178 <!-- C forking implementation does not support
179 min/max idle children, but may in the future -->
181 <!-- min idle children -->
182 <min_spare_children>1</min_spare_children>
183 <!-- max idle children -->
184 <max_spare_children>5</max_spare_children>
189 <!-- defined app-specific settings here -->
191 <!-- default login timeouts based on login type -->
200 <!-- Generic search server -->
202 <keepalive>5</keepalive>
203 <stateless>1</stateless>
204 <language>perl</language>
205 <implementation>OpenILS::Application::Search</implementation>
206 <max_requests>93</max_requests>
209 <!-- the following 3 settings are currently used by Perl services only -->
210 <unix_sock>open-ils.search_unix.sock</unix_sock>
211 <unix_pid>open-ils.search_unix.pid</unix_pid>
212 <unix_log>open-ils.search_unix.log</unix_log>
214 <max_requests>1000</max_requests>
215 <min_children>1</min_children>
216 <max_children>15</max_children>
217 <min_spare_children>1</min_spare_children>
218 <max_spare_children>5</max_spare_children>
221 <marc_html_xsl>oilsMARC21slim2HTML.xsl</marc_html_xsl>
222 <!-- zip code database file -->
223 <!--<zips_file>/openils/var/data/zips.txt</zips_file>-->
227 <!-- server for accessing user info -->
229 <keepalive>5</keepalive>
230 <stateless>1</stateless>
231 <language>perl</language>
232 <implementation>OpenILS::Application::Actor</implementation>
233 <max_requests>93</max_requests>
235 <unix_sock>open-ils.actor_unix.sock</unix_sock>
236 <unix_pid>open-ils.actor_unix.pid</unix_pid>
237 <max_requests>1000</max_requests>
238 <unix_log>open-ils.actor_unix.log</unix_log>
239 <min_children>1</min_children>
240 <max_children>15</max_children>
241 <min_spare_children>1</min_spare_children>
242 <max_spare_children>5</max_spare_children>
248 <keepalive>5</keepalive>
249 <stateless>1</stateless>
250 <language>perl</language>
251 <implementation>OpenILS::Application::Cat</implementation>
252 <max_requests>199</max_requests>
254 <unix_sock>open-ils.cat_unix.sock</unix_sock>
255 <unix_pid>open-ils.cat_unix.pid</unix_pid>
256 <max_requests>1000</max_requests>
257 <unix_log>open-ils.cat_unix.log</unix_log>
258 <min_children>1</min_children>
259 <max_children>15</max_children>
260 <min_spare_children>1</min_spare_children>
261 <max_spare_children>5</max_spare_children>
265 <K_book>/openils/var/templates/marc/k_book.xml</K_book>
271 <keepalive>5</keepalive>
272 <stateless>1</stateless>
273 <language>perl</language>
274 <implementation>OpenILS::Application::SuperCat</implementation>
275 <max_requests>199</max_requests>
277 <unix_sock>open-ils.supercat_unix.sock</unix_sock>
278 <unix_pid>open-ils.supercat_unix.pid</unix_pid>
279 <max_requests>1000</max_requests>
280 <unix_log>open-ils.supercat_unix.log</unix_log>
281 <min_children>1</min_children>
282 <max_children>15</max_children>
283 <min_spare_children>1</min_spare_children>
284 <max_spare_children>5</max_spare_children>
290 <keepalive>3</keepalive>
291 <stateless>1</stateless>
292 <language>c</language>
293 <implementation>osrf_math.so</implementation>
294 <max_requests>97</max_requests>
296 <unix_sock>opensrf.math_unix.sock</unix_sock>
297 <unix_pid>opensrf.math_unix.pid</unix_pid>
298 <max_requests>1000</max_requests>
299 <unix_log>opensrf.math_unix.log</unix_log>
300 <min_children>1</min_children>
301 <max_children>15</max_children>
302 <min_spare_children>1</min_spare_children>
303 <max_spare_children>5</max_spare_children>
308 <keepalive>3</keepalive>
309 <stateless>1</stateless>
310 <language>c</language>
311 <implementation>osrf_dbmath.so</implementation>
312 <max_requests>99</max_requests>
314 <max_requests>1000</max_requests>
315 <unix_log>opensrf.dbmath_unix.log</unix_log>
316 <unix_sock>opensrf.dbmath_unix.sock</unix_sock>
317 <unix_pid>opensrf.dbmath_unix.pid</unix_pid>
318 <min_children>1</min_children>
319 <max_children>15</max_children>
320 <min_spare_children>1</min_spare_children>
321 <max_spare_children>5</max_spare_children>
326 <keepalive>3</keepalive>
327 <stateless>1</stateless>
328 <language>perl</language>
329 <implementation>OpenILS::Application::Penalty</implementation>
330 <max_requests>99</max_requests>
332 <max_requests>1000</max_requests>
333 <unix_log>open-ils.penalty_unix.log</unix_log>
334 <unix_sock>open-ils.penalty_unix.sock</unix_sock>
335 <unix_pid>open-ils.penalty_unix.pid</unix_pid>
336 <min_children>1</min_children>
337 <max_children>15</max_children>
338 <min_spare_children>1</min_spare_children>
339 <max_spare_children>5</max_spare_children>
342 <patron_penalty>penalty/patron_penalty.js</patron_penalty>
343 <script_path>/openils/var</script_path>
344 <script_path>/openils/var/catalog</script_path>
349 <keepalive>3</keepalive>
350 <stateless>1</stateless>
351 <language>perl</language>
352 <implementation>OpenILS::Application::Circ</implementation>
353 <max_requests>99</max_requests>
355 <max_requests>1000</max_requests>
356 <unix_log>open-ils.circ_unix.log</unix_log>
357 <unix_sock>open-ils.circ_unix.sock</unix_sock>
358 <unix_pid>open-ils.circ_unix.pid</unix_pid>
359 <min_children>1</min_children>
360 <max_children>15</max_children>
361 <min_spare_children>1</min_spare_children>
362 <max_spare_children>5</max_spare_children>
366 <email>false</email> <!-- set to true for hold notice emails -->
369 <!-- circulation policy scripts -->
370 <script_path>/openils/var</script_path>
371 <script_path>/openils/var/catalog</script_path>
373 <circ_permit_patron>circ/circ_permit_patron.js</circ_permit_patron>
374 <circ_permit_copy>circ/circ_permit_copy.js</circ_permit_copy>
375 <circ_duration>circ/circ_duration.js</circ_duration>
376 <circ_recurring_fines>circ/circ_recurring_fines.js</circ_recurring_fines>
377 <circ_max_fines>circ/circ_max_fines.js</circ_max_fines>
378 <circ_permit_renew>circ/circ_permit_renew.js</circ_permit_renew>
379 <circ_permit_hold>circ/circ_permit_hold.js</circ_permit_hold>
388 <mod>bestseller</mod>
389 <mod>bestsellernh</mod>
404 <mod>softwrlong</mod>
405 <mod>equip-long</mod>
406 <mod>talking book</mod>
409 <mod>video-long</mod>
413 <type>Miscellaneous</type>
414 <type>Overdue materials</type>
415 <type>Fee for placing a hold</type>
416 <type>Fee for checking out a book</type>
417 <type>Fee for library card</type>
418 <type>Miscellaneous charges</type>
419 <type>Lost materials</type>
420 <type>Damaged material</type>
421 <type>Overdue Reserves charge</type>
422 <type>Recall overdue</type>
423 <type>Fee for processing lost library materials</type>
424 <type>Fee for sending patron bills to collection agency</type>
425 <type>Fee for interlibrary loan</type>
426 <type>Fee for copies</type>
427 <type>Money advanced to pay for telephone use</type>
428 <type>Deposit fee</type>
429 <type>Fee for disk</type>
430 <type>Fee for faxing</type>
431 <type>Fee for laminating</type>
432 <type>Fee for room cleaning</type>
433 <type>Deposit returned; fee refund</type>
434 <type>Sale items</type>
435 <type>Fee for lost card</type>
436 <type>Long overdue items</type>
437 <type>Lost/Replacement Cassette</type>
438 <type>Returned Check</type>
444 <keepalive>3</keepalive>
445 <stateless>1</stateless>
446 <implementation>OpenILS::Application::Ingest</implementation>
447 <language>perl</language>
448 <max_requests>1000000</max_requests>
450 <max_requests>1000000</max_requests>
451 <unix_log>open-ils.ingest-unix.log</unix_log>
452 <unix_sock>open-ils.ingest-unix.sock</unix_sock>
453 <unix_pid>open-ils.ingest-unix.pid</unix_pid>
454 <min_children>5</min_children>
455 <max_children>20</max_children>
456 <min_spare_children>2</min_spare_children>
457 <max_spare_children>5</max_spare_children>
460 <script_path>/openils/var/catalog/</script_path>
461 <script_path>/openils/var/web/opac/common/js/</script_path>
463 <biblio_fingerprint>biblio_fingerprint.js</biblio_fingerprint>
464 <biblio_descriptor>biblio_descriptor.js</biblio_descriptor>
470 <keepalive>10</keepalive>
471 <stateless>1</stateless>
472 <language>perl</language>
473 <implementation>OpenILS::Application::Storage</implementation>
475 <max_requests>1000</max_requests>
476 <unix_log>storage_unix.log</unix_log>
477 <unix_sock>storage_unix.sock</unix_sock>
478 <unix_pid>storage_unix.pid</unix_pid>
479 <min_children>1</min_children>
480 <max_children>10</max_children>
481 <min_spare_children>1</min_spare_children>
482 <max_spare_children>5</max_spare_children>
485 <script_path>/openils/var/catalog/</script_path>
487 <biblio_fingerprint>biblio_fingerprint.js</biblio_fingerprint>
494 <user>postgres</user>
495 <host>localhost</host>
499 <client_encoding>UTF-8</client_encoding>
507 <keepalive>6</keepalive>
508 <stateless>1</stateless>
509 <language>C</language>
510 <implementation>oils_cstore.so</implementation>
511 <max_requests>95</max_requests>
513 <max_requests>400</max_requests>
514 <min_children>1</min_children>
515 <max_children>15</max_children>
516 <min_spare_children>1</min_spare_children>
517 <max_spare_children>5</max_spare_children>
520 <IDL>/openils/conf/fm_IDL.xml</IDL> <!-- deprecated with 1.1.0-->
521 <driver>pgsql</driver>
525 <user>postgres</user>
526 <host>localhost</host>
530 <client_encoding>UTF-8</client_encoding>
538 <keepalive>1</keepalive>
539 <stateless>1</stateless>
540 <language>perl</language>
541 <implementation>OpenSRF::Application::Settings</implementation>
542 <max_requests>17</max_requests>
544 <unix_sock>opensrf.settings_unix.sock</unix_sock>
545 <unix_pid>opoensrf.settings_unix.pid</unix_pid>
546 <max_requests>300</max_requests>
547 <unix_log>opensrf.settings_unix.log</unix_log>
548 <min_children>5</min_children>
549 <max_children>15</max_children>
550 <min_spare_children>3</min_spare_children>
551 <max_spare_children>5</max_spare_children>
555 <open-ils.collections>
556 <keepalive>3</keepalive>
557 <stateless>1</stateless>
558 <language>perl</language>
559 <implementation>OpenILS::Application::Collections</implementation>
560 <max_requests>17</max_requests>
562 <unix_sock>opensrf.collections_unix.sock</unix_sock>
563 <unix_pid>opoensrf.collections_unix.pid</unix_pid>
564 <max_requests>1000</max_requests>
565 <unix_log>opensrf.collections_unix.log</unix_log>
566 <min_children>1</min_children>
567 <max_children>10</max_children>
568 <min_spare_children>1</min_spare_children>
569 <max_spare_children>5</max_spare_children>
571 </open-ils.collections>
574 <keepalive>3</keepalive>
575 <stateless>1</stateless>
576 <language>perl</language>
577 <implementation>OpenILS::Application::Reporter</implementation>
578 <max_requests>99</max_requests>
580 <unix_sock>opensrf.reporter_unix.sock</unix_sock>
581 <unix_pid>opoensrf.reporter_unix.pid</unix_pid>
582 <max_requests>1000</max_requests>
583 <unix_log>opensrf.reporter_unix.log</unix_log>
584 <min_children>1</min_children>
585 <max_children>10</max_children>
586 <min_spare_children>1</min_spare_children>
587 <max_spare_children>5</max_spare_children>
592 <open-ils.reporter-store>
593 <keepalive>6</keepalive>
594 <stateless>1</stateless>
595 <language>C</language>
596 <implementation>oils_rstore.so</implementation>
597 <max_requests>95</max_requests>
599 <max_requests>400</max_requests>
600 <min_children>1</min_children>
601 <max_children>10</max_children>
602 <min_spare_children>1</min_spare_children>
603 <max_spare_children>5</max_spare_children>
606 <IDL>/openils/conf/fm_IDL.xml</IDL> <!-- deprecated with 1.1.0 -->
607 <driver>pgsql</driver>
611 <user>postgres</user>
612 <host>localhost</host>
616 <client_encoding>UTF-8</client_encoding>
619 </open-ils.reporter-store>
628 <!-- ^-=- must match the fully qualified domain name of the host
629 on Linux, this is usually the output of "hostname -f"
633 <!-- services hosted on this machine -->
634 <appname>opensrf.settings</appname>
635 <appname>opensrf.math</appname>
636 <appname>opensrf.dbmath</appname>
637 <appname>open-ils.cat</appname>
638 <appname>open-ils.supercat</appname>
639 <appname>open-ils.search</appname>
640 <appname>open-ils.circ</appname>
641 <appname>open-ils.actor</appname>
642 <appname>open-ils.auth</appname>
643 <appname>open-ils.storage</appname>
644 <appname>open-ils.penalty</appname>
645 <appname>open-ils.cstore</appname>
646 <appname>open-ils.collections</appname>
647 <appname>open-ils.ingest</appname>
648 <appname>open-ils.reporter</appname>
649 <appname>open-ils.reporter-store</appname>