Bitpoll

Bitpoll is a software to conduct polls about Dates, Times or general Questions.

This is a new version of the Dudel from opatut (https://github.com/opatut/dudel) used on <mafiasi.de>, rewritten using the Django framework as a backend.

Install

Get the code:

git clone https://github.com/dabch/Bitpoll.git

Generate a Python virtualenv and install dependencies:

virtualenv -p $(which python3) .pyenv
source .pyenv/bin/activate
pip install -r requirements.txt

The following settings have to be adjusted to the intended production setting (but are not necessary for debugging):

• SECRET_KEY: This key should be set once on first install.
• FIELD_ENCRYPTION_KEY: ./manage.py generate_encryption_key
• SOCIALACCOUNT_PROVIDERS: More infos are in the code.
• BASE_URL: Bitpoll app base url
• HOME_URL: Nextcloud instance base url
• ALLOWED_HOSTS: Bitpoll app base url / host
• DATABASES: the database backend configuration (https://docs.djangoproject.com/en/2.2/ref/databases/)
• ADMIN_GROUPS: list of nextcloud group names which will be imported as website admins (be careful!)

Initialise Database:

./manage.py migrate

Run Testserver:

./manage.py runserver

Production

In production Senty is used for error reporting.

Install Dependencies for Production:

sudo apt install python3 python3-dev python3-pip python3-virtualenv

Install Python Dependencies

pip install -r requirements.txt

For Production systems it is necessary to run

./manage.py compilemessages
./manage.py collectstatic --no-input

And of course migrate the database for every production deploy

./manage.py migrate

Define a nextcloud group which only contains admins which should also have administrative access to the BitPoll instance:

Edit the ADMIN_GROUPS in the settings_local.py file. As soon as a user logs in using the nextcloud oauth, his/her groups are compared to the groups in this list. If any of them matches, the user is granted administrative rights.

Translation

To translate strings that are already wrapped in a gettext call (sometime aliased as _), just run the following command:

./manage.py makemessages

This will create updated .po files in the /locale/de_DE/ and /locale/en_US/ directories. For a reference on how to use these files for translation, have a look at this tutorial.

After adding all required translations, run the following command to convert the .po files to the compiled .mo files for runtime translation with gettext.

./manage.py compilemessages

nginx Webserver Setup

Add the following code snippet to your virtual host configuration:

server {
    listen 80;
    server_name bitpoll.<your-domain>.de;
    access_log /var/log/bitpoll/access_log;
    
    location / {
        root /var/www/html;
        uwsgi_pass bitpoll:8000;
        include uwsgi_params;
    }
    
    location /static {
        alias /app/_static;
    }

Apache Webserver Setup

We use an apache2 webserver in production which serves the bitpoll django application via the mod_wsgi module.

Install this module first (if it doesn't exist yet):

pip install mod_wsgi

Then, add the following line to your apache2 webserver config file (not the virtual host file):

LoadModule proxy_module modules/mod_proxy.so
LoadModule proxy_uwsgi_module modules/mod_proxy_uwsgi.so

To successfully serve the bitpoll application, we still need to correctly route the static files and give apache access to the wsgi.py entrypoint file. This code snipped has to be added to the VirtualHost-file which will be used for serving the bitpoll application.

<VirtualHost *:80>
    ServerName localhost

    Alias /static /app/_static
    ProxyPass /static !
    ProxyPass / uwsgi://bitpoll:8000/

    <Directory /app/_static>
        Require all granted
    </Directory>
</VirtualHost>

Nextcloud OAuth setup

For enabling the nextcloud OAuth login, first navigate to Settings/Administration/Security on your Nextcloud instance. On the bottom of the site should be a section called "OAuth 2.0 clients" (tested with version 21.0.2).

Enter a custom name and https://<bitpoll_domain>/accounts/nextcloud_auth/login/callback/ as the redirection URI.

Management of Dependencies

We use pip-tools to manage the dependencies. After modification or the requirements*.in files or for updates of packages run

pip-compile --upgrade --output-file requirements.txt requirements.in
pip-compile --upgrade --output-file requirements-production.txt  requirements-production.in requirements.in

to sync your enviroment with the requirements.txt just run

pip-sync

this will install/deinstall dependencies so that the virtualenv is matching the requirements file