liquid_feedback_frontend

annotate INSTALL.mkd @ 1196:5f9cf5a1d12f

find changesets by author, revision, files, or words in the commit message
Added missing "lf_update_suggestion_order" file to "cp" command in INSTALL.mkd and INSTALL.html
author jbe
date Mon Jun 01 15:11:32 2015 +0200 (2015-06-01)
parents bf158c59f827
children ae9812d9f653
rev   line source
bsw@1045 1 LiquidFeedback Installation Instructions
bsw@1045 2 ========================================
bsw@1045 3
bsw@1045 4 This document gives a short outline about the necessary steps to setup a
bsw@1045 5 LiquidFeedback system.
bsw@1045 6
bsw@1045 7
bsw@1045 8 1. Install necessary dependencies
bsw@1045 9 ---------------------------------
bsw@1045 10
bsw@1045 11 If you're using a Debian system, make sure that the following packages are
bsw@1045 12 installed:
bsw@1045 13
jbe@1156 14 * build-essential
jbe@1156 15 * lua5.2
jbe@1156 16 * liblua5.2-dev
bsw@1045 17 * postgresql
bsw@1045 18 * libpq-dev
jbe@1156 19 * lighttpd (only for WebMCP 1.2.x support)
jbe@1188 20 * pmake or bmake (only for WebMCP 2.x with Moonbridge)
bsw@1045 21 * imagemagick
bsw@1045 22 * exim4
jbe@1191 23 * markdown2 (``apt-get install python-pip; pip install markdown2``)
bsw@1045 24
bsw@1045 25 If you're using any other Linux distribution or BSD system, install the
bsw@1045 26 necessary software components accordingly.
bsw@1045 27
bsw@1045 28
bsw@1045 29 2. Ensure that the user account of your webserver has access to the database
bsw@1045 30 ----------------------------------------------------------------------------
bsw@1045 31
jbe@1156 32 The useraccount of the webserver (usually `www-data`) or the Moonbridge server
jbe@1156 33 process needs to have access to your PostgreSQL installation. This is done by
jbe@1156 34 executing PostgreSQL's shell command `createuser` as database superuser
jbe@1156 35 (usually `pgsql`, or `postgres` for Debian installations):
bsw@1045 36
jbe@1191 37 su postgres -s $SHELL
jbe@1191 38 createuser --no-superuser --createdb --no-createrole www-data
bsw@1045 39 exit
bsw@1045 40
bsw@1045 41
bsw@1045 42 3. Install and configure LiquidFeedback-Core
bsw@1045 43 --------------------------------------------
bsw@1045 44
bsw@1045 45 We recommend to create the database with the same user as your webserver
bsw@1045 46 (usually `www-data`) to avoid having to setup database privileges.
bsw@1045 47
bsw@1045 48 The example below installs the database as `www-data` and stores the two
bsw@1045 49 executables `lf_update` and `lf_update_issue_order` in the directory
bsw@1045 50 `/opt/liquid_feedback_core/`:
bsw@1045 51
bsw@1045 52 # Download and unpack LiquidFeedback-Core
bsw@1045 53 # from http://www.public-software-group.org/pub/projects/liquid_feedback/backend/
bsw@1045 54 make
bsw@1045 55 mkdir /opt/liquid_feedback_core
jbe@1196 56 cp core.sql lf_update lf_update_issue_order lf_update_suggestion_order /opt/liquid_feedback_core
jbe@1191 57 su www-data -s $SHELL
bsw@1045 58 cd /opt/liquid_feedback_core
bsw@1045 59 createdb liquid_feedback
bsw@1045 60 createlang plpgsql liquid_feedback # command may be omitted, depending on PostgreSQL version
bsw@1045 61 psql -v ON_ERROR_STOP=1 -f core.sql liquid_feedback
bsw@1045 62
bsw@1045 63 A simple configuration may look as follows:
bsw@1045 64
bsw@1045 65 psql liquid_feedback
bsw@1045 66
bsw@1045 67 INSERT INTO system_setting (member_ttl) VALUES ('1 year');
bsw@1045 68 INSERT INTO contingent (polling, time_frame, text_entry_limit, initiative_limit) VALUES (false, '1 hour', 20, 6);
bsw@1045 69 INSERT INTO contingent (polling, time_frame, text_entry_limit, initiative_limit) VALUES (false, '1 day', 80, 12);
bsw@1045 70 INSERT INTO contingent (polling, time_frame, text_entry_limit, initiative_limit) VALUES (true, '1 hour', 200, 60);
bsw@1045 71 INSERT INTO contingent (polling, time_frame, text_entry_limit, initiative_limit) VALUES (true, '1 day', 800, 120);
bsw@1045 72 INSERT INTO policy (index, name, admission_time, discussion_time, verification_time, voting_time, issue_quorum_num, issue_quorum_den, initiative_quorum_num, initiative_quorum_den) VALUES (1, 'Default policy', '8 days', '15 days', '8 days', '15 days', 10, 100, 10, 100);
bsw@1045 73 INSERT INTO unit (name) VALUES ('Our organization');
bsw@1045 74 INSERT INTO area (unit_id, name) VALUES (1, 'Default area');
bsw@1045 75 INSERT INTO allowed_policy (area_id, policy_id, default_policy) VALUES (1, 1, TRUE);
bsw@1045 76
bsw@1045 77 If you want to create an admin user with an empty password (CAUTION!), then execute the following SQL statement:
bsw@1045 78
bsw@1045 79 INSERT INTO member (login, name, admin, password) VALUES ('admin', 'Administrator', TRUE, '$1$/EMPTY/$NEWt7XJg2efKwPm4vectc1');
bsw@1045 80
bsw@1045 81 Exit the `psql` interface by typing:
bsw@1045 82
bsw@1045 83 \q
bsw@1045 84
bsw@1045 85 And don't forget to quit the `www-data` shell:
bsw@1045 86
bsw@1045 87 exit
bsw@1045 88
bsw@1045 89
jbe@1156 90 4. Install Moonbridge (only for WebMCP 2.x)
jbe@1156 91 -------------------------------------------
jbe@1156 92
jbe@1156 93 # Download and unpack Moonbridge
jbe@1156 94 # from http://www.public-software-group.org/pub/projects/moonbridge/
jbe@1156 95 pmake MOONBR_LUA_PATH=/opt/moonbridge/?.lua
jbe@1156 96 mkdir /opt/moonbridge
jbe@1156 97 cp moonbridge /opt/moonbridge/
jbe@1156 98 cp moonbridge_http.lua /opt/moonbridge/
jbe@1156 99
jbe@1156 100
jbe@1156 101 5. Install WebMCP
bsw@1045 102 -----------------
bsw@1045 103
jbe@1156 104 Note: Using Debian, it may be necessary to append `-I /usr/include/lua5.2` at
bsw@1045 105 the end of the CFLAGS line in `Makefile.options` of the WebMCP source
bsw@1045 106 distibution:
bsw@1045 107
bsw@1045 108 # Download and unpack WebMCP
bsw@1045 109 # from http://www.public-software-group.org/pub/projects/webmcp/
jbe@1156 110 vi Makefile.options # Debian requires -I /usr/include/lua5.2 at end of CFLAGS line
bsw@1045 111 make
bsw@1045 112 mkdir /opt/webmcp
bsw@1045 113 cp -RL framework/* /opt/webmcp/
bsw@1045 114
bsw@1045 115
jbe@1156 116 6. Install the LiquidFeedback-Frontend
bsw@1045 117 --------------------------------------
bsw@1045 118
bsw@1045 119 Unpack source tree into appropriate directory, e.g. `/opt/liquid_feedback_frontend`:
bsw@1045 120
bsw@1045 121 # Download LiquidFeedback-Frontend
bsw@1045 122 # from http://www.public-software-group.org/pub/projects/liquid_feedback/frontend/
bsw@1045 123 mv liquid_feedback_frontend-vX.X.X /opt/liquid_feedback_frontend
bsw@1045 124
bsw@1045 125 Make `tmp/` directory of LiquidFeedback-Frontend writable for webserver:
bsw@1045 126
bsw@1045 127 chown www-data /opt/liquid_feedback_frontend/tmp
bsw@1045 128
jbe@1156 129 Compile binary for fast delivery of member images (only necessary for WebMCP 1.2.x):
bsw@1045 130
bsw@1045 131 cd /opt/liquid_feedback_frontend/fastpath
bsw@1045 132 vi getpic.c # check and modify #define commands as necessary
bsw@1045 133 make
bsw@1045 134
bsw@1045 135
jbe@1156 136 7. Configure mail system
bsw@1045 137 ------------------------
bsw@1045 138
bsw@1045 139 It may be necessary to configure your server's mail system, e.g. running
bsw@1045 140 `dpkg-reconfigure exim4-config` on a Debian system.
bsw@1045 141
bsw@1045 142
jbe@1156 143 8. Configure the Webserver for LiquidFeedback (only for WebMCP 1.2.x)
jbe@1156 144 ---------------------------------------------------------------------
bsw@1045 145
bsw@1045 146 A sample configuration for `lighttpd` is given below (assuming `mod_alias` has
bsw@1045 147 been included elsewhere):
bsw@1045 148
bsw@1045 149 server.modules += ("mod_cgi", "mod_rewrite", "mod_redirect", "mod_setenv")
bsw@1045 150
bsw@1045 151 # Enable CGI-Execution of *.lua files through lua binary
bsw@1045 152 cgi.assign += ( ".lua" => "/usr/bin/lua5.1" )
bsw@1045 153
bsw@1045 154 alias.url += ( "/lf/fastpath/" => "/opt/liquid_feedback_frontend/fastpath/",
bsw@1045 155 "/lf/static" => "/opt/liquid_feedback_frontend/static",
bsw@1045 156 "/lf" => "/opt/webmcp/cgi-bin" )
bsw@1045 157
bsw@1045 158 # Configure environment for demo application
bsw@1045 159 $HTTP["url"] =~ "^/lf" {
bsw@1045 160 setenv.add-environment += (
bsw@1045 161 "LANG" => "en_US.UTF-8",
bsw@1045 162 "WEBMCP_APP_BASEPATH" => "/opt/liquid_feedback_frontend/",
bsw@1045 163 "WEBMCP_CONFIG_NAME" => "myconfig")
bsw@1045 164 }
bsw@1045 165
bsw@1045 166 # URL beautification
bsw@1045 167 url.rewrite-once += (
bsw@1045 168 # do not rewrite static URLs
bsw@1045 169 "^/lf/fastpath/(.*)$" => "/lf/fastpath/$1",
bsw@1045 170 "^/lf/static/(.*)$" => "/lf/static/$1",
bsw@1045 171
bsw@1045 172 # dynamic URLs
bsw@1045 173 "^/lf/([^\?]*)(\?(.*))?$" => "/lf/webmcp-wrapper.lua?_webmcp_path=$1&$3",
bsw@1045 174
bsw@1045 175 )
bsw@1045 176
bsw@1045 177 $HTTP["url"] =~ "^/lf/fastpath/" {
bsw@1045 178 cgi.assign = ( "" => "" )
bsw@1045 179 setenv.add-response-header = ( "Cache-Control" => "private; max-age=86400" )
bsw@1045 180 }
bsw@1045 181
bsw@1045 182 If you're using Debian, you may want to create a file with the name
bsw@1045 183 `/etc/lighttpd/conf-available/60-liquidfeedback.conf` and create a softlink in
bsw@1045 184 `/etc/lighttpd/conf-enabled/`.
bsw@1045 185
bsw@1045 186
jbe@1156 187 9. Configure the LiquidFeedback-Frontend
jbe@1156 188 ----------------------------------------
bsw@1045 189
bsw@1045 190 cd /opt/liquid_feedback_frontend/config
bsw@1045 191 cp example.lua myconfig.lua
bsw@1045 192 # edit myconfig.lua according to your needs
bsw@1045 193
bsw@1045 194 Use the following option in your configuration file to enable fast image
jbe@1156 195 loading (only for WebMCP 1.2.x):
bsw@1045 196
bsw@1045 197 config.fastpath_url_func = function(member_id, image_type)
bsw@1045 198 return request.get_absolute_baseurl() .. "fastpath/getpic?" .. tostring(member_id) .. "+" .. tostring(image_type)
bsw@1045 199 end
bsw@1045 200
bsw@1045 201
jbe@1156 202 10. Setup regular execution of `lf_update` and related commands
jbe@1156 203 ---------------------------------------------------------------
bsw@1045 204
jbe@1051 205 The executables `lf_update`, `lf_update_issue_order`, and
jbe@1051 206 `lf_update_suggestion_order` must be executed regularly. This may be achieved
jbe@1051 207 by creating a file named `/opt/liquid_feedback_core/lf_updated` with the
jbe@1051 208 following contents:
bsw@1045 209
bsw@1045 210 #!/bin/sh
bsw@1045 211
bsw@1045 212 PIDFILE="/var/run/lf_updated.pid"
bsw@1045 213 PID=$$
bsw@1045 214
bsw@1045 215 if [ -f "${PIDFILE}" ] && kill -CONT $( cat "${PIDFILE}" ); then
bsw@1045 216 echo "lf_updated is already running."
bsw@1045 217 exit 1
bsw@1045 218 fi
bsw@1045 219
bsw@1045 220 echo "${PID}" > "${PIDFILE}"
bsw@1045 221
bsw@1045 222 while true; do
jbe@1191 223 su - www-data -s /bin/sh -c 'nice /opt/liquid_feedback_core/lf_update dbname=liquid_feedback 2>&1 | logger -t "lf_updated"'
jbe@1191 224 su - www-data -s /bin/sh -c 'nice /opt/liquid_feedback_core/lf_update_issue_order dbname=liquid_feedback 2>&1 | logger -t "lf_updated"'
jbe@1191 225 su - www-data -s /bin/sh -c 'nice /opt/liquid_feedback_core/lf_update_suggestion_order dbname=liquid_feedback 2>&1 | logger -t "lf_updated"'
bsw@1045 226 sleep 5
bsw@1045 227 done
bsw@1045 228
bsw@1045 229 This file must be marked as executable:
bsw@1045 230
bsw@1045 231 chmod +x /opt/liquid_feedback_core/lf_updated
bsw@1045 232
bsw@1045 233 And this file should be started automatically at system boot.
bsw@1045 234
bsw@1045 235
jbe@1156 236 11. Setup notification loop in background (only for WebMCP 1.2.x)
jbe@1156 237 -----------------------------------------------------------------
bsw@1045 238
bsw@1045 239 In addition to regular execution of `lf_update` and
bsw@1045 240 `lf_update_suggestion_order`, the following commands should be executed in
bsw@1045 241 background:
bsw@1045 242
jbe@1191 243 su www-data -s $SHELL
bsw@1045 244 cd /opt/liquid_feedback_frontend/
bsw@1045 245 echo "Event:send_notifications_loop()" | ../webmcp/bin/webmcp_shell myconfig
bsw@1045 246
bsw@1045 247
jbe@1190 248 12. Start the system
jbe@1190 249 --------------------
bsw@1045 250
jbe@1162 251 After `lf_update` has been executed at least once and (in case of WebMCP 1.2.x)
jbe@1162 252 the webserver has been restarted (using the configuration above), you should be
jbe@1162 253 able to access your LiquidFeedback system.
bsw@1045 254
jbe@1156 255 If you use WebMCP 2.x, the server is started by calling:
bsw@1045 256
jbe@1192 257 su www-data -s $SHELL
jbe@1156 258 /opt/moonbridge/moonbridge /opt/webmcp/bin/mcp.lua /opt/webmcp/ /opt/liquid_feedback_frontend/ main myconfig
jbe@1156 259
jbe@1162 260 In the latter case, the Moonbridge server will open a TCP port according to
jbe@1162 261 your configuration. Directly accessing this TCP port through your webbrowser
jbe@1162 262 is helpful for development purposes. For real-life deployment, however, it is
jbe@1162 263 recommended to further proxy the application (e.g. using nginx). The proxy can
jbe@1190 264 also add HTTPS and/or HTTP/2 support (which is not supported by Moonbridge
jbe@1190 265 itself).
jbe@1190 266
jbe@1190 267 To start the Moonbridge as a background process, please refer to the Moonbridge
jbe@1190 268 command line options:
jbe@1190 269
jbe@1190 270 Get this help message: moonbridge {-h|--help}
jbe@1190 271 Usage: moonbridge \
jbe@1190 272 [-b|--background] \
jbe@1190 273 [-d|--debug] \
jbe@1190 274 [-f|--logfacility {DAEMON|USER|0|1|...|7}] \
jbe@1190 275 [-i|--logident <syslog ident> \
jbe@1190 276 [-l|--logfile <logfile>] \
jbe@1190 277 [-p|--pidfile <pidfile>] \
jbe@1190 278 [-s|--stats] \
jbe@1190 279 -- <Lua script> [<cmdline options for Lua script>]
jbe@1162 280
jbe@1162 281

Impressum / About Us