LP#1268619: temporary websocket installer README
[OpenSRF.git] / README.websockets
1
2 Websockets installation instructions for Debian:
3
4 # TODO: Most of this can be scripted.
5 # TODO: Better handling of external dependencies (websocket_plugin.h).  
6
7 # as root
8
9 # see also /usr/share/doc/apache2/README.multiple-instances
10 % sh /usr/share/doc/apache2.2-common/examples/setup-instance websockets
11
12 % cp examples/apache2/websockets.conf /etc/apache2-websockets/sites-available/
13
14 # activate the websockets configuration
15 % a2ensite-websockets websockets.conf 
16
17 # deactivate the default site
18 % a2dissite-websockets default 
19
20 # remove most of the mods with this shell script
21
22 MODS=$(apache2ctl-websockets -M | grep shared | grep -v 'Syntax OK' | sed 's/_module//g' | cut -d' ' -f2 | xargs);
23 for mod in $MODS; do
24     if [ $mod = 'mime' -o $mod = 'ssl' -o $mod = 'websocket' ]; then
25         echo "* Leaving module $mod in place";
26     else
27         echo "* Disabling module $mod";
28         a2dismod-websockets $mod;
29     fi;
30 done
31
32 # follow the instructions for installing Apache mod_websockets at
33 # https://github.com/disconnect/apache-websocket
34
35 # copy the headers into place so OpenSRF can compile
36 % cp $LOCATION_OF_APACHE_WEBSOCKET_CHECKOUT/websocket_plugin.h src/gateway/
37
38 # install OpenSRF
39
40 # remove the websocket module from the default OpenSRF Apache instance
41 % a2dismod osrf_websocket_translator
42
43 # After OpenSRF is up and running, fire up the secondary Apache instance
44 # errors will appear in /var/log/apache2-websockets/error.log
45 % /etc/init.d/apache2-websockets restart
46
47