LP#1268619: websockets : added config docs to install readme
authorBill Erickson <berick@esilibrary.com>
Thu, 16 Jan 2014 16:41:01 +0000 (11:41 -0500)
committerGalen Charlton <gmc@esilibrary.com>
Tue, 19 Aug 2014 22:50:48 +0000 (15:50 -0700)
Signed-off-by: Bill Erickson <berick@esilibrary.com>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>

README.websockets
src/gateway/osrf_websocket_translator.c

index c9f2391..0b94fd3 100644 (file)
@@ -40,6 +40,25 @@ done
 # remove the websocket module from the default OpenSRF Apache instance
 % a2dismod osrf_websocket_translator
 
+# optional: add these configuration variables to 
+# /etc/init.d/apache2-websockets/envvars and adjust as needed.
+# export OSRF_WEBSOCKET_IDLE_TIMEOUT=60
+# export OSRF_WEBSOCKET_IDLE_CHECK_INTERVAL=5
+# export OSRF_WEBSOCKET_CONFIG_FILE=/openils/conf/opensrf_core.xml
+# export OSRF_WEBSOCKET_CONFIG_CTXT=gateway
+#
+# IDLE_TIMEOUT specifies how long we will allow a client to stay connected
+# while idle.  A longer timeout means less network traffic (from fewer
+# websocket CONNECT calls), but it also means more Apache processes are 
+# tied up doing nothing.
+#
+# IDLE_CHECK_INTERVAL specifies how often we wake to check the idle status
+# of the connected client.
+#
+# Both specified in seconds
+#
+# CONFIG_FILE / CTXT are the standard opensrf core config options.
+
 # After OpenSRF is up and running, fire up the secondary Apache instance
 # errors will appear in /var/log/apache2-websockets/error.log
 % /etc/init.d/apache2-websockets restart
index e2cfc98..6a0caac 100644 (file)
@@ -98,7 +98,7 @@
 // default values, replaced during setup (below) as needed.
 static char* config_file = "/openils/conf/opensrf_core.xml";
 static char* config_ctxt = "gateway";
-static time_t idle_timeout_interval = 300; 
+static time_t idle_timeout_interval = 60; 
 static time_t idle_check_interval = 5;
 static time_t last_activity_time = 0;