attempting to update the documentation

git-svn-id: svn://svn.open-ils.org/OpenSRF/trunk@730 9efc2488-bf62-4759-914b-345cdb29e865

diff --git a/examples/opensrf_core.xml.example b/examples/opensrf_core.xml.example
index 7ca6bcd..3c9deb9 100644 (file)
--- a/examples/opensrf_core.xml.example
+++ b/examples/opensrf_core.xml.example
@@ -1,34 +1,61 @@
 <?xml version='1.0'?>
 
-<!-- Bootstrap config file for the C opensrf_stack library -->
 <config>
 
-
        <opensrf> <!-- bootstrap config for the C apps -->
+
+               <!--  the routers's name on the network -->
+               <!-- do not change this -->
       <router_name>router</router_name>
-      <routers>
+               
+      <routers> 
+                       <!-- 
+                               list of router domains we should register with. 
+                               We must at least have our default jabber domain in here
+                       -->
          <router>127.0.0.1</router>
       </routers>
+
       <domains>
+                       <!-- Our jabber domain, currenlty only one domain is supported -->
          <domain>127.0.0.1</domain>
       </domains>
+
       <username>client</username>
       <passwd>mypass</passwd>
       <port>5222</port>
+
+               <!-- log to a local file -->
       <logfile>/openils/var/log/osrfsys.log</logfile>
+
+               <!-- 
+                       Log to syslog. You can use this same layout for 
+                       defining the logging of all services in this file 
+               -->
+
+               <!--
+               <logfile>syslog</logfile>
+               <syslog>local2</syslog>
+               <actlog>local1</actlog>
+               -->
+
+               <!-- 0 None, 1 Error, 2 Warning, 3 Info, 4 debug, 5 Internal (Nasty) -->
       <loglevel>3</loglevel>
    </opensrf>
 
 
+       <!-- Update this if you use ChopChop -->
        <chopchop> <!-- Our jabber server -->
                <domain>127.0.0.1</domain>
-               <secret>secret</secret>
                <port>5222</port>
+
+               <!-- used when multiple servers need to communicate -->
                <s2sport>5269</s2sport>
+               <secret>secret</secret>
+
                <listen_address>10.0.0.3</listen_address>
                <loglevel>3</loglevel>
-               <logfile>syslog</logfile>
-               <syslog>local2</syslog>
+               <logfile>/openils/var/log/osrfsys.log</logfile>
        </chopchop>
 
 
@@ -44,7 +71,9 @@
                </domains>
 
                <!-- These are the services that the gateway will serve. 
-                       Any other requests will receive a HTT_NOT_FOUND -->
+                       Any other requests will receive an HTTP_NOT_FOUND (404) 
+                       DO NOT put any services here that you don't want the internet to have access to
+                       -->
                <services>
                        <service>opensrf.math</service> 
                        <service>open-ils.cat</service> 
@@ -58,16 +87,9 @@
                <!-- jabber login info -->
                <username>mylogin</username>
                <passwd>mypassword</passwd>
-
-               <!-- If the port is a positive number,
-                       we will connect via TCP port, if not and unixpath is defined,
-                       we will connect via UNIX domain socket with the given path -->
                <port>5222</port>
-               <unixpath>/openils/var/sock/jserver.sock</unixpath>
        
-               <!-- log file location -->
                <logfile>/openils/var/log/gateway.log</logfile>
-               <!-- 0 None, 1 Error, 2 Warning, 3 Info, 4 debug -->
                <loglevel>3</loglevel>
 
        </gateway>
@@ -88,7 +110,9 @@
        <!-- ======================================================================================== -->
 
        <router>
-               <component>0</component> <!-- leave disabled for now -->
+
+               <!-- do not change -->
+               <component>0</component>
        
                <trusted_domains>
                        <!-- Trusted servers are allowed to register apps with the router -->
@@ -100,17 +124,17 @@
                <transport>
                        <!-- jabber server are we connecting to -->
                        <server>127.0.0.1</server>
-                       <!-- If the port is a positive number,
-                               we will connect via TCP port, if not and unixpath is defined,
-                               we will connect via UNIX domain socket with the given path -->
                        <port>5222</port>
-                       <unixpath>/openils/var/sock/unix_sock</unixpath>
 
-                       <!-- router's name on the network -->
+                       <!-- do not change this -->
                        <username>router</username>
+
                        <password>mypassword</password>
+
                        <!-- router's jabber resource --> 
+                       <!-- do not change this -->
                        <resource>router</resource>
+
                        <connect_timeout>10</connect_timeout>
                        <max_reconnect_attempts>5</max_reconnect_attempts>
                </transport>