summaryrefslogtreecommitdiffstats
path: root/docs/html/geninstall.html
blob: b5cecc5fc8f9b28b533919238e15339e6c075598 (plain)
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
<HTML
><HEAD
><TITLE
>Installation General Notes</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><LINK
REL="HOME"
TITLE="The Bugzilla Guide"
HREF="index.html"><LINK
REL="UP"
TITLE="Installation"
HREF="installation.html"><LINK
REL="PREVIOUS"
TITLE="BSD Installation Notes"
HREF="bsdinstall.html"><LINK
REL="NEXT"
TITLE="Win32 Installation Notes"
HREF="win32.html"></HEAD
><BODY
CLASS="section"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>The Bugzilla Guide</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="bsdinstall.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 3. Installation</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="win32.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="geninstall">3.5. Installation General Notes</H1
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="AEN874">3.5.1. Modifying Your Running System</H2
><P
>&#13;	Bugzilla optimizes database lookups by storing all relatively static
	information in the versioncache file, located in the data/ subdirectory
	under your installation directory.
      </P
><P
>&#13;	If you make a change to the structural data in your database
	(the versions table for example), or to the
	<SPAN
CLASS="QUOTE"
>"constants"</SPAN
> encoded in defparams.pl, you will
	need to remove the cached content from the data directory
	(by doing a <SPAN
CLASS="QUOTE"
>"rm data/versioncache"</SPAN
>), or your
	changes won't show up.
      </P
><P
>&#13;	That file gets automatically regenerated whenever it's more than an
	hour old, so Bugzilla will eventually notice your changes by itself, but
	generally you want it to notice right away, so that you can test things.
      </P
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="AEN881">3.5.2. Upgrading From Previous Versions</H2
><P
>&#13;  A plain Bugzilla is fairly easy to upgrade from one version to a newer one.
  However, things get a bit more complicated if you've made changes to 
  Bugzilla's code. In this case, you may have to re-make or reapply those
  changes.
  It is recommended that you take a backup of your database and your entire
  Bugzilla installation before attempting an upgrade. You can upgrade a 'clean'
  installation by untarring a new tarball over the old installation. If you
  are upgrading from 2.12 or later, you can type <TT
CLASS="filename"
>cvs -z3 
  update</TT
>, and resolve conflicts if there are any.   
      </P
><P
>&#13;	Because the developers of Bugzilla are constantly adding new tables, columns
  and fields, you'll probably get SQL errors if you just update the code and
  attempt to use Bugzilla. Always run the checksetup.pl script whenever
	you upgrade your installation. 
      </P
><P
>&#13;	If you are running Bugzilla version 2.8 or lower, and wish to upgrade to
	the latest version, please consult the file, "UPGRADING-pre-2.8" in the
	Bugzilla root directory after untarring the archive.
      </P
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="htaccess">3.5.3. <TT
CLASS="filename"
>.htaccess</TT
> files and security</H2
><P
>&#13;	To enhance the security of your Bugzilla installation,
	Bugzilla  will generate
	<I
CLASS="glossterm"
><TT
CLASS="filename"
>.htaccess</TT
></I
> files
	which the Apache webserver can use to restrict  access to
	the bugzilla data files. The checksetup script  will
	generate the <TT
CLASS="filename"
>.htaccess</TT
> files. These .htaccess files
  will not work with Apache 1.2.x - but this has security holes, so you
  shouldn't be using it anyway.
	
	<DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>&#13;	    If you are using an alternate provider of
	    <SPAN
CLASS="productname"
>webdot</SPAN
> services for graphing
	    (as described when viewing
	    <TT
CLASS="filename"
>editparams.cgi</TT
> in your web
	    browser), you will need to change  the ip address in
	    <TT
CLASS="filename"
>data/webdot/.htaccess</TT
> to the ip
	    address of the webdot server that  you are using. 
	  </P
></TD
></TR
></TABLE
></DIV
>
	
      </P
><P
>&#13;	The default .htaccess file may not provide adequate access
	restrictions, depending on your web server configuration.
	Be sure to check the &#60;Directory&#62; entries for your
	Bugzilla directory so that the <TT
CLASS="filename"
>.htaccess</TT
>
	file is allowed to override web server defaults.  For instance,
	let's assume your installation of Bugzilla is installed to 
	<TT
CLASS="filename"
>/usr/local/bugzilla</TT
>.  You should have
	this &#60;Directory&#62; entry in your <TT
CLASS="filename"
>httpd.conf</TT
>
	file:
      </P
><P
>&#13;	<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;
&#60;Directory /usr/local/bugzilla/&#62;
  Options +FollowSymLinks +Indexes +Includes +ExecCGI
  AllowOverride All
&#60;/Directory&#62;

	</PRE
