summaryrefslogtreecommitdiffstats
path: root/docs/html/postinstall-check.html
blob: 2ab4a39ceb13423ce3bdb94d0b6b1c2e5fcf0d55 (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
<HTML
><HEAD
><TITLE
>Post-Installation Checklist</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.64
"><LINK
REL="HOME"
TITLE="The Bugzilla Guide"
HREF="index.html"><LINK
REL="UP"
TITLE="Administering Bugzilla"
HREF="administration.html"><LINK
REL="PREVIOUS"
TITLE="Administering Bugzilla"
HREF="administration.html"><LINK
REL="NEXT"
TITLE="User Administration"
HREF="useradmin.html"></HEAD
><BODY
CLASS="SECTION"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><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="administration.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 3. Administering Bugzilla</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="useradmin.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECTION"
><H1
CLASS="SECTION"
><A
NAME="POSTINSTALL-CHECK"
>3.1. Post-Installation Checklist</A
></H1
><P
>      After installation, follow the checklist below to ensure that
      you have a successful installation.
      If you do not see a recommended setting for a parameter,
      consider leaving it at the default
      while you perform your initial tests on your Bugzilla setup.
    </P
><DIV
CLASS="PROCEDURE"
><OL
TYPE="1"
><LI
><P
>	  Bring up "editparams.cgi" in your web browser.  For instance, to edit parameters
	  at mozilla.org, the URL would be <A
HREF="http://bugzilla.mozilla.org/editparams.cgi"
TARGET="_top"
>	  http://bugzilla.mozilla.org/editparams.cgi</A
>, also available under the "edit parameters"
	  link on your query page.
	</P
></LI
><LI
><P
>	  Set "maintainer" to <EM
>your</EM
> email address.
	  This allows Bugzilla's error messages
	  to display your email
	  address and allow people to contact you for help.
	</P
></LI
><LI
><P
>	  Set "urlbase" to the URL reference for your Bugzilla installation.
	  If your bugzilla query page is at http://www.foo.com/bugzilla/query.cgi,
	  your url base is http://www.foo.com/bugzilla/
	</P
></LI
><LI
><P
>	  Set "usebuggroups" to "1" <EM
>only</EM
>
	  if you need to restrict access to products.
	  I suggest leaving this parameter <EM
>off</EM
>
	  while initially testing your Bugzilla.
	</P
></LI
><LI
><P
>	  Set "usebuggroupsentry" to "1" if you want to restrict access to products.
	  Once again, if you are simply testing your installation, I suggest against
	  turning this parameter on; the strict security checking may stop you from
	  being able to modify your new entries.
	</P
></LI
><LI
><P
>	  Set "shadowdb" to "bug_shadowdb" if you will be
	  running a *very* large installation of Bugzilla.
	  The shadow database enables many simultaneous users
	  to read and write to the database
	  without interfering with one another.  
	  <DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
>	      Enabling "shadowdb" can adversely affect the stability
	      of your installation of Bugzilla.
	      You may frequently need to manually synchronize your databases,
	      or schedule nightly syncs
	      via "cron"
	    </P
></BLOCKQUOTE
></DIV
>
	  Once again, in testing you should
	  avoid this option -- use it if or when you <EM
>need</EM
> to use it, and have
	  repeatedly run into the problem it was designed to solve -- very long wait times while
	  attempting to commit a change to the database.
        </P
><P
>	  If you use the "shadowdb" option,
	  it is only natural that you should turn the "queryagainstshadowdb"
	  option "On" as well.  Otherwise you are replicating data into a shadow database for no reason!
	</P
></LI
><LI
><P
>	  If you have custom logos or HTML you must put in place to fit within your site design guidelines,
	  place the code in the "headerhtml", "footerhtml", "errorhtml",
	  "bannerhtml", or "blurbhtml" text boxes.
	  <DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
>	      The "headerhtml" text box is the HTML printed out
	      <EM
>before</EM
> any other code on the page.
	      If you have a special banner, put the code for it in "bannerhtml".
	      You may want to leave these
	      settings at the defaults initially.
	    </P
></BLOCKQUOTE
></DIV
>
	</P
></LI
><LI
><P
>	  Add any text you wish to the "passwordmail" parameter box.  For instance,
	  many people choose to use this box to give a quick training blurb about how to
	  use Bugzilla at your site.
        </P
></LI
><LI
><P
>	  Ensure "newemailtech" is "on".
	  Your users will thank you.  This is the default in the post-2.12 world, and is
	  only an issue if you are upgrading.
	</P
></LI
><LI
><P
>	  Do you want to use the qa contact ("useqacontact")
	  and status whiteboard ("usestatuswhiteboard") fields?
	  These fields are useful because they allow for more flexibility,
	  particularly when you have an existing
	  Quality Assurance and/or Release Engineering team, 
	  but they may not be needed for smaller installations.
	</P
></LI
><LI
><P
>	  Set "whinedays" to the amount of days you want to let bugs go
	  in the "New" or "Reopened" state before
	  notifying people they have untouched new bugs.  If you do not plan to use this feature, simply do
	  not set up the whining cron job described in the README, or set this value to "0".
	</P
></LI
><LI
><P
>	  Set the "commenton" options according to your site policy.
	  It is a wise idea to require comments when users
	  resolve, reassign, or reopen bugs.
	  <DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
>	      It is generally far better to require a developer comment when resolving bugs than not.
	      Few things are more annoying to bug database users than having a developer
	      mark a bug "fixed" without any comment as to what the fix was (or even that it was truly fixed!)
	    </P
></BLOCKQUOTE
></DIV
>
	</P
></LI
><LI
><P
>	  Set "supportwatchers" to "On".  This feature is helpful for team leads to monitor progress in their
	  respective areas, and can offer many other benefits, such as allowing a developer to pick up a
	  former engineer's bugs without requiring her to change all the information in the bug.
	</P
></LI
></OL
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="administration.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="useradmin.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Administering Bugzilla</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="administration.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>User Administration</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>