OpenSlides/INSTALL.txt

244 lines
7.6 KiB
Plaintext
Raw Normal View History

2013-04-25 13:10:50 +02:00
==============================================
2013-07-08 19:36:00 +02:00
Installation instructions for OpenSlides 1.4
2013-04-25 13:10:50 +02:00
==============================================
2012-04-27 16:07:57 +02:00
Content
2013-04-25 13:10:50 +02:00
=======
2012-11-28 18:46:47 +01:00
2013-04-25 13:10:50 +02:00
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 using the Python Package Index (PyPI)
2012-04-27 16:07:57 +02:00
2012-07-15 17:05:36 +02:00
If you need help ask on OpenSlides users mailing list.
See http://openslides.org for more information.
2012-04-27 16:07:57 +02:00
2013-07-08 19:36:00 +02:00
I. Installation on GNU/Linux and MacOSX using the Python Package Index (PyPI)
===============================================================================
2012-11-28 18:46:47 +01:00
1. Check requirements:
2012-12-01 13:51:00 +01:00
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
2012-11-28 18:46:47 +01:00
2. Setup a virtual environment with Virtual Python Environment builder (optional):
2012-11-28 18:46:47 +01:00
You can setup a virtual environment to install OpenSlides as
non-root user.
2013-04-25 13:10:50 +02:00
Make sure that you have installed Virtual Python Environment builder
on your system.
2012-12-01 13:51:00 +01:00
E. g. for Ubuntu run:
2012-11-28 18:46:47 +01:00
$ sudo apt-get install python-virtualenv
2012-11-28 18:46:47 +01:00
To setup and activate the virtual environment, create your
OpenSlides directory, change to it and run:
2012-11-28 18:46:47 +01:00
$ virtualenv .venv
$ source .venv/bin/activate
3. Install OpenSlides:
$ pip install openslides
2012-11-28 18:46:47 +01:00
OpenSlides will install the following required python packages:
+ Django
+ django-mptt
+ reportlab
+ pillow
+ qrcode
+ tornado
+ bleach
+ beautifulsoup4
+ html5lib
2012-11-28 18:46:47 +01:00
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.
2013-04-25 13:10:50 +02:00
5. Restart OpenSlides:
To restart OpenSlides after closing the terminal activate the
virtual environment before starting the server:
$ source .venv/bin/activate
$ openslides
2013-07-08 19:36:00 +02:00
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.
2013-07-08 19:36:00 +02:00
$ pip install openslides-1.4.tar.gz
instead of $ pip install openslides.
III. Installation on GNU/Linux and MacOSX using the sources (for development)
=============================================================================
2012-11-28 18:46:47 +01:00
1. Check requirements:
2012-11-28 18:46:47 +01:00
Make sure that you have installed Python Programming Language 2
2013-04-25 13:10:50 +02:00
(>= 2.6) on your system. You will also need the Python
development headers.
2012-11-28 18:46:47 +01:00
2012-12-01 13:51:00 +01:00
E. g. for Ubuntu run:
2013-04-25 13:10:50 +02:00
$ sudo apt-get install python-dev
2012-11-28 18:46:47 +01:00
2. Get OpenSlides:
Clone current master version from OpenSlides' GitHub repository
2013-04-25 13:10:50 +02:00
https://github.com/OpenSlides/OpenSlides. This requires Git
(see http://git-scm.com/).
E. g. for Ubuntu run:
$ sudo apt-get install git
2013-04-25 13:10:50 +02:00
$ git clone git://github.com/OpenSlides/OpenSlides.git
2012-11-28 18:46:47 +01:00
3. Setup a virtual environment with Virtual Python Environment builder (optional):
2012-11-28 18:46:47 +01:00
You can setup a virtual environment to install OpenSlides as
non-root user.
2012-11-28 18:46:47 +01:00
2013-04-25 13:10:50 +02:00
Make sure that you have installed Virtual Python Environment builder
on your system.
E. g. for Ubuntu run:
$ sudo apt-get install python-virtualenv
2012-11-28 18:46:47 +01:00
To setup and activate the virtual environment go to the
(extracted/cloned) root directory of OpenSlides and run:
2012-11-28 18:46:47 +01:00
$ virtualenv .venv
2012-11-28 18:46:47 +01:00
$ source .venv/bin/activate
4. Install all required python packages:
2012-11-28 18:46:47 +01:00
2013-05-23 23:46:14 +02:00
$ pip install -r requirements.txt
2012-11-28 18:46:47 +01:00
5. Start OpenSlides server and open URL in your default browser:
2012-11-28 18:46:47 +01:00
$ 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
2012-11-28 18:46:47 +01:00
first login!
Username: admin
Password: admin
Use 'python start.py --help' to show all start options.
6. Restart OpenSlides:
2012-11-28 18:46:47 +01:00
To restart OpenSlides after closing the terminal activate the
virtual environment before starting the server:
$ source .venv/bin/activate
$ python start.py
2012-11-28 18:46:47 +01:00
2013-07-08 19:36:00 +02:00
IV. Installation on Windows 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.
2012-07-15 17:05:36 +02:00
1. Install requirements:
The OpenSlides install requires following programs, which should be
installed first:
2012-12-14 14:21:53 +01:00
+ Python Programming Language 2 (>= 2.6)
+ Setuptools
a) Download and run 32-bit MSI installer from http://www.python.org/:
http://www.python.org/ftp/python/2.7.5/python-2.7.5.msi
Note that the 32-bit MSI installer is required even on a 64-bit
Windows system. If you use the 64-bit MSI installer, step 3 of this
instruction will fail unless you installed the packages reportlab
and pillow manually.
2012-04-27 16:07:57 +02:00
b) Add python dirs to PATH (via Control Panel > System > Advanced):
2012-07-15 17:05:36 +02:00
";C:\Python27;C:\Python27\Scripts"
2012-04-27 16:07:57 +02:00
Note that the path can differ if you customized the install of
Python in step a).
2012-04-27 16:07:57 +02:00
c) Download the install script ez_setup.py for Setuptools 0.7.7 from
https://pypi.python.org/pypi/setuptools/0.7.7#windows and run (via
double click).
2. Setup a virtual environment with Virtual Python Environment builder (optional):
2013-04-25 13:10:50 +02:00
You can setup a virtual environment to install OpenSlides as
non-root user.
To install Virtual Python Environment builder, open command line
(cmd) and run:
> easy_install https://pypi.python.org/packages/source/v/virtualenv/virtualenv-1.9.1.tar.gz
2013-04-25 13:10:50 +02:00
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
2012-04-27 16:07:57 +02:00
2013-04-25 13:10:50 +02:00
3. Install OpenSlides:
Run on command line (cmd):
2012-11-28 18:46:47 +01:00
> easy_install openslides
2013-04-25 13:10:50 +02:00
OpenSlides will install all required python packages.
2012-04-27 16:07:57 +02:00
2013-04-25 13:10:50 +02:00
4. Start OpenSlides server and open URL in your default browser:
2012-04-27 16:07:57 +02:00
2013-04-25 13:10:50 +02:00
Run on command line (cmd):
2013-04-25 13:10:50 +02:00
> openslides
2012-04-27 16:07:57 +02:00
2012-07-15 17:05:36 +02:00
If you run this script the first time a new database and the
admin account are created. Please change the password after
first login!
2012-04-27 16:07:57 +02:00
2012-07-15 17:05:36 +02:00
Username: admin
Password: admin
2012-04-27 16:07:57 +02:00
Use 'openslides --help' to show all start options.
2013-04-25 13:10:50 +02:00
5. Restart OpenSlides:
To restart OpenSlides after closing the command line activate the
virtual environment before starting the server:
> .venv/Scripts/activate
> openslides