bsw@1045: LiquidFeedback Installation Instructions bsw@1045: ======================================== bsw@1045: bsw@1045: This document gives a short outline about the necessary steps to setup a bsw@1045: LiquidFeedback system. bsw@1045: bsw@1045: bsw@1045: 1. Install necessary dependencies bsw@1045: --------------------------------- bsw@1045: bsw@1045: If you're using a Debian system, make sure that the following packages are bsw@1045: installed: bsw@1045: jbe@1156: * build-essential jbe@1156: * lua5.2 jbe@1156: * liblua5.2-dev jbe@1308: * postgresql (including the corresponding server-dev package) bsw@1045: * libpq-dev jbe@1308: * libbsd-dev jbe@1244: * pmake or bmake bsw@1045: * imagemagick bsw@1045: * exim4 jbe@1191: * markdown2 (``apt-get install python-pip; pip install markdown2``) bsw@1045: bsw@1045: If you're using any other Linux distribution or BSD system, install the bsw@1045: necessary software components accordingly. bsw@1045: bsw@1045: bsw@1045: 2. Ensure that the user account of your webserver has access to the database bsw@1045: ---------------------------------------------------------------------------- bsw@1045: jbe@1156: 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): bsw@1045: jbe@1191: su postgres -s $SHELL jbe@1191: createuser --no-superuser --createdb --no-createrole www-data bsw@1045: exit bsw@1045: bsw@1045: bsw@1045: 3. Install and configure LiquidFeedback-Core bsw@1045: -------------------------------------------- bsw@1045: bsw@1045: We recommend to create the database with the same user as your webserver bsw@1045: (usually `www-data`) to avoid having to setup database privileges. bsw@1045: bsw@1045: The example below installs the database as `www-data` and stores the two bsw@1045: executables `lf_update` and `lf_update_issue_order` in the directory bsw@1045: `/opt/liquid_feedback_core/`: bsw@1045: bsw@1045: # 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 jbe@1196: cp core.sql lf_update lf_update_issue_order lf_update_suggestion_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 bsw@1045: psql -v ON_ERROR_STOP=1 -f core.sql liquid_feedback bsw@1045: bsw@1045: A simple configuration may look as follows: bsw@1045: bsw@1045: psql liquid_feedback bsw@1045: bsw@1045: INSERT INTO system_setting (member_ttl) VALUES ('1 year'); bsw@1045: INSERT INTO contingent (polling, time_frame, text_entry_limit, initiative_limit) VALUES (false, '1 hour', 20, 6); bsw@1045: INSERT INTO contingent (polling, time_frame, text_entry_limit, initiative_limit) VALUES (false, '1 day', 80, 12); bsw@1045: INSERT INTO contingent (polling, time_frame, text_entry_limit, initiative_limit) VALUES (true, '1 hour', 200, 60); bsw@1045: INSERT INTO contingent (polling, time_frame, text_entry_limit, initiative_limit) VALUES (true, '1 day', 800, 120); jbe@1246: INSERT INTO policy (index, name, min_admission_time, max_admission_time, discussion_time, verification_time, voting_time, issue_quorum_num, issue_quorum_den, initiative_quorum_num, initiative_quorum_den) VALUES (1, 'Default policy', '4 days', '8 days', '15 days', '8 days', '15 days', 10, 100, 10, 100); bsw@1045: INSERT INTO unit (name) VALUES ('Our organization'); bsw@1045: INSERT INTO area (unit_id, name) VALUES (1, 'Default area'); bsw@1045: INSERT INTO allowed_policy (area_id, policy_id, default_policy) VALUES (1, 1, TRUE); bsw@1045: bsw@1045: If you want to create an admin user with an empty password (CAUTION!), then execute the following SQL statement: bsw@1045: bsw@1045: INSERT INTO member (login, name, admin, password) VALUES ('admin', 'Administrator', TRUE, '$1$/EMPTY/$NEWt7XJg2efKwPm4vectc1'); bsw@1045: bsw@1045: Exit the `psql` interface by typing: bsw@1045: bsw@1045: \q bsw@1045: bsw@1045: And don't forget to quit the `www-data` shell: bsw@1045: bsw@1045: exit bsw@1045: bsw@1045: jbe@1244: 4. Install Moonbridge jbe@1244: --------------------- jbe@1156: jbe@1156: # 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: jbe@1156: jbe@1156: 5. Install WebMCP bsw@1045: ----------------- bsw@1045: jbe@1156: Note: Using Debian, it may be necessary to append `-I /usr/include/lua5.2` at bsw@1045: the end of the CFLAGS line in `Makefile.options` of the WebMCP source bsw@1045: distibution: bsw@1045: bsw@1045: # 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 bsw@1045: cp -RL framework/* /opt/webmcp/ bsw@1045: bsw@1045: jbe@1156: 6. Install the LiquidFeedback-Frontend bsw@1045: -------------------------------------- bsw@1045: bsw@1045: Unpack source tree into appropriate directory, e.g. `/opt/liquid_feedback_frontend`: bsw@1045: bsw@1045: # Download LiquidFeedback-Frontend bsw@1045: # from http://www.public-software-group.org/pub/projects/liquid_feedback/frontend/ bsw@1045: mv liquid_feedback_frontend-vX.X.X /opt/liquid_feedback_frontend bsw@1045: bsw@1045: Make `tmp/` directory of LiquidFeedback-Frontend writable for webserver: bsw@1045: bsw@1045: chown www-data /opt/liquid_feedback_frontend/tmp bsw@1045: bsw@1045: jbe@1156: 7. Configure mail system bsw@1045: ------------------------ bsw@1045: bsw@1045: It may be necessary to configure your server's mail system, e.g. running bsw@1045: `dpkg-reconfigure exim4-config` on a Debian system. bsw@1045: bsw@1045: jbe@1244: 8. Configure the LiquidFeedback-Frontend jbe@1156: ---------------------------------------- bsw@1045: bsw@1045: cd /opt/liquid_feedback_frontend/config bsw@1045: cp example.lua myconfig.lua bsw@1045: # edit myconfig.lua according to your needs bsw@1045: bsw@1045: jbe@1244: 9. Setup regular execution of `lf_update` and related commands jbe@1244: -------------------------------------------------------------- bsw@1045: jbe@1051: 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: bsw@1045: bsw@1045: #!/bin/sh bsw@1045: bsw@1045: PIDFILE="/var/run/lf_updated.pid" bsw@1045: PID=$$ bsw@1045: bsw@1045: if [ -f "${PIDFILE}" ] && kill -CONT $( cat "${PIDFILE}" ); then bsw@1045: echo "lf_updated is already running." bsw@1045: exit 1 bsw@1045: fi bsw@1045: bsw@1045: 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 bsw@1045: done bsw@1045: bsw@1045: This file must be marked as executable: bsw@1045: bsw@1045: chmod +x /opt/liquid_feedback_core/lf_updated bsw@1045: bsw@1045: And this file should be started automatically at system boot. bsw@1045: bsw@1045: jbe@1244: 10. Start the system jbe@1190: -------------------- bsw@1045: jbe@1244: After `lf_update` has been executed at least once, you should be able to use jbe@1244: your LiquidFeedback system. bsw@1045: jbe@1244: The server is started by calling: bsw@1045: jbe@1192: su www-data -s $SHELL jbe@1156: /opt/moonbridge/moonbridge /opt/webmcp/bin/mcp.lua /opt/webmcp/ /opt/liquid_feedback_frontend/ main myconfig jbe@1156: jbe@1162: 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 \ jbe@1190: [-l|--logfile ] \ jbe@1190: [-p|--pidfile ] \ jbe@1190: [-s|--stats] \ jbe@1190: -- [] jbe@1162: jbe@1162: