214 lines
7.7 KiB
ReStructuredText
214 lines
7.7 KiB
ReStructuredText
============
|
|
OpenSlides
|
|
============
|
|
|
|
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
|
|
============
|
|
|
|
1. Installation on GNU/Linux or Mac OS X
|
|
----------------------------------------
|
|
|
|
a. Check requirements
|
|
'''''''''''''''''''''
|
|
|
|
Make sure that you have installed `Python (>= 3.4)
|
|
<https://www.python.org/>`_ on your system. You also need the Python
|
|
development headers, the Independent JPEG Group's JPEG runtime library
|
|
(dependency package) and the compression library (development).
|
|
|
|
\E. g. for Ubuntu run::
|
|
|
|
$ sudo apt-get install python3-dev libjpeg-dev zlib1g-dev
|
|
|
|
|
|
b. Setup a virtual Python environment (optional)
|
|
''''''''''''''''''''''''''''''''''''''''''''''''
|
|
|
|
You can setup a virtual Python environment using the virtual environment
|
|
(venv) package for Python to install OpenSlides as non-root user.
|
|
|
|
*Note: For Ubuntu 14.04 you have to install the pyvenv binary package*
|
|
``python3.4-venv`` *before.*
|
|
|
|
Create your OpenSlides directory, change to it, setup and activate the
|
|
virtual environment::
|
|
|
|
$ mkdir OpenSlides
|
|
$ cd OpenSlides
|
|
$ python3 -m venv .virtualenv
|
|
$ source .virtualenv/bin/activate
|
|
|
|
|
|
c. Install OpenSlides
|
|
'''''''''''''''''''''
|
|
|
|
To install OpenSlides just run::
|
|
|
|
$ pip install openslides
|
|
|
|
You can also use the package from the `OpenSlides website
|
|
<https://openslides.org/>`_. Download latest OpenSlides release as
|
|
compressed tar archive and run::
|
|
|
|
$ pip install openslides-x.x.tar.gz
|
|
|
|
This will install all required Python packages (see
|
|
``requirements_production.txt``).
|
|
|
|
|
|
d. Start OpenSlides
|
|
'''''''''''''''''''
|
|
|
|
To start OpenSlides simply run::
|
|
|
|
$ openslides
|
|
|
|
If you run this command the first time, a new database and the admin
|
|
account (Username: `admin`, Password: `admin`) will be created. Please
|
|
change the password after first login!
|
|
|
|
OpenSlides will start using the integrated Tornado webserver. It will also
|
|
try to open the webinterface in your default webbrowser. The server will
|
|
try to listen on the local ip address on port 8000. That means that the
|
|
server will be available to everyone on your local network (at least for
|
|
commonly used network configurations).
|
|
|
|
If you use a virtual environment (see step b.), do not forget to activate
|
|
the environment before restart after you have closed the terminal::
|
|
|
|
$ source .virtualenv/bin/activate
|
|
|
|
To get help on the command line options run::
|
|
|
|
$ openslides --help
|
|
|
|
You can store settings, database and other personal files in a local
|
|
subdirectory and use these files e. g. if you want to run multiple
|
|
instances of OpenSlides::
|
|
|
|
$ openslides --local-installation
|
|
|
|
|
|
2. Installation on Windows
|
|
--------------------------
|
|
|
|
Download the latest portable version of OpenSlides for Windows from
|
|
`OpenSlides website <https://openslides.org/>`_ which does not require any
|
|
install steps. Simply unzip the downloaded file and run ``openslides.exe``.
|
|
|
|
|
|
Development
|
|
===========
|
|
|
|
If you want to contribute to OpenSlides, have a look at `OpenSlides website
|
|
<https://openslides.org/>`_ and write us an email. There is also an
|
|
`instruction to install the development version
|
|
<https://github.com/OpenSlides/OpenSlides/blob/master/DEVELOPMENT.rst>`_.
|
|
|
|
|
|
Used software
|
|
=============
|
|
|
|
OpenSlides uses the following projects or parts of them:
|
|
|
|
* `backports-abc <https://github.com/cython/backports_abc>`_,
|
|
License: Python Software Foundation License
|
|
|
|
* `Beautiful Soup <http://www.crummy.com/software/BeautifulSoup/>`_,
|
|
License: MIT
|
|
|
|
* `Django <https://www.djangoproject.com>`_, License: BSD
|
|
|
|
* `Django REST framework <http://www.django-rest-framework.org>`_, License:
|
|
BSD
|
|
|
|
* `html5lib <https://github.com/html5lib/html5lib-python>`_, License: MIT
|
|
|
|
* `django-jsonfield <https://github.com/bradjasper/django-jsonfield/>`_,
|
|
License: MIT
|
|
|
|
* `natsort <https://pypi.python.org/pypi/natsort>`_, License: MIT
|
|
|
|
* `PyPDF2 <http://mstamy2.github.io/PyPDF2/>`_, License: BSD
|
|
|
|
* `ReportLab <http://www.reportlab.com/opensource/>`_,
|
|
License: BSD
|
|
|
|
* `roman <https://pypi.python.org/pypi/roman>`_, License: Python 2.1.1
|
|
|
|
* `setuptools <https://pypi.python.org/pypi/setuptools>`_,
|
|
License: Python Software Foundation License
|
|
|
|
* `Six <http://pythonhosted.org/six/>`_, License: MIT
|
|
|
|
* `sockjs-tornado <https://github.com/mrjoes/sockjs-tornado>`_,
|
|
License: MIT
|
|
|
|
* `Tornado <http://www.tornadoweb.org/en/stable/>`_, License: Apache
|
|
License v2.0
|
|
|
|
* `Whoosh <https://bitbucket.org/mchaput/whoosh/wiki/Home>`_, License: BSD
|
|
|
|
* Several JavaScript packages (see ``bower.json``)
|
|
|
|
* `angular <http://angularjs.org>`_, License: MIT
|
|
* `angular-animate <http://angularjs.org>`_, License: MIT
|
|
* `angular-bootstrap <http://angular-ui.github.io/bootstrap>`_, License: MIT
|
|
* `angular-bootstrap-colorpicker <https://github.com/buberdds/angular-bootstrap-colorpicker>`_, License: MIT
|
|
* `angular-chosen-localytics <http://github.com/leocaseiro/angular-chosen>`_, License: MIT
|
|
* `angular-csv-import-tmp <https://github.com/cybadave/angular-csv-import>`_, License: MIT
|
|
* `angular-formly <http://formly-js.github.io/angular-formly/>`_, License: MIT
|
|
* `angular-formly-templates-bootstrap <http://formly-js.github.io/angular-formly-templates-bootstrap/>`_, License: MIT
|
|
* `angular-gettext <http://angular-gettext.rocketeer.be/>`_, License: MIT
|
|
* `angular-loading-bar <https://chieffancypants.github.io/angular-loading-bar>`_, License: MIT
|
|
* `angular-messages <http://angularjs.org>`_, License: MIT
|
|
* `angular-pdf <http://github.com/sayanee/angularjs-pdf>`_, License: MIT
|
|
* `angular-sanitize <http://angularjs.org>`_, License: MIT
|
|
* `angular-scroll-glue <https://github.com/Luegg/angularjs-scroll-glue>`_, License: MIT
|
|
* `angular-ui-router <http://angular-ui.github.io/ui-router/>`_, License: MIT
|
|
* `angular-ui-tinymce <http://angular-ui.github.com>`_, License: MIT
|
|
* `angular-ui-tree <https://github.com/angular-ui-tree/angular-ui-tree>`_, License: MIT
|
|
* `api-check <https://github.com/kentcdodds/api-check>`_, License: MIT
|
|
* `bootstrap <http://getbootstrap.com>`_, License: MIT
|
|
* `chosen <http://harvesthq.github.io/chosen/>`_, License: MIT
|
|
* `font-awesome-bower <https://github.com/tdg5/font-awesome-bower>`_, License: MIT
|
|
* `jquery <https://jquery.com>`_, License: MIT
|
|
* `jquery.cookie <https://plugins.jquery.com/cookie>`_, License: MIT
|
|
* `js-data <http://www.js-data.io>`_, License: MIT
|
|
* `js-data-angular <http://www.js-data.io/docs/js-data-angular>`_, License: MIT
|
|
* `js-data-http <http://www.js-data.io/docs/dshttpadapter>`_, License: MIT
|
|
* `lodash <https://lodash.com/>`_, License: MIT
|
|
* `ng-dialog <https://github.com/likeastore/ngDialog>`_, License: MIT
|
|
* `ng-file-upload <https://github.com/danialfarid/ng-file-upload>`_, License: MIT
|
|
* `ngbootbox <https://github.com/eriktufvesson/ngBootbox>`_, License: MIT
|
|
* `open-sans-fontface <https://github.com/FontFaceKit/open-sans>`_, License: Apache License version 2.0
|
|
* `pdfjs-dist <http://mozilla.github.io/pdf.js/>`_, License: Apache-2.0
|
|
* `roboto-condensed <https://github.com/davidcunningham/roboto-condensed>`_, License: Apache 2.0
|
|
* `sockjs <https://github.com/sockjs/sockjs-client>`_, License: MIT
|
|
* `tinymce <http://www.tinymce.com>`_, License: LGPL-2.1
|
|
* `tinymce-i18n <https://github.com/OpenSlides/tinymce-i18n>`_, License: LGPL-2.1
|
|
|
|
|
|
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.
|