></FONT
></TD
></TR
></TABLE
>
      </P
><P
>&#13;	The important part above is <SPAN
CLASS="QUOTE"
>"AllowOverride All"</SPAN
>.
	Without that, the <TT
CLASS="filename"
>.htaccess</TT
> file created by 
	<TT
CLASS="filename"
>checksetup.pl</TT
> will not have sufficient
	permissions to protect your Bugzilla installation.
      </P
><P
>&#13;	If you are using Internet Information Server or other web
	server which does not observe <TT
CLASS="filename"
>.htaccess</TT
>
	conventions, you can disable their creation by editing
	<TT
CLASS="filename"
>localconfig</TT
> and setting the
	<TT
CLASS="varname"
>$create_htaccess</TT
> variable to
	<TT
CLASS="parameter"
><I
>0</I
></TT
>.
      </P
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="mod-throttle">3.5.4. <TT
CLASS="filename"
>mod_throttle</TT
> and Security</H2
><P
>&#13;	It is possible for a user, by mistake or on purpose, to access
	the database many times in a row which can result in very slow
	access speeds for other users.  If your Bugzilla installation
	is experiencing this problem , you may install  the Apache
	module <TT
CLASS="filename"
>mod_throttle</TT
> which can limit
	connections by ip-address. You may download this module at
	<A
HREF="http://www.snert.com/Software/Throttle/"
TARGET="_top"
>http://www.snert.com/Software/Throttle/</A
>. Follow the instructions to install into your Apache install.  <EM
>This module only functions with the Apache web server!</EM
>. You may use the <B
CLASS="command"
>ThrottleClientIP</B
> command provided by this module  to accomplish this goal. See the <A
HREF="http://www.snert.com/Software/Throttle/"
TARGET="_top"
>Module Instructions</A
> for more  information. </P
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="content-type">3.5.5. Preventing untrusted Bugzilla content from executing malicious Javascript code</H2
><P
>It is possible for a Bugzilla to execute malicious
	Javascript code.  Due to internationalization concerns, we are
	unable to incorporate the code changes necessary to fulfill
	the CERT advisory requirements mentioned in <A
HREF="http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3"
TARGET="_top"
>http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3</A
>.  Executing the following code snippet from a UNIX command shell will rectify the problem if your Bugzilla installation is intended for an English-speaking audience.  As always, be sure your Bugzilla installation has a good backup before making changes, and I recommend you understand what the script is doing before executing it. </P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;bash# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \
	  do cat $i | sed 's/Content-type\: text\/html/Content-Type: text\/html\; charset=ISO-8859-1/' &#62;$i.tmp; \
	  mv $i.tmp $i; done
	</PRE
></FONT
></TD
></TR
></TABLE
></P
><P
>&#13;	All this one-liner command does is search for all instances of
	<SPAN
CLASS="QUOTE"
>"Content-type: text/html"</SPAN
> and replaces it with
	<SPAN
CLASS="QUOTE"
>"Content-Type: text/html; charset=ISO-8859-1"</SPAN
>.
	This specification prevents possible Javascript attacks on the
	browser, and is suggested for all English-speaking sites.  For
	non-english-speaking Bugzilla sites, I suggest changing
	<SPAN
CLASS="QUOTE"
>"ISO-8859-1"</SPAN
>, above, to <SPAN
CLASS="QUOTE"
>"UTF-8"</SPAN
>.
      </P
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="unixhistory">3.5.6. UNIX Installation Instructions History</H2
><P
>&#13;	This document was originally adapted from the Bonsai
	installation instructions by Terry Weissman
	&#60;terry@mozilla.org&#62;.
      </P
><P
>&#13;	The February 25, 1999 re-write of this page was done by Ry4an
	Brase &#60;ry4an@ry4an.org&#62;, with some edits by Terry
	Weissman, Bryce Nesbitt, Martin Pool, &#38; Dan Mosedale (But
	don't send bug reports to them; report them using bugzilla, at <A
HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla"
TARGET="_top"
>http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla</A
> ).
      </P
><P
>&#13;	This document was heavily modified again Wednesday, March 07
	2001 to reflect changes for Bugzilla 2.12 release by Matthew
	P. Barnson.  The securing MySQL section should be changed to
	become standard procedure for Bugzilla installations.
      </P
><P
>&#13;	Finally, the README in its entirety was marked up in SGML and
	included into the Guide on April 24, 2001 by Matt Barnson.
	Since that time, it's undergone extensive modification as
	Bugzilla grew.
      </P
><P
>&#13;	Comments from people using this Guide for the first time are
	particularly welcome.
      </P
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="bsdinstall.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="win32.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>BSD Installation Notes</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="installation.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Win32 Installation Notes</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>