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