LP#1369169: Add Apache 2.4 specific configuration file for websockets
[OpenSRF.git] / README.websockets
1 Websockets installation instructions for Debian
2
3 # TODO: Most of this can be scripted.
4
5 # ! as root !
6 # Perform these steps after installing OpenSRF.
7
8 # install the apache-websocket module
9 % cd tmp # or wherever
10 % git clone https://github.com/disconnect/apache-websocket
11 % cd apache-websocket
12 % apxs2 -i -a -c mod_websocket.c
13
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
17
18 # remove from the main apache instance
19 % a2dismod websocket
20
21 # update configs
22 % cp /path/to/OpenSRF/examples/apache2/websockets/apache2.conf /etc/apache2-websockets/
23
24 # OPTIONAL: add these configuration variables to
25 # /etc/apache2-websockets/envvars and adjust as needed.
26 # export OSRF_WEBSOCKET_IDLE_TIMEOUT=120
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
30 # export OSRF_WEBSOCKET_MAX_REQUEST_WAIT_TIME=600
31 #
32 # IDLE_TIMEOUT specifies how long we will allow a client to stay connected
33 # while idle.  A longer timeout means less network traffic (from fewer
34 # websocket CONNECT calls), but it also means more Apache processes are
35 # tied up doing nothing.
36 #
37 # IDLE_CHECK_INTERVAL specifies how often we wake to check the idle status
38 # of the connected client.
39 #
40 # MAX_REQUEST_WAIT_TIME is the maximum amount of time the gateway will
41 # wait before declaring a client as idle when there is a long-running
42 # outstanding request, yet no other activity is occurring.  This is
43 # primarily a fail-safe to allow idle timeouts when one or more requests
44 # died on the server, and thus no response was ever delivered to the gateway.
45 #
46 # Both specified in seconds
47 #
48 # CONFIG_FILE / CTXT are the standard opensrf core config options.
49
50 # After OpenSRF is up and running (or after any re-install),
51 # fire up the secondary Apache instance. Errors will appear in
52 # /var/log/apache2-websockets/error.log
53 % /etc/init.d/apache2-websockets start