Log redaction for sensitive input values, C side
[OpenSRF.git] / examples / opensrf_core.xml.example
1 <?xml version="1.0"?>
2 <!-- 
3 vim:et:ts=2:sw=2:
4 -->
5 <config>
6
7   <!-- bootstrap config for OpenSRF apps -->
8   <opensrf>
9
10     <routers>
11
12       <!-- define the list of routers our services will register with -->
13
14       <router>
15
16         <!-- This is the public router.  On this router, we only register applications
17              which should be accessible to everyone on the opensrf network -->
18         <name>router</name>
19         <domain>public.localhost</domain>
20         <services>
21             <service>opensrf.math</service> 
22         </services>
23       </router>
24
25       <router>
26         <!-- This is the private router.  All applications must register with 
27             this router, so no explicit <services> section is required -->
28         <name>router</name>
29         <domain>private.localhost</domain>
30       </router>
31     </routers>
32
33
34     <!-- Jabber login settings
35         Our domain should match that of the private router -->
36     <domain>private.localhost</domain>
37     <username>opensrf</username>
38     <passwd>password</passwd>
39     <port>5222</port>
40     <!-- name of the router used on our private domain.  
41         this should match one of the <name> of the private router above -->
42     <router_name>router</router_name>
43
44     <!-- Log a warning when an outbound message reaches this size in bytes -->
45     <msg_size_warn>1800000</msg_size_warn>
46
47     <!-- log file settings ======================================  -->
48     <!-- log to a local file -->
49     <logfile>LOCALSTATEDIR/log/osrfsys.log</logfile>
50
51     <!-- Log to syslog. You can use this same layout for 
52         defining the logging of all services in this file -->
53     <!--
54     <logfile>syslog</logfile>
55     <syslog>local2</syslog>
56     <actlog>local1</actlog>
57     -->
58
59     <!-- 0 None, 1 Error, 2 Warning, 3 Info, 4 debug, 5 Internal (Nasty) -->
60     <loglevel>3</loglevel>
61
62     <!-- Maximum log message length; if using syslog, you might need to adjust
63          your syslog service's configuration to match longer message lengths -->
64     <loglength>1536</loglength>
65
66     <!-- config file for the services -->
67     <settings_config>SYSCONFDIR/opensrf.xml</settings_config>
68
69   </opensrf>
70
71   <!-- Update this if you use ChopChop -->
72   <chopchop>
73     <!-- Our jabber server -->
74     <domain>private.localhost</domain>
75     <port>5222</port>
76     <!-- used when multiple servers need to communicate -->
77     <s2sport>5269</s2sport>
78     <secret>secret</secret>
79     <listen_address>10.0.0.3</listen_address>
80     <loglevel>3</loglevel>
81     <logfile>LOCALSTATEDIR/log/osrfsys.log</logfile>
82   </chopchop>
83
84   <!-- The section between <gateway>...</gateway> is a standard OpenSRF C stack config file -->
85   <gateway>
86
87     <!--
88     we consider ourselves to be the "originating" client for requests,
89     which means we define the log XID string for log traces
90     -->
91     <client>true</client>
92
93     <!--  the routers's name on the network -->
94     <router_name>router</router_name>
95
96     <!-- jabber login info -->
97     <!-- The gateway connects to the public domain -->
98     <domain>public.localhost</domain>
99     <username>opensrf</username>
100     <passwd>password</passwd>
101     <port>5222</port>
102     <logfile>LOCALSTATEDIR/log/gateway.log</logfile>
103     <loglevel>3</loglevel>
104
105   </gateway>
106
107   <!-- ======================================================================================== -->
108
109     <routers>
110         <router> <!-- public router -->
111             <trusted_domains>
112                 <!-- allow private services to register with this router 
113                      and public clients to send requests to this router. -->
114                 <server>private.localhost</server>
115                 <!-- also allow private clients to send to the router so it can receive error messages -->
116                 <client>private.localhost</client>
117                 <client>public.localhost</client>
118             </trusted_domains>
119             <transport>
120                 <server>public.localhost</server>
121                 <port>5222</port>
122                 <unixpath>LOCALSTATEDIR/sock/unix_sock</unixpath>
123                 <username>router</username>
124                 <password>password</password>
125                 <resource>router</resource>
126                 <connect_timeout>10</connect_timeout>
127                 <max_reconnect_attempts>5</max_reconnect_attempts>
128             </transport>
129             <logfile>LOCALSTATEDIR/log/router.log</logfile>
130             <!--
131             <logfile>syslog</logfile>
132             <syslog>local2</syslog>
133             -->
134             <loglevel>2</loglevel>
135         </router>
136         <router> <!-- private router -->
137             <trusted_domains>
138                 <server>private.localhost</server>
139                 <!-- only clients on the private domain can send requests to this router -->
140                 <client>private.localhost</client>
141             </trusted_domains>
142             <transport>
143                 <server>private.localhost</server>
144                 <port>5222</port>
145                 <username>router</username>
146                 <password>password</password>
147                 <resource>router</resource>
148                 <connect_timeout>10</connect_timeout>
149                 <max_reconnect_attempts>5</max_reconnect_attempts>
150             </transport>
151             <logfile>LOCALSTATEDIR/log/router.log</logfile>
152             <!--
153             <logfile>syslog</logfile>
154             <syslog>local2</syslog>
155             -->
156             <loglevel>4</loglevel>
157         </router>
158     </routers>
159
160   <!-- ======================================================================================== -->
161
162   <shared>
163     <!-- Any methods which match any of these match_string node values will
164          have their params redacted from lower-level input logging.
165          Adjust these examples as needed. -->
166     <!--
167     <log_protect>
168       <match_string>open-ils.auth_proxy.login</match_string>
169       <match_string>open-ils.some_service.some_method</match_string>
170     </log_protect>
171     -->
172   </shared>
173
174 </config>