From 3c54d1fd655d9ccc4f9b48484f914443050662f3 Mon Sep 17 00:00:00 2001 From: Emanuel Schuetze Date: Tue, 27 Nov 2012 22:05:06 +0100 Subject: [PATCH] Updated INSTALL to install OpenSlides via Python Package Index (PyPI) --- INSTALL.txt | 119 ++++++++++++++++++++-------------------------------- 1 file changed, 45 insertions(+), 74 deletions(-) diff --git a/INSTALL.txt b/INSTALL.txt index 68ef8416a..512fae243 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -3,15 +3,56 @@ Installation Instructions for OpenSlides 1.3 Content ------- -I. Installation on Windows (32/64bit) -II. Installation on GNU/Linux and MacOSX +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 Windows (32/64bit) -------------------------------------- +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: @@ -76,73 +117,3 @@ I. Installation on Windows (32/64bit) Use 'python start.py --help' to show all start options. - -II. Installation on GNU/Linux and MacOSX ----------------------------------------- - - 1. Install requirements: - - OpenSlides requires following programs, which should be - installed first: - + Python Programming Language 2 (>= 2.5) - + virtualenv (>= 1.4.1) - + ReportLab Toolkit - + Python Imaging Library (PIL) - - E.g. for ubuntu run: - $ sudo apt-get install python python-virtualenv python-reportlab python-imaging - - 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. Setup your virtual environment with virtualenv: - - Go to the (extracted/cloned) root directory of OpenSlides - and create virtualenv environment: - - $ virtualenv .venv - - For virtualenv >= 1.7 use instead: - $ virtualenv --system-site-packages .venv - - 4. Activate the virtual environment: - - $ source .venv/bin/activate - - 5. Install the required python-packages: - - $ pip install django django-mptt - - If you use python < 2.6 you also have to install simplejson: - $ pip install simplejson - - If requirements reportlab or PIL still missing (see 1.): - $ pip install reportlab pil - - 6. 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. - - 7. Restart OpenSlides: - - To restart OpenSlides after closing the terminal activate the - virtual environment (see 4.) before starting the server (see 6.).