liquid_feedback_frontend
changeset 1244:ae9812d9f653
Updated documentation (removed WebMCP 1.x support)
author | jbe |
---|---|
date | Mon Dec 21 12:21:52 2015 +0100 (2015-12-21) |
parents | 30d44975a323 |
children | 9578cef4018a 78d3be54cfe0 |
files | INSTALL.html INSTALL.mkd |
line diff
1.1 --- a/INSTALL.html Mon Dec 14 17:54:06 2015 +0100 1.2 +++ b/INSTALL.html Mon Dec 21 12:21:52 2015 +0100 1.3 @@ -19,8 +19,7 @@ 1.4 <li>liblua5.2-dev</li> 1.5 <li>postgresql</li> 1.6 <li>libpq-dev</li> 1.7 -<li>lighttpd (only for WebMCP 1.2.x support)</li> 1.8 -<li>pmake or bmake (only for WebMCP 2.x with Moonbridge)</li> 1.9 +<li>pmake or bmake</li> 1.10 <li>imagemagick</li> 1.11 <li>exim4</li> 1.12 <li>markdown2 (<code>apt-get install python-pip; pip install markdown2</code>)</li> 1.13 @@ -92,7 +91,7 @@ 1.14 <pre><code>exit 1.15 </code></pre> 1.16 1.17 -<h2>4. Install Moonbridge (only for WebMCP 2.x)</h2> 1.18 +<h2>4. Install Moonbridge</h2> 1.19 1.20 <pre><code># Download and unpack Moonbridge 1.21 # from http://www.public-software-group.org/pub/projects/moonbridge/ 1.22 @@ -130,77 +129,19 @@ 1.23 <pre><code>chown www-data /opt/liquid_feedback_frontend/tmp 1.24 </code></pre> 1.25 1.26 -<p>Compile binary for fast delivery of member images (only necessary for WebMCP 1.2.x):</p> 1.27 - 1.28 -<pre><code>cd /opt/liquid_feedback_frontend/fastpath 1.29 -vi getpic.c # check and modify #define commands as necessary 1.30 -make 1.31 -</code></pre> 1.32 - 1.33 <h2>7. Configure mail system</h2> 1.34 1.35 <p>It may be necessary to configure your server's mail system, e.g. running 1.36 <code>dpkg-reconfigure exim4-config</code> on a Debian system.</p> 1.37 1.38 -<h2>8. Configure the Webserver for LiquidFeedback (only for WebMCP 1.2.x)</h2> 1.39 - 1.40 -<p>A sample configuration for <code>lighttpd</code> is given below (assuming <code>mod_alias</code> has 1.41 -been included elsewhere):</p> 1.42 - 1.43 -<pre><code>server.modules += ("mod_cgi", "mod_rewrite", "mod_redirect", "mod_setenv") 1.44 - 1.45 -# Enable CGI-Execution of *.lua files through lua binary 1.46 -cgi.assign += ( ".lua" => "/usr/bin/lua5.1" ) 1.47 - 1.48 -alias.url += ( "/lf/fastpath/" => "/opt/liquid_feedback_frontend/fastpath/", 1.49 - "/lf/static" => "/opt/liquid_feedback_frontend/static", 1.50 - "/lf" => "/opt/webmcp/cgi-bin" ) 1.51 - 1.52 -# Configure environment for demo application 1.53 -$HTTP["url"] =~ "^/lf" { 1.54 - setenv.add-environment += ( 1.55 - "LANG" => "en_US.UTF-8", 1.56 - "WEBMCP_APP_BASEPATH" => "/opt/liquid_feedback_frontend/", 1.57 - "WEBMCP_CONFIG_NAME" => "myconfig") 1.58 -} 1.59 - 1.60 -# URL beautification 1.61 -url.rewrite-once += ( 1.62 - # do not rewrite static URLs 1.63 - "^/lf/fastpath/(.*)$" => "/lf/fastpath/$1", 1.64 - "^/lf/static/(.*)$" => "/lf/static/$1", 1.65 - 1.66 - # dynamic URLs 1.67 - "^/lf/([^\?]*)(\?(.*))?$" => "/lf/webmcp-wrapper.lua?_webmcp_path=$1&$3", 1.68 - 1.69 -) 1.70 - 1.71 -$HTTP["url"] =~ "^/lf/fastpath/" { 1.72 - cgi.assign = ( "" => "" ) 1.73 - setenv.add-response-header = ( "Cache-Control" => "private; max-age=86400" ) 1.74 -} 1.75 -</code></pre> 1.76 - 1.77 -<p>If you're using Debian, you may want to create a file with the name 1.78 -<code>/etc/lighttpd/conf-available/60-liquidfeedback.conf</code> and create a softlink in 1.79 -<code>/etc/lighttpd/conf-enabled/</code>.</p> 1.80 - 1.81 -<h2>9. Configure the LiquidFeedback-Frontend</h2> 1.82 +<h2>8. Configure the LiquidFeedback-Frontend</h2> 1.83 1.84 <pre><code>cd /opt/liquid_feedback_frontend/config 1.85 cp example.lua myconfig.lua 1.86 # edit myconfig.lua according to your needs 1.87 </code></pre> 1.88 1.89 -<p>Use the following option in your configuration file to enable fast image 1.90 -loading (only for WebMCP 1.2.x):</p> 1.91 - 1.92 -<pre><code>config.fastpath_url_func = function(member_id, image_type) 1.93 - return request.get_absolute_baseurl() .. "fastpath/getpic?" .. tostring(member_id) .. "+" .. tostring(image_type) 1.94 -end 1.95 -</code></pre> 1.96 - 1.97 -<h2>10. Setup regular execution of <code>lf_update</code> and related commands </h2> 1.98 +<h2>9. Setup regular execution of <code>lf_update</code> and related commands </h2> 1.99 1.100 <p>The executables <code>lf_update</code>, <code>lf_update_issue_order</code>, and 1.101 <code>lf_update_suggestion_order</code> must be executed regularly. This may be achieved 1.102 @@ -234,24 +175,12 @@ 1.103 1.104 <p>And this file should be started automatically at system boot.</p> 1.105 1.106 -<h2>11. Setup notification loop in background (only for WebMCP 1.2.x)</h2> 1.107 - 1.108 -<p>In addition to regular execution of <code>lf_update</code> and 1.109 -<code>lf_update_suggestion_order</code>, the following commands should be executed in 1.110 -background:</p> 1.111 +<h2>10. Start the system</h2> 1.112 1.113 -<pre><code>su www-data -s $SHELL 1.114 -cd /opt/liquid_feedback_frontend/ 1.115 -echo "Event:send_notifications_loop()" | ../webmcp/bin/webmcp_shell myconfig 1.116 -</code></pre> 1.117 +<p>After <code>lf_update</code> has been executed at least once, you should be able to use 1.118 +your LiquidFeedback system.</p> 1.119 1.120 -<h2>12. Start the system</h2> 1.121 - 1.122 -<p>After <code>lf_update</code> has been executed at least once and (in case of WebMCP 1.2.x) 1.123 -the webserver has been restarted (using the configuration above), you should be 1.124 -able to access your LiquidFeedback system.</p> 1.125 - 1.126 -<p>If you use WebMCP 2.x, the server is started by calling:</p> 1.127 +<p>The server is started by calling:</p> 1.128 1.129 <pre><code>su www-data -s $SHELL 1.130 /opt/moonbridge/moonbridge /opt/webmcp/bin/mcp.lua /opt/webmcp/ /opt/liquid_feedback_frontend/ main myconfig
2.1 --- a/INSTALL.mkd Mon Dec 14 17:54:06 2015 +0100 2.2 +++ b/INSTALL.mkd Mon Dec 21 12:21:52 2015 +0100 2.3 @@ -16,8 +16,7 @@ 2.4 * liblua5.2-dev 2.5 * postgresql 2.6 * libpq-dev 2.7 - * lighttpd (only for WebMCP 1.2.x support) 2.8 - * pmake or bmake (only for WebMCP 2.x with Moonbridge) 2.9 + * pmake or bmake 2.10 * imagemagick 2.11 * exim4 2.12 * markdown2 (``apt-get install python-pip; pip install markdown2``) 2.13 @@ -87,8 +86,8 @@ 2.14 exit 2.15 2.16 2.17 -4. Install Moonbridge (only for WebMCP 2.x) 2.18 -------------------------------------------- 2.19 +4. Install Moonbridge 2.20 +--------------------- 2.21 2.22 # Download and unpack Moonbridge 2.23 # from http://www.public-software-group.org/pub/projects/moonbridge/ 2.24 @@ -126,12 +125,6 @@ 2.25 2.26 chown www-data /opt/liquid_feedback_frontend/tmp 2.27 2.28 -Compile binary for fast delivery of member images (only necessary for WebMCP 1.2.x): 2.29 - 2.30 - cd /opt/liquid_feedback_frontend/fastpath 2.31 - vi getpic.c # check and modify #define commands as necessary 2.32 - make 2.33 - 2.34 2.35 7. Configure mail system 2.36 ------------------------ 2.37 @@ -140,67 +133,16 @@ 2.38 `dpkg-reconfigure exim4-config` on a Debian system. 2.39 2.40 2.41 -8. Configure the Webserver for LiquidFeedback (only for WebMCP 1.2.x) 2.42 ---------------------------------------------------------------------- 2.43 - 2.44 -A sample configuration for `lighttpd` is given below (assuming `mod_alias` has 2.45 -been included elsewhere): 2.46 - 2.47 - server.modules += ("mod_cgi", "mod_rewrite", "mod_redirect", "mod_setenv") 2.48 - 2.49 - # Enable CGI-Execution of *.lua files through lua binary 2.50 - cgi.assign += ( ".lua" => "/usr/bin/lua5.1" ) 2.51 - 2.52 - alias.url += ( "/lf/fastpath/" => "/opt/liquid_feedback_frontend/fastpath/", 2.53 - "/lf/static" => "/opt/liquid_feedback_frontend/static", 2.54 - "/lf" => "/opt/webmcp/cgi-bin" ) 2.55 - 2.56 - # Configure environment for demo application 2.57 - $HTTP["url"] =~ "^/lf" { 2.58 - setenv.add-environment += ( 2.59 - "LANG" => "en_US.UTF-8", 2.60 - "WEBMCP_APP_BASEPATH" => "/opt/liquid_feedback_frontend/", 2.61 - "WEBMCP_CONFIG_NAME" => "myconfig") 2.62 - } 2.63 - 2.64 - # URL beautification 2.65 - url.rewrite-once += ( 2.66 - # do not rewrite static URLs 2.67 - "^/lf/fastpath/(.*)$" => "/lf/fastpath/$1", 2.68 - "^/lf/static/(.*)$" => "/lf/static/$1", 2.69 - 2.70 - # dynamic URLs 2.71 - "^/lf/([^\?]*)(\?(.*))?$" => "/lf/webmcp-wrapper.lua?_webmcp_path=$1&$3", 2.72 - 2.73 - ) 2.74 - 2.75 - $HTTP["url"] =~ "^/lf/fastpath/" { 2.76 - cgi.assign = ( "" => "" ) 2.77 - setenv.add-response-header = ( "Cache-Control" => "private; max-age=86400" ) 2.78 - } 2.79 - 2.80 -If you're using Debian, you may want to create a file with the name 2.81 -`/etc/lighttpd/conf-available/60-liquidfeedback.conf` and create a softlink in 2.82 -`/etc/lighttpd/conf-enabled/`. 2.83 - 2.84 - 2.85 -9. Configure the LiquidFeedback-Frontend 2.86 +8. Configure the LiquidFeedback-Frontend 2.87 ---------------------------------------- 2.88 2.89 cd /opt/liquid_feedback_frontend/config 2.90 cp example.lua myconfig.lua 2.91 # edit myconfig.lua according to your needs 2.92 2.93 -Use the following option in your configuration file to enable fast image 2.94 -loading (only for WebMCP 1.2.x): 2.95 2.96 - config.fastpath_url_func = function(member_id, image_type) 2.97 - return request.get_absolute_baseurl() .. "fastpath/getpic?" .. tostring(member_id) .. "+" .. tostring(image_type) 2.98 - end 2.99 - 2.100 - 2.101 -10. Setup regular execution of `lf_update` and related commands 2.102 ---------------------------------------------------------------- 2.103 +9. Setup regular execution of `lf_update` and related commands 2.104 +-------------------------------------------------------------- 2.105 2.106 The executables `lf_update`, `lf_update_issue_order`, and 2.107 `lf_update_suggestion_order` must be executed regularly. This may be achieved 2.108 @@ -233,26 +175,13 @@ 2.109 And this file should be started automatically at system boot. 2.110 2.111 2.112 -11. Setup notification loop in background (only for WebMCP 1.2.x) 2.113 ------------------------------------------------------------------ 2.114 - 2.115 -In addition to regular execution of `lf_update` and 2.116 -`lf_update_suggestion_order`, the following commands should be executed in 2.117 -background: 2.118 - 2.119 - su www-data -s $SHELL 2.120 - cd /opt/liquid_feedback_frontend/ 2.121 - echo "Event:send_notifications_loop()" | ../webmcp/bin/webmcp_shell myconfig 2.122 - 2.123 - 2.124 -12. Start the system 2.125 +10. Start the system 2.126 -------------------- 2.127 2.128 -After `lf_update` has been executed at least once and (in case of WebMCP 1.2.x) 2.129 -the webserver has been restarted (using the configuration above), you should be 2.130 -able to access your LiquidFeedback system. 2.131 +After `lf_update` has been executed at least once, you should be able to use 2.132 +your LiquidFeedback system. 2.133 2.134 -If you use WebMCP 2.x, the server is started by calling: 2.135 +The server is started by calling: 2.136 2.137 su www-data -s $SHELL 2.138 /opt/moonbridge/moonbridge /opt/webmcp/bin/mcp.lua /opt/webmcp/ /opt/liquid_feedback_frontend/ main myconfig