This document gives a short outline about the necessary steps to setup a jbe@1046: LiquidFeedback system.
jbe@1046: jbe@1046:If you're using a Debian system, make sure that the following packages are jbe@1046: installed:
jbe@1046: bsw@1045:apt-get install python-pip; pip install markdown2)If you're using any other Linux distribution or BSD system, install the jbe@1046: necessary software components accordingly.
jbe@1046: jbe@1046:The useraccount of the webserver (usually www-data) or the Moonbridge server
jbe@1156: process needs to have access to your PostgreSQL installation. This is done by
jbe@1156: executing PostgreSQL's shell command createuser as database superuser
jbe@1156: (usually pgsql, or postgres for Debian installations):
su postgres -s $SHELL
jbe@1191: createuser --no-superuser --createdb --no-createrole www-data
jbe@1046: exit
jbe@1046: We recommend to create the database with the same user as your webserver
jbe@1046: (usually www-data) to avoid having to setup database privileges.
The example below installs the database as www-data and stores the two
jbe@1046: executables lf_update and lf_update_issue_order in the directory
jbe@1046: /opt/liquid_feedback_core/:
# Download and unpack LiquidFeedback-Core
bsw@1045: # from http://www.public-software-group.org/pub/projects/liquid_feedback/backend/
bsw@1045: make
bsw@1045: mkdir /opt/liquid_feedback_core
bsw@1045: cp core.sql lf_update lf_update_issue_order /opt/liquid_feedback_core
jbe@1191: su www-data -s $SHELL
bsw@1045: cd /opt/liquid_feedback_core
bsw@1045: createdb liquid_feedback
bsw@1045: createlang plpgsql liquid_feedback # command may be omitted, depending on PostgreSQL version
jbe@1046: psql -v ON_ERROR_STOP=1 -f core.sql liquid_feedback
jbe@1046: A simple configuration may look as follows:
jbe@1046: bsw@1045:psql liquid_feedback
bsw@1045:
jbe@1046: INSERT INTO system_setting (member_ttl) VALUES ('1 year');
jbe@1046: INSERT INTO contingent (polling, time_frame, text_entry_limit, initiative_limit) VALUES (false, '1 hour', 20, 6);
jbe@1046: INSERT INTO contingent (polling, time_frame, text_entry_limit, initiative_limit) VALUES (false, '1 day', 80, 12);
jbe@1046: INSERT INTO contingent (polling, time_frame, text_entry_limit, initiative_limit) VALUES (true, '1 hour', 200, 60);
jbe@1046: INSERT INTO contingent (polling, time_frame, text_entry_limit, initiative_limit) VALUES (true, '1 day', 800, 120);
jbe@1046: 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);
jbe@1046: INSERT INTO unit (name) VALUES ('Our organization');
jbe@1046: INSERT INTO area (unit_id, name) VALUES (1, 'Default area');
jbe@1046: INSERT INTO allowed_policy (area_id, policy_id, default_policy) VALUES (1, 1, TRUE);
jbe@1046: If you want to create an admin user with an empty password (CAUTION!), then execute the following SQL statement:
jbe@1046: jbe@1046:INSERT INTO member (login, name, admin, password) VALUES ('admin', 'Administrator', TRUE, '$1$/EMPTY/$NEWt7XJg2efKwPm4vectc1');
jbe@1046: Exit the psql interface by typing:
\q
jbe@1046: And don't forget to quit the www-data shell:
exit
jbe@1046: # Download and unpack Moonbridge
jbe@1156: # from http://www.public-software-group.org/pub/projects/moonbridge/
jbe@1156: pmake MOONBR_LUA_PATH=/opt/moonbridge/?.lua
jbe@1156: mkdir /opt/moonbridge
jbe@1156: cp moonbridge /opt/moonbridge/
jbe@1156: cp moonbridge_http.lua /opt/moonbridge/
jbe@1156: Note: Using Debian, it may be necessary to append -I /usr/include/lua5.2 at
jbe@1046: the end of the CFLAGS line in Makefile.options of the WebMCP source
jbe@1046: distibution:
# Download and unpack WebMCP
bsw@1045: # from http://www.public-software-group.org/pub/projects/webmcp/
jbe@1156: vi Makefile.options # Debian requires -I /usr/include/lua5.2 at end of CFLAGS line
bsw@1045: make
bsw@1045: mkdir /opt/webmcp
jbe@1046: cp -RL framework/* /opt/webmcp/
jbe@1046: Unpack source tree into appropriate directory, e.g. /opt/liquid_feedback_frontend:
# Download LiquidFeedback-Frontend
bsw@1045: # from http://www.public-software-group.org/pub/projects/liquid_feedback/frontend/
jbe@1046: mv liquid_feedback_frontend-vX.X.X /opt/liquid_feedback_frontend
jbe@1046: Make tmp/ directory of LiquidFeedback-Frontend writable for webserver:
chown www-data /opt/liquid_feedback_frontend/tmp
jbe@1046: Compile binary for fast delivery of member images (only necessary for WebMCP 1.2.x):
jbe@1046: bsw@1045:cd /opt/liquid_feedback_frontend/fastpath
bsw@1045: vi getpic.c # check and modify #define commands as necessary
jbe@1046: make
jbe@1046: It may be necessary to configure your server's mail system, e.g. running
jbe@1046: dpkg-reconfigure exim4-config on a Debian system.
A sample configuration for lighttpd is given below (assuming mod_alias has
jbe@1046: been included elsewhere):
server.modules += ("mod_cgi", "mod_rewrite", "mod_redirect", "mod_setenv")
bsw@1045:
bsw@1045: # Enable CGI-Execution of *.lua files through lua binary
jbe@1046: cgi.assign += ( ".lua" => "/usr/bin/lua5.1" )
bsw@1045:
jbe@1046: alias.url += ( "/lf/fastpath/" => "/opt/liquid_feedback_frontend/fastpath/",
jbe@1046: "/lf/static" => "/opt/liquid_feedback_frontend/static",
jbe@1046: "/lf" => "/opt/webmcp/cgi-bin" )
bsw@1045:
bsw@1045: # Configure environment for demo application
jbe@1046: $HTTP["url"] =~ "^/lf" {
bsw@1045: setenv.add-environment += (
jbe@1046: "LANG" => "en_US.UTF-8",
jbe@1046: "WEBMCP_APP_BASEPATH" => "/opt/liquid_feedback_frontend/",
jbe@1046: "WEBMCP_CONFIG_NAME" => "myconfig")
bsw@1045: }
bsw@1045:
bsw@1045: # URL beautification
bsw@1045: url.rewrite-once += (
bsw@1045: # do not rewrite static URLs
jbe@1046: "^/lf/fastpath/(.*)$" => "/lf/fastpath/$1",
jbe@1046: "^/lf/static/(.*)$" => "/lf/static/$1",
bsw@1045:
bsw@1045: # dynamic URLs
jbe@1046: "^/lf/([^\?]*)(\?(.*))?$" => "/lf/webmcp-wrapper.lua?_webmcp_path=$1&$3",
bsw@1045:
bsw@1045: )
bsw@1045:
jbe@1046: $HTTP["url"] =~ "^/lf/fastpath/" {
jbe@1046: cgi.assign = ( "" => "" )
jbe@1046: setenv.add-response-header = ( "Cache-Control" => "private; max-age=86400" )
jbe@1046: }
jbe@1046: If you're using Debian, you may want to create a file with the name
jbe@1046: /etc/lighttpd/conf-available/60-liquidfeedback.conf and create a softlink in
jbe@1046: /etc/lighttpd/conf-enabled/.
cd /opt/liquid_feedback_frontend/config
bsw@1045: cp example.lua myconfig.lua
jbe@1046: # edit myconfig.lua according to your needs
jbe@1046: Use the following option in your configuration file to enable fast image jbe@1156: loading (only for WebMCP 1.2.x):
jbe@1046: bsw@1045:config.fastpath_url_func = function(member_id, image_type)
jbe@1046: return request.get_absolute_baseurl() .. "fastpath/getpic?" .. tostring(member_id) .. "+" .. tostring(image_type)
jbe@1046: end
jbe@1046: lf_update and related commands The executables lf_update, lf_update_issue_order, and
jbe@1051: lf_update_suggestion_order must be executed regularly. This may be achieved
jbe@1051: by creating a file named /opt/liquid_feedback_core/lf_updated with the
jbe@1051: following contents:
#!/bin/sh
bsw@1045:
jbe@1046: PIDFILE="/var/run/lf_updated.pid"
bsw@1045: PID=$$
bsw@1045:
jbe@1046: if [ -f "${PIDFILE}" ] && kill -CONT $( cat "${PIDFILE}" ); then
jbe@1046: echo "lf_updated is already running."
bsw@1045: exit 1
bsw@1045: fi
bsw@1045:
jbe@1046: echo "${PID}" > "${PIDFILE}"
bsw@1045:
bsw@1045: while true; do
jbe@1191: 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: 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: 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: sleep 5
jbe@1046: done
jbe@1046: This file must be marked as executable:
jbe@1046: jbe@1046:chmod +x /opt/liquid_feedback_core/lf_updated
jbe@1046: And this file should be started automatically at system boot.
jbe@1046: jbe@1156:In addition to regular execution of lf_update and
jbe@1046: lf_update_suggestion_order, the following commands should be executed in
jbe@1046: background:
su www-data -s $SHELL
bsw@1045: cd /opt/liquid_feedback_frontend/
jbe@1046: echo "Event:send_notifications_loop()" | ../webmcp/bin/webmcp_shell myconfig
jbe@1046: After lf_update has been executed at least once and (in case of WebMCP 1.2.x)
jbe@1162: the webserver has been restarted (using the configuration above), you should be
jbe@1162: able to access your LiquidFeedback system.
If you use WebMCP 2.x, the server is started by calling:
jbe@1156: jbe@1192:su www-data -s $SHELL
jbe@1192: /opt/moonbridge/moonbridge /opt/webmcp/bin/mcp.lua /opt/webmcp/ /opt/liquid_feedback_frontend/ main myconfig
jbe@1156: In the latter case, the Moonbridge server will open a TCP port according to jbe@1162: your configuration. Directly accessing this TCP port through your webbrowser jbe@1162: is helpful for development purposes. For real-life deployment, however, it is jbe@1162: recommended to further proxy the application (e.g. using nginx). The proxy can jbe@1190: also add HTTPS and/or HTTP/2 support (which is not supported by Moonbridge jbe@1190: itself).
jbe@1190: jbe@1190:To start the Moonbridge as a background process, please refer to the Moonbridge jbe@1190: command line options:
jbe@1190: jbe@1190:Get this help message: moonbridge {-h|--help}
jbe@1190: Usage: moonbridge \
jbe@1190: [-b|--background] \
jbe@1190: [-d|--debug] \
jbe@1190: [-f|--logfacility {DAEMON|USER|0|1|...|7}] \
jbe@1190: [-i|--logident <syslog ident> \
jbe@1190: [-l|--logfile <logfile>] \
jbe@1190: [-p|--pidfile <pidfile>] \
jbe@1190: [-s|--stats] \
jbe@1190: -- <Lua script> [<cmdline options for Lua script>]
jbe@1190: