comparison doc/installation.txt @ 5140:7ea6bbf4286c

update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
author John Rouillard <rouilj@ieee.org>
date Sun, 10 Jul 2016 14:24:12 -0400
parents c54720396f40
children d8ed32b297e2
comparison
equal deleted inserted replaced
5139:e098536107ea 5140:7ea6bbf4286c
38 38
39 Some variants of Linux will need an additional "python dev" package 39 Some variants of Linux will need an additional "python dev" package
40 installed for Roundup installation to work. Debian and derivatives, are 40 installed for Roundup installation to work. Debian and derivatives, are
41 known to require this. 41 known to require this.
42 42
43 If you are using the Roundup Windows installer on a 64 bit system and
44 you get the error message::
45
46 "No Python installation found in the registry"
47
48 you need to install a 32 bit version of python. The 64 bit versions
49 use a different registry key that the installer doesn't detect. See:
50 http://issues.roundup-tracker.org/issue2550718 for details.
43 51
44 Optional Components 52 Optional Components
45 =================== 53 ===================
46 54
47 You may optionally install and use: 55 You may optionally install and use:
48 56
49 Timezone Definitions 57 Timezone Definitions
50 Full timezone support requires pytz_ module (version 2005i or later) 58 Full timezone support requires pytz_ module (version 2005i or later)
51 which brings the `Olson tz database`_ into Python. If pytz_ is not 59 which brings the `Olson tz database`_ into Python. If pytz_ is not
52 installed, timezones may be specified as numeric hour offsets only. 60 installed, timezones may be specified as numeric hour offsets only.
53 61 This is optional but strongly suggested.
62
54 An RDBMS 63 An RDBMS
55 Sqlite, MySQL and Postgresql are all supported by Roundup and will be 64 Sqlite, MySQL and Postgresql are all supported by Roundup and will be
56 used if available. One of these is recommended if you are anticipating a 65 used if available. One of these is recommended if you are anticipating a
57 large user base (see `choosing your backend`_ below). 66 large user base (see `choosing your backend`_ below).
58 67
103 its TEMPLATE-INFO.txt file) you need 112 its TEMPLATE-INFO.txt file) you need
104 to have the jinja2_ template engine installed. 113 to have the jinja2_ template engine installed.
105 114
106 Windows Service 115 Windows Service
107 You can run Roundup as a Windows service if pywin32_ is installed. 116 You can run Roundup as a Windows service if pywin32_ is installed.
117 Otherwise it must be started manually.
108 118
109 .. _Xapian: http://xapian.org/ 119 .. _Xapian: http://xapian.org/
110 .. _Whoosh: https://bitbucket.org/mchaput/whoosh/wiki/Home 120 .. _Whoosh: https://bitbucket.org/mchaput/whoosh/wiki/Home
111 .. _pytz: http://www.python.org/pypi/pytz 121 .. _pytz: http://www.python.org/pypi/pytz
112 .. _Olson tz database: http://www.twinsun.com/tz/tz-link.htm 122 .. _Olson tz database: http://www.twinsun.com/tz/tz-link.htm
163 UNIX machine and want to restrict local access to roundup 173 UNIX machine and want to restrict local access to roundup
164 174
165 For information about how Roundup installs, see the `administration 175 For information about how Roundup installs, see the `administration
166 guide`_. 176 guide`_.
167 177
178 The following assumes that you are using the source distribution. If
179 you are using the Windows installer, run it with Administrator
180 privileges so it can correctly update the registry.
168 181
169 Basic Installation Steps 182 Basic Installation Steps
170 ------------------------ 183 ------------------------
171 184
172 To install the Roundup support code into your Python tree and 185 To install the Roundup support code into your Python tree and

Roundup Issue Tracker: http://roundup-tracker.org/