-
-Websockets installation instructions for Debian:
+Websockets installation instructions for Debian
# TODO: Most of this can be scripted.
-# TODO: Better handling of external dependencies (websocket_plugin.h).
-# as root
+# ! as root !
+# Perform these steps after installing OpenSRF.
+
+# install the apache-websocket module
+% cd tmp # or wherever
+% git clone https://github.com/disconnect/apache-websocket
+% cd apache-websocket
+% apxs2 -i -a -c mod_websocket.c
+# create the websocket Apache instance
# see also /usr/share/doc/apache2/README.multiple-instances
% sh /usr/share/doc/apache2.2-common/examples/setup-instance websockets
-% cp examples/apache2/websockets.conf /etc/apache2-websockets/sites-available/
-
-# activate the websockets configuration
-% a2ensite-websockets websockets.conf
-
-# deactivate the default site
-% a2dissite-websockets default
-
-# remove most of the mods with this shell script
-
-MODS=$(apache2ctl-websockets -M | grep shared | grep -v 'Syntax OK' | sed 's/_module//g' | cut -d' ' -f2 | xargs);
-for mod in $MODS; do
- if [ $mod = 'mime' -o $mod = 'ssl' -o $mod = 'websocket' ]; then
- echo "* Leaving module $mod in place";
- else
- echo "* Disabling module $mod";
- a2dismod-websockets $mod;
- fi;
-done
+# remove from the main apache instance
+% a2dismod websocket
-# follow the instructions for installing Apache mod_websockets at
-# https://github.com/disconnect/apache-websocket
+# update configs
+% cp /path/to/OpenSRF/examples/apache2/websockets/apache2.conf /etc/apache2-websockets/
-# copy the headers into place so OpenSRF can compile
-% cp $LOCATION_OF_APACHE_WEBSOCKET_CHECKOUT/websocket_plugin.h src/gateway/
-
-# install OpenSRF
-
-# remove the websocket module from the default OpenSRF Apache instance
-% a2dismod osrf_websocket_translator
-
-# optional: add these configuration variables to
+# 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
#
# 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
+# 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
#
# 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
-
-
+# After OpenSRF is up and running (or after any re-install),
+# fire up the secondary Apache instance errors will appear in
+# /var/log/apache2-websockets/error.log
+% /etc/init.d/apache2-websockets start
-# :vim set syntax apache
-#
-# This is the top-level configuration file for the
-# apache2-websockets instance. For example, in Debian
-# this file lives in /etc/apache2-websockets/sites-available/
-
-LogLevel info
-# - log locally
-CustomLog /var/log/apache2-websockets/access.log combined
-ErrorLog /var/log/apache2-websockets/error.log
-# Add the PID to the error log (Apache 2.4 only)
-# ErrorLogFormat "[%t] [%P] [%l] [pid %P] %F: %E: [client %a] %M"
-
-# ----------------------------------------------------------------------------------
-# Set up our SSL virtual host
-# ----------------------------------------------------------------------------------
+# This is the main Apache server configuration file for the OpenSRF
+# WebSockets gateway.
+
+# if we don't want to run as "opensrf", change the LockFile
+LockFile ${APACHE_LOCK_DIR}/accept.lock
+PidFile ${APACHE_PID_FILE}
+User ${APACHE_RUN_USER}
+Group ${APACHE_RUN_GROUP}
+
+DefaultType None
+HostnameLookups Off
+ErrorLog ${APACHE_LOG_DIR}/error.log
+LogLevel warn
+
+# only affects the initial connection, which should be quick.
+Timeout 30
+
+# WebSockets is KeepAlive on steroids
+KeepAlive Off
+
+<IfModule mpm_prefork_module>
+ StartServers 5
+ MinSpareServers 5
+ MaxSpareServers 20
+ # use ServerLimit to raise beyond 256
+ MaxClients 256
+ MaxRequestsPerChild 0
+</IfModule>
+
+# include the exact mods we need
+Include mods-available/mime.load
+Include mods-available/mime.conf
+# SSL requires mime
+Include mods-available/ssl.load
+Include mods-available/ssl.conf
+Include mods-available/websocket.load
+
+LogFormat "%v:%p %h %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" vhost_combined
+LogFormat "%h %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" combined
+LogFormat "%h %l %u %t \"%r\" %>s %O" common
+LogFormat "%{Referer}i -> %U" referer
+LogFormat "%{User-agent}i" agent
+
+# WebSockets via SSL
Listen 7682
NameVirtualHost *:7682
<VirtualHost *:7682>
SSLCertificateKeyFile /etc/apache2/ssl/server.key
</VirtualHost>
+# WebSockets via non-SSL
Listen 7680
NameVirtualHost *:7680
<VirtualHost *:7680>
DocumentRoot /var/www
</VirtualHost>
+# OpenSRF WebSockets gateway
<Location /osrf-websocket-translator>
SetHandler websocket-handler
WebSocketHandler /usr/lib/apache2/modules/osrf_websocket_translator.so osrf_websocket_init
projects / opensrf-equinox.git / commitdiff