OpenSlides/INSTALL

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

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



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

  1. Install Python 2.7

     a) Download and run 32bit MSI installer from http://www.python.org/download/
        e.g. version 2.7.2:
        http://www.python.org/ftp/python/2.7.2/python-2.7.2.msi

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

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

  2. Install Setuptools 0.6c11

     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

  3. Install required packages
     Open command line (cmd) and run:

       easy_install django django-mptt reportlab pil

  4. Get OpenSlides:

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

        OR

     b) Clone development version from mercurial repository
        (anonymous checkout):

        hg clone http://hg.openslides.org

        If you have write access use instead:
        hg clone ssh://hg@openslides.org/openslides

  5. Copy default.settings.py to settings.py
     (in subdirectory 'openslides')

  6. Create OpenSlides database (and follow on screen instruction).
     Go to the extracted OpenSlides root directory and enter:

       python manage.py syncdb

     -> Note: Answer "yes" to create superuser!

  7. Run OpenSlides server:

       python manage.py runserver

     Optional: Add <port> or <address:port> to use server on custom
     address/port.

  8. Open OpenSlides in your browser:

       http://127.0.0.1:8000/  (or customized server address:port)



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

Make sure that you have installed python and virtualenv on your
system.

  1. Get OpenSlides:

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

        OR

     b) Clone development version from mercurial repository (anonymous
        checkout):

        hg clone http://hg.openslides.org

        If you have write access use instead:
        hg clone ssh://hg@openslides.org/openslides

  2. Setup virtualenv:

       # Go to the (extracted/cloned) root directory of OpenSlides
       # and create virtualenv environment
       virtualenv --no-site-packages .venv

       # activate virtualenv environment
       . .venv/bin/activate

  3. Install 'pip' (if not available):

       easy_install pip

  4. Install required packages:

       pip install django django-mptt reportlab pil simplejson mercurial

  5. Copy default.settings.py to settings.py:

       cp openslides/default.settings.py openslides/settings.py

  6. Create OpenSlides database in the OpenSlides root directory
     and follow on screen instruction:

       python manage.py syncdb

     -> Note: Answer "yes" to create superuser!

  7. Run OpenSlides server:

       python manage.py runserver

     Optional: Add <port> or <address:port> to use server on custom
     address/port.

  8. Open OpenSlides in your browser:

       http://127.0.0.1:8000/  (or customized server address:port)


--
If you need help ask on OpenSlides users mailing list.
See www.openslides.org for more information.