/
Configuration.xml
3366 lines (3195 loc) · 150 KB
/
Configuration.xml
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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version='1.0' encoding='UTF-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "Admin_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="admin.config">
<title>Configuration</title>
<section id="admin.config.database">
<title>Database</title>
<para>The database settings must be set in order for the package
to work properly. These settings should be provided to you by your
system administrator or your hosting company.
</para>
<variablelist>
<varlistentry>
<term>$g_hostname</term>
<listitem>
<para>Host name or connection string for Database server. The
default value is localhost. For MySql, this should be hostname or
hostname:port (e.g. localhost:3306).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_db_username</term>
<listitem>
<para>User name to use for connecting to the database. The user
needs to have read/write access to the MantisBT database. The default
user name is "root".
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_db_password</term>
<listitem>
<para>Password for the specified user name. The default password
is empty.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_database_name</term>
<listitem>
<para>Name of database that contains MantisBT tables. The default name is 'bugtracker'.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_db_schema</term>
<listitem>
<para>The database schema (used in case of DB2), otherwise should be left blank.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_db_type</term>
<listitem>
<para>The supported database types include: 'mysql' or 'mysqli' for MySQL,
'pgsql' for PostgreSQL, 'mssql' for MS SQL Server, 'oci8' for Oracle,
and 'db2' for DB2. It is important to make sure that the PHP extension
corresponding to the database type is enabled.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="admin.config.path">
<title>Path</title>
<para>These path settings are important for proper linking within
MantisBT. In most scenarios the default values should work fine, and
you should not need to override them.
</para>
<variablelist>
<varlistentry>
<term>$g_path</term>
<listitem>
<para>URL to your installation as seen from the web browser; this
is what you type into the URL field. Requires trailing '/'
character. eg. 'http://www.example.com/mantisbt/'. In the following example
https protocol is used: eg. 'https://www.example.com/mantisbt/'. MantisBT will default this to
the correct value. However, in some cases it might be necessary to
override the default. This is typically needed when an installation can be
accessed by multiple URLs (internal vs external).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_icon_path</term>
<listitem>
<para>This is the URL to the icons (images) directory as seen from
the web browser. All MantisBT images/icons are loaded from this URL.
The default value for this URL is based on $g_path (i.e. '%path%images/'). Note that a trailing
'/' is required.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_short_path</term>
<listitem>
<para>Short web path without the domain name. This requires the trailing '/'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_absolute_path</term>
<listitem>
<para>This is the absolute file system path to the MantisBT installation, it is
defaulted to the directory where config_defaults_inc.php resides.
Requires trailing '/' character (eg. '/usr/apache/htdocs/mantisbt/').
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_core_path</term>
<listitem>
<para>This is the path to the core directory of your installation.
The default value is usually OK but it is recommended
that you move the 'core' directory out of your webroot.
Requires trailing DIRECTORY_SEPARATOR character.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_class_path</term>
<listitem>
<para>This is the path to the classes directory which is a sub-directory of core by default.
The default value is typically OK. Requires trailing DIRECTORY_SEPARATOR.
character.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_library_path</term>
<listitem>
<para>This is the path to the library directory of your installation.
The default value is usually OK but it is recommended
that you move the 'library' directory out of your webroot.
Requires trailing DIRECTORY_SEPARATOR character.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_language_path</term>
<listitem>
<para>This is the path to the language directory of your installation.
The default value is usually OK but it is recommended
that you move the 'language' directory out of your webroot.
Requires trailing DIRECTORY_SEPARATOR character.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_manual_url</term>
<listitem>
<para>This is the url to the MantisBT online manual. Requires trailing '/' character.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="admin.config.webserver">
<title>Webserver</title>
<para></para>
</section>
<section id="admin.config.settings">
<title>Configuration Settings</title>
<variablelist>
<varlistentry>
<term>$g_global_settings</term>
<listitem>
<para>This option contains the list of regular expressions that are used to determine if it is allowed for a specific configuration option to be saved to or loaded from the database. Configuration options that matches the regular expressions are considered global only and hence are only configurable via the config_inc.php file and defaulted by config_defaults_inc.php file.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="admin.config.security">
<title>Security and Cryptography</title>
<variablelist>
<varlistentry>
<term>$g_crypto_master_salt</term>
<listitem>
<para>Master salt value used for cryptographic hashing
throughout MantisBT. This value must be kept secret at
all costs. You must generate a unique and random salt
value for each installation of MantisBT you control.
The minimum length of this string must be at least 16
characters.
</para>
<para>The value you select for this salt should be a long
string generated using a secure random number
generator. An example for Linux systems is:
</para>
<para>cat /dev/urandom | head -c 64 | base64</para>
<para>Note that the number of bits of entropy per byte of
output from /dev/urandom is not 8. If you're
particularly paranoid and don't mind waiting a long
time, you could use /dev/random to get much closer to
8 bits of entropy per byte. Moving the mouse
(if possible) while generating entropy via /dev/random
will greatly improve the speed at which /dev/random
produces entropy.
</para>
<para>This setting is blank by default. MantisBT will not
operate in this state. Hence you are forced to change
the value of this configuration option.
</para>
<warning>
<para>WARNING: This configuration option has a profound
impact on the security of your MantisBT
installation. Failure to set this configuration
option correctly could lead to your MantisBT
installation being compromised. Ensure that this
value remains secret. Treat it with the same
security that you'd treat the password to your
MantisDB database.
</para>
</warning>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="admin.config.signup">
<title>Signup and Lost Password</title>
<variablelist>
<varlistentry>
<term>$g_allow_signup</term>
<listitem>
<para>Allow users to signup for their own accounts. Default is ON.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_max_failed_login_count</term>
<listitem>
<para>Maximum failing login attempts before the account is locked.
Once locked, it's required to reset the password (lost password).
Value resets to zero at each successfully login. Default is OFF.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_notify_new_user_created_threshold_min</term>
<listitem>
<para>The minimum global access level required to be notified when a new user registers via the "signup form". To pick specific access levels that are not necessarily at the higher end of access levels, use an array of access levels. Default is ADMINISTRATOR.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_send_reset_password</term>
<listitem>
<para>When set to ON, MantisBT will email the users their new
passwords when their accounts are reset. If set to OFF, the
password will be reset to blank and no e-mail will be sent. Default
is ON.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_signup_use_captcha</term>
<listitem>
<para>TODO</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_system_font_folder</term>
<listitem>
<para>TODO</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_font_per_captcha</term>
<listitem>
<para>TODO</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_lost_password_feature</term>
<listitem>
<para>TODO</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_max_lost_password_in_progress_count</term>
<listitem>
<para>TODO</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="admin.config.email">
<title>Email</title>
<variablelist>
<varlistentry>
<term>$g_administrator_email</term>
<listitem>
<para>The administrator's e-mail address. This is mainly prompted
to the user in case of errors that might require the intervention
of the system administrator. For example, SQL
errors. sysadmin@example.com
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_webmaster_email</term>
<listitem>
<para>The webmaster's e-mail address. This address is displayed in
the bottom of all MantisBT
pages. webmaster@example.com
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_from_email</term>
<listitem>
<para>The email address to be used as the source of all emails
sent by MantisBT. noreply@example.com
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_return_path_email</term>
<listitem>
<para>Email address to receive bounced emails.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_enable_email_notification</term>
<listitem>
<para>Set to ON to enable email notifications, OFF to
disable them. Default is ON. Note that disabling
email notifications has no effect on emails generated
as part of the user signup process. When set to OFF,
the password reset feature is disabled. Additionally,
notifications of administrators updating accounts are
not sent to users.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_default_notify_flags</term>
<listitem>
<para>Associated with each action a list of flags to control who
should be notified.The default will be used if the action is not
included in $g_notify_flags or if the flag is not included in the
specific action definition. The list of actions include: new,
assigned, resolved, bugnote, reopened, closed, deleted,
feedback.The default is:
$g_default_notify_flags = array('reporter' => ON, 'handler'
=> ON, 'monitor' => ON, 'bugnotes' => ON, 'explicit' => ON,
'threshold_min' => NOBODY, 'threshold_max' => NOBODY);
threshold_min and threshold_max are used to send messages to all
members of the project whose status is greater than or equal to
"threshold_min" and less than or equal to "threshold_max". Sending
messages to everyone would set "threshold_min" to ANYBODY and
"threshold_max to "NOBODY". To send to all DEVELOPERS and above (as
0.17.5), use DEVELOPER and NOBODY respectively.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_notify_flags</term>
<listitem>
<para>Defines the notification flags that are different from the
defaults that are defined in $g_default_notify_flags. The following
code overrides the default by disabling notifications to bugnote
authors and users monitoring the bug on submitting a new bug:
$g_notify_flags['new'] = array('bugnotes' => OFF, 'monitor'
=> OFF);
Available actions include:
<itemizedlist>
<listitem>
<para>'new': a new bug has been added</para>
</listitem>
<listitem>
<para>'reopened': the bug has been reopened</para>
</listitem>
<listitem>
<para>'deleted': a bug has been deleted</para>
</listitem>
<listitem>
<para>'owner': the bug has been assigned a new owner</para>
</listitem>
<listitem>
<para>'bugnote': a bugnote has been added to a bug</para>
</listitem>
<listitem>
<para>'sponsor': the sponsorship for the bug has changed
(added, deleted or updated)
</para>
</listitem>
<listitem>
<para>'relation': a relationship for the bug has changed
(added, deleted or updated)
</para>
</listitem>
<listitem>
<para>'monitor': a user is added to the monitor list.
</para>
</listitem>
</itemizedlist>
In addition, an action can match the bug status in
$g_status_enum_string. Note that spaces in the string are replaced
with underscores ('_') in creating the action. Thus, using the
defaults, 'feedback' would be a valid action.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_email_receive_own</term>
<listitem>
<para>This defines whether users should receive emails for their
own actions. This option is defaulted to OFF, hence, users do not
receive email notification for their own actions.
This can be a source for confusions for users upgrading from MantisBT
0.17.x versions, since in these versions users used to get notified
of their own actions.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_validate_email</term>
<listitem>
<para>Set to OFF to disable email checking. Default is ON.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_check_mx_record</term>
<listitem>
<para>Set to OFF to disable email checking. Default is
OFF.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_allow_blank_email</term>
<listitem>
<para>If ON, allows the user to omit an email address field.
If you allow users to create their own accounts, they must specify
an email at that point, no matter what the value of this option is.
Otherwise they wouldn't get their passwords.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_limit_email_domain</term>
<listitem>
<para>Only allow and send email to addresses in the given domain.
This is useful as a security feature and it is also useful in cases
like Sourceforge where its servers are only limited to send emails
to SourceForge email addresses in order to avoid
spam. $g_limit_email_domain =
'users.sourceforge.net';
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_show_user_email_threshold</term>
<listitem>
<para>This specifies the access level that is needed to have user
names hyperlinked with mailto: links. The default value is NOBODY,
hence, even administrators won't have this feature enabled.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_mail_priority</term>
<listitem>
<para>If use_x_priority is set to ON, what should the value be?
Urgent = 1, Not Urgent = 5, Disable = 0 . Default is 3
Some MTAs interpret X-Priority = 0 to mean 'Very Urgent'
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_phpMailer_method</term>
<listitem>
<para>Select the method to mail by: PHPMAILER_METHOD_MAIL for use of mail() function,
PHPMAILER_METHOD_SENDMAIL for sendmail (or postfix), PHPMAILER_METHOD_SMTP for SMTP.
Default is PHPMAILER_METHOD_MAIL.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_smtp_host</term>
<listitem>
<para>This option specifies the SMTP server to submit messages to. The SMTP
server (MTA) then takes on the responsibility of delivering such messages
to their final destinations. To use the local SMTP (if available) set this
to 'localhost', otherwise use the fully qualified domain name of the remote
SMTP server. Default value is 'localhost'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_smtp_port</term>
<listitem>
<para>
The smtp port to use. The typical SMTP ports are 25 and 587. The port to use
will depend on the SMTP server configuration and hence others may be used.
The default is 25.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_smtp_connection_mode</term>
<listitem>
<para>This option allows you to specify the connection mode to the SMTP server.
Possible values are '', 'ssl', 'tls'. The default value is ''.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_smtp_username</term>
<listitem>
<para>This option allows the use of SMTP Authentication when using
a remote SMTP host with PHPMailer. If smtp_username is not '' then
the username and password will be used when logging in to the SMTP
server. Default is ''.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_smtp_password</term>
<listitem>
<para>This is the password that is used in SMTP Authentication .
Default is ''.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_email_send_using_cronjob</term>
<listitem>
<para>TODO</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_email_set_category</term>
<listitem>
<para>Specify whether e-mails should be sent with the category set
or not. This is tested with Microsoft Outlook. More testing for
this feature + other formats will be added in the future. OFF,
EMAIL_CATEGORY_PROJECT_CATEGORY (format: [Project] Category).
Default is OFF.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_email_separator1</term>
<listitem>
<para>Default is str_pad('', 70, '='); This means 70 equal
signs.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_email_separator2</term>
<listitem>
<para>Default is str_pad('', 70, '-'); This means 70 minus
signs.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_email_padding_length</term>
<listitem>
<para>Default is 28.</para>
</listitem>
</varlistentry>
</variablelist>
<para>MantisBT uses flags and a threshold system to generate emails on
events. For each new event, email is sent to:
<itemizedlist>
<listitem>
<para>the reporter, qualified by the notify flag 'reporter'
below
</para>
</listitem>
<listitem>
<para>the handler (or Assigned to), qualified by the notify
flag 'handler' below
</para>
</listitem>
<listitem>
<para>anyone monitoring the bug, qualified by the notify flag
'monitor' below
</para>
</listitem>
<listitem>
<para>anyone who has ever added a bugnote the bug, qualified by
the notify flag 'bugnotes' below
</para>
</listitem>
<listitem>
<para>anyone assigned to the project whose access level is
greater than or equal to the notify flag 'threshold_min' and less
than or equal to the notify flag 'threshold_max' below
</para>
</listitem>
</itemizedlist>
</para>
<para>
From this list, those recipients who meet the following criteria
are eliminated:
<itemizedlist>
<listitem>
<para>the originator of the change, if $g_email_receive_own is
OFF
</para>
</listitem>
<listitem>
<para>the recipient either no longer exists, or is
disabled
</para>
</listitem>
<listitem>
<para>the recipient has turned their email_on_<new
status> preference OFF
</para>
</listitem>
<listitem>
<para>the recipient has no email address entered</para>
</listitem>
</itemizedlist>
</para>
</section>
<section id="admin.config.version">
<title>Version</title>
<variablelist>
<varlistentry>
<term>$g_show_version</term>
<listitem>
<para>Whether to show the MantisBT version at the bottom of each
page or not. Default is ON.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="admin.config.language">
<title>Language</title>
<variablelist>
<varlistentry>
<term>$g_default_language</term>
<listitem>
<para>This is the language used by default in MantisBT. This may be set
to 'auto' where MantisBT will try to determine the language from the browser.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_language_choices_arr</term>
<listitem>
<para>This is to be set to an array of languages that are
available for users to choose from. The default value includes all
languages supported by MantisBT. The administrator can limit the
languages available for users to choose from by overriding this
value. For example, to support English, French and German include
the following code: array( 'english', 'french', 'german'
); Of course, administrators can also add their own languages
by translating the strings and creating their own language files.
You are encouraged to share any translation work that you do with
the MantisBT team. This will ensure that the newly created language
file is maintained with future MantisBT releases.All language files
reside in the lang/ folder. They are all named according to the
following pattern: strings_<language>.txt.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_fallback_language</term>
<listitem>
<para>This is the language used if MantisBT cannot determine the
language from the browser. It defaults to 'english'.As of 0.19.0,
this may be set to 'auto' where MantisBT will try to determine the
language from the browser.
</para>
</listitem>
</varlistentry>
</variablelist>
<note>
<para>If a string does not exist in the active language, the
English string is used instead.
</para>
</note>
</section>
<!-- Stopped here -->
<section id="admin.config.display">
<title>Display</title>
<variablelist>
<varlistentry>
<term>$g_window_title</term>
<listitem>
<para>This is the browser window title (<TITLE>
tag).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_page_title</term>
<listitem>
<para>This is a heading that is displayed in the viewing area of
the page.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_favicon_image</term>
<listitem>
<para>Path to the favorites icon relative to MantisBT root folder (default 'images/favicon.ico').</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_logo_image</term>
<listitem>
<para>Path to the logo image relative to MantisBT root folder (default 'images/mantis_logo.gif').</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_logo_url</term>
<listitem>
<para>The default URL to be associated with the logo. By default this is set to $g_default_home_page (which defaults to My View page). Clicking on the logo from any page in the bug tracker will navigate to the URL specified in this configuration option.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_show_footer_menu</term>
<listitem>
<para>Show the menu at the bottom of the page as well as at the
top. Default value is OFF.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_show_project_menu_bar</term>
<listitem>
<para>This option specifies whether to add menu at the top of the
page which includes links to all the projects. The default value is
OFF.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_show_assigned_names</term>
<listitem>
<para>When a bug is assigned then replace the word "assigned" with
the name of the developer in parenthesis. Default is ON.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_show_priority_text</term>
<listitem>
<para>Specifies whether to show priority as text (ON) or icon
(OFF) in the view all bugs page. Default is OFF (icon).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_priority_significant_threshold</term>
<listitem>
<para>Define the priority level at which a bug becomes
significant. Significant bugs are displayed with
emphasis. Set this value to -1 to disable the feature.
The default value is HIGH.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_severity_significant_threshold</term>
<listitem>
<para>Define the severity level at which a bug becomes
significant. Significant bugs are displayed with
emphasis. Set this value to -1 to disable the feature.
The default value is MAJOR.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_view_issues_page_columns</term>
<listitem>
<para>This configuration option is used to select the columns to be included in the View Issues page and in which order. If one of the column is not accessible to the logged in user, or corresponds to a disabled feature, then it will be automatically removed from the list at runtime. Hence, the same column list may show a different set of columns based on the logged in user, the currently selected project and enabled features (e.g. sponsorship_total is only shown if the sponsorship feature is enabled).</para>
<para>The supported columns are: selection, edit, id, project_id, reporter_id, handler_id, priority, reproducibility, projection, eta, resolution, fixed_in_version, view_state, os, os_build, build (for product build), platform, version, date_submitted, attachment_count, category, sponsorship_total, severity, status, last_updated, summary, bugnotes_count, description, steps_to_reproduce, additional_information. As for custom fields they can be referenced by adding a 'custom_' to their name (e.g. xyz would be custom_xyz).</para>
<para>By default the following columns are selected: selection, edit, priority, id, sponsorship_total, bugnotes_count, attachment_count, category_id, severity, status, last_updated, summary.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_print_issues_page_columns</term>
<listitem>
<para>This configuration option is used to select the columns to be included in the Print Issues page and in which order. See $g_view_issues_page_columns for more details about the supported fields.</para>
<para>By default the following columns are selected: selection, priority, id, sponsorship_total, bugnotes_count, attachment_count, category_id, severity, status, last_updated, summary</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_csv_columns</term>
<listitem>
<para>This configuration option is used to select the columns to be included in the CSV export and in which order. See $g_view_issues_page_columns for more details about the supported fields.</para>
<para>By default the following columns are selected: id, project_id, reporter_id, handler_id, priority, severity, reproducibility, version, build, projection, category_id, date_submitted, eta, os, os_build, platform, view_state, last_updated, summary, status, resolution, fixed_in_version, duplicate_id.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_excel_columns</term>
<listitem>
<para>This configuration option is used to select the columns to be included in the CSV export and in which order. See $g_view_issues_page_columns for more details about the supported fields.</para>
<para>By default the following columns are selected: id, project_id, reporter_id, handler_id, priority, severity, reproducibility, version, build, projection, category_id, date_submitted, eta, os, os_build, platform, view_state, last_updated, summary, status, resolution, fixed_in_version, duplicate_id.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_show_bug_project_links</term>
<listitem>
<para>Show project links when in All Projects mode. Default is
ON.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_status_legend_position</term>
<listitem>
<para>Specifies the position of the status colour legend, can be:
STATUS_LEGEND_POSITION_TOP or STATUS_LEGEND_POSITION_BOTTOM.
Default is STATUS_LEGEND_POSITION_BOTTOM.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_show_product_version</term>
<listitem>
<para>This controls display of the product version in the
report, view, update and print issue pages. This flag also applies
to other product version related fields like product build, fixed in version,
and target version. Valid values are ON, OFF, and AUTO.
ON for always displayed, AUTO for displayed when project has versions defined, and OFF for
always OFF. The default value is AUTO.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_show_version_dates_threshold</term>
<listitem>
<para>The access level threshold at which users will see
the date of release for product versions. Dates will
be shown next to the product version, target version
and fixed in version fields. Set this threshold to
NOBODY to disable the feature. Default value is NOBODY.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_show_realname</term>
<listitem>
<para>This control will replace the user's userid with their
realname. If it is set to ON, and the real name field has been
populated, the replacement will occur. It defaults to OFF.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_show_avatar</term>
<listitem>
<para>Show user avatar (default OFF); the current implementation is based on http://www.gravatar.com,
users will need to register there with the same email address used in
this MantisBT installation to have their avatar shown.</para>
<note><para>Upon registration or avatar change, it takes some time for the updated gravatar images to show on sites.</para></note>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_show_avatar_threshold</term>
<listitem>
<para>The threshold of users for which MantisBT should attempt to show the avatar (default DEVELOPER). Note that the threshold is related to the user for whom the avatar is being shown, rather than the user who is currently logged in.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_default_avatar</term>
<listitem>
<para>The full URL to the image to be used when a user doesn't have an avatar account.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="admin.config.time">
<title>Time</title>
<variablelist>
<varlistentry>
<term>$g_cookie_time_length</term>
<listitem>
<para>Time for 'permanent' cookie to live in seconds. This is what
is used when a user selects "save login". Default is the equivalent
of 1 year (30000000).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_wait_time</term>
<listitem>
<para>Time to delay between page redirects (in seconds). Users can
override this setting in their user preferences. Default is 2
seconds.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_content_expire</term>
<listitem>
<para>Time to wait before document is stale (in minutes). This is
used in meta_inc.php. Default is 0 (expires right away).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_long_process_timeout</term>
<listitem>
<para>This timeout is used by pages which does time consuming
operations like upgrading the database. The default value of 0
disables timeout. Note that this timeout is specified in
seconds.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="admin.config.date">
<title>Date</title>
<para>These variables control how the date is displayed (default
is 'US' formatting). Go to the
<ulink url="http://www.php.net/manual/en/function.date.php">date()</ulink>
function in PHP online manual for detailed instructions on date
formatting.
</para>
<variablelist>
<varlistentry>
<term>$g_short_date_format</term>
<listitem>
<para>This format is used in the bug listing pages (eg: View
Bugs). Default is 'm-d-y'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_normal_date_format</term>
<listitem>
<para>This format is used in the view/update bug pages, bug notes,
manage section, and news section. Default is 'm-d-y H:i'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_complete_date_format</term>
<listitem>
<para>This format is used on the top of each page (current time)
and the emails that are sent out. Default is 'm-d-y H:i T'.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="admin.config.news">
<title>News</title>
<para>These options are used to control the query that selects the
news entries to be displayed.
</para>
<variablelist>
<varlistentry>
<term>$g_news_enabled</term>
<listitem>
<para>Indicates whether the news feature should be enabled or disabled.
The default is OFF. The news feature is deprecated in favor of
being moved to a plugin.
</para>