From 86e6d8438bd751820aff59a6183ae3c37d7fd09c Mon Sep 17 00:00:00 2001 From: Ben Shum Date: Mon, 4 May 2015 17:01:23 -0400 Subject: [PATCH] Docs: Emphasize variables and paths consistently in README Some variables and paths were not emphasized when the instructions for websockets was added. Maintain consistency in the document and emphasize them. Signed-off-by: Ben Shum --- README | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README b/README index 9da4cfd..4e1675f 100644 --- a/README +++ b/README @@ -365,7 +365,7 @@ apxs2 -i -a -c mod_websocket.c --------------------------------------------------------------------------- + 3. Create the websocket Apache instance (more information about this in - /usr/share/doc/apache2/README.multiple-instances) + `/usr/share/doc/apache2/README.multiple-instances`) + .(Debian / Ubuntu Precise) [source, bash] @@ -400,7 +400,7 @@ cp examples/apache2/websockets/apache2.conf /etc/apache2-websockets/ cp examples/apache_24/websockets/apache2.conf /etc/apache2-websockets/ --------------------------------------------------------------------------- + -6. OPTIONAL: add these configuration variables to /etc/apache2-websockets/envvars +6. OPTIONAL: add these configuration variables to `/etc/apache2-websockets/envvars` and adjust as needed. + [source, bash] @@ -412,18 +412,18 @@ export OSRF_WEBSOCKET_CONFIG_CTXT=gateway export OSRF_WEBSOCKET_MAX_REQUEST_WAIT_TIME=600 --------------------------------------------------------------------------- + - * IDLE_TIMEOUT specifies how long we will allow a client to stay connected + * `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 + * `IDLE_CHECK_INTERVAL` specifies how often we wake to check the idle status of the connected client. - * MAX_REQUEST_WAIT_TIME is the maximum amount of time the gateway will + * `MAX_REQUEST_WAIT_TIME` is the maximum amount of time the gateway will wait before declaring a client as idle when there is a long-running outstanding request, yet no other activity is occurring. This is primarily a fail-safe to allow idle timeouts when one or more requests died on the server, and thus no response was ever delivered to the gateway. - * CONFIG_FILE / CTXT are the standard opensrf core config options. + * `CONFIG_FILE / CTXT` are the standard opensrf core config options. 7. Before you can start websockets, you must install a valid SSL certificate in `/etc/apache2/ssl/`. It is possible, but not recommended, to generate a -- 2.43.2