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>
80 <!-- Z3950 settings for OCLC. Note that OCLC requires username/password -->
81 <host>zcat.oclc.org</host>
86 These are directly from the Bib-1 Attribute Set
87 http://www.loc.gov/z3950/agency/defns/bib1.html
88 <code> is the "use attribute", <format> is the "structure attribute"
89 This just puts some friendly names on the data.
90 Just copy this chunk to the <attrs> section of <loc> and
91 uncomment the chunk to use the LoC Z server instead
93 <tcn><code>12</code><format>1</format></tcn>
94 <isbn><code>7</code><format>6</format></isbn>
95 <lccn><code>9</code><format>1</format></lccn>
96 <author><code>1003</code><format>6</format></author>
97 <title><code>4</code><format>6</format></title>
98 <issn><code>8</code><format>1</format></issn>
99 <publisher><code>1018</code><format>6</format></publisher>
100 <pubdate><code>31</code><format>1</format></pubdate>
101 <item_type><code>1001</code><format>1</format></item_type>
108 <host>z3950.loc.gov</host>
121 <!-- configure an added content plugin -->
122 <module>OpenILS::WWW::AddedContent::Syndetic</module>
123 <userid>MY_USER_ID</userid>
124 <base_url>http://syndetics.com/index.aspx</base_url>
129 <!-- no apps are enabled globally by default -->
133 <!-- memcache servers -->
136 <server>localhost:11211</server>
138 <max_cache_time>86400</max_cache_time>
143 <!-- Authentication server -->
146 <!-- how long to wait between stateful requests before the child process re-joins the pool -->
147 <keepalive>5</keepalive>
149 <!-- true if this service support stateless requests -->
150 <stateless>1</stateless>
152 <!-- implementation language -->
153 <language>c</language>
155 <!-- library to plugin -->
156 <implementation>oils_auth.so</implementation>
158 <!-- maximum required opensrf requests within a stateful connection -->
159 <max_requests>93</max_requests>
163 <!-- Note that not all implementations use all settings -->
165 <!-- unix sock file -->
166 <unix_sock>open-ils.auth_unix.sock</unix_sock>
169 <unix_pid>open-ils.auth_unix.pid</unix_pid>
171 <!-- maximum number of top level requests coming to
172 this child before the child is recycled -->
173 <max_requests>1000</max_requests>
175 <!-- Perl net::server log -->
176 <unix_log>open-ils.auth_unix.log</unix_log>
177 <!-- min children to fork -->
178 <min_children>1</min_children>
179 <!-- max possible children to fork -->
180 <max_children>15</max_children>
181 <!-- min idle children -->
182 <min_spare_children>1</min_spare_children>
183 <!-- max idle children -->
184 <max_spare_children>5</max_spare_children>
188 <!-- defined app-specific settings here -->
190 <!-- default login timeouts based on login type -->
199 <!-- Generic search server -->
201 <keepalive>5</keepalive>
202 <stateless>1</stateless>
203 <language>perl</language>
204 <implementation>OpenILS::Application::Search</implementation>
205 <max_requests>93</max_requests>
207 <unix_sock>open-ils.search_unix.sock</unix_sock>
208 <unix_pid>open-ils.search_unix.pid</unix_pid>
209 <max_requests>1000</max_requests>
210 <unix_log>open-ils.search_unix.log</unix_log>
211 <min_children>1</min_children>
212 <max_children>15</max_children>
213 <min_spare_children>1</min_spare_children>
214 <max_spare_children>5</max_spare_children>
217 <marc_html_xsl>oilsMARC21slim2HTML.xsl</marc_html_xsl>
218 <!-- zip code database file -->
219 <!--<zips_file>/openils/var/data/zips.txt</zips_file>-->
223 <!-- server for accessing user info -->
225 <keepalive>5</keepalive>
226 <stateless>1</stateless>
227 <language>perl</language>
228 <implementation>OpenILS::Application::Actor</implementation>
229 <max_requests>93</max_requests>
231 <unix_sock>open-ils.actor_unix.sock</unix_sock>
232 <unix_pid>open-ils.actor_unix.pid</unix_pid>
233 <max_requests>1000</max_requests>
234 <unix_log>open-ils.actor_unix.log</unix_log>
235 <min_children>1</min_children>
236 <max_children>15</max_children>
237 <min_spare_children>1</min_spare_children>
238 <max_spare_children>5</max_spare_children>
244 <keepalive>5</keepalive>
245 <stateless>1</stateless>
246 <language>perl</language>
247 <implementation>OpenILS::Application::Cat</implementation>
248 <max_requests>199</max_requests>
250 <unix_sock>open-ils.cat_unix.sock</unix_sock>
251 <unix_pid>open-ils.cat_unix.pid</unix_pid>
252 <max_requests>1000</max_requests>
253 <unix_log>open-ils.cat_unix.log</unix_log>
254 <min_children>1</min_children>
255 <max_children>15</max_children>
256 <min_spare_children>1</min_spare_children>
257 <max_spare_children>5</max_spare_children>
261 <K_book>/openils/var/templates/marc/k_book.xml</K_book>
267 <keepalive>5</keepalive>
268 <stateless>1</stateless>
269 <language>perl</language>
270 <implementation>OpenILS::Application::SuperCat</implementation>
271 <max_requests>199</max_requests>
273 <unix_sock>open-ils.supercat_unix.sock</unix_sock>
274 <unix_pid>open-ils.supercat_unix.pid</unix_pid>
275 <max_requests>1000</max_requests>
276 <unix_log>open-ils.supercat_unix.log</unix_log>
277 <min_children>1</min_children>
278 <max_children>15</max_children>
279 <min_spare_children>1</min_spare_children>
280 <max_spare_children>5</max_spare_children>
286 <keepalive>3</keepalive>
287 <stateless>1</stateless>
288 <language>c</language>
289 <implementation>osrf_math.so</implementation>
290 <max_requests>97</max_requests>
292 <unix_sock>opensrf.math_unix.sock</unix_sock>
293 <unix_pid>opensrf.math_unix.pid</unix_pid>
294 <max_requests>1000</max_requests>
295 <unix_log>opensrf.math_unix.log</unix_log>
296 <min_children>1</min_children>
297 <max_children>15</max_children>
298 <min_spare_children>1</min_spare_children>
299 <max_spare_children>5</max_spare_children>
304 <keepalive>3</keepalive>
305 <stateless>1</stateless>
306 <language>c</language>
307 <implementation>osrf_dbmath.so</implementation>
308 <max_requests>99</max_requests>
310 <max_requests>1000</max_requests>
311 <unix_log>opensrf.dbmath_unix.log</unix_log>
312 <unix_sock>opensrf.dbmath_unix.sock</unix_sock>
313 <unix_pid>opensrf.dbmath_unix.pid</unix_pid>
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>perl</language>
325 <implementation>OpenILS::Application::Penalty</implementation>
326 <max_requests>99</max_requests>
328 <max_requests>1000</max_requests>
329 <unix_log>open-ils.penalty_unix.log</unix_log>
330 <unix_sock>open-ils.penalty_unix.sock</unix_sock>
331 <unix_pid>open-ils.penalty_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>
338 <patron_penalty>penalty/patron_penalty.js</patron_penalty>
339 <script_path>/openils/var</script_path>
340 <script_path>/openils/var/catalog</script_path>
345 <keepalive>3</keepalive>
346 <stateless>1</stateless>
347 <language>perl</language>
348 <implementation>OpenILS::Application::Circ</implementation>
349 <max_requests>99</max_requests>
351 <max_requests>1000</max_requests>
352 <unix_log>open-ils.circ_unix.log</unix_log>
353 <unix_sock>open-ils.circ_unix.sock</unix_sock>
354 <unix_pid>open-ils.circ_unix.pid</unix_pid>
355 <min_children>1</min_children>
356 <max_children>15</max_children>
357 <min_spare_children>1</min_spare_children>
358 <max_spare_children>5</max_spare_children>
362 <email>false</email> <!-- set to true for hold notice emails -->
365 <!-- circulation policy scripts -->
366 <script_path>/openils/var</script_path>
367 <script_path>/openils/var/catalog</script_path>
369 <circ_permit_patron>circ/circ_permit_patron.js</circ_permit_patron>
370 <circ_permit_copy>circ/circ_permit_copy.js</circ_permit_copy>
371 <circ_duration>circ/circ_duration.js</circ_duration>
372 <circ_recurring_fines>circ/circ_recurring_fines.js</circ_recurring_fines>
373 <circ_max_fines>circ/circ_max_fines.js</circ_max_fines>
374 <circ_permit_renew>circ/circ_permit_renew.js</circ_permit_renew>
375 <circ_permit_hold>circ/circ_permit_hold.js</circ_permit_hold>
384 <mod>bestseller</mod>
385 <mod>bestsellernh</mod>
400 <mod>softwrlong</mod>
401 <mod>equip-long</mod>
402 <mod>talking book</mod>
405 <mod>video-long</mod>
409 <type>Miscellaneous</type>
410 <type>Overdue materials</type>
411 <type>Fee for placing a hold</type>
412 <type>Fee for checking out a book</type>
413 <type>Fee for library card</type>
414 <type>Miscellaneous charges</type>
415 <type>Lost materials</type>
416 <type>Damaged material</type>
417 <type>Overdue Reserves charge</type>
418 <type>Recall overdue</type>
419 <type>Fee for processing lost library materials</type>
420 <type>Fee for sending patron bills to collection agency</type>
421 <type>Fee for interlibrary loan</type>
422 <type>Fee for copies</type>
423 <type>Money advanced to pay for telephone use</type>
424 <type>Deposit fee</type>
425 <type>Fee for disk</type>
426 <type>Fee for faxing</type>
427 <type>Fee for laminating</type>
428 <type>Fee for room cleaning</type>
429 <type>Deposit returned; fee refund</type>
430 <type>Sale items</type>
431 <type>Fee for lost card</type>
432 <type>Long overdue items</type>
433 <type>Lost/Replacement Cassette</type>
434 <type>Returned Check</type>
440 <keepalive>3</keepalive>
441 <stateless>1</stateless>
442 <implementation>OpenILS::Application::Ingest</implementation>
443 <language>perl</language>
444 <max_requests>1000000</max_requests>
446 <max_requests>1000000</max_requests>
447 <unix_log>open-ils.ingest-unix.log</unix_log>
448 <unix_sock>open-ils.ingest-unix.sock</unix_sock>
449 <unix_pid>open-ils.ingest-unix.pid</unix_pid>
450 <min_children>5</min_children>
451 <max_children>20</max_children>
452 <min_spare_children>2</min_spare_children>
453 <max_spare_children>5</max_spare_children>
456 <script_path>/openils/var/catalog/</script_path>
457 <script_path>/openils/var/web/opac/common/js/</script_path>
459 <biblio_fingerprint>biblio_fingerprint.js</biblio_fingerprint>
460 <biblio_descriptor>biblio_descriptor.js</biblio_descriptor>
466 <keepalive>10</keepalive>
467 <stateless>1</stateless>
468 <language>perl</language>
469 <implementation>OpenILS::Application::Storage</implementation>
471 <max_requests>1000</max_requests>
472 <unix_log>storage_unix.log</unix_log>
473 <unix_sock>storage_unix.sock</unix_sock>
474 <unix_pid>storage_unix.pid</unix_pid>
475 <max_requests>400</max_requests>
476 <min_children>1</min_children>
477 <max_children>10</max_children>
478 <min_spare_children>1</min_spare_children>
479 <max_spare_children>5</max_spare_children>
482 <script_path>/openils/var/catalog/</script_path>
484 <biblio_fingerprint>biblio_fingerprint.js</biblio_fingerprint>
491 <user>postgres</user>
492 <host>localhost</host>
496 <client_encoding>UTF-8</client_encoding>
504 <keepalive>6</keepalive>
505 <stateless>1</stateless>
506 <language>C</language>
507 <implementation>oils_cstore.so</implementation>
508 <max_requests>95</max_requests>
510 <unix_log>cstore.log</unix_log>
511 <unix_sock>cstore.sock</unix_sock>
512 <unix_pid>cstore.pid</unix_pid>
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 <unix_log>rstore.log</unix_log>
600 <unix_sock>rstore.sock</unix_sock>
601 <unix_pid>rstore.pid</unix_pid>
602 <max_requests>400</max_requests>
603 <min_children>1</min_children>
604 <max_children>10</max_children>
605 <min_spare_children>1</min_spare_children>
606 <max_spare_children>5</max_spare_children>
609 <IDL>/openils/conf/fm_IDL.xml</IDL> <!-- deprecated with 1.1.0 -->
610 <driver>pgsql</driver>
614 <user>postgres</user>
615 <host>localhost</host>
619 <client_encoding>UTF-8</client_encoding>
622 </open-ils.reporter-store>
629 <localhost> <!-- must match "hostname -f" of the hosting machine -->
631 <!-- services hosted on this machine -->
632 <appname>opensrf.settings</appname>
633 <appname>opensrf.math</appname>
634 <appname>opensrf.dbmath</appname>
635 <appname>open-ils.cat</appname>
636 <appname>open-ils.supercat</appname>
637 <appname>open-ils.search</appname>
638 <appname>open-ils.circ</appname>
639 <appname>open-ils.actor</appname>
640 <appname>open-ils.auth</appname>
641 <appname>open-ils.storage</appname>
642 <appname>open-ils.penalty</appname>
643 <appname>open-ils.cstore</appname>
644 <appname>open-ils.collections</appname>
645 <appname>open-ils.ingest</appname>
646 <appname>open-ils.reporter</appname>
647 <appname>open-ils.reporter-store</appname>