openslides 2.1.1

What is OpenSlides?

OpenSlides is a free, web based presentation and assembly system for managing and projecting agenda, motions and elections of an assembly. See https://openslides.org/ for more information.

Requirements

OpenSlides runs everywhere where Python is running (for example on GNU/Linux, Mac or Windows (XP or newer)). On each client you need only a current version of a webbrowser.

Installation

$ mkdir OpenSlides
$ cd OpenSlides

$ python3 -m venv .virtualenv
$ source .virtualenv/bin/activate
$ pip install --upgrade setuptools pip

$ pip install openslides

$ pip install openslides-x.x.tar.gz

$ openslides

$ source .virtualenv/bin/activate

$ openslides --help

$ openslides start --local-installation

Development

If you want to contribute to OpenSlides, have a look at OpenSlides website and write us an email. There is also an instruction to install the development version.

In OpenSlides repository you find a Dockerfile but this is not for production use. See our Multi instance backend for OpenSlides for more information.

Installation for big assemblies

The installation steps described above install OpenSlides in a way that does NOT support hundreds of concurrent clients. To install OpenSlides for big assemblies some variables have to be changed in the OpenSlides settings file (usually called settings.py).

The configuration values that have to be altered are:

• CACHES

• CHANNEL_LAYERS

• DATABASES

• SESSION_ENGINE

You should use a webserver like Apache HTTP Server or nginx to serve the static and media files as proxy server in front of your OpenSlides interface server. You also should use a database like PostgreSQL and Redis as channels backend, cache backend and session engine. Finally you should start some WSGI workers and one or more interface servers (Daphne or Geiss).

Please see the respective section in the DEVELOPMENT.rst and:

• https://channels.readthedocs.io/en/latest/deploying.html

• https://github.com/ostcar/geiss

• https://docs.djangoproject.com/en/1.10/topics/cache/

• https://github.com/sebleier/django-redis-cache

• https://docs.djangoproject.com/en/1.10/ref/settings/#databases

Used software

OpenSlides uses the following projects or parts of them:

• Several Python packages (see requirements_production.txt).

• Several JavaScript packages (see bower.json)

  • angular, License: MIT

  • angular-animate, License: MIT

  • angular-bootstrap, License: MIT

  • angular-bootstrap-colorpicker, License: MIT

  • angular-chosen-localytics, License: MIT

  • angular-ckeditor, License: MIT

  • angular-formly, License: MIT

  • angular-formly-templates-bootstrap, License: MIT

  • angular-gettext, License: MIT

  • angular-messages, License: MIT

  • pdfmake, License: MIT

  • angular-pdf, License: MIT

  • angular-sanitize, License: MIT

  • angular-scroll-glue, License: MIT

  • angular-ui-router, License: MIT

  • angular-ui-tree, License: MIT

  • angular-xeditable, License: MIT

  • api-check, License: MIT

  • bootstrap, License: MIT

  • bootstrap-ui-datetime-picker, License: MIT

  • chosen, License: MIT

  • ckeditor, License: GPL 2+, LGPL 2.1+ or MPL 1.1.

  • font-awesome-bower, License: MIT

  • jquery, License: MIT

  • jquery.cookie, License: MIT

  • js-data, License: MIT

  • js-data-angular, License: MIT

  • js-data-http, License: MIT

  • lodash, License: MIT

  • ng-dialog, License: MIT

  • ng-file-upload, License: MIT

  • ngStorage, License: MIT

  • ngbootbox, License: MIT

  • open-sans-fontface, License: Apache License version 2.0

  • Papa Parse, License: MIT

  • pdfjs-dist, License: Apache-2.0

  • roboto-condensed, License: Apache 2.0

License and authors

OpenSlides is Free/Libre Open Source Software (FLOSS), and distributed under the MIT License, see LICENSE file. The authors of OpenSlides are mentioned in the AUTHORS file.