OpenSlides/INSTALL.txt

Installation Instructions for OpenSlides 1.3
============================================

Content
-------
I.  Installation on GNU/Linux and MacOSX
II. Installation on Windows (32/64bit)

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


I. Installation on GNU/Linux and MacOSX
----------------------------------------

Make sure that you have installed Python (>= 2.5) on your system.

You can setup a virtualenv environment to install OpenSlides as non-root user.
Run before you start install OpenSlides:

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


  1. Install OpenSlides:
  
        $ pip install openslides
  
        OpenSlides will installed the following required python packages:
          + Django
          + django-mptt
          + ReportLab Toolkit
          + Python Imaging Library (PIL)

  2. 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.


II. Installation on Windows (32/64bit)
--------------------------------------

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:

        OpenSlides requires following programs, which should be
        installed first:
          + Python Programming Language 2 (>= 2.5),
          + Setuptools
          + ReportLab Toolkit
          + Python Imaging Library (PIL)
          + Django
          + django-mptt


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

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

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

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

     c) Install Setuptools:

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

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

     d) Install ReportLab Toolkit, Python Imaging Library (PIL), Django
        and django-mptt:

        Open command line (cmd) and run:

        easy_install django django-mptt reportlab pil

        If you use a 64bit version of Python, you have to install reportlab
        and PIL manually - without using easy_install.

  2. Get OpenSlides:

     a)  Download latest OpenSlides release from http://openslides.org.

     OR

     b) Clone development version from OpenSlides' github repository
        https://github.com/OpenSlides/OpenSlides.
        This requires Git, see http://git-scm.com/.
        Open command line (cmd) and run:

        git clone git://github.com/OpenSlides/OpenSlides.git

  3. 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 are created. Please change the password after
        first login!

        Username: admin
        Password: admin

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