1 Websockets installation instructions for Debian
3 # TODO: Most of this can be scripted.
6 # Perform these steps after installing OpenSRF.
8 # install the apache-websocket module
10 % git clone https://github.com/disconnect/apache-websocket
12 % apxs2 -i -a -c mod_websocket.c
14 # create the websocket Apache instance
15 # see also /usr/share/doc/apache2/README.multiple-instances
16 % sh /usr/share/doc/apache2.2-common/examples/setup-instance websockets
18 # remove from the main apache instance
22 % cp /path/to/OpenSRF/examples/apache2/websockets/apache2.conf /etc/apache2-websockets/
24 # OPTIONAL: add these configuration variables to
25 # /etc/init.d/apache2-websockets/envvars and adjust as needed.
26 # export OSRF_WEBSOCKET_IDLE_TIMEOUT=60
27 # export OSRF_WEBSOCKET_IDLE_CHECK_INTERVAL=5
28 # export OSRF_WEBSOCKET_CONFIG_FILE=/openils/conf/opensrf_core.xml
29 # export OSRF_WEBSOCKET_CONFIG_CTXT=gateway
31 # IDLE_TIMEOUT specifies how long we will allow a client to stay connected
32 # while idle. A longer timeout means less network traffic (from fewer
33 # websocket CONNECT calls), but it also means more Apache processes are
34 # tied up doing nothing.
36 # IDLE_CHECK_INTERVAL specifies how often we wake to check the idle status
37 # of the connected client.
39 # Both specified in seconds
41 # CONFIG_FILE / CTXT are the standard opensrf core config options.
43 # After OpenSRF is up and running (or after any re-install),
44 # fire up the secondary Apache instance errors will appear in
45 # /var/log/apache2-websockets/error.log
46 % /etc/init.d/apache2-websockets start