liquid_feedback_frontend

annotate INSTALL.mkd @ 1051:53b0139ed930

find changesets by author, revision, files, or words in the commit message
Include "lf_update_issue_order" command in installation instructions
author jbe
date Mon Jul 14 21:01:18 2014 +0200 (2014-07-14)
parents b9300c2e75da
children 08adef9f05b9
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
bsw@1045 14 * lua5.1
bsw@1045 15 * postgresql
bsw@1045 16 * build-essential
bsw@1045 17 * libpq-dev
bsw@1045 18 * liblua5.1-0-dev
bsw@1045 19 * lighttpd
bsw@1045 20 * ghc
bsw@1045 21 * libghc6-parsec3-dev
bsw@1045 22 * imagemagick
bsw@1045 23 * exim4
jbe@1046 24 * markdown2 (install with Python's pip)
bsw@1045 25
bsw@1045 26 If you're using any other Linux distribution or BSD system, install the
bsw@1045 27 necessary software components accordingly.
bsw@1045 28
bsw@1045 29
bsw@1045 30 2. Ensure that the user account of your webserver has access to the database
bsw@1045 31 ----------------------------------------------------------------------------
bsw@1045 32
bsw@1045 33 Whichever useraccount is used by the webserver (usually `www-data`) needs to
bsw@1045 34 have access to your PostgreSQL installation. This is done by executing
bsw@1045 35 PostgreSQL's shell command `createuser` as database superuser (usually `pgsql`,
bsw@1045 36 or `postgres` for Debian installations):
bsw@1045 37
bsw@1045 38 su - postgres
bsw@1045 39 createuser
bsw@1045 40
bsw@1045 41 Enter name of role to add: www-data
bsw@1045 42 Shall the new role be a superuser? (y/n) n
bsw@1045 43 Shall the new role be allowed to create databases? (y/n) y
bsw@1045 44 Shall the new role be allowed to create more new roles? (y/n) n
bsw@1045 45
bsw@1045 46 exit
bsw@1045 47
bsw@1045 48
bsw@1045 49 3. Install and configure LiquidFeedback-Core
bsw@1045 50 --------------------------------------------
bsw@1045 51
bsw@1045 52 We recommend to create the database with the same user as your webserver
bsw@1045 53 (usually `www-data`) to avoid having to setup database privileges.
bsw@1045 54
bsw@1045 55 The example below installs the database as `www-data` and stores the two
bsw@1045 56 executables `lf_update` and `lf_update_issue_order` in the directory
bsw@1045 57 `/opt/liquid_feedback_core/`:
bsw@1045 58
bsw@1045 59 # Download and unpack LiquidFeedback-Core
bsw@1045 60 # from http://www.public-software-group.org/pub/projects/liquid_feedback/backend/
bsw@1045 61 make
bsw@1045 62 mkdir /opt/liquid_feedback_core
bsw@1045 63 cp core.sql lf_update lf_update_issue_order /opt/liquid_feedback_core
bsw@1045 64 su - www-data
bsw@1045 65 cd /opt/liquid_feedback_core
bsw@1045 66 createdb liquid_feedback
bsw@1045 67 createlang plpgsql liquid_feedback # command may be omitted, depending on PostgreSQL version
bsw@1045 68 psql -v ON_ERROR_STOP=1 -f core.sql liquid_feedback
bsw@1045 69
bsw@1045 70 A simple configuration may look as follows:
bsw@1045 71
bsw@1045 72 psql liquid_feedback
bsw@1045 73
bsw@1045 74 INSERT INTO system_setting (member_ttl) VALUES ('1 year');
bsw@1045 75 INSERT INTO contingent (polling, time_frame, text_entry_limit, initiative_limit) VALUES (false, '1 hour', 20, 6);
bsw@1045 76 INSERT INTO contingent (polling, time_frame, text_entry_limit, initiative_limit) VALUES (false, '1 day', 80, 12);
bsw@1045 77 INSERT INTO contingent (polling, time_frame, text_entry_limit, initiative_limit) VALUES (true, '1 hour', 200, 60);
bsw@1045 78 INSERT INTO contingent (polling, time_frame, text_entry_limit, initiative_limit) VALUES (true, '1 day', 800, 120);
bsw@1045 79 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 80 INSERT INTO unit (name) VALUES ('Our organization');
bsw@1045 81 INSERT INTO area (unit_id, name) VALUES (1, 'Default area');
bsw@1045 82 INSERT INTO allowed_policy (area_id, policy_id, default_policy) VALUES (1, 1, TRUE);
bsw@1045 83
bsw@1045 84 If you want to create an admin user with an empty password (CAUTION!), then execute the following SQL statement:
bsw@1045 85
bsw@1045 86 INSERT INTO member (login, name, admin, password) VALUES ('admin', 'Administrator', TRUE, '$1$/EMPTY/$NEWt7XJg2efKwPm4vectc1');
bsw@1045 87
bsw@1045 88 Exit the `psql` interface by typing:
bsw@1045 89
bsw@1045 90 \q
bsw@1045 91
bsw@1045 92 And don't forget to quit the `www-data` shell:
bsw@1045 93
bsw@1045 94 exit
bsw@1045 95
bsw@1045 96
bsw@1045 97 4. Install WebMCP
bsw@1045 98 -----------------
bsw@1045 99
bsw@1045 100 Note: Using Debian, it may be necessary to append `-I /usr/include/lua5.1` at
bsw@1045 101 the end of the CFLAGS line in `Makefile.options` of the WebMCP source
bsw@1045 102 distibution:
bsw@1045 103
bsw@1045 104 # Download and unpack WebMCP
bsw@1045 105 # from http://www.public-software-group.org/pub/projects/webmcp/
bsw@1045 106 vi Makefile.options # Debian requires -I /usr/include/lua5.1 at end of CFLAGS line
bsw@1045 107 make
bsw@1045 108 mkdir /opt/webmcp
bsw@1045 109 cp -RL framework/* /opt/webmcp/
bsw@1045 110
bsw@1045 111
jbe@1046 112 5. Install the LiquidFeedback-Frontend
bsw@1045 113 --------------------------------------
bsw@1045 114
bsw@1045 115 Unpack source tree into appropriate directory, e.g. `/opt/liquid_feedback_frontend`:
bsw@1045 116
bsw@1045 117 # Download LiquidFeedback-Frontend
bsw@1045 118 # from http://www.public-software-group.org/pub/projects/liquid_feedback/frontend/
bsw@1045 119 mv liquid_feedback_frontend-vX.X.X /opt/liquid_feedback_frontend
bsw@1045 120
bsw@1045 121 Create HTML code for help texts:
bsw@1045 122
bsw@1045 123 cd /opt/liquid_feedback_frontend/locale
bsw@1045 124 PATH=/opt/rocketwiki-lqfb:$PATH make
bsw@1045 125
bsw@1045 126 Make `tmp/` directory of LiquidFeedback-Frontend writable for webserver:
bsw@1045 127
bsw@1045 128 chown www-data /opt/liquid_feedback_frontend/tmp
bsw@1045 129
bsw@1045 130 Compile binary for fast delivery of member images:
bsw@1045 131
bsw@1045 132 cd /opt/liquid_feedback_frontend/fastpath
bsw@1045 133 vi getpic.c # check and modify #define commands as necessary
bsw@1045 134 make
bsw@1045 135
bsw@1045 136
jbe@1046 137 6. Configure mail system
bsw@1045 138 ------------------------
bsw@1045 139
bsw@1045 140 It may be necessary to configure your server's mail system, e.g. running
bsw@1045 141 `dpkg-reconfigure exim4-config` on a Debian system.
bsw@1045 142
bsw@1045 143
jbe@1046 144 7. Configure the Webserver for LiquidFeedback:
bsw@1045 145 ----------------------------------------------
bsw@1045 146
bsw@1045 147 A sample configuration for `lighttpd` is given below (assuming `mod_alias` has
bsw@1045 148 been included elsewhere):
bsw@1045 149
bsw@1045 150 server.modules += ("mod_cgi", "mod_rewrite", "mod_redirect", "mod_setenv")
bsw@1045 151
bsw@1045 152 # Enable CGI-Execution of *.lua files through lua binary
bsw@1045 153 cgi.assign += ( ".lua" => "/usr/bin/lua5.1" )
bsw@1045 154
bsw@1045 155 alias.url += ( "/lf/fastpath/" => "/opt/liquid_feedback_frontend/fastpath/",
bsw@1045 156 "/lf/static" => "/opt/liquid_feedback_frontend/static",
bsw@1045 157 "/lf" => "/opt/webmcp/cgi-bin" )
bsw@1045 158
bsw@1045 159 # Configure environment for demo application
bsw@1045 160 $HTTP["url"] =~ "^/lf" {
bsw@1045 161 setenv.add-environment += (
bsw@1045 162 "LANG" => "en_US.UTF-8",
bsw@1045 163 "WEBMCP_APP_BASEPATH" => "/opt/liquid_feedback_frontend/",
bsw@1045 164 "WEBMCP_CONFIG_NAME" => "myconfig")
bsw@1045 165 }
bsw@1045 166
bsw@1045 167 # URL beautification
bsw@1045 168 url.rewrite-once += (
bsw@1045 169 # do not rewrite static URLs
bsw@1045 170 "^/lf/fastpath/(.*)$" => "/lf/fastpath/$1",
bsw@1045 171 "^/lf/static/(.*)$" => "/lf/static/$1",
bsw@1045 172
bsw@1045 173 # dynamic URLs
bsw@1045 174 "^/lf/([^\?]*)(\?(.*))?$" => "/lf/webmcp-wrapper.lua?_webmcp_path=$1&$3",
bsw@1045 175
bsw@1045 176 )
bsw@1045 177
bsw@1045 178 $HTTP["url"] =~ "^/lf/fastpath/" {
bsw@1045 179 cgi.assign = ( "" => "" )
bsw@1045 180 setenv.add-response-header = ( "Cache-Control" => "private; max-age=86400" )
bsw@1045 181 }
bsw@1045 182
bsw@1045 183 If you're using Debian, you may want to create a file with the name
bsw@1045 184 `/etc/lighttpd/conf-available/60-liquidfeedback.conf` and create a softlink in
bsw@1045 185 `/etc/lighttpd/conf-enabled/`.
bsw@1045 186
bsw@1045 187
jbe@1046 188 8. Configure the LiquidFeedback-Frontend:
bsw@1045 189 -----------------------------------------
bsw@1045 190
bsw@1045 191 cd /opt/liquid_feedback_frontend/config
bsw@1045 192 cp example.lua myconfig.lua
bsw@1045 193 # edit myconfig.lua according to your needs
bsw@1045 194
bsw@1045 195 Use the following option in your configuration file to enable fast image
bsw@1045 196 loading:
bsw@1045 197
bsw@1045 198 config.fastpath_url_func = function(member_id, image_type)
bsw@1045 199 return request.get_absolute_baseurl() .. "fastpath/getpic?" .. tostring(member_id) .. "+" .. tostring(image_type)
bsw@1045 200 end
bsw@1045 201
bsw@1045 202
jbe@1051 203 9. Setup regular execution of `lf_update` and related commands
jbe@1051 204 --------------------------------------------------------------
bsw@1045 205
jbe@1051 206 The executables `lf_update`, `lf_update_issue_order`, and
jbe@1051 207 `lf_update_suggestion_order` must be executed regularly. This may be achieved
jbe@1051 208 by creating a file named `/opt/liquid_feedback_core/lf_updated` with the
jbe@1051 209 following contents:
bsw@1045 210
bsw@1045 211 #!/bin/sh
bsw@1045 212
bsw@1045 213 PIDFILE="/var/run/lf_updated.pid"
bsw@1045 214 PID=$$
bsw@1045 215
bsw@1045 216 if [ -f "${PIDFILE}" ] && kill -CONT $( cat "${PIDFILE}" ); then
bsw@1045 217 echo "lf_updated is already running."
bsw@1045 218 exit 1
bsw@1045 219 fi
bsw@1045 220
bsw@1045 221 echo "${PID}" > "${PIDFILE}"
bsw@1045 222
bsw@1045 223 while true; do
bsw@1045 224 su - www-data -c 'nice /opt/liquid_feedback_core/lf_update dbname=liquid_feedback 2>&1 | logger -t "lf_updated"'
jbe@1051 225 su - www-data -c 'nice /opt/liquid_feedback_core/lf_update_issue_order dbname=liquid_feedback 2>&1 | logger -t "lf_updated"'
bsw@1045 226 su - www-data -c 'nice /opt/liquid_feedback_core/lf_update_suggestion_order dbname=liquid_feedback 2>&1 | logger -t "lf_updated"'
bsw@1045 227 sleep 5
bsw@1045 228 done
bsw@1045 229
bsw@1045 230 This file must be marked as executable:
bsw@1045 231
bsw@1045 232 chmod +x /opt/liquid_feedback_core/lf_updated
bsw@1045 233
bsw@1045 234 And this file should be started automatically at system boot.
bsw@1045 235
bsw@1045 236
jbe@1046 237 10. Setup notification loop in background
bsw@1045 238 -----------------------------------------
bsw@1045 239
bsw@1045 240 In addition to regular execution of `lf_update` and
bsw@1045 241 `lf_update_suggestion_order`, the following commands should be executed in
bsw@1045 242 background:
bsw@1045 243
bsw@1045 244 su - www-data
bsw@1045 245 cd /opt/liquid_feedback_frontend/
bsw@1045 246 echo "Event:send_notifications_loop()" | ../webmcp/bin/webmcp_shell myconfig
bsw@1045 247
bsw@1045 248
jbe@1046 249 11. Start the sytem
bsw@1045 250 -------------------
bsw@1045 251
bsw@1045 252 After `lf_update` has been executed at least once, and the webserver has been
bsw@1045 253 restarted (using the configuration above), you should be able to access your
bsw@1045 254 LiquidFeedback system.
bsw@1045 255
bsw@1045 256

Impressum / About Us