]> git.evergreen-ils.org Git - working/Evergreen.git/blob - Open-ILS/examples/opensrf.xml.example
updated some comments, removed some unused configs for the C apps
[working/Evergreen.git] / Open-ILS / examples / opensrf.xml.example
1 <?xml version='1.0'?>
2
3 <!-- 
4 Example opensrf config file for OpenILS
5 -->
6
7 <opensrf version='0.0.2'>
8
9     <default>
10             
11         <dirs>
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>
18         </dirs>
19
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 -->
23         
24         <email_notify>
25             <!-- global email notification settings -->
26             <template>/openils/var/data/hold_notification_template.example</template>
27             <smtp_server>localhost</smtp_server>
28
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>
32         </email_notify>
33
34
35         <reporter>
36             <!--
37                 Settings for the reporter daemon process 
38             -->
39             <setup>
40                 <base_uri>https://localhost/reporter/</base_uri>
41                 <database>
42                     <driver>Pg</driver>
43                     <host>localhost</host>
44                     <port>5432</port>
45                     <name>evergreen</name>
46                     <user>postgres</user>
47                     <password>postgres</password>
48                 </database>
49                 <files>
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>
54                 </files>
55             </setup>
56         </reporter>
57
58
59
60         <xml-rpc>
61             <!-- XML-RPC gateway.  Do NOT publish unprotected services here -->
62             <allowed_services>
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>
72             </allowed_services>
73         </xml-rpc>
74
75
76         <z3950>
77             <default>oclc</default>
78             <services>
79                 <oclc>
80                     <!-- Z3950 settings for OCLC.  Note that OCLC requires username/password -->
81                     <host>zcat.oclc.org</host>
82                     <port>210</port>
83                     <db>OLUCWorldCat</db>
84                     <attrs>
85                         <!--
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
92                         -->
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>
102                     </attrs>
103                 </oclc>
104
105                 <!--
106                 <loc>
107                     <name>loc</name>
108                     <host>z3950.loc.gov</host>
109                     <port>7090</port>
110                     <db>Voyager</db>
111                     <attrs>
112                     </attrs>
113                 </loc>
114                 -->
115
116             </services>
117         </z3950>
118
119
120         <added_content>
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>
125             <timeout>2</timeout>
126         </added_content>
127
128
129
130         <!-- no apps are enabled globally by default -->
131         <activeapps/> 
132         
133         <cache>
134             <!-- memcache servers -->
135             <global>
136                 <servers>
137                     <server>localhost:11211</server>
138                 </servers>
139                 <max_cache_time>86400</max_cache_time>
140             </global>
141         </cache>
142
143         <apps>
144             <!-- Authentication server -->
145             <open-ils.auth>
146
147                 <!-- how long to wait between stateful requests before the child process re-joins the pool -->
148                 <keepalive>5</keepalive>
149
150                 <!-- true if this service support stateless requests -->
151                 <stateless>1</stateless>
152
153                 <!-- implementation language -->
154                 <language>c</language>
155
156                 <!-- library to plugin -->
157                 <implementation>oils_auth.so</implementation>
158
159                 <!-- maximum required opensrf requests within a stateful connection -->
160                 <max_requests>93</max_requests>
161
162                 <unix_config>
163                     <!-- maximum number of top level requests coming to 
164                         this child before the child is recycled -->
165                     <max_requests>1000</max_requests>
166                     <!-- min children to fork -->
167                     <min_children>1</min_children>
168                     <!-- max possible children to fork -->
169                     <max_children>15</max_children>
170
171                     <!-- C forking implementation does not support 
172                         min/max idle children, but may in the future -->
173
174                     <!-- min idle children -->
175                     <min_spare_children>1</min_spare_children>
176                     <!-- max idle children -->
177                     <max_spare_children>5</max_spare_children>
178
179                 </unix_config>
180
181                 <app_settings>
182                     <!-- defined app-specific settings here -->
183                     <default_timeout>
184                         <!-- default login timeouts based on login type -->
185                         <opac>420</opac>
186                         <staff>7200</staff>
187                         <temp>300</temp>
188                     </default_timeout>
189                 </app_settings>
190             </open-ils.auth>
191
192
193             <!-- Generic search server -->
194             <open-ils.search>
195                 <keepalive>5</keepalive>
196                 <stateless>1</stateless>
197                 <language>perl</language>
198                 <implementation>OpenILS::Application::Search</implementation>
199                 <max_requests>93</max_requests>
200                 <unix_config>
201
202                     <!-- the following 3 settings are currently used by Perl services only -->
203                     <unix_sock>open-ils.search_unix.sock</unix_sock>
204                     <unix_pid>open-ils.search_unix.pid</unix_pid>
205                     <unix_log>open-ils.search_unix.log</unix_log>
206
207                     <max_requests>1000</max_requests>
208                     <min_children>1</min_children>
209                     <max_children>15</max_children>
210                     <min_spare_children>1</min_spare_children>
211                     <max_spare_children>5</max_spare_children>
212                 </unix_config>
213                 <app_settings>
214                     <marc_html_xsl>oilsMARC21slim2HTML.xsl</marc_html_xsl>
215                     <!-- zip code database file -->
216                     <!--<zips_file>/openils/var/data/zips.txt</zips_file>-->
217                 </app_settings>
218             </open-ils.search>
219
220             <!-- server for accessing user info -->
221             <open-ils.actor>
222                 <keepalive>5</keepalive>
223                 <stateless>1</stateless>
224                 <language>perl</language>
225                 <implementation>OpenILS::Application::Actor</implementation>
226                 <max_requests>93</max_requests>
227                 <unix_config>
228                     <unix_sock>open-ils.actor_unix.sock</unix_sock>
229                     <unix_pid>open-ils.actor_unix.pid</unix_pid>
230                     <max_requests>1000</max_requests>
231                     <unix_log>open-ils.actor_unix.log</unix_log>
232                     <min_children>1</min_children>
233                     <max_children>15</max_children>
234                     <min_spare_children>1</min_spare_children>
235                     <max_spare_children>5</max_spare_children>
236                 </unix_config>
237             </open-ils.actor>
238
239
240             <open-ils.cat>
241                 <keepalive>5</keepalive>
242                 <stateless>1</stateless>
243                 <language>perl</language>
244                 <implementation>OpenILS::Application::Cat</implementation>
245                 <max_requests>199</max_requests>
246                 <unix_config>
247                     <unix_sock>open-ils.cat_unix.sock</unix_sock>
248                     <unix_pid>open-ils.cat_unix.pid</unix_pid>
249                     <max_requests>1000</max_requests>
250                     <unix_log>open-ils.cat_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>
255                 </unix_config>
256                 <app_settings>
257                     <marctemplates>
258                         <K_book>/openils/var/templates/marc/k_book.xml</K_book>
259                     </marctemplates>
260                 </app_settings>
261             </open-ils.cat>
262
263             <open-ils.supercat>
264                 <keepalive>5</keepalive>
265                 <stateless>1</stateless>
266                 <language>perl</language>
267                 <implementation>OpenILS::Application::SuperCat</implementation>
268                 <max_requests>199</max_requests>
269                 <unix_config>
270                     <unix_sock>open-ils.supercat_unix.sock</unix_sock>
271                     <unix_pid>open-ils.supercat_unix.pid</unix_pid>
272                     <max_requests>1000</max_requests>
273                     <unix_log>open-ils.supercat_unix.log</unix_log>
274                     <min_children>1</min_children>
275                     <max_children>15</max_children>
276                     <min_spare_children>1</min_spare_children>
277                     <max_spare_children>5</max_spare_children>
278                 </unix_config>
279             </open-ils.supercat>
280
281
282             <opensrf.math>
283                 <keepalive>3</keepalive>
284                 <stateless>1</stateless>
285                 <language>c</language>
286                 <implementation>osrf_math.so</implementation>
287                 <max_requests>97</max_requests>
288                 <unix_config>
289                     <unix_sock>opensrf.math_unix.sock</unix_sock>
290                     <unix_pid>opensrf.math_unix.pid</unix_pid>
291                     <max_requests>1000</max_requests>
292                     <unix_log>opensrf.math_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>
297                 </unix_config>
298             </opensrf.math>
299
300             <opensrf.dbmath> 
301                 <keepalive>3</keepalive>
302                 <stateless>1</stateless>
303                 <language>c</language>
304                 <implementation>osrf_dbmath.so</implementation>
305                 <max_requests>99</max_requests>
306                 <unix_config>
307                     <max_requests>1000</max_requests>
308                     <unix_log>opensrf.dbmath_unix.log</unix_log>
309                     <unix_sock>opensrf.dbmath_unix.sock</unix_sock>
310                     <unix_pid>opensrf.dbmath_unix.pid</unix_pid>
311                     <min_children>1</min_children>
312                     <max_children>15</max_children>
313                     <min_spare_children>1</min_spare_children> 
314                     <max_spare_children>5</max_spare_children>
315                 </unix_config>
316             </opensrf.dbmath>
317
318             <open-ils.penalty>
319                 <keepalive>3</keepalive>
320                 <stateless>1</stateless>
321                 <language>perl</language>
322                 <implementation>OpenILS::Application::Penalty</implementation>
323                 <max_requests>99</max_requests>
324                 <unix_config>
325                     <max_requests>1000</max_requests>
326                     <unix_log>open-ils.penalty_unix.log</unix_log>
327                     <unix_sock>open-ils.penalty_unix.sock</unix_sock>
328                     <unix_pid>open-ils.penalty_unix.pid</unix_pid>
329                     <min_children>1</min_children>
330                     <max_children>15</max_children>
331                     <min_spare_children>1</min_spare_children>
332                     <max_spare_children>5</max_spare_children>
333                 </unix_config>
334                 <app_settings>
335                     <patron_penalty>penalty/patron_penalty.js</patron_penalty>
336                     <script_path>/openils/var</script_path>
337                     <script_path>/openils/var/catalog</script_path>
338                 </app_settings>
339             </open-ils.penalty>
340
341             <open-ils.circ> 
342                 <keepalive>3</keepalive>
343                 <stateless>1</stateless>
344                 <language>perl</language>
345                 <implementation>OpenILS::Application::Circ</implementation>
346                 <max_requests>99</max_requests>
347                 <unix_config>
348                     <max_requests>1000</max_requests>
349                     <unix_log>open-ils.circ_unix.log</unix_log>
350                     <unix_sock>open-ils.circ_unix.sock</unix_sock>
351                     <unix_pid>open-ils.circ_unix.pid</unix_pid>
352                     <min_children>1</min_children>
353                     <max_children>15</max_children>
354                     <min_spare_children>1</min_spare_children> 
355                     <max_spare_children>5</max_spare_children>
356                 </unix_config>
357                 <app_settings>
358                     <notify_hold>
359                         <email>false</email> <!-- set to true for hold notice emails -->
360                     </notify_hold>
361
362                     <!-- circulation policy scripts -->
363                     <script_path>/openils/var</script_path>
364                     <script_path>/openils/var/catalog</script_path>
365                     <scripts> 
366                         <circ_permit_patron>circ/circ_permit_patron.js</circ_permit_patron>
367                         <circ_permit_copy>circ/circ_permit_copy.js</circ_permit_copy>
368                         <circ_duration>circ/circ_duration.js</circ_duration>
369                         <circ_recurring_fines>circ/circ_recurring_fines.js</circ_recurring_fines>
370                         <circ_max_fines>circ/circ_max_fines.js</circ_max_fines>
371                         <circ_permit_renew>circ/circ_permit_renew.js</circ_permit_renew>
372                         <circ_permit_hold>circ/circ_permit_hold.js</circ_permit_hold>
373                     </scripts>               
374
375                     <circ_modifiers>
376                         <mod>art</mod>
377                         <mod>atlas</mod>
378                         <mod>audiobook</mod>
379                         <mod>av</mod>
380                         <mod>new-av</mod>
381                         <mod>bestseller</mod>
382                         <mod>bestsellernh</mod>
383                         <mod>book</mod>
384                         <mod>cd</mod>
385                         <mod>dvd</mod>
386                         <mod>dvd-long</mod>
387                         <mod>e-book</mod>
388                         <mod>equipment</mod>
389                         <mod>filmstrip</mod>
390                         <mod>kit</mod>
391                         <mod>magazine</mod>
392                         <mod>map</mod>
393                         <mod>microform</mod>
394                         <mod>music</mod>
395                         <mod>record</mod>
396                         <mod>software</mod>
397                         <mod>softwrlong</mod>
398                         <mod>equip-long</mod>
399                         <mod>talking book</mod>
400                         <mod>toy</mod>
401                         <mod>video</mod>
402                         <mod>video-long</mod>
403                     </circ_modifiers>
404
405                     <billing_types>
406                         <type>Miscellaneous</type>
407                         <type>Overdue materials</type>
408                         <type>Fee for placing a hold</type>
409                         <type>Fee for checking out a book</type>
410                         <type>Fee for library card</type>
411                         <type>Miscellaneous charges</type>
412                         <type>Lost materials</type>
413                         <type>Damaged material</type>
414                         <type>Overdue Reserves charge</type>
415                         <type>Recall overdue</type>
416                         <type>Fee for processing lost library materials</type>
417                         <type>Fee for sending patron bills to collection agency</type>
418                         <type>Fee for interlibrary loan</type>
419                         <type>Fee for copies</type>
420                         <type>Money advanced to pay for telephone use</type>
421                         <type>Deposit fee</type>
422                         <type>Fee for disk</type>
423                         <type>Fee for faxing</type>
424                         <type>Fee for laminating</type>
425                         <type>Fee for room cleaning</type>
426                         <type>Deposit returned; fee refund</type>
427                         <type>Sale items</type>
428                         <type>Fee for lost card</type>
429                         <type>Long overdue items</type>
430                         <type>Lost/Replacement Cassette</type>
431                         <type>Returned Check</type>
432                     </billing_types>
433                 </app_settings>
434             </open-ils.circ>
435
436             <open-ils.ingest>
437                 <keepalive>3</keepalive>
438                 <stateless>1</stateless>
439                 <implementation>OpenILS::Application::Ingest</implementation>
440                 <language>perl</language>
441                 <max_requests>1000000</max_requests>
442                 <unix_config>
443                     <max_requests>1000000</max_requests>
444                     <unix_log>open-ils.ingest-unix.log</unix_log>
445                     <unix_sock>open-ils.ingest-unix.sock</unix_sock>
446                     <unix_pid>open-ils.ingest-unix.pid</unix_pid>
447                     <min_children>5</min_children>
448                     <max_children>20</max_children>
449                     <min_spare_children>2</min_spare_children>
450                     <max_spare_children>5</max_spare_children>
451                 </unix_config>
452                 <app_settings>
453                     <script_path>/openils/var/catalog/</script_path>
454                     <script_path>/openils/var/web/opac/common/js/</script_path>
455                     <scripts>
456                     <biblio_fingerprint>biblio_fingerprint.js</biblio_fingerprint>
457                     <biblio_descriptor>biblio_descriptor.js</biblio_descriptor>
458                     </scripts>
459                 </app_settings>
460             </open-ils.ingest>
461
462             <open-ils.storage>
463                 <keepalive>10</keepalive>
464                 <stateless>1</stateless>
465                 <language>perl</language>
466                 <implementation>OpenILS::Application::Storage</implementation>
467                 <unix_config>
468                     <max_requests>1000</max_requests>
469                     <unix_log>storage_unix.log</unix_log>
470                     <unix_sock>storage_unix.sock</unix_sock>
471                     <unix_pid>storage_unix.pid</unix_pid>
472                     <max_requests>400</max_requests>
473                     <min_children>1</min_children>
474                     <max_children>10</max_children>
475                     <min_spare_children>1</min_spare_children>
476                     <max_spare_children>5</max_spare_children>
477                 </unix_config>
478                 <app_settings>
479                     <script_path>/openils/var/catalog/</script_path>
480                     <scripts>
481                         <biblio_fingerprint>biblio_fingerprint.js</biblio_fingerprint>
482                     </scripts>
483                     <databases>
484                         <driver>Pg</driver>
485                         <database>
486                             <type>master</type>
487                             <weight>2</weight>
488                             <user>postgres</user>
489                             <host>localhost</host>
490                             <port>5432</port>
491                             <pw>postgres</pw>
492                             <db>evergreen</db>
493                             <client_encoding>UTF-8</client_encoding>
494                         </database>
495                     </databases>
496                 </app_settings>
497             </open-ils.storage>
498
499
500             <open-ils.cstore>
501                 <keepalive>6</keepalive>
502                 <stateless>1</stateless>
503                 <language>C</language>
504                 <implementation>oils_cstore.so</implementation>
505                 <max_requests>95</max_requests>
506                 <unix_config>
507                     <max_requests>400</max_requests>
508                     <min_children>1</min_children>
509                     <max_children>15</max_children>
510                     <min_spare_children>1</min_spare_children>
511                     <max_spare_children>5</max_spare_children>
512                 </unix_config>
513                 <app_settings>
514                     <IDL>/openils/conf/fm_IDL.xml</IDL> <!-- deprecated with 1.1.0-->
515                     <driver>pgsql</driver>
516                     <database>
517                         <type>master</type>
518                         <weight>2</weight>
519                         <user>postgres</user>
520                         <host>localhost</host>
521                         <port>5432</port>
522                         <pw>postgres</pw>
523                         <db>evergreen</db>
524                         <client_encoding>UTF-8</client_encoding>
525                     </database>
526                 </app_settings>
527             </open-ils.cstore>
528
529
530
531             <opensrf.settings>
532                 <keepalive>1</keepalive>
533                 <stateless>1</stateless>
534                 <language>perl</language>
535                 <implementation>OpenSRF::Application::Settings</implementation>
536                 <max_requests>17</max_requests>
537                 <unix_config>
538                     <unix_sock>opensrf.settings_unix.sock</unix_sock>
539                     <unix_pid>opoensrf.settings_unix.pid</unix_pid>
540                     <max_requests>300</max_requests>
541                     <unix_log>opensrf.settings_unix.log</unix_log>
542                     <min_children>5</min_children>
543                     <max_children>15</max_children>
544                     <min_spare_children>3</min_spare_children>
545                     <max_spare_children>5</max_spare_children>
546                 </unix_config>
547             </opensrf.settings>
548
549             <open-ils.collections>
550                 <keepalive>3</keepalive>
551                 <stateless>1</stateless>
552                 <language>perl</language>
553                 <implementation>OpenILS::Application::Collections</implementation>
554                 <max_requests>17</max_requests>
555                 <unix_config>
556                     <unix_sock>opensrf.collections_unix.sock</unix_sock>
557                     <unix_pid>opoensrf.collections_unix.pid</unix_pid>
558                     <max_requests>1000</max_requests>
559                     <unix_log>opensrf.collections_unix.log</unix_log>
560                     <min_children>1</min_children>
561                     <max_children>10</max_children>
562                     <min_spare_children>1</min_spare_children>
563                     <max_spare_children>5</max_spare_children>
564                 </unix_config>
565             </open-ils.collections>
566
567             <open-ils.reporter>
568                 <keepalive>3</keepalive>
569                 <stateless>1</stateless>
570                 <language>perl</language>
571                 <implementation>OpenILS::Application::Reporter</implementation>
572                 <max_requests>99</max_requests>
573                 <unix_config>
574                     <unix_sock>opensrf.reporter_unix.sock</unix_sock>
575                     <unix_pid>opoensrf.reporter_unix.pid</unix_pid>
576                     <max_requests>1000</max_requests>
577                     <unix_log>opensrf.reporter_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>
582                 </unix_config>
583             </open-ils.reporter>
584
585
586             <open-ils.reporter-store>
587                 <keepalive>6</keepalive>
588                 <stateless>1</stateless>
589                 <language>C</language>
590                 <implementation>oils_rstore.so</implementation>
591                 <max_requests>95</max_requests>
592                 <unix_config>
593                     <max_requests>400</max_requests>
594                     <min_children>1</min_children>
595                     <max_children>10</max_children>
596                     <min_spare_children>1</min_spare_children>
597                     <max_spare_children>5</max_spare_children>
598                 </unix_config>
599                 <app_settings>
600                 <IDL>/openils/conf/fm_IDL.xml</IDL> <!-- deprecated with 1.1.0 -->
601                 <driver>pgsql</driver>
602                 <database>
603                     <type>master</type>
604                     <weight>2</weight>
605                     <user>postgres</user>
606                     <host>localhost</host>
607                     <port>5432</port>
608                     <pw>postgres</pw>
609                     <db>evergreen</db>
610                     <client_encoding>UTF-8</client_encoding>
611                 </database>
612                 </app_settings>
613             </open-ils.reporter-store>
614
615
616         </apps>
617     </default>
618
619     <hosts>
620
621         <localhost> 
622             <!-- ^-=- must match the fully qualified domain name of the host 
623                on Linux, this is usually the output of "hostname -f"
624             -->
625
626             <activeapps>
627                 <!-- services hosted on this machine -->
628                 <appname>opensrf.settings</appname> 
629                 <appname>opensrf.math</appname> 
630                 <appname>opensrf.dbmath</appname> 
631                 <appname>open-ils.cat</appname> 
632                 <appname>open-ils.supercat</appname> 
633                 <appname>open-ils.search</appname> 
634                 <appname>open-ils.circ</appname> 
635                 <appname>open-ils.actor</appname> 
636                 <appname>open-ils.auth</appname> 
637                 <appname>open-ils.storage</appname>  
638                 <appname>open-ils.penalty</appname>  
639                 <appname>open-ils.cstore</appname>  
640                 <appname>open-ils.collections</appname>  
641                 <appname>open-ils.ingest</appname>  
642                 <appname>open-ils.reporter</appname>  
643                 <appname>open-ils.reporter-store</appname>  
644             </activeapps>
645         </localhost>
646     </hosts>
647
648 </opensrf>