liquid_feedback_frontend
diff INSTALL.html @ 1156:08adef9f05b9
Updated installation instructions for WebMCP 2.x
author | jbe |
---|---|
date | Mon Mar 23 23:17:43 2015 +0100 (2015-03-23) |
parents | 53b0139ed930 |
children | a2922edacce0 |
line diff
1.1 --- a/INSTALL.html Sun Mar 22 22:59:17 2015 +0100 1.2 +++ b/INSTALL.html Mon Mar 23 23:17:43 2015 +0100 1.3 @@ -14,14 +14,12 @@ 1.4 installed:</p> 1.5 1.6 <ul> 1.7 -<li>lua5.1</li> 1.8 +<li>build-essential</li> 1.9 +<li>lua5.2</li> 1.10 +<li>liblua5.2-dev</li> 1.11 <li>postgresql</li> 1.12 -<li>build-essential</li> 1.13 <li>libpq-dev</li> 1.14 -<li>liblua5.1-0-dev</li> 1.15 -<li>lighttpd</li> 1.16 -<li>ghc</li> 1.17 -<li>libghc6-parsec3-dev</li> 1.18 +<li>lighttpd (only for WebMCP 1.2.x support)</li> 1.19 <li>imagemagick</li> 1.20 <li>exim4</li> 1.21 <li>markdown2 (install with Python's pip)</li> 1.22 @@ -32,10 +30,10 @@ 1.23 1.24 <h2>2. Ensure that the user account of your webserver has access to the database</h2> 1.25 1.26 -<p>Whichever useraccount is used by the webserver (usually <code>www-data</code>) needs to 1.27 -have access to your PostgreSQL installation. This is done by executing 1.28 -PostgreSQL's shell command <code>createuser</code> as database superuser (usually <code>pgsql</code>, 1.29 -or <code>postgres</code> for Debian installations):</p> 1.30 +<p>The useraccount of the webserver (usually <code>www-data</code>) or the Moonbridge server 1.31 +process needs to have access to your PostgreSQL installation. This is done by 1.32 +executing PostgreSQL's shell command <code>createuser</code> as database superuser 1.33 +(usually <code>pgsql</code>, or <code>postgres</code> for Debian installations):</p> 1.34 1.35 <pre><code>su - postgres 1.36 createuser 1.37 @@ -99,21 +97,31 @@ 1.38 <pre><code>exit 1.39 </code></pre> 1.40 1.41 -<h2>4. Install WebMCP</h2> 1.42 +<h2>4. Install Moonbridge (only for WebMCP 2.x)</h2> 1.43 1.44 -<p>Note: Using Debian, it may be necessary to append <code>-I /usr/include/lua5.1</code> at 1.45 +<pre><code># Download and unpack Moonbridge 1.46 +# from http://www.public-software-group.org/pub/projects/moonbridge/ 1.47 +pmake MOONBR_LUA_PATH=/opt/moonbridge/?.lua 1.48 +mkdir /opt/moonbridge 1.49 +cp moonbridge /opt/moonbridge/ 1.50 +cp moonbridge_http.lua /opt/moonbridge/ 1.51 +</code></pre> 1.52 + 1.53 +<h2>5. Install WebMCP</h2> 1.54 + 1.55 +<p>Note: Using Debian, it may be necessary to append <code>-I /usr/include/lua5.2</code> at 1.56 the end of the CFLAGS line in <code>Makefile.options</code> of the WebMCP source 1.57 distibution:</p> 1.58 1.59 <pre><code># Download and unpack WebMCP 1.60 # from http://www.public-software-group.org/pub/projects/webmcp/ 1.61 -vi Makefile.options # Debian requires -I /usr/include/lua5.1 at end of CFLAGS line 1.62 +vi Makefile.options # Debian requires -I /usr/include/lua5.2 at end of CFLAGS line 1.63 make 1.64 mkdir /opt/webmcp 1.65 cp -RL framework/* /opt/webmcp/ 1.66 </code></pre> 1.67 1.68 -<h2>5. Install the LiquidFeedback-Frontend</h2> 1.69 +<h2>6. Install the LiquidFeedback-Frontend</h2> 1.70 1.71 <p>Unpack source tree into appropriate directory, e.g. <code>/opt/liquid_feedback_frontend</code>:</p> 1.72 1.73 @@ -122,30 +130,24 @@ 1.74 mv liquid_feedback_frontend-vX.X.X /opt/liquid_feedback_frontend 1.75 </code></pre> 1.76 1.77 -<p>Create HTML code for help texts:</p> 1.78 - 1.79 -<pre><code>cd /opt/liquid_feedback_frontend/locale 1.80 -PATH=/opt/rocketwiki-lqfb:$PATH make 1.81 -</code></pre> 1.82 - 1.83 <p>Make <code>tmp/</code> directory of LiquidFeedback-Frontend writable for webserver:</p> 1.84 1.85 <pre><code>chown www-data /opt/liquid_feedback_frontend/tmp 1.86 </code></pre> 1.87 1.88 -<p>Compile binary for fast delivery of member images:</p> 1.89 +<p>Compile binary for fast delivery of member images (only necessary for WebMCP 1.2.x):</p> 1.90 1.91 <pre><code>cd /opt/liquid_feedback_frontend/fastpath 1.92 vi getpic.c # check and modify #define commands as necessary 1.93 make 1.94 </code></pre> 1.95 1.96 -<h2>6. Configure mail system</h2> 1.97 +<h2>7. Configure mail system</h2> 1.98 1.99 <p>It may be necessary to configure your server's mail system, e.g. running 1.100 <code>dpkg-reconfigure exim4-config</code> on a Debian system.</p> 1.101 1.102 -<h2>7. Configure the Webserver for LiquidFeedback:</h2> 1.103 +<h2>8. Configure the Webserver for LiquidFeedback (only for WebMCP 1.2.x)</h2> 1.104 1.105 <p>A sample configuration for <code>lighttpd</code> is given below (assuming <code>mod_alias</code> has 1.106 been included elsewhere):</p> 1.107 @@ -188,7 +190,7 @@ 1.108 <code>/etc/lighttpd/conf-available/60-liquidfeedback.conf</code> and create a softlink in 1.109 <code>/etc/lighttpd/conf-enabled/</code>.</p> 1.110 1.111 -<h2>8. Configure the LiquidFeedback-Frontend:</h2> 1.112 +<h2>9. Configure the LiquidFeedback-Frontend</h2> 1.113 1.114 <pre><code>cd /opt/liquid_feedback_frontend/config 1.115 cp example.lua myconfig.lua 1.116 @@ -196,14 +198,14 @@ 1.117 </code></pre> 1.118 1.119 <p>Use the following option in your configuration file to enable fast image 1.120 -loading:</p> 1.121 +loading (only for WebMCP 1.2.x):</p> 1.122 1.123 <pre><code>config.fastpath_url_func = function(member_id, image_type) 1.124 return request.get_absolute_baseurl() .. "fastpath/getpic?" .. tostring(member_id) .. "+" .. tostring(image_type) 1.125 end 1.126 </code></pre> 1.127 1.128 -<h2>9. Setup regular execution of <code>lf_update</code> and related commands </h2> 1.129 +<h2>10. Setup regular execution of <code>lf_update</code> and related commands </h2> 1.130 1.131 <p>The executables <code>lf_update</code>, <code>lf_update_issue_order</code>, and 1.132 <code>lf_update_suggestion_order</code> must be executed regularly. This may be achieved 1.133 @@ -237,7 +239,7 @@ 1.134 1.135 <p>And this file should be started automatically at system boot.</p> 1.136 1.137 -<h2>10. Setup notification loop in background</h2> 1.138 +<h2>11. Setup notification loop in background (only for WebMCP 1.2.x)</h2> 1.139 1.140 <p>In addition to regular execution of <code>lf_update</code> and 1.141 <code>lf_update_suggestion_order</code>, the following commands should be executed in 1.142 @@ -248,10 +250,15 @@ 1.143 echo "Event:send_notifications_loop()" | ../webmcp/bin/webmcp_shell myconfig 1.144 </code></pre> 1.145 1.146 -<h2>11. Start the sytem</h2> 1.147 +<h2>12. Start the sytem</h2> 1.148 1.149 <p>After <code>lf_update</code> has been executed at least once, and the webserver has been 1.150 restarted (using the configuration above), you should be able to access your 1.151 LiquidFeedback system.</p> 1.152 + 1.153 +<p>If you use WebMCP 2.x, the server is started by calling:</p> 1.154 + 1.155 +<pre><code>/opt/moonbridge/moonbridge /opt/webmcp/bin/mcp.lua /opt/webmcp/ /opt/liquid_feedback_frontend/ main myconfig 1.156 +</code></pre> 1.157 </body> 1.158 </html>