Mercurial > p > roundup > code

comparison doc/installation.txt @ 1049:b9988e118055

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
moved
author Richard Jones <richard@users.sourceforge.net>
date Thu, 05 Sep 2002 00:37:09 +0000
parents 0fa94554443f
children 344bad728d10
comparison
equal deleted inserted replaced
1048:1250251f2793 1049:b9988e118055
1 ================== 1 ==================
2 Installing Roundup 2 Installing Roundup
3 ================== 3 ==================
4 4
5 :Version: $Revision: 1.19 $ 5 :Version: $Revision: 1.20 $
6 6
7 .. contents:: 7 .. contents::
8 8
9 9
10 Overview 10 Overview
83 83
84 Installation 84 Installation
85 ============ 85 ============
86 86
87 Set aside 15-30 minutes. Please make sure you're using a supported version of 87 Set aside 15-30 minutes. Please make sure you're using a supported version of
88 Python -- see `testing your python`_. 88 Python -- see `testing your python`_. There's three sections to this
89 installation guide:
90
91 1. `basic installation steps`_ that all installers must follow
92 2. `shared environment steps`_ to take if you're installing on a shared
93 UNIX machine and want to restrict local access to roundup
94 3. `internet setup`_ steps to take if your tracker is to be used by the wider
95 internet community
96
97 Most users will only need to follow the first step, since the environment will
98 be a trusted one.
99
100
101 Basic Installation Steps
102 ~~~~~~~~~~~~~~~~~~~~~~~~
89 103
90 1. To install the Roundup support code into your Python tree and 104 1. To install the Roundup support code into your Python tree and
91 Roundup scripts into /usr/local/bin:: 105 Roundup scripts into /usr/local/bin::
92 106
93 python setup.py install 107 python setup.py install
137 Admin Password: 151 Admin Password:
138 Confirm: 152 Confirm:
139 153
140 Once this is done, the instance has been created. 154 Once this is done, the instance has been created.
141 155
142 3. Each instance ideally should have its own UNIX group, so create 156 3. XXX Set up the CGI interface
143 a UNIX group (edit ``/etc/group`` or your appropriate NIS map if 157
144 you're using NIS). To continue with my examples so far, I would 158 4. XXX Set up the mail gateway
145 create the UNIX group 'support', although the name of the UNIX 159
146 group does not have to be the same as the instance name. To this 160
147 'support' group I then add all of the UNIX usernames who will be 161 Shared Environment Steps
148 working with this Roundup instance. In addition to 'real' users, 162 ~~~~~~~~~~~~~~~~~~~~~~~~
149 the Roundup email gateway will need to have permissions to this 163
150 area as well, so add the user your mail service runs as to the 164 Each instance ideally should have its own UNIX group, so create
151 group. The UNIX group might then look like:: 165 a UNIX group (edit ``/etc/group`` or your appropriate NIS map if
152 166 you're using NIS). To continue with my examples so far, I would
153 support:*:1002:jblaine,samh,geezer,mail 167 create the UNIX group 'support', although the name of the UNIX
154 168 group does not have to be the same as the instance name. To this
155 If you intend to use the web interface (as most people do), you 169 'support' group I then add all of the UNIX usernames who will be
156 should also add the username your web server runs as to the group. 170 working with this Roundup instance. In addition to 'real' users,
157 My group now looks like this:: 171 the Roundup email gateway will need to have permissions to this
158 172 area as well, so add the user your mail service runs as to the
159 support:*:1002:jblaine,samh,geezer,mail,apache 173 group. The UNIX group might then look like::
160 174
161 4. Configure your new instance by editing the file ``instance_config.py`` 175 support:*:1002:jblaine,samh,geezer,mail
162 located in the instance home you specified in step 2c above. This 176
163 file is Python code and must adhere to Python syntax rules, but 177 If you intend to use the web interface (as most people do), you
164 don't be daunted if you do not know Python - it should look pretty 178 should also add the username your web server runs as to the group.
165 straightfoward if you carefully read the comments in the file. 179 My group now looks like this::
166 180
167 5. There are two supported ways to get emailed issues into the 181 support:*:1002:jblaine,samh,geezer,mail,apache
182
183 An alternative to the above is to create a new user who has the sole
184 responsibility of running roundup. This user:
185
186 1. runs the CGI interface daemon
187 2. runs regular polls for email
188 3. runs regular checks (using cron) to ensure the daemon is up
189 4. optionally has no login password so that nobody but the "root" user
190 may actually login and play with the roundup setup.
191
192
193 Internet Setup
194 ~~~~~~~~~~~~~~
195
196 1. There are two supported ways to get emailed issues into the
168 Roundup instance. You should pick ONE of the following, both 197 Roundup instance. You should pick ONE of the following, both
169 of which will continue my example setup from above: 198 of which will continue my example setup from above:
170 199
171 a. Set up a mail alias called "support" as:: 200 a. Set up a mail alias called "support" as::
172 201
183 /opt/roundup/instances/support /var/mail/support 212 /opt/roundup/instances/support /var/mail/support
184 213
185 If you don't want to use the email component of Roundup, then remove the 214 If you don't want to use the email component of Roundup, then remove the
186 "``nosyreator.py``" module from your instance "``detectors``" directory. 215 "``nosyreator.py``" module from your instance "``detectors``" directory.
187 216
188 6. Test the email gateway. Under most flavors of UNIX, this 217 2. Test the email gateway. Under most flavors of UNIX, this
189 can be done by:: 218 can be done by::
190 219
191 echo test | mail -s '[issue] test' support@YOUR_DOMAIN_HERE 220 echo test | mail -s '[issue] test' support@YOUR_DOMAIN_HERE
221
222 XXX mention HTTPS
223 XXX mention Basic vs. cookie auth
192 224
193 225
194 Upgrading 226 Upgrading
195 ========= 227 =========
196 228
Roundup Issue Tracker: http://roundup-tracker.org/