forked from OpenSlides/OpenSlides
-
Notifications
You must be signed in to change notification settings - Fork 0
/
INSTALL.txt
243 lines (156 loc) · 7.61 KB
/
INSTALL.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
================================================
Installation instructions for OpenSlides 1.4.1
================================================
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 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 Virtual Python Environment builder (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-1.4.1.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 Virtual Python Environment builder (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 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 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.
b) Add python dirs to PATH (via Control Panel > System > Advanced):
";C:\Python27;C:\Python27\Scripts"
Note that the path can differ if you customized the install of
Python in step a).
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):
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
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):
> easy_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