liquid_feedback_frontend

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

Impressum / About Us