OpenSlides/INSTALL.txt

==============================================
 Installation Instructions for OpenSlides 1.4
==============================================

Content
=======

I.   Installation on GNU/Linux and MacOSX using the Python Package Index (PyPI)
II.  Installation on GNU/Linux and MacOSX using the package from openslides.org
III. Installation on GNU/Linux and MacOSX using the sources (for development)
IV.  Installation on Windows (32bit) using the Python Package Index (PyPI)

If you need help ask on OpenSlides users mailing list.
See http://openslides.org for more information.


I. Installation on GNU/Linux and MacOSX using the Python Package Index (PyPI)
=============================================================================

  1. Check requirements:

        Make sure that you have installed Python Programming Language 2
        (>= 2.6) on your system. You will also need the Python
        development headers.

        E. g. for Ubuntu run:
        $ sudo apt-get install python-dev

  2. Setup a virtual environment with virtualenv (optional):

        You can setup a virtual environment to install OpenSlides as
        non-root user.

        Make sure that you have installed Virtual Python Environment builder
        on your system.

        E. g. for Ubuntu run:
        $ sudo apt-get install python-virtualenv

        To setup and activate the virtual environment, create your
        OpenSlides directory, change to it and run:

        $ virtualenv .venv
        $ source .venv/bin/activate

  3. Install OpenSlides:

        $ pip install openslides

        OpenSlides will install the following required python packages:
          + Django
          + django-mptt
          + reportlab
          + pillow
          + qrcode
          + tornado
          + bleach
          + beautifulsoup4
          + html5lib
          
  4. Start OpenSlides server and open URL in your default browser:

        $ openslides

        If you run this command the first time a new database and the
        admin account are created. Please change the password after
        first login!

        Username: admin
        Password: admin

        Use 'openslides --help' to show all start options.

  5. Restart OpenSlides:

        To restart OpenSlides after closing the terminal activate the
        virtual environment before starting the server:

        $ source .venv/bin/activate
        $ openslides


II.   Installation on GNU/Linux and MacOSX using the package from openslides.org
================================================================================

  1. Get OpenSlides:
  
        Download latest OpenSlides release from http://openslides.org as
        compressed tar archive.

  2. Follow the same steps as in I. but use in step 3.

        $ pip install openslides-XXX.tar.gz

     instead of $ pip install openslides.


III. Installation on GNU/Linux and MacOSX using the sources (for development)
=============================================================================

  1. Check requirements:

        Make sure that you have installed Python Programming Language 2
        (>= 2.6) on your system. You will also need the Python
        development headers.

        E. g. for Ubuntu run:
        $ sudo apt-get install python-dev

  2. Get OpenSlides:

        Clone current master version from OpenSlides' GitHub repository
        https://github.com/OpenSlides/OpenSlides. This requires Git
        (see http://git-scm.com/).

        E. g. for Ubuntu run:
        $ sudo apt-get install git
        $ git clone git://github.com/OpenSlides/OpenSlides.git

  3. Setup a virtual environment with virtualenv (optional):

        You can setup a virtual environment to install OpenSlides as
        non-root user.

        Make sure that you have installed Virtual Python Environment builder
        on your system.

        E. g. for Ubuntu run:
        $ sudo apt-get install python-virtualenv

        To setup and activate the virtual environment go to the
        (extracted/cloned) root directory of OpenSlides and run:

        $ virtualenv .venv
        $ source .venv/bin/activate

  4. Install all required python packages:

        $ pip install -r requirements.txt

  5. Start OpenSlides server and open URL in your default browser:

        $ python start.py

        If you run this script the first time a new database and the
        admin account will be created. Please change the password after
        first login!

        Username: admin
        Password: admin

        Use 'python start.py --help' to show all start options.

  6. Restart OpenSlides:

        To restart OpenSlides after closing the terminal activate the
        virtual environment before starting the server:

        $ source .venv/bin/activate
        $ python start.py


IV. Installation on Windows (32bit) using the Python Package Index (PyPI)
=========================================================================

NOTE: There is a portable version of OpenSlides for Windows which does not
required any install steps! If there is a reason that you can not use the
portable version you should run the following install steps.

  1. Install requirements:

        The OpenSlides install requires following programs, which should be
        installed first:
          + Python Programming Language 2 (>= 2.6)
          + Setuptools

     a) Download and run 32bit MSI installer from http://www.python.org/:

        http://python.org/ftp/python/2.7.4/python-2.7.4.msi

     b) Add python dirs to PATH (via Control Panel > System > Advanced):

        ";C:\Python27;C:\Python27\Scripts"

     c) Download and run 32bit binary installer from http://pypi.python.org/pypi/setuptools:

        https://pypi.python.org/packages/2.7/s/setuptools/setuptools-0.6c11.win32-py2.7.exe

  2. Setup a virtual environment with virtualenv (optional):

        You can setup a virtual environment to install OpenSlides as
        non-root user.

        To setup and activate the virtual environment, create your
        OpenSlides directory, open command line (cmd), change to the
        directory and run:

        > virtualenv .venv
        > .venv\Scripts\activate

  3. Install OpenSlides:

        Run on command line (cmd):

        > pip install openslides

        OpenSlides will install all required python packages.

  4. Start OpenSlides server and open URL in your default browser:

        Run on command line (cmd):

        > openslides

        If you run this script the first time a new database and the
        admin account are created. Please change the password after
        first login!

        Username: admin
        Password: admin

        Use 'openslides --help' to show all start options.

  5. Restart OpenSlides:

        To restart OpenSlides after closing the command line activate the
        virtual environment before starting the server:

        > .venv/Scripts/activate
        > openslides