| [ Index ] |
PHP Cross Reference of MantisBT |
[Summary view] [Print] [Text view]
1 <?xml version='1.0' encoding='utf-8' ?> 2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ 3 <!ENTITY % BOOK_ENTITIES SYSTEM "Admin_Guide.ent"> 4 %BOOK_ENTITIES; 5 ]> 6 <chapter id="admin.config"> 7 <title>Configuration</title> 8 <section id="admin.config.database"> 9 <title>Database</title> 10 <para>The database settings must be set in order for the package 11 to work properly. These settings should be provided to you by your 12 system administrator or your hosting company. 13 </para> 14 15 <variablelist> 16 <varlistentry> 17 <term>$g_hostname</term> 18 <listitem> 19 <para>Host name or connection string for Database server. The 20 default value is localhost. For MySql, this should be hostname or 21 hostname:port (e.g. localhost:3306). 22 </para> 23 </listitem> 24 </varlistentry> 25 <varlistentry> 26 <term>$g_db_username</term> 27 <listitem> 28 <para>User name to use for connecting to the database. The user 29 needs to have read/write access to the MantisBT database. The default 30 user name is "root". 31 </para> 32 </listitem> 33 </varlistentry> 34 <varlistentry> 35 <term>$g_db_password</term> 36 <listitem> 37 <para>Password for the specified user name. The default password 38 is empty. 39 </para> 40 </listitem> 41 </varlistentry> 42 <varlistentry> 43 <term>$g_database_name</term> 44 <listitem> 45 <para>Name of database that contains MantisBT tables. The default name is 'bugtracker'.</para> 46 </listitem> 47 </varlistentry> 48 <varlistentry> 49 <term>$g_db_schema</term> 50 <listitem> 51 <para>The database schema (used in case of DB2), otherwise should be left blank.</para> 52 </listitem> 53 </varlistentry> 54 <varlistentry> 55 <term>$g_db_type</term> 56 <listitem> 57 <para>The supported database types include: 'mysql' or 'mysqli' for MySQL, 58 'pgsql' for PostgreSQL, 'mssql' for MS SQL Server, 'oci8' for Oracle, 59 and 'db2' for DB2. It is important to make sure that the PHP extension 60 corresponding to the database type is enabled. 61 </para> 62 </listitem> 63 </varlistentry> 64 </variablelist> 65 </section> 66 67 <section id="admin.config.path"> 68 <title>Path</title> 69 <para>These path settings are important for proper linking within 70 MantisBT. In most scenarios the default values should work fine, and 71 you should not need to override them. 72 </para> 73 <variablelist> 74 <varlistentry> 75 <term>$g_path</term> 76 <listitem> 77 <para>URL to your installation as seen from the web browser; this 78 is what you type into the URL field. Requires trailing '/' 79 character. eg. 'http://www.example.com/mantisbt/'. In the following example 80 https protocol is used: eg. 'https://www.example.com/mantisbt/'. MantisBT will default this to 81 the correct value. However, in some cases it might be necessary to 82 override the default. This is typically needed when an installation can be 83 accessed by multiple URLs (internal vs external). 84 </para> 85 </listitem> 86 </varlistentry> 87 <varlistentry> 88 <term>$g_icon_path</term> 89 <listitem> 90 <para>This is the URL to the icons (images) directory as seen from 91 the web browser. All MantisBT images/icons are loaded from this URL. 92 The default value for this URL is based on $g_path (i.e. '%path%images/'). Note that a trailing 93 '/' is required. 94 </para> 95 </listitem> 96 </varlistentry> 97 <varlistentry> 98 <term>$g_short_path</term> 99 <listitem> 100 <para>Short web path without the domain name. This requires the trailing '/'. 101 </para> 102 </listitem> 103 </varlistentry> 104 <varlistentry> 105 <term>$g_absolute_path</term> 106 <listitem> 107 <para>This is the absolute file system path to the MantisBT installation, it is 108 defaulted to the directory where config_defaults_inc.php resides. 109 Requires trailing '/' character (eg. '/usr/apache/htdocs/mantisbt/'). 110 </para> 111 </listitem> 112 </varlistentry> 113 <varlistentry> 114 <term>$g_core_path</term> 115 <listitem> 116 <para>This is the path to the core directory of your installation. 117 The default value is usually OK but it is recommended 118 that you move the 'core' directory out of your webroot. 119 Requires trailing DIRECTORY_SEPARATOR character. 120 </para> 121 </listitem> 122 </varlistentry> 123 <varlistentry> 124 <term>$g_class_path</term> 125 <listitem> 126 <para>This is the path to the classes directory which is a sub-directory of core by default. 127 The default value is typically OK. Requires trailing DIRECTORY_SEPARATOR. 128 character. 129 </para> 130 </listitem> 131 </varlistentry> 132 <varlistentry> 133 <term>$g_library_path</term> 134 <listitem> 135 <para>This is the path to the library directory of your installation. 136 The default value is usually OK but it is recommended 137 that you move the 'library' directory out of your webroot. 138 Requires trailing DIRECTORY_SEPARATOR character. 139 </para> 140 </listitem> 141 </varlistentry> 142 <varlistentry> 143 <term>$g_language_path</term> 144 <listitem> 145 <para>This is the path to the language directory of your installation. 146 The default value is usually OK but it is recommended 147 that you move the 'language' directory out of your webroot. 148 Requires trailing DIRECTORY_SEPARATOR character. 149 </para> 150 </listitem> 151 </varlistentry> 152 <varlistentry> 153 <term>$g_manual_url</term> 154 <listitem> 155 <para>This is the url to the MantisBT online manual. Requires trailing '/' character. 156 </para> 157 </listitem> 158 </varlistentry> 159 </variablelist> 160 </section> 161 162 <section id="admin.config.webserver"> 163 <title>Webserver</title> 164 <para></para> 165 </section> 166 167 <section id="admin.config.settings"> 168 <title>Configuration Settings</title> 169 170 <variablelist> 171 <varlistentry> 172 <term>$g_global_settings</term> 173 <listitem> 174 <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> 175 </listitem> 176 </varlistentry> 177 </variablelist> 178 </section> 179 180 <section id="admin.config.security"> 181 <title>Security and Cryptography</title> 182 183 <variablelist> 184 <varlistentry> 185 <term>$g_crypto_master_salt</term> 186 <listitem> 187 <para>Master salt value used for cryptographic hashing 188 throughout MantisBT. This value must be kept secret at 189 all costs. You must generate a unique and random salt 190 value for each installation of MantisBT you control. 191 The minimum length of this string must be at least 16 192 characters. 193 </para> 194 <para>The value you select for this salt should be a long 195 string generated using a secure random number 196 generator. An example for Linux systems is: 197 </para> 198 <para>cat /dev/urandom | head -c 64 | base64</para> 199 <para>Note that the number of bits of entropy per byte of 200 output from /dev/urandom is not 8. If you're 201 particularly paranoid and don't mind waiting a long 202 time, you could use /dev/random to get much closer to 203 8 bits of entropy per byte. Moving the mouse 204 (if possible) while generating entropy via /dev/random 205 will greatly improve the speed at which /dev/random 206 produces entropy. 207 </para> 208 <para>This setting is blank by default. MantisBT will not 209 operate in this state. Hence you are forced to change 210 the value of this configuration option. 211 </para> 212 <warning> 213 <para>WARNING: This configuration option has a profound 214 impact on the security of your MantisBT 215 installation. Failure to set this configuration 216 option correctly could lead to your MantisBT 217 installation being compromised. Ensure that this 218 value remains secret. Treat it with the same 219 security that you'd treat the password to your 220 MantisDB database. 221 </para> 222 </warning> 223 </listitem> 224 </varlistentry> 225 </variablelist> 226 </section> 227 228 <section id="admin.config.signup"> 229 <title>Signup and Lost Password</title> 230 231 <variablelist> 232 <varlistentry> 233 <term>$g_allow_signup</term> 234 <listitem> 235 <para>Allow users to signup for their own accounts. Default is ON. 236 </para> 237 </listitem> 238 </varlistentry> 239 240 <varlistentry> 241 <term>$g_max_failed_login_count</term> 242 <listitem> 243 <para>Maximum failing login attempts before the account is locked. 244 Once locked, it's required to reset the password (lost password). 245 Value resets to zero at each successfully login. Default is OFF. 246 </para> 247 </listitem> 248 </varlistentry> 249 250 <varlistentry> 251 <term>$g_notify_new_user_created_threshold_min</term> 252 <listitem> 253 <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. 254 </para> 255 </listitem> 256 </varlistentry> 257 258 <varlistentry> 259 <term>$g_send_reset_password</term> 260 <listitem> 261 <para>When set to ON, MantisBT will email the users their new 262 passwords when their accounts are reset. If set to OFF, the 263 password will be reset to blank and no e-mail will be sent. Default 264 is ON. 265 </para> 266 </listitem> 267 </varlistentry> 268 269 <varlistentry> 270 <term>$g_signup_use_captcha</term> 271 <listitem> 272 <para>TODO</para> 273 </listitem> 274 </varlistentry> 275 276 <varlistentry> 277 <term>$g_system_font_folder</term> 278 <listitem> 279 <para>TODO</para> 280 </listitem> 281 </varlistentry> 282 283 <varlistentry> 284 <term>$g_font_per_captcha</term> 285 <listitem> 286 <para>TODO</para> 287 </listitem> 288 </varlistentry> 289 290 <varlistentry> 291 <term>$g_lost_password_feature</term> 292 <listitem> 293 <para>TODO</para> 294 </listitem> 295 </varlistentry> 296 297 <varlistentry> 298 <term>$g_max_lost_password_in_progress_count</term> 299 <listitem> 300 <para>TODO</para> 301 </listitem> 302 </varlistentry> 303 </variablelist> 304 </section> 305 306 <section id="admin.config.email"> 307 <title>Email</title> 308 309 <variablelist> 310 <varlistentry> 311 <term>$g_administrator_email</term> 312 <listitem> 313 <para>The administrator's e-mail address. This is mainly prompted 314 to the user in case of errors that might require the intervention 315 of the system administrator. For example, SQL 316 errors. sysadmin@example.com 317 </para> 318 </listitem> 319 </varlistentry> 320 <varlistentry> 321 <term>$g_webmaster_email</term> 322 <listitem> 323 <para>The webmaster's e-mail address. This address is displayed in 324 the bottom of all MantisBT 325 pages. webmaster@example.com 326 </para> 327 </listitem> 328 </varlistentry> 329 <varlistentry> 330 <term>$g_from_email</term> 331 <listitem> 332 <para>The email address to be used as the source of all emails 333 sent by MantisBT. noreply@example.com 334 </para> 335 </listitem> 336 </varlistentry> 337 <varlistentry> 338 <term>$g_return_path_email</term> 339 <listitem> 340 <para>Email address to receive bounced emails.</para> 341 </listitem> 342 </varlistentry> 343 <varlistentry> 344 <term>$g_enable_email_notification</term> 345 <listitem> 346 <para>Set to ON to enable email notifications, OFF to 347 disable them. Default is ON. Note that disabling 348 email notifications has no effect on emails generated 349 as part of the user signup process. When set to OFF, 350 the password reset feature is disabled. Additionally, 351 notifications of administrators updating accounts are 352 not sent to users. 353 </para> 354 </listitem> 355 </varlistentry> 356 <varlistentry> 357 <term>$g_default_notify_flags</term> 358 <listitem> 359 <para>Associated with each action a list of flags to control who 360 should be notified.The default will be used if the action is not 361 included in $g_notify_flags or if the flag is not included in the 362 specific action definition. The list of actions include: new, 363 assigned, resolved, bugnote, reopened, closed, deleted, 364 feedback.The default is: 365 $g_default_notify_flags = array('reporter' => ON, 'handler' 366 => ON, 'monitor' => ON, 'bugnotes' => ON, 'explicit' => ON, 367 'threshold_min' => NOBODY, 'threshold_max' => NOBODY); 368 threshold_min and threshold_max are used to send messages to all 369 members of the project whose status is greater than or equal to 370 "threshold_min" and less than or equal to "threshold_max". Sending 371 messages to everyone would set "threshold_min" to ANYBODY and 372 "threshold_max to "NOBODY". To send to all DEVELOPERS and above (as 373 0.17.5), use DEVELOPER and NOBODY respectively. 374 </para> 375 </listitem> 376 </varlistentry> 377 <varlistentry> 378 <term>$g_notify_flags</term> 379 <listitem> 380 <para>Defines the notification flags that are different from the 381 defaults that are defined in $g_default_notify_flags. The following 382 code overrides the default by disabling notifications to bugnote 383 authors and users monitoring the bug on submitting a new bug: 384 $g_notify_flags['new'] = array('bugnotes' => OFF, 'monitor' 385 => OFF); 386 Available actions include: 387 <itemizedlist> 388 <listitem> 389 <para>'new': a new bug has been added</para> 390 </listitem> 391 <listitem> 392 <para>'reopened': the bug has been reopened</para> 393 </listitem> 394 <listitem> 395 <para>'deleted': a bug has been deleted</para> 396 </listitem> 397 <listitem> 398 <para>'owner': the bug has been assigned a new owner</para> 399 </listitem> 400 <listitem> 401 <para>'bugnote': a bugnote has been added to a bug</para> 402 </listitem> 403 <listitem> 404 <para>'sponsor': the sponsorship for the bug has changed 405 (added, deleted or updated) 406 </para> 407 </listitem> 408 <listitem> 409 <para>'relation': a relationship for the bug has changed 410 (added, deleted or updated) 411 </para> 412 </listitem> 413 <listitem> 414 <para>'monitor': a user is added to the monitor list. 415 </para> 416 </listitem> 417 </itemizedlist> 418 In addition, an action can match the bug status in 419 $g_status_enum_string. Note that spaces in the string are replaced 420 with underscores ('_') in creating the action. Thus, using the 421 defaults, 'feedback' would be a valid action. 422 </para> 423 </listitem> 424 </varlistentry> 425 <varlistentry> 426 <term>$g_email_receive_own</term> 427 <listitem> 428 <para>This defines whether users should receive emails for their 429 own actions. This option is defaulted to OFF, hence, users do not 430 receive email notification for their own actions. 431 This can be a source for confusions for users upgrading from MantisBT 432 0.17.x versions, since in these versions users used to get notified 433 of their own actions. 434 </para> 435 </listitem> 436 </varlistentry> 437 <varlistentry> 438 <term>$g_validate_email</term> 439 <listitem> 440 <para>Set to OFF to disable email checking. Default is ON.</para> 441 </listitem> 442 </varlistentry> 443 <varlistentry> 444 <term>$g_check_mx_record</term> 445 <listitem> 446 <para>Set to OFF to disable email checking. Default is 447 OFF. 448 </para> 449 </listitem> 450 </varlistentry> 451 <varlistentry> 452 <term>$g_allow_blank_email</term> 453 <listitem> 454 <para>If ON, allows the user to omit an email address field. 455 If you allow users to create their own accounts, they must specify 456 an email at that point, no matter what the value of this option is. 457 Otherwise they wouldn't get their passwords. 458 </para> 459 </listitem> 460 </varlistentry> 461 <varlistentry> 462 <term>$g_limit_email_domain</term> 463 <listitem> 464 <para>Only allow and send email to addresses in the given domain. 465 This is useful as a security feature and it is also useful in cases 466 like Sourceforge where its servers are only limited to send emails 467 to SourceForge email addresses in order to avoid 468 spam. $g_limit_email_domain = 469 'users.sourceforge.net'; 470 </para> 471 </listitem> 472 </varlistentry> 473 <varlistentry> 474 <term>$g_show_user_email_threshold</term> 475 <listitem> 476 <para>This specifies the access level that is needed to have user 477 names hyperlinked with mailto: links. The default value is NOBODY, 478 hence, even administrators won't have this feature enabled. 479 </para> 480 </listitem> 481 </varlistentry> 482 <varlistentry> 483 <term>$g_mail_priority</term> 484 <listitem> 485 <para>If use_x_priority is set to ON, what should the value be? 486 Urgent = 1, Not Urgent = 5, Disable = 0 . Default is 3 487 Some MTAs interpret X-Priority = 0 to mean 'Very Urgent' 488 </para> 489 </listitem> 490 </varlistentry> 491 <varlistentry> 492 <term>$g_phpMailer_method</term> 493 <listitem> 494 <para>Select the method to mail by: PHPMAILER_METHOD_MAIL for use of mail() function, 495 PHPMAILER_METHOD_SENDMAIL for sendmail (or postfix), PHPMAILER_METHOD_SMTP for SMTP. 496 Default is PHPMAILER_METHOD_MAIL. 497 </para> 498 </listitem> 499 </varlistentry> 500 <varlistentry> 501 <term>$g_smtp_host</term> 502 <listitem> 503 <para>This option specifies the SMTP server to submit messages to. The SMTP 504 server (MTA) then takes on the responsibility of delivering such messages 505 to their final destinations. To use the local SMTP (if available) set this 506 to 'localhost', otherwise use the fully qualified domain name of the remote 507 SMTP server. Default value is 'localhost'. 508 </para> 509 </listitem> 510 </varlistentry> 511 <varlistentry> 512 <term>$g_smtp_port</term> 513 <listitem> 514 <para> 515 The smtp port to use. The typical SMTP ports are 25 and 587. The port to use 516 will depend on the SMTP server configuration and hence others may be used. 517 The default is 25. 518 </para> 519 </listitem> 520 </varlistentry> 521 <varlistentry> 522 <term>$g_smtp_connection_mode</term> 523 <listitem> 524 <para>This option allows you to specify the connection mode to the SMTP server. 525 Possible values are '', 'ssl', 'tls'. The default value is ''. 526 </para> 527 </listitem> 528 </varlistentry> 529 <varlistentry> 530 <term>$g_smtp_username</term> 531 <listitem> 532 <para>This option allows the use of SMTP Authentication when using 533 a remote SMTP host with PHPMailer. If smtp_username is not '' then 534 the username and password will be used when logging in to the SMTP 535 server. Default is ''. 536 </para> 537 </listitem> 538 </varlistentry> 539 <varlistentry> 540 <term>$g_smtp_password</term> 541 <listitem> 542 <para>This is the password that is used in SMTP Authentication . 543 Default is ''. 544 </para> 545 </listitem> 546 </varlistentry> 547 <varlistentry> 548 <term>$g_email_send_using_cronjob</term> 549 <listitem> 550 <para>TODO</para> 551 </listitem> 552 </varlistentry> 553 <varlistentry> 554 <term>$g_email_set_category</term> 555 <listitem> 556 <para>Specify whether e-mails should be sent with the category set 557 or not. This is tested with Microsoft Outlook. More testing for 558 this feature + other formats will be added in the future. OFF, 559 EMAIL_CATEGORY_PROJECT_CATEGORY (format: [Project] Category). 560 Default is OFF. 561 </para> 562 </listitem> 563 </varlistentry> 564 <varlistentry> 565 <term>$g_email_separator1</term> 566 <listitem> 567 <para>Default is str_pad('', 70, '='); This means 70 equal 568 signs. 569 </para> 570 </listitem> 571 </varlistentry> 572 <varlistentry> 573 <term>$g_email_separator2</term> 574 <listitem> 575 <para>Default is str_pad('', 70, '-'); This means 70 minus 576 signs. 577 </para> 578 </listitem> 579 </varlistentry> 580 <varlistentry> 581 <term>$g_email_padding_length</term> 582 <listitem> 583 <para>Default is 28.</para> 584 </listitem> 585 </varlistentry> 586 </variablelist> 587 588 <para>MantisBT uses flags and a threshold system to generate emails on 589 events. For each new event, email is sent to: 590 <itemizedlist> 591 <listitem> 592 <para>the reporter, qualified by the notify flag 'reporter' 593 below 594 </para> 595 </listitem> 596 <listitem> 597 <para>the handler (or Assigned to), qualified by the notify 598 flag 'handler' below 599 </para> 600 </listitem> 601 <listitem> 602 <para>anyone monitoring the bug, qualified by the notify flag 603 'monitor' below 604 </para> 605 </listitem> 606 <listitem> 607 <para>anyone who has ever added a bugnote the bug, qualified by 608 the notify flag 'bugnotes' below 609 </para> 610 </listitem> 611 <listitem> 612 <para>anyone assigned to the project whose access level is 613 greater than or equal to the notify flag 'threshold_min' and less 614 than or equal to the notify flag 'threshold_max' below 615 </para> 616 </listitem> 617 </itemizedlist> 618 </para> 619 620 <para> 621 From this list, those recipients who meet the following criteria 622 are eliminated: 623 <itemizedlist> 624 <listitem> 625 <para>the originator of the change, if $g_email_receive_own is 626 OFF 627 </para> 628 </listitem> 629 <listitem> 630 <para>the recipient either no longer exists, or is 631 disabled 632 </para> 633 </listitem> 634 <listitem> 635 <para>the recipient has turned their email_on_<new 636 status> preference OFF 637 </para> 638 </listitem> 639 <listitem> 640 <para>the recipient has no email address entered</para> 641 </listitem> 642 </itemizedlist> 643 </para> 644 </section> 645 646 <section id="admin.config.version"> 647 <title>Version</title> 648 649 <variablelist> 650 <varlistentry> 651 <term>$g_show_version</term> 652 <listitem> 653 <para>Whether to show the MantisBT version at the bottom of each 654 page or not. Default is ON. 655 </para> 656 </listitem> 657 </varlistentry> 658 </variablelist> 659 </section> 660 661 <section id="admin.config.language"> 662 <title>Language</title> 663 <variablelist> 664 <varlistentry> 665 <term>$g_default_language</term> 666 <listitem> 667 <para>This is the language used by default in MantisBT. This may be set 668 to 'auto' where MantisBT will try to determine the language from the browser. 669 </para> 670 </listitem> 671 </varlistentry> 672 <varlistentry> 673 <term>$g_language_choices_arr</term> 674 <listitem> 675 <para>This is to be set to an array of languages that are 676 available for users to choose from. The default value includes all 677 languages supported by MantisBT. The administrator can limit the 678 languages available for users to choose from by overriding this 679 value. For example, to support English, French and German include 680 the following code: array( 'english', 'french', 'german' 681 ); Of course, administrators can also add their own languages 682 by translating the strings and creating their own language files. 683 You are encouraged to share any translation work that you do with 684 the MantisBT team. This will ensure that the newly created language 685 file is maintained with future MantisBT releases.All language files 686 reside in the lang/ folder. They are all named according to the 687 following pattern: strings_<language>.txt. 688 </para> 689 </listitem> 690 </varlistentry> 691 <varlistentry> 692 <term>$g_fallback_language</term> 693 <listitem> 694 <para>This is the language used if MantisBT cannot determine the 695 language from the browser. It defaults to 'english'.As of 0.19.0, 696 this may be set to 'auto' where MantisBT will try to determine the 697 language from the browser. 698 </para> 699 </listitem> 700 </varlistentry> 701 </variablelist> 702 <note> 703 <para>If a string does not exist in the active language, the 704 English string is used instead. 705 </para> 706 </note> 707 </section> 708 <!-- Stopped here --> 709 710 <section id="admin.config.display"> 711 <title>Display</title> 712 713 <variablelist> 714 <varlistentry> 715 <term>$g_window_title</term> 716 <listitem> 717 <para>This is the browser window title (<TITLE> 718 tag). 719 </para> 720 </listitem> 721 </varlistentry> 722 <varlistentry> 723 <term>$g_page_title</term> 724 <listitem> 725 <para>This is a heading that is displayed in the viewing area of 726 the page. 727 </para> 728 </listitem> 729 </varlistentry> 730 <varlistentry> 731 <term>$g_favicon_image</term> 732 <listitem> 733 <para>Path to the favorites icon relative to MantisBT root folder (default 'images/favicon.ico').</para> 734 </listitem> 735 </varlistentry> 736 <varlistentry> 737 <term>$g_logo_image</term> 738 <listitem> 739 <para>Path to the logo image relative to MantisBT root folder (default 'images/mantis_logo.gif').</para> 740 </listitem> 741 </varlistentry> 742 <varlistentry> 743 <term>$g_logo_url</term> 744 <listitem> 745 <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> 746 </listitem> 747 </varlistentry> 748 <varlistentry> 749 <term>$g_show_footer_menu</term> 750 <listitem> 751 <para>Show the menu at the bottom of the page as well as at the 752 top. Default value is OFF. 753 </para> 754 </listitem> 755 </varlistentry> 756 <varlistentry> 757 <term>$g_show_project_menu_bar</term> 758 <listitem> 759 <para>This option specifies whether to add menu at the top of the 760 page which includes links to all the projects. The default value is 761 OFF. 762 </para> 763 </listitem> 764 </varlistentry> 765 <varlistentry> 766 <term>$g_show_assigned_names</term> 767 <listitem> 768 <para>When a bug is assigned then replace the word "assigned" with 769 the name of the developer in parenthesis. Default is ON. 770 </para> 771 </listitem> 772 </varlistentry> 773 <varlistentry> 774 <term>$g_show_priority_text</term> 775 <listitem> 776 <para>Specifies whether to show priority as text (ON) or icon 777 (OFF) in the view all bugs page. Default is OFF (icon). 778 </para> 779 </listitem> 780 </varlistentry> 781 <varlistentry> 782 <term>$g_priority_significant_threshold</term> 783 <listitem> 784 <para>Define the priority level at which a bug becomes 785 significant. Significant bugs are displayed with 786 emphasis. Set this value to -1 to disable the feature. 787 The default value is HIGH. 788 </para> 789 </listitem> 790 </varlistentry> 791 <varlistentry> 792 <term>$g_severity_significant_threshold</term> 793 <listitem> 794 <para>Define the severity level at which a bug becomes 795 significant. Significant bugs are displayed with 796 emphasis. Set this value to -1 to disable the feature. 797 The default value is MAJOR. 798 </para> 799 </listitem> 800 </varlistentry> 801 <varlistentry> 802 <term>$g_view_issues_page_columns</term> 803 <listitem> 804 <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> 805 <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, 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> 806 <para>By default the following columns are selected: selection, edit, priority, id, sponsorship_total, bugnotes_count, attachment, category_id, severity, status, last_updated, summary.</para> 807 </listitem> 808 </varlistentry> 809 <varlistentry> 810 <term>$g_print_issues_page_columns</term> 811 <listitem> 812 <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> 813 <para>By default the following columns are selected: selection, priority, id, sponsorship_total, bugnotes_count, attachment, category_id, severity, status, last_updated, summary</para> 814 </listitem> 815 </varlistentry> 816 <varlistentry> 817 <term>$g_csv_columns</term> 818 <listitem> 819 <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> 820 <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> 821 </listitem> 822 </varlistentry> 823 <varlistentry> 824 <term>$g_excel_columns</term> 825 <listitem> 826 <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> 827 <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> 828 </listitem> 829 </varlistentry> 830 <varlistentry> 831 <term>$g_show_bug_project_links</term> 832 <listitem> 833 <para>Show project links when in All Projects mode. Default is 834 ON. 835 </para> 836 </listitem> 837 </varlistentry> 838 <varlistentry> 839 <term>$g_status_legend_position</term> 840 <listitem> 841 <para>Specifies the position of the status colour legend, can be: 842 STATUS_LEGEND_POSITION_TOP or STATUS_LEGEND_POSITION_BOTTOM. 843 Default is STATUS_LEGEND_POSITION_BOTTOM. 844 </para> 845 </listitem> 846 </varlistentry> 847 <varlistentry> 848 <term>$g_show_attachments_indicator</term> 849 <listitem> 850 <para>In view all bug page, show a clip icon next to bugs that has 851 one or more attachments. The default value is OFF. 852 The reason why this is defaulted to OFF is that it adds an extra 853 query for every bug displayed in the list. 854 </para> 855 </listitem> 856 </varlistentry> 857 <varlistentry> 858 <term>$g_show_product_version</term> 859 <listitem> 860 <para>This controls display of the product version in the 861 report, view, update and print issue pages. This flag also applies 862 to other product version related fields like product build, fixed in version, 863 and target version. Valid values are ON, OFF, and AUTO. 864 ON for always displayed, AUTO for displayed when project has versions defined, and OFF for 865 always OFF. The default value is AUTO. 866 </para> 867 </listitem> 868 </varlistentry> 869 <varlistentry> 870 <term>$g_show_version_dates_threshold</term> 871 <listitem> 872 <para>The access level threshold at which users will see 873 the date of release for product versions. Dates will 874 be shown next to the product version, target version 875 and fixed in version fields. Set this threshold to 876 NOBODY to disable the feature. Default value is NOBODY. 877 </para> 878 </listitem> 879 </varlistentry> 880 <varlistentry> 881 <term>$g_show_realname</term> 882 <listitem> 883 <para>This control will replace the user's userid with their 884 realname. If it is set to ON, and the real name field has been 885 populated, the replacement will occur. It defaults to OFF. 886 </para> 887 </listitem> 888 </varlistentry> 889 <varlistentry> 890 <term>$g_show_avatar</term> 891 <listitem> 892 <para>Show user avatar (default OFF); the current implementation is based on http://www.gravatar.com, 893 users will need to register there with the same email address used in 894 this MantisBT installation to have their avatar shown.</para> 895 <note><para>Upon registration or avatar change, it takes some time for the updated gravatar images to show on sites.</para></note> 896 </listitem> 897 </varlistentry> 898 <varlistentry> 899 <term>$g_show_avatar_threshold</term> 900 <listitem> 901 <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> 902 </listitem> 903 </varlistentry> 904 <varlistentry> 905 <term>$g_default_avatar</term> 906 <listitem> 907 <para>The full URL to the image to be used when a user doesn't have an avatar account.</para> 908 </listitem> 909 </varlistentry> 910 </variablelist> 911 </section> 912 913 <section id="admin.config.time"> 914 <title>Time</title> 915 916 <variablelist> 917 <varlistentry> 918 <term>$g_cookie_time_length</term> 919 <listitem> 920 <para>Time for 'permanent' cookie to live in seconds. This is what 921 is used when a user selects "save login". Default is the equivalent 922 of 1 year (30000000). 923 </para> 924 </listitem> 925 </varlistentry> 926 <varlistentry> 927 <term>$g_wait_time</term> 928 <listitem> 929 <para>Time to delay between page redirects (in seconds). Users can 930 override this setting in their user preferences. Default is 2 931 seconds. 932 </para> 933 </listitem> 934 </varlistentry> 935 <varlistentry> 936 <term>$g_content_expire</term> 937 <listitem> 938 <para>Time to wait before document is stale (in minutes). This is 939 used in meta_inc.php. Default is 0 (expires right away). 940 </para> 941 </listitem> 942 </varlistentry> 943 <varlistentry> 944 <term>$g_long_process_timeout</term> 945 <listitem> 946 <para>This timeout is used by pages which does time consuming 947 operations like upgrading the database. The default value of 0 948 disables timeout. Note that this timeout is specified in 949 seconds. 950 </para> 951 </listitem> 952 </varlistentry> 953 </variablelist> 954 955 </section> 956 957 <section id="admin.config.date"> 958 <title>Date</title> 959 <para>These variables control how the date is displayed (default 960 is 'US' formatting). Go to the 961 <ulink url="http://www.php.net/manual/en/function.date.php">date()</ulink> 962 function in PHP online manual for detailed instructions on date 963 formatting. 964 </para> 965 966 <variablelist> 967 <varlistentry> 968 <term>$g_short_date_format</term> 969 <listitem> 970 <para>This format is used in the bug listing pages (eg: View 971 Bugs). Default is 'm-d-y'. 972 </para> 973 </listitem> 974 </varlistentry> 975 <varlistentry> 976 <term>$g_normal_date_format</term> 977 <listitem> 978 <para>This format is used in the view/update bug pages, bug notes, 979 manage section, and news section. Default is 'm-d-y H:i'. 980 </para> 981 </listitem> 982 </varlistentry> 983 <varlistentry> 984 <term>$g_complete_date_format</term> 985 <listitem> 986 <para>This format is used on the top of each page (current time) 987 and the emails that are sent out. Default is 'm-d-y H:i T'. 988 </para> 989 </listitem> 990 </varlistentry> 991 992 </variablelist> 993 994 </section> 995 996 997 <section id="admin.config.news"> 998 <title>News</title> 999 <para>These options are used to control the query that selects the 1000 news entries to be displayed. 1001 </para> 1002 1003 <variablelist> 1004 <varlistentry> 1005 <term>$g_news_enabled</term> 1006 <listitem> 1007 <para>Indicates whether the news feature should be enabled or disabled. 1008 The default is OFF. The news feature is deprecated in favor of 1009 being moved to a plugin. 1010 </para> 1011 </listitem> 1012 </varlistentry> 1013 <varlistentry> 1014 <term>$g_news_limit_method</term> 1015 <listitem> 1016 <para>Limit the news entry that are displayed by number of entries 1017 (BY_LIMIT) or by date (BY_DATE). The default is BY_LIMIT. 1018 </para> 1019 </listitem> 1020 </varlistentry> 1021 <varlistentry> 1022 <term>$g_news_view_limit</term> 1023 <listitem> 1024 <para>The limit for the number of news entries to be displayed. 1025 This option is only used if $g_news_limit_method is set to 1026 BY_LIMIT. 1027 </para> 1028 </listitem> 1029 </varlistentry> 1030 <varlistentry> 1031 <term>$g_news_view_limit_days</term> 1032 <listitem> 1033 <para>Specifies the number of dates after which the news are not 1034 displayed. This option is only used if $g_news_limit_method is set 1035 to BY_DATE. 1036 </para> 1037 </listitem> 1038 </varlistentry> 1039 <varlistentry> 1040 <term>$g_private_news_threshold</term> 1041 <listitem> 1042 <para>Specifies the access level required to view private news. 1043 The default is DEVELOPER. 1044 </para> 1045 </listitem> 1046 </varlistentry> 1047 </variablelist> 1048 </section> 1049 1050 1051 <section id="admin.config.defaults"> 1052 <title>Default Preferences</title> 1053 <variablelist> 1054 <varlistentry> 1055 <term>$g_default_new_account_access_level</term> 1056 <listitem> 1057 <para>This is the default access level users are given when their 1058 account is created by email. The default access level is REPORTER. 1059 Look in constant_inc.php for other values. 1060 </para> 1061 </listitem> 1062 </varlistentry> 1063 <varlistentry> 1064 <term>$g_default_bug_view_status</term> 1065 <listitem> 1066 <para>The default viewing status for the new bug (VS_PUBLIC or 1067 VS_PRIVATE). The default is VS_PUBLIC. 1068 </para> 1069 </listitem> 1070 </varlistentry> 1071 <varlistentry> 1072 <term>$g_default_bugnote_view_status</term> 1073 <listitem> 1074 <para>The default viewing status for the new bugnote (VS_PUBLIC or 1075 VS_PRIVATE). The default is VS_PUBLIC. 1076 </para> 1077 </listitem> 1078 </varlistentry> 1079 <varlistentry> 1080 <term>$g_default_reminder_view_status</term> 1081 <listitem> 1082 <para>The default viewing status for the new reminders (VS_PUBLIC 1083 or VS_PRIVATE). The default is VS_PUBLIC. 1084 </para> 1085 </listitem> 1086 </varlistentry> 1087 <varlistentry> 1088 <term>$g_reminder_receive_threshold</term> 1089 <listitem> 1090 <para>The minimum access level for a user to show up in the reminder user picker. 1091 Note that this is the access level for the project for which the issue belongs. 1092 The default is DEVELOPER. 1093 </para> 1094 </listitem> 1095 </varlistentry> 1096 <varlistentry> 1097 <term>$g_default_bug_resolution</term> 1098 <listitem> 1099 <para>The resolution for a newly created issue. The default 1100 is OPEN. Look in constant_inc.php for other values. 1101 </para> 1102 </listitem> 1103 </varlistentry> 1104 <varlistentry> 1105 <term>$g_default_bug_severity</term> 1106 <listitem> 1107 <para>The severity for a newly created issue. The default is 1108 MINOR. Look in constant_inc.php for other values. 1109 </para> 1110 </listitem> 1111 </varlistentry> 1112 <varlistentry> 1113 <term>$g_default_bug_priority</term> 1114 <listitem> 1115 <para>The priority for a newly created issue. The default is 1116 NORMAL. Look in constant_inc.php for other values. 1117 </para> 1118 </listitem> 1119 </varlistentry> 1120 <varlistentry> 1121 <term>$g_default_bug_reproducibility</term> 1122 <listitem> 1123 <para>The reproducibility for a newly created issue. The 1124 default is REPRODUCIBILITY_HAVENOTTRIED. Look in 1125 constant_inc.php for other values. 1126 </para> 1127 </listitem> 1128 </varlistentry> 1129 <varlistentry> 1130 <term>$g_default_bug_projection</term> 1131 <listitem> 1132 <para>The projection for a newly created issue. The default 1133 is PROJECTION_NONE. Look in constant_inc.php for other 1134 values. 1135 </para> 1136 </listitem> 1137 </varlistentry> 1138 <varlistentry> 1139 <term>$g_default_bug_eta</term> 1140 <listitem> 1141 <para>The ETA for a newly created issue. The default is 1142 ETA_NONE. Look in constant_inc.php for other values. 1143 </para> 1144 </listitem> 1145 </varlistentry> 1146 <varlistentry> 1147 <term>$g_default_category_for_moves</term> 1148 <listitem> 1149 <para> 1150 Default global category to be used when an issue is moved from a project to another 1151 that doesn't have a category with a matching name. The default is 1 which is the "General" 1152 category that is created in the default database. 1153 </para> 1154 </listitem> 1155 </varlistentry> 1156 <varlistentry> 1157 <term>$g_default_limit_view</term> 1158 <listitem> 1159 <para>Number of bugs to show in the View Bugs page. The default 1160 value is 50. 1161 </para> 1162 </listitem> 1163 </varlistentry> 1164 <varlistentry> 1165 <term>$g_default_show_changed</term> 1166 <listitem> 1167 <para>Highlight bugs that have changed during the last N hours. 1168 The default value is 6. 1169 </para> 1170 </listitem> 1171 </varlistentry> 1172 <varlistentry> 1173 <term>$g_hide_status_default</term> 1174 <listitem> 1175 <para>Controls which issues will be displayed in the View Issues 1176 page. Default value is CLOSED, implying that all issues at "closed" 1177 or higher state will not be shown. 1178 </para> 1179 </listitem> 1180 </varlistentry> 1181 <varlistentry> 1182 <term>$g_min_refresh_delay</term> 1183 <listitem> 1184 <para>This is the delay between automatic refreshes of the View 1185 Issues page in minutes. Make sure refresh delay in user preferences isn't too 1186 short. If a users set their preferences to be lower then it is 1187 bumped back up to this minimum value. The default value is 10 1188 minutes. 1189 </para> 1190 </listitem> 1191 </varlistentry> 1192 </variablelist> 1193 <para> 1194 These settings are used as the default values for preferences for 1195 new users. Each user can override these settings through the user 1196 preferences form. Default language is set to default site language 1197 ($g_default_language). 1198 </para> 1199 <variablelist> 1200 <varlistentry> 1201 <term>$g_default_refresh_delay</term> 1202 <listitem> 1203 <para>Default page refresh delay (in minutes). This is for the bug 1204 listing pages. Default value is 30 minutes. 1205 </para> 1206 </listitem> 1207 </varlistentry> 1208 <varlistentry> 1209 <term>$g_default_redirect_delay</term> 1210 <listitem> 1211 <para>Default delay before a user is redirected to a page after 1212 being prompted by a message (eg: operational successful). Default 1213 value is 2 seconds. 1214 </para> 1215 </listitem> 1216 </varlistentry> 1217 <varlistentry> 1218 <term>$g_default_bugnote_order</term> 1219 <listitem> 1220 <para>This controls the time order in which bug notes are 1221 displayed. It can be either ASC (oldest first, the default) or DESC 1222 (newest first). 1223 </para> 1224 </listitem> 1225 </varlistentry> 1226 <varlistentry> 1227 <term>$g_default_email_on_new$g_default_email_on_assigned$g_default_email_on_feedback$g_default_email_on_resolved$g_default_email_on_closed</term> 1228 <listitem> 1229 <para>Default user preferences to enable receiving emails when a 1230 bug is set to the corresponding status. This option only has an 1231 effect if users have the required access level to receive such 1232 emails. Default value is ON. 1233 </para> 1234 </listitem> 1235 </varlistentry> 1236 <varlistentry> 1237 <term>$g_default_email_on_reopened</term> 1238 <listitem> 1239 <para>Default user preferences to enable receiving emails when 1240 bugs are re-opened. Default value is ON. 1241 </para> 1242 </listitem> 1243 </varlistentry> 1244 <varlistentry> 1245 <term>$g_default_email_on_bugnote</term> 1246 <listitem> 1247 <para>Default user preferences to enable receiving emails when 1248 bugnotes are added to bugs. Default value is ON. 1249 </para> 1250 </listitem> 1251 </varlistentry> 1252 <varlistentry> 1253 <term>$g_default_email_on_status$g_default_email_on_priority</term> 1254 <listitem> 1255 <para>Default user preferences to enable receiving emails when 1256 status or priority is changed. Default is ON. Note that this option 1257 is not implemented. 1258 </para> 1259 </listitem> 1260 </varlistentry> 1261 <varlistentry> 1262 <term>$g_default_email_on_new_minimum_severity$g_default_email_on_assigned_minimum_severity$g_default_email_on_feedback_minimum_severity$g_default_email_on_resolved_minimum_severity$g_default_email_on_closed_minimum_severity$g_default_email_on_reopened_minimum_severity$g_default_email_on_bugnote_minimum_severity</term> 1263 <listitem> 1264 <para>Default user preferences to enable filtering based on issue 1265 severity. These correspond to the email_on_<status> settings. 1266 Default is 'any'. 1267 </para> 1268 </listitem> 1269 </varlistentry> 1270 <varlistentry> 1271 <term>$g_default_email_on_bugnote_minimum_severity</term> 1272 <listitem> 1273 <para>Default user preference to enable filtering based on issue 1274 severity. These corresponds to the email_on_bugnote setting. 1275 Default is 'any'. 1276 </para> 1277 </listitem> 1278 </varlistentry> 1279 <varlistentry> 1280 <term>$g_default_email_on_status_minimum_severity$g_default_email_on_priority_minimum_severity</term> 1281 <listitem> 1282 <para>Default user preferences to enable filtering based on issue 1283 severity. These correspond to the email_on_status and 1284 email_on_priority settings. Default is 'any'. Note that this option 1285 is not yet implemented. 1286 </para> 1287 </listitem> 1288 </varlistentry> 1289 </variablelist> 1290 <para>See also: 1291 <xref linkend="admin.customize.email" /> 1292 </para> 1293 </section> 1294 1295 1296 <section id="admin.config.summary"> 1297 <title>Summary</title> 1298 <para>These are the settings that are used to configuration 1299 options related to the Summary page. This page contains statistics 1300 about the bugs in MantisBT. 1301 </para> 1302 <variablelist> 1303 <varlistentry> 1304 <term>$g_reporter_summary_limit</term> 1305 <listitem> 1306 <para>Limit how many reporters to show in the summary page. This 1307 is useful when there are dozens or hundreds of reporters. The 1308 default value is 10. 1309 </para> 1310 </listitem> 1311 </varlistentry> 1312 <varlistentry> 1313 <term>$g_date_partitions</term> 1314 <listitem> 1315 <para>An array of date lengths to count bugs by (in days) for the 1316 summary by date. The default is to count for 1, 2, 3, 7, 30, 60, 1317 90, 180, and 365. 1318 </para> 1319 </listitem> 1320 </varlistentry> 1321 <varlistentry> 1322 <term>$g_summary_category_include_project</term> 1323 <listitem> 1324 <para>Specifies whether category names should be preceded by 1325 project names (eg: [Project] Category) when the summary page is 1326 viewed for all projects. This is useful in the case where category 1327 names are common across projects. The default is OFF. 1328 </para> 1329 </listitem> 1330 </varlistentry> 1331 <varlistentry> 1332 <term>$g_view_summary_threshold</term> 1333 <listitem> 1334 <para>Specifies the access level required to view the summary 1335 page. Default is VIEWER. 1336 </para> 1337 </listitem> 1338 </varlistentry> 1339 <varlistentry> 1340 <term>$g_severity_multipliers</term> 1341 <listitem> 1342 <para>An array of multipliers which are used to determine 1343 the effectiveness of reporters based on the severity of 1344 bugs. Higher multipliers will result in an increase in 1345 reporter effectiveness. The default multipliers are: 1346 <programlisting>$g_severity_multipliers = array ( FEATURE => 1, 1347 TRIVIAL => 2, 1348 TEXT => 3, 1349 TWEAK => 2, 1350 MINOR => 5, 1351 MAJOR => 8, 1352 CRASH => 8, 1353 BLOCK => 10 ); 1354 </programlisting> 1355 The keys of the array are severity constants from 1356 constant_inc.php or from custom_constants_inc.php if 1357 you have custom severities defined. The values are 1358 integers, typically in the range of 0 to 10. If you 1359 would like for a severity to not count towards 1360 effectiveness, set the value to 0 for that severity. 1361 </para> 1362 </listitem> 1363 </varlistentry> 1364 <varlistentry> 1365 <term>$g_resolution_multipliers</term> 1366 <listitem> 1367 <para>An array of multipliers which are used to determine 1368 the effectiveness of reporters based on the resolution 1369 of bugs. Higher multipliers will result in a decrease 1370 in reporter effectiveness. The only resolutions that 1371 need to be defined here are those which match or exceed 1372 $g_bug_resolution_not_fixed_threshold. The default 1373 multipliers are: 1374 <programlisting>$g_resolution_multipliers = array( UNABLE_TO_DUPLICATE => 2, 1375 NOT_FIXABLE => 1, 1376 DUPLICATE => 3, 1377 NOT_A_BUG => 5, 1378 SUSPENDED => 1, 1379 WONT_FIX => 1 ); 1380 </programlisting> 1381 The keys of the array are resolution constants from 1382 constant_inc.php or from custom_constants_inc.php if 1383 you have custom resolutions defined. Resolutions not 1384 included here will be assumed to have a multiplier 1385 value of 0. The values are integers, typically in the 1386 range of 0 to 10. If you would like for a resolution to 1387 not count towards effectiveness, set the value to 0 for 1388 that resolution or remove it from the array completely. 1389 Note that these resolution multipliers are stacked on 1390 top of the severity multipliers. Therefore by default, 1391 a user reporting many duplicate bugs at severity level 1392 BLOCK will be far worse off than a user reporting many 1393 duplicate bugs at severity level FEATURE. 1394 </para> 1395 </listitem> 1396 </varlistentry> 1397 </variablelist> 1398 1399 </section> 1400 1401 1402 <section id="admin.config.bugnote"> 1403 <title>Bugnote</title> 1404 <variablelist> 1405 1406 <varlistentry> 1407 <term>$g_bugnote_order</term> 1408 <listitem> 1409 <para>Order to use for sorting bugnotes by submit date. Possible 1410 values include ASC for ascending and DESC for descending order. The 1411 default value is ASC. 1412 </para> 1413 </listitem> 1414 </varlistentry> 1415 </variablelist> 1416 1417 </section> 1418 1419 1420 <section id="admin.config.uploads"> 1421 <title>File Upload</title> 1422 1423 <para>MantisBT allows users to upload file attachments and 1424 associate them with bugs as well as projects. Bug attachments / 1425 project documents can be uploaded to the webserver, database or an 1426 FTP server. When bugs are uploaded to the webserver they are 1427 uploaded to the path that is configured in the project 1428 properties. In case of problems getting the file upload feature to 1429 work, check the following resources: 1430 <ulink url="http://www.php.net/manual/en/features.file-upload.php">PHP 1431 Manual 1432 </ulink> 1433 . 1434 </para> 1435 1436 <variablelist> 1437 <varlistentry> 1438 <term>$g_allow_file_upload</term> 1439 <listitem> 1440 <para>Whether to allow/disallow uploading of attachments. Default 1441 value is ON. 1442 </para> 1443 </listitem> 1444 </varlistentry> 1445 <varlistentry> 1446 <term>$g_file_upload_method</term> 1447 <listitem> 1448 <para>Specify the location for uploading attachments. This can be 1449 DISK, DATABASE, or FTP. In case of FTP, the files are saved on the 1450 webserver (same as disk) as well as on the specified FTP server. 1451 Default value is DATABASE. 1452 In case of DISK / FTP upload methods you need to provide the 1453 webserver with write access rights to the configured upload path 1454 (configured in the project) and temporary upload path (used by 1455 PHP). 1456 </para> 1457 </listitem> 1458 </varlistentry> 1459 <varlistentry> 1460 <term>$g_max_file_size</term> 1461 <listitem> 1462 <para>The maximum file size to allow as an attachment. 1463 You may also have to configure your php.ini file to increase the 1464 execution time, memory limit, max post size, and max upload size. 1465 </para> 1466 </listitem> 1467 </varlistentry> 1468 <varlistentry> 1469 <term>$g_file_upload_ftp_server</term> 1470 <listitem> 1471 <para>Address of the FTP server to write to (eg: ftp.example.com). 1472 This option is only effective if upload method is FTP. 1473 </para> 1474 </listitem> 1475 </varlistentry> 1476 <varlistentry> 1477 <term>$g_file_upload_ftp_user</term> 1478 <listitem> 1479 <para>FTP user name for account to be used in uploading files to 1480 the FTP server. This account must have read/write access to the FTP 1481 server. The default path for the account is used for uploading the 1482 files. 1483 </para> 1484 </listitem> 1485 </varlistentry> 1486 <varlistentry> 1487 <term>$g_file_upload_ftp_pass</term> 1488 <listitem> 1489 <para>Password to use when logging in to the FTP server.</para> 1490 </listitem> 1491 </varlistentry> 1492 <varlistentry> 1493 <term>$g_max_file_size</term> 1494 <listitem> 1495 <para>Maximum file size that can be uploaded. Default value is 1496 about 5MB. 1497 The max file upload size is also affected by the value specified in 1498 php.ini. The PHP value is usually defaulted to 2MB. 1499 </para> 1500 </listitem> 1501 </varlistentry> 1502 <varlistentry> 1503 <term>$g_allowed_files</term> 1504 <listitem> 1505 <para>Files that are allowed. Separate items by commas. eg. 1506 "zip,bmp,gif,jpg,txt" If $g_allowed_files is filled in NO other 1507 file types will be allowed. If empty it will assume any files are 1508 accepted that pass the $g_disallowed_files list. 1509 </para> 1510 </listitem> 1511 </varlistentry> 1512 <varlistentry> 1513 <term>$g_disallowed_files</term> 1514 <listitem> 1515 <para>Files that are not allowed. Separate items by commas. eg. 1516 "php,php3,phtml,html,class,java,exe,pl" $g_disallowed_files takes 1517 precedence over $g_allowed_files. 1518 It is recommended to disable all extensions that can be executed by 1519 your server. 1520 </para> 1521 </listitem> 1522 </varlistentry> 1523 <varlistentry> 1524 <term>$g_document_files_prefix</term> 1525 <listitem> 1526 <para>Prefix to give to uploaded files when saved to the upload 1527 directory. This is used for documents that are attached to projects 1528 in order to be able to differentiate them from files that are 1529 attached to bugs. The name of the file has the following format 1530 prefix-projectcode-filename. The default value is 'doc'. 1531 </para> 1532 </listitem> 1533 </varlistentry> 1534 <varlistentry> 1535 <term>$g_preview_attachments_inline_max_size</term> 1536 <listitem> 1537 <para>This limit applies to previewing of image / text attachments. 1538 If the attachment size is smaller than the specified value, the attachment 1539 is previewed with the issue details. The previewing can be disabled 1540 by setting this configuration to 0. The default value is 256 * 1024 (256KB). 1541 </para> 1542 </listitem> 1543 </varlistentry> 1544 <varlistentry> 1545 <term>$g_fileinfo_magic_db_file</term> 1546 <listitem> 1547 <para>Specify the filename of the magic database file. 1548 This is used by PHP 5.3.0 (or earlier versions with the 1549 fileinfo PECL extension) to guess what the MIME type of a 1550 file is. Usually it is safe to leave this setting as the 1551 default (blank) as PHP is usually able to find this file 1552 by itself. 1553 </para> 1554 </listitem> 1555 </varlistentry> 1556 <varlistentry> 1557 <term>$g_file_download_xsendfile_enabled</term> 1558 <listitem> 1559 <para>Enable support for sending files to users via a more efficient 1560 X-Sendfile method. HTTP server software supporting this technique 1561 includes Lighttpd, Cherokee, Apache with mod_xsendfile and nginx. 1562 You may need to set the proceeding file_download_xsendfile_header_name 1563 option to suit the server you are using. 1564 </para> 1565 </listitem> 1566 </varlistentry> 1567 <varlistentry> 1568 <term>$g_file_download_xsendfile_header_name</term> 1569 <listitem> 1570 <para>The name of the X-Sendfile header to use. Each server tends to 1571 implement this functionality in a slightly different way and thus 1572 the naming conventions for the header differ between each server. 1573 Lighttpd from v1.5, Apache with mod_xsendfile and Cherokee web 1574 servers use X-Sendfile. nginx uses X-Accel-Redirect and Lighttpd 1575 v1.4 uses X-LIGHTTPD-send-file. 1576 </para> 1577 </listitem> 1578 </varlistentry> 1579 </variablelist> 1580 1581 </section> 1582 1583 1584 <section id="admin.config.html"> 1585 <title>HTML</title> 1586 1587 <variablelist> 1588 <varlistentry> 1589 <term>$g_html_tags</term> 1590 <listitem> 1591 <para>This is the list of HTML tags that are allowed.Do NOT 1592 include href or img tags here.Do NOT include tags that have 1593 parameters (eg. )The HTML code is allowed to enter the database as 1594 is. The $g_allow_href_tags does not have to be enabled to make URL 1595 links. The package will automatically hyperlink properly formatted 1596 URLs eg. http://blah.blah/ or 1597 mailto://me@more.com/  1598 </para> 1599 </listitem> 1600 </varlistentry> 1601 <varlistentry> 1602 <term>$g_hr_size</term> 1603 <listitem> 1604 <para>hr size.</para> 1605 </listitem> 1606 </varlistentry> 1607 <varlistentry> 1608 <term>$g_hr_width</term> 1609 <listitem> 1610 <para>hr width. Leave off the percentage (%) symbol.</para> 1611 </listitem> 1612 </varlistentry> 1613 <varlistentry> 1614 <term>$g_bottom_include_page</term> 1615 <listitem> 1616 <para>If this page exists it will be displayed at the bottom of 1617 every page. It makes a good company branding include page. 1618 </para> 1619 </listitem> 1620 </varlistentry> 1621 <varlistentry> 1622 <term>$g_top_include_page</term> 1623 <listitem> 1624 <para>If this page exists it will be displayed at the top of every 1625 page. It makes a good company branding include page. 1626 </para> 1627 </listitem> 1628 </varlistentry> 1629 <varlistentry> 1630 <term>$g_css_include_file</term> 1631 <listitem> 1632 <para>Set this to point to the CSS file of your choice.</para> 1633 </listitem> 1634 </varlistentry> 1635 <varlistentry> 1636 <term>$g_css_rtl_include_file</term> 1637 <listitem> 1638 <para>Set this to point to the RTL CSS file of your choice.</para> 1639 </listitem> 1640 </varlistentry> 1641 <varlistentry> 1642 <term>$g_meta_include_file</term> 1643 <listitem> 1644 <para>Set this to point to the META tag file of your 1645 choice. 1646 </para> 1647 </listitem> 1648 </varlistentry> 1649 <varlistentry> 1650 <term>$g_main_menu_custom_options</term> 1651 <listitem> 1652 <para>This option will add custom options to the main menu. It is 1653 an array of arrays listing the caption, access level required, and 1654 the link to be executed. For example: 1655 $g_main_menu_custom_options = array( array( "My Link", MANAGER, 1656 'my_link.php' ), array( "My Link2", ADMINISTRATOR, 'my_link2.php' ) 1657 ); 1658 Note that if the caption is found in custom_strings_inc.php, then 1659 it will be replaced by the translated string. Options will only be 1660 added to the menu if the current logged in user has the appropriate 1661 access level. 1662 </para> 1663 </listitem> 1664 </varlistentry> 1665 </variablelist> 1666 </section> 1667 1668 <section id="admin.config.auth"> 1669 <title>Authentication</title> 1670 <variablelist> 1671 <varlistentry> 1672 <term>$g_login_method</term> 1673 <listitem><para> 1674 <itemizedlist> 1675 <listitem> 1676 <para>MD5</para> 1677 </listitem> 1678 <listitem> 1679 <para>LDAP</para> 1680 </listitem> 1681 <listitem> 1682 <para>PLAIN</para> 1683 </listitem> 1684 <listitem> 1685 <para>CRYPT</para> 1686 </listitem> 1687 <listitem> 1688 <para>CRYPT_FULL_SALT</para> 1689 </listitem> 1690 <listitem> 1691 <para>BASIC_AUTH</para> 1692 </listitem> 1693 <listitem> 1694 <para>Some systems (mostly non-unix) do not have crypt support 1695 in PHP. MD5 will accomplish almost the same thing. PLAIN is plain 1696 text and there is no attempt to secure the password in the 1697 database. You will not be able to easily convert between encryption 1698 methods so this needs to be chosen at install time. MD5 is the default. 1699 </para> 1700 </listitem> 1701 </itemizedlist> 1702 </para> 1703 </listitem> 1704 </varlistentry> 1705 <varlistentry> 1706 <term>$g_reauthentication</term> 1707 <listitem> 1708 <para>TODO</para> 1709 </listitem> 1710 </varlistentry> 1711 <varlistentry> 1712 <term>$g_reauthentication_expiry</term> 1713 <listitem> 1714 <para>TODO</para> 1715 </listitem> 1716 </varlistentry> 1717 </variablelist> 1718 1719 <para>LDAP authentication method parameters</para> 1720 1721 <variablelist> 1722 <varlistentry> 1723 <term>$g_ldap_server</term> 1724 <listitem> 1725 <para>The ldap server (eg: ldaps://ldap.example.com).</para> 1726 </listitem> 1727 </varlistentry> 1728 <varlistentry> 1729 <term>$g_ldap_port</term> 1730 <listitem> 1731 <para>LDAP port (default 389). If this doesn't work, try 389.</para> 1732 </listitem> 1733 </varlistentry> 1734 <varlistentry> 1735 <term>$g_ldap_protocol_version</term> 1736 <listitem> 1737 <para> 1738 The LDAP Protocol Version, if 0, then the protocol version is not set. Default is 0. 1739 For Active Directory use protocol version 3. 1740 </para> 1741 </listitem> 1742 </varlistentry> 1743 <varlistentry> 1744 <term>$g_ldap_follow_referrals</term> 1745 <listitem> 1746 <para> 1747 Determines whether the LDAP library automatically follows referrals returned by LDAP servers or not. 1748 This maps to LDAP_OPT_REFERRALS ldap library option. For Active Directory, this should be set to OFF. 1749 Default value is ON. 1750 </para> 1751 </listitem> 1752 </varlistentry> 1753 <varlistentry> 1754 <term>$g_ldap_root_dn</term> 1755 <listitem> 1756 <para>The root distinguished name. For example, "dc=example, dc=com".</para> 1757 </listitem> 1758 </varlistentry> 1759 <varlistentry> 1760 <term>$g_ldap_organization</term> 1761 <listitem> 1762 <para>The organization. For example, "organizationname=*Example)". Default value is ''.</para> 1763 </listitem> 1764 </varlistentry> 1765 <varlistentry> 1766 <term>$g_ldap_uid_field</term> 1767 <listitem> 1768 <para>The LDAP field for user id. The default value is 'uid'. For Active Directory, set to 'sAMAccountName'.</para> 1769 </listitem> 1770 </varlistentry> 1771 <varlistentry> 1772 <term>$g_ldap_realname_field</term> 1773 <listitem> 1774 <para>The LDAP field for real name (i.e. common name). Default value is 'cn'.</para> 1775 </listitem> 1776 </varlistentry> 1777 <varlistentry> 1778 <term>$g_use_ldap_email</term> 1779 <listitem> 1780 <para>Use email address in LDAP rather than the email stored in 1781 the database. 1782 </para> 1783 </listitem> 1784 </varlistentry> 1785 <varlistentry> 1786 <term>$g_use_ldap_realname</term> 1787 <listitem> 1788 <para>Use realname in LDAP rather than the email stored in the database. 1789 ON for LDAP, OFF for database. The default value is OFF. 1790 </para> 1791 </listitem> 1792 </varlistentry> 1793 <varlistentry> 1794 <term>$g_ldap_bind_dn</term> 1795 <listitem> 1796 <para> 1797 The distinguished of the user account to use for binding to the LDAP server. 1798 For example, 'CN=ldap,OU=Administrators,DC=example,DC=com'. 1799 </para> 1800 </listitem> 1801 </varlistentry> 1802 <varlistentry> 1803 <term>$g_ldap_bind_passwd</term> 1804 <listitem> 1805 <para>The password for the service account to be used for connecting to the LDAP server.</para> 1806 </listitem> 1807 </varlistentry> 1808 <varlistentry> 1809 <term>$g_ldap_simulation_file_path</term> 1810 <listitem> 1811 <para> 1812 For development purposes, this is a configuration option that allows replacing 1813 the ldap communication with a comma separated text file. The text file has a line 1814 per user. Each line includes: user name, user real name, email, password. 1815 For production systems this option should be set to ''. 1816 </para> 1817 </listitem> 1818 </varlistentry> 1819 </variablelist> 1820 </section> 1821 1822 <section id="admin.config.status"> 1823 <title>Status Settings</title> 1824 1825 1826 <variablelist> 1827 <varlistentry> 1828 <term>$g_bug_submit_status</term> 1829 <listitem> 1830 <para>Status to assign to the bug when submitted. Default value is 1831 NEW_. 1832 </para> 1833 </listitem> 1834 </varlistentry> 1835 <varlistentry> 1836 <term>$g_bug_assigned_status</term> 1837 <listitem> 1838 <para>Status to assign to the bug when assigned. Default value is 1839 ASSIGNED. 1840 </para> 1841 </listitem> 1842 </varlistentry> 1843 <varlistentry> 1844 <term>$g_bug_reopen_status</term> 1845 <listitem> 1846 <para>Status to assign to the bug when reopened. Default value is 1847 FEEDBACK. 1848 </para> 1849 </listitem> 1850 </varlistentry> 1851 <varlistentry> 1852 <term>$g_bug_feedback_status</term> 1853 <listitem> 1854 <para> 1855 Status to assign to the bug when feedback is required from the issue reporter. 1856 Once the reporter adds a note the status moves back from feedback to $g_bug_assigned_status 1857 or $g_bug_submit_status based on whether the bug assigned or not. 1858 </para> 1859 </listitem> 1860 </varlistentry> 1861 <varlistentry> 1862 <term>$g_reassign_on_feedback</term> 1863 <listitem> 1864 <para> 1865 When a note is added to a bug currently in $g_bug_feedback_status, and the note 1866 author is the bug's reporter, this option will automatically set the bug status 1867 to $g_bug_submit_status or $g_bug_assigned_status if the bug is assigned to a 1868 developer. Defaults to enabled. 1869 </para> 1870 </listitem> 1871 </varlistentry> 1872 <varlistentry> 1873 <term>$g_bug_reopen_resolution</term> 1874 <listitem> 1875 <para>Default resolution to assign to a bug when it is 1876 resolved as being a duplicate of another issue. 1877 Default value is DUPLICATE. 1878 </para> 1879 </listitem> 1880 </varlistentry> 1881 <varlistentry> 1882 <term>$g_bug_duplicate_resolution</term> 1883 <listitem> 1884 <para>Resolution to assign to the bug when reopened. Default value 1885 is REOPENED. 1886 </para> 1887 </listitem> 1888 </varlistentry> 1889 <varlistentry> 1890 <term>$g_auto_set_status_to_assigned</term> 1891 <listitem> 1892 <para>Automatically set status to $g_bug_assigned_status whenever 1893 a bug is assigned to a person. Installations where assigned status 1894 is to be used when the defect is in progress, rather than just put 1895 in a person's queue should set it to OFF. Default is ON. 1896 </para> 1897 </listitem> 1898 </varlistentry> 1899 <varlistentry> 1900 <term>$g_bug_resolved_status_threshold</term> 1901 <listitem> 1902 <para>Bug is resolved, ready to be closed or reopened. In some 1903 custom installations a bug maybe considered as resolved when it is 1904 moved to a custom (FIXED OR TESTED) status. 1905 </para> 1906 </listitem> 1907 </varlistentry> 1908 <varlistentry> 1909 <term>$g_bug_resolution_fixed_threshold</term> 1910 <listitem> 1911 <para>Threshold resolution which denotes that a bug has 1912 been resolved and successfully fixed by developers. 1913 Resolutions above this threshold and below 1914 $g_bug_resolution_not_fixed_threshold are considered 1915 to be resolved successfully. Default value is FIXED. 1916 </para> 1917 </listitem> 1918 </varlistentry> 1919 <varlistentry> 1920 <term>$g_bug_resolution_not_fixed_threshold</term> 1921 <listitem> 1922 <para>Threshold resolution which denotes that a bug has 1923 been resolved without being successfully fixed by 1924 developers. Resolutions above this threshold are 1925 considered to be resolved in an unsuccessful way. 1926 Default value is UNABLE_TO_DUPLICATE. 1927 </para> 1928 </listitem> 1929 </varlistentry> 1930 <varlistentry> 1931 <term> 1932 $g_bug_readonly_status_threshold $g_update_readonly_bug_threshold 1933 </term> 1934 <listitem> 1935 <para>Bug becomes readonly if its status is >= 1936 $g_bug_readonly_status_threshold. The bug becomes read/write again 1937 if re-opened and its status becomes less than this threshold. The 1938 default is RESOLVED. Once the bug becomes readonly, a user with an 1939 access level greater than or equal to 1940 $g_update_readonly_bug_threshold can still edit the bug. 1941 </para> 1942 </listitem> 1943 </varlistentry> 1944 <varlistentry> 1945 <term>$g_status_enum_workflow</term> 1946 <listitem> 1947 <para>'status_enum_workflow' defines the workflow, and reflects a 1948 simple 2-dimensional matrix. For each existing status, you define 1949 which statuses you can go to from that status, e.g. from NEW_ you 1950 might list statuses '10:new,20:feedback,30:acknowledged' but not 1951 higher ones.The default is no workflow, where all states are 1952 accessible from any others. 1953 </para> 1954 </listitem> 1955 </varlistentry> 1956 <varlistentry> 1957 <term>$g_report_bug_threshold</term> 1958 <listitem> 1959 <para>This is the access level required to open a bug. The default 1960 is REPORTER. 1961 </para> 1962 </listitem> 1963 </varlistentry> 1964 <varlistentry> 1965 <term>$g_update_bug_threshold</term> 1966 <listitem> 1967 <para>This is the access level generally required to update the 1968 content of a bug. The default is UPDATER. 1969 </para> 1970 </listitem> 1971 </varlistentry> 1972 <varlistentry> 1973 <term>$g_handle_bug_threshold</term> 1974 <listitem> 1975 <para>This is the access level generally required to be access 1976 level needed to be listed in the assign to field. The default is 1977 DEVELOPER. If a more restrictive setting can be determined from 1978 $g_set_status_threshold, it will be used. 1979 </para> 1980 </listitem> 1981 </varlistentry> 1982 <varlistentry> 1983 <term>$g_update_bug_status_threshold $g_set_status_threshold 1984 </term> 1985 <listitem> 1986 <para>These settings control the access level required to promote 1987 a bug to a new status once the bug is 1988 opened.$g_set_status_threshold is an array indexed by the status 1989 value that allows a distinct setting for each status. It defaults 1990 to blank.If the appropriate status is not defined above, 1991 $g_update_bug_status_threshold is used instead. The default is 1992 DEVELOPER. 1993 </para> 1994 </listitem> 1995 </varlistentry> 1996 <varlistentry> 1997 <term>$g_bugnote_user_edit_threshold</term> 1998 <listitem> 1999 <para>Threshold at which a user can edit his/her own 2000 bugnotes. The default value is equal to the 2001 configuration setting $g_update_bugnote_threshold. 2002 </para> 2003 </listitem> 2004 </varlistentry> 2005 <varlistentry> 2006 <term>$g_bugnote_user_delete_threshold</term> 2007 <listitem> 2008 <para>Threshold at which a user can delete his/her own 2009 bugnotes. The default value is equal to the 2010 configuration setting $g_delete_bugnote_threshold. 2011 </para> 2012 </listitem> 2013 </varlistentry> 2014 <varlistentry> 2015 <term>$g_bugnote_user_change_view_state_threshold</term> 2016 <listitem> 2017 <para>Threshold at which a user can change the view status 2018 of his/her own bugnotes. The default value is equal to 2019 the configuration setting $g_change_view_status_threshold. 2020 </para> 2021 </listitem> 2022 </varlistentry> 2023 <varlistentry> 2024 <term>$g_allow_reporter_close</term> 2025 <listitem> 2026 <para>If set, the bug reporter is allowed to close their own bugs, 2027 regardless of their access level. The default is OFF. 2028 </para> 2029 </listitem> 2030 </varlistentry> 2031 <varlistentry> 2032 <term>$g_allow_reporter_reopen</term> 2033 <listitem> 2034 <para>If set, the bug reporter is allowed to reopen their own bugs 2035 once resolved, regardless of their access level. This allows the 2036 reporter to disagree with the resolution. The default is 2037 ON. 2038 </para> 2039 </listitem> 2040 </varlistentry> 2041 </variablelist> 2042 2043 <para>See also: 2044 <xref linkend="admin.customize.status" /> 2045 </para> 2046 </section> 2047 2048 2049 <section id="admin.config.filters"> 2050 <title>Filters</title> 2051 2052 2053 <variablelist> 2054 <varlistentry> 2055 <term>$g_filter_by_custom_fields</term> 2056 <listitem> 2057 <para>Show custom fields in the filter dialog and use these in 2058 filtering. Defaults to ON. 2059 </para> 2060 </listitem> 2061 </varlistentry> 2062 <varlistentry> 2063 <term>$g_filter_custom_fields_per_row</term> 2064 <listitem> 2065 <para>The number of custom fields to display per row. The default 2066 is 7. The value should be greater than or equal to 7. 2067 </para> 2068 </listitem> 2069 </varlistentry> 2070 <varlistentry> 2071 <term>$g_view_filters = SIMPLE_DEFAULT;</term> 2072 <listitem> 2073 <para>Controls the display of the filter pages. Possible values 2074 are: 2075 <itemizedlist> 2076 <listitem> 2077 <para>SIMPLE_ONLY - only simple view</para> 2078 </listitem> 2079 <listitem> 2080 <para>ADVANCED_ONLY - only advanced view (allows multiple value 2081 selections) 2082 </para> 2083 </listitem> 2084 <listitem> 2085 <para>SIMPLE_DEFAULT - defaults to simple view, but shows a 2086 link for advanced 2087 </para> 2088 </listitem> 2089 <listitem> 2090 <para>ADVANCED_DEFAULT - defaults to advanced view, but shows a 2091 link for simple 2092 </para> 2093 </listitem> 2094 </itemizedlist> 2095 </para> 2096 </listitem> 2097 </varlistentry> 2098 <varlistentry> 2099 <term>$g_use_dynamic_filters = ON;</term> 2100 <listitem> 2101 <para>This switch enables the use of AJAX to dynamically 2102 load and create filter form controls upon request. 2103 This method will reduce the amount of data that needs 2104 to be transferred upon each page load dealing with 2105 filters and thus will result in speed improvements and 2106 bandwidth reduction. This requires $g_use_javascript 2107 to be set to ON. By default, this configuration option 2108 is set to ON. 2109 </para> 2110 </listitem> 2111 </varlistentry> 2112 <varlistentry> 2113 <term>$g_create_permalink_threshold</term> 2114 <listitem> 2115 <para>The threshold required for users to be able to create permalinks (default DEVELOPER). To turn this feature off use NOBODY.</para> 2116 </listitem> 2117 </varlistentry> 2118 <varlistentry> 2119 <term>$g_create_short_url</term> 2120 <listitem> 2121 <para>The service to use to create a short URL. The %s will be replaced by the long URL. By default http://www.tinyurl service is used to shorten URLs.</para> 2122 </listitem> 2123 </varlistentry> 2124 </variablelist> 2125 </section> 2126 2127 <section id="admin.config.misc"> 2128 <title>Misc</title> 2129 <variablelist> 2130 <varlistentry> 2131 <term>$g_user_login_valid_regex</term> 2132 <listitem> 2133 <para> 2134 The regular expression to use when validating new user login names. 2135 The default regular expression allows a-z, A-Z, 0-9, +, -, dot, space and 2136 underscore. If you change this, you may want to update the 2137 ERROR_USER_NAME_INVALID string in the language files to explain 2138 the rules you are using on your site. 2139 </para> 2140 <para> 2141 See <ulink url="http://en.wikipedia.org/wiki/Regular_Expression">Wikipedia</ulink> for more 2142 details about regular expressions. For testing regular expressions, use 2143 <ulink url="http://rubular.com/">Rubular</ulink>. 2144 </para> 2145 </listitem> 2146 </varlistentry> 2147 <varlistentry> 2148 <term>$g_monitor_bug_threshold</term> 2149 <listitem> 2150 <para>Access level needed to monitor bugs. The default 2151 value is REPORTER. 2152 </para> 2153 </listitem> 2154 </varlistentry> 2155 <varlistentry> 2156 <term>$g_monitor_add_others_bug_threshold</term> 2157 <listitem> 2158 <para>Access level needed to add other users to the list of 2159 users monitoring a bug. The default value is DEVELOPER. 2160 </para> 2161 </listitem> 2162 </varlistentry> 2163 <varlistentry> 2164 <term>$g_monitor_delete_others_bug_threshold</term> 2165 <listitem> 2166 <para>Access level needed to delete other users from the 2167 list of users monitoring a bug. The default value is 2168 DEVELOPER. 2169 </para> 2170 </listitem> 2171 </varlistentry> 2172 <varlistentry> 2173 <term>$g_limit_reporters</term> 2174 <listitem> 2175 <para>Limit reporters to only viewing bugs that they 2176 report. 2177 </para> 2178 </listitem> 2179 </varlistentry> 2180 <varlistentry> 2181 <term>$g_allow_reporter_close</term> 2182 <listitem> 2183 <para>Allow reporters to close the bugs they reported.</para> 2184 </listitem> 2185 </varlistentry> 2186 <varlistentry> 2187 <term>$g_allow_bug_delete_access_level</term> 2188 <listitem> 2189 <para>Allow the specified access level and above to delete 2190 bugs. 2191 </para> 2192 </listitem> 2193 </varlistentry> 2194 <varlistentry> 2195 <term>$g_bug_move_access_level</term> 2196 <listitem> 2197 <para>Allow the specified access level and above to move bugs 2198 between projects. 2199 </para> 2200 </listitem> 2201 </varlistentry> 2202 <varlistentry> 2203 <term>$g_allow_account_delete</term> 2204 <listitem> 2205 <para>Allow users to delete their own accounts.</para> 2206 </listitem> 2207 </varlistentry> 2208 <varlistentry> 2209 <term>$g_allow_anonymous_login</term> 2210 <listitem> 2211 <para>Enable anonymous access to Mantis. You must also 2212 specify $g_anonymous_account as the account which 2213 anonymous users will browse Mantis with. The default 2214 setting is OFF.</para> 2215 </listitem> 2216 </varlistentry> 2217 <varlistentry> 2218 <term>$g_anonymous_account</term> 2219 <listitem> 2220 <para>Define the account which anonymous users will assume 2221 when using Mantis. This account is considered by Mantis 2222 to be protected from modification. In other words, this 2223 account can only be modified by users with an access 2224 level equal to or higher than $g_manage_user_threshold. 2225 Anonymous users will not be able to adjust preferences 2226 or change account settings like normal users can. 2227 </para> 2228 <para>You will need to create a new account to use for this 2229 $g_anonymous_account setting. When creating the account 2230 you should specify a password, email address and so 2231 forth in the same way you'd create any other account. 2232 It is suggested that the access level for this account 2233 be set to VIEWER or some other read only level. 2234 </para> 2235 <para>The anonymous user account will not receive standard 2236 notifications and can not monitor issues. 2237 </para> 2238 <para>The default setting is blank/undefined. You only need 2239 to define this setting when $g_allow_anonymous_login 2240 is set to ON. 2241 </para> 2242 </listitem> 2243 </varlistentry> 2244 <varlistentry> 2245 <term>$g_bug_link_tag</term> 2246 <listitem> 2247 <para>If a number follows this tag it will create a link to a 2248 bug. eg. for # a link would be #45 eg. for bug: a 2249 link would be bug:98 2250 </para> 2251 </listitem> 2252 </varlistentry> 2253 <varlistentry> 2254 <term>$g_show_timer</term> 2255 <listitem> 2256 <para>Time page loads. Shows at the bottom of the page.</para> 2257 </listitem> 2258 </varlistentry> 2259 <varlistentry> 2260 <term>$g_show_queries_count</term> 2261 <listitem> 2262 <para>Shows the total number/unique number of queries executed to 2263 serve the page. Default is ON. 2264 </para> 2265 </listitem> 2266 </varlistentry> 2267 <varlistentry> 2268 <term>$g_show_queries_list</term> 2269 <listitem> 2270 <para>Shows the list of all queries that are executed in 2271 chronological order from top to bottom. This option is only 2272 effective when $g_show_queries_count is ON. Default is OFF. 2273 WARNING: Potential security hazard. Only turn this on when you 2274 really need it (for debugging or profiling) 2275 </para> 2276 </listitem> 2277 </varlistentry> 2278 <varlistentry> 2279 <term>$g_register_globals</term> 2280 <listitem> 2281 <para>If your register_globals is Off then set this to OFF. Check 2282 your register_globals setting in php.ini or phpinfo(). 2283 </para> 2284 </listitem> 2285 </varlistentry> 2286 <varlistentry> 2287 <term>$g_enable_project_documentation</term> 2288 <listitem> 2289 <para>Specifies whether to enable support for project documents or 2290 not. Default is OFF. This feature is deprecated and is expected 2291 to be moved to a plugin in the future. 2292 </para> 2293 </listitem> 2294 </varlistentry> 2295 <varlistentry> 2296 <term>$g_admin_site_threshold</term> 2297 <listitem> 2298 <para>Threshold at which a user is considered to be a site 2299 administrator. These users have the highest level of 2300 access to your Mantis installation. This access level 2301 is required to change key Mantis settings (such as 2302 server paths) and perform other administrative duties. 2303 You may need to change this value from the default of 2304 ADMINISTRATOR if you have defined a new access level 2305 to replace the default ADMINISTRATOR level in 2306 constant_inc.php. 2307 </para> 2308 <warning> 2309 <para>This is a potentially dangerous configuration 2310 option. Users at or above this threshold value will 2311 have permission to all aspects of Mantis including 2312 the admin/ directory. With this access level, users 2313 can damage your installation of Mantis, destroy 2314 your database or have elevated access to your 2315 server. 2316 </para> 2317 <para>DO NOT CHANGE THIS VALUE UNLESS YOU ABSOLUTELY 2318 KNOW WHAT YOU'RE DOING. BE VERY CAREFUL WITH 2319 CHANGING THIS CONFIGURATION VALUE FROM THE DEFAULT 2320 SETTING. 2321 </para> 2322 </warning> 2323 </listitem> 2324 </varlistentry> 2325 <varlistentry> 2326 <term>$g_manage_configuration_threshold</term> 2327 <listitem> 2328 <para>The threshold required for users to be able to manage configuration of a project. 2329 This includes workflow, email notifications, columns to view, and others. Default is MANAGER. 2330 </para> 2331 </listitem> 2332 </varlistentry> 2333 <varlistentry> 2334 <term>$g_view_configuration_threshold</term> 2335 <listitem> 2336 <para>Threshold for users to view the raw system configurations as stored in the database. 2337 The default value is ADMINISTRATOR. 2338 </para> 2339 </listitem> 2340 </varlistentry> 2341 <varlistentry> 2342 <term>$g_set_configuration_threshold</term> 2343 <listitem> 2344 <para>Threshold for users to set the system configurations generically via MantisBT web interface. 2345 WARNING: Users who have access to set configuration via the interface MUST be trusted. This is due 2346 to the fact that such users can set configurations to PHP code and hence there can be a security 2347 risk if such users are not trusted. The default value is ADMINISTRATOR. 2348 </para> 2349 </listitem> 2350 </varlistentry> 2351 </variablelist> 2352 </section> 2353 2354 2355 <section id="admin.config.cookies"> 2356 <title>Cookies</title> 2357 <para>The configuration variables $g_string_cookie, 2358 $g_project_cookie, $g_view_all_cookie, $g_manage_cookie are 2359 calculated based on $g_cookie_prefix. When you change the cookie 2360 prefix in config_inc.php, you need to follow it with a copy of the 2361 four lines that calculate the names for these cookies. 2362 </para> 2363 2364 <variablelist> 2365 <varlistentry> 2366 <term>$g_cookie_path</term> 2367 <listitem> 2368 <para>This is specifies to the path under which a cookie is 2369 visible. All scripts in this directory and its sub-directories will 2370 be able to access MantisBT cookies. Default value is '/'. It is 2371 recommended to set this to the actual MantisBT path. 2372 </para> 2373 </listitem> 2374 </varlistentry> 2375 <varlistentry> 2376 <term>$g_cookie_domain</term> 2377 <listitem> 2378 <para>Unused</para> 2379 </listitem> 2380 </varlistentry> 2381 <varlistentry> 2382 <term>$g_cookie_version</term> 2383 <listitem> 2384 <para>Cookie version is used as a prefix for cookies that should 2385 be expire when the code is changed in a certain way. The developers 2386 would increase this version when necessary, which in effect will 2387 cause the creation of new cookies that are compatible with the new 2388 code. It is not expected for the user to need to change this 2389 setting. 2390 </para> 2391 </listitem> 2392 </varlistentry> 2393 <varlistentry> 2394 <term>$g_cookie_prefix</term> 2395 <listitem> 2396 <para>This should be set to a unique identifier which does not 2397 include spaces or periods. Again, this should be unique per 2398 MantisBT installation, especially if $g_cookie_path is not 2399 restricting the cookies scope to the actual MantisBT 2400 directory. 2401 </para> 2402 </listitem> 2403 </varlistentry> 2404 </variablelist> 2405 2406 </section> 2407 2408 2409 <section id="admin.config.tables"> 2410 <title>Database Tables</title> 2411 2412 <para>MantisBT enables users to configure a table prefix for all its 2413 tables. This is useful to be able to have multiple MantisBT 2414 installation in the same database. The advantage of that is for 2415 users who are limited by their ISP to have one database. 2416 </para> 2417 2418 <variablelist> 2419 2420 <varlistentry> 2421 <term>$g_db_table_prefix</term> 2422 <listitem> 2423 <para>Specifies the prefix to be use for all table names. The 2424 default value is 'mantis'. If you override the default prefix, make 2425 sure to update doc/db_generate.sql file before generating your 2426 database. The other option is to import db_generate.sql as is, then 2427 rename the tables to match the new prefix. 2428 </para> 2429 2430 <para>The prefix is used to help make sure table names are unique. 2431 This is useful for users who are limited to one database. 2432 </para> 2433 <note><para> 2434 The table name for each of the tables is stored in a variable which 2435 is calculated based on this configuration option. If you change the 2436 prefix you have to make sure these variables are re-calculated (by 2437 adding these calculation statements to config_inc.php after 2438 assigning the new prefix). An example of these variables is: 2439 $g_mantis_bug_file_table 2440 </para> 2441 </note> 2442 </listitem> 2443 </varlistentry> 2444 </variablelist> 2445 2446 </section> 2447 2448 <section id="admin.config.speed"> 2449 <title>Speed Optimisation</title> 2450 2451 2452 <variablelist> 2453 <varlistentry> 2454 <term>$g_compress_html</term> 2455 <listitem> 2456 <para>This option is used to enable buffering/compression of HTML 2457 output if the user's browser supports it. Default value is ON. 2458 This option will be ignored in the following scenarios: 2459 <itemizedlist> 2460 <listitem> 2461 <para>If php.ini has zlib.output_compression 2462 enabled. 2463 </para> 2464 </listitem> 2465 <listitem> 2466 <para>If php.ini has output_handler set to a 2467 handler. 2468 </para> 2469 </listitem> 2470 <listitem> 2471 <para>If PHP does not include the zlib extension (PHP 4.3.0 and 2472 later include zlib extension by default). 2473 </para> 2474 </listitem> 2475 </itemizedlist> 2476 You can check the loaded modules in your PHP by running "php -m" on 2477 the command line, or by using php_info() command in a php script. 2478 </para> 2479 </listitem> 2480 </varlistentry> 2481 <varlistentry> 2482 <term>$g_use_persistent_connections</term> 2483 <listitem> 2484 <para>Use persistent database connections, setting this to ON will 2485 open the database once per connection, rather than once per page. 2486 There might be some scalability issues here and that is why it is 2487 defaulted to OFF. 2488 </para> 2489 </listitem> 2490 </varlistentry> 2491 </variablelist> 2492 2493 </section> 2494 2495 2496 <section id="admin.config.reminders"> 2497 <title>Reminders</title> 2498 2499 <para>Sending reminders is a feature where a user can notify / 2500 remind other users about a bug. In the past, only selected users 2501 like the managers, or developers would get notified about bugs. 2502 However, these people can not invite other people (through MantisBT) 2503 to look at or monitor these bugs. 2504 </para> 2505 <para>This feature is useful if the Manager needs to get feedback 2506 from testers / requirements team about a certain bug. It avoid 2507 needing this person to do this manual outside MantisBT. It also 2508 records the history of such reminders. 2509 </para> 2510 2511 <variablelist> 2512 <varlistentry> 2513 <term>$g_store_reminders</term> 2514 <listitem> 2515 <para>Specifies if reminders should be stored as bugnotes. The 2516 bugnote will still reflect that it is a reminder and list the names 2517 of users that got it. Default is ON. 2518 </para> 2519 </listitem> 2520 </varlistentry> 2521 <varlistentry> 2522 <term>$g_reminder_recipients_monitor_bug</term> 2523 <listitem> 2524 <para>Specifies if users who receive reminders about a bug, should 2525 be automatically added to the monitor list of that bug. Default is 2526 ON. 2527 </para> 2528 </listitem> 2529 </varlistentry> 2530 </variablelist> 2531 2532 </section> 2533 2534 2535 <section id="admin.config.bughistory"> 2536 <title>Bug History</title> 2537 2538 2539 <para>Bug history is a feature where MantisBT tracks all 2540 modifications that are made to bugs. These include everything 2541 starting from its creation, till it is closed. For each change, the 2542 bug history will record the time stamp, user who made the change, 2543 field that changed, old value, and new value. 2544 </para> 2545 <para>Independent of the these settings, MantisBT will always track 2546 the changes to a bug and add them to its history. 2547 </para> 2548 <variablelist> 2549 <varlistentry> 2550 <term>$g_history_default_visible</term> 2551 <listitem> 2552 <para>Make the bug history visible by default. If this option is 2553 not enabled, then the user will have to click on the Bug History 2554 link to see the bug history. Default is ON. 2555 </para> 2556 </listitem> 2557 </varlistentry> 2558 <varlistentry> 2559 <term>$g_history_order</term> 2560 <listitem> 2561 <para>Show bug history entries in ascending or descending order. 2562 Default value is 'ASC'. 2563 </para> 2564 </listitem> 2565 </varlistentry> 2566 </variablelist> 2567 2568 </section> 2569 2570 2571 <section id="admin.config.sponsorship"> 2572 <title>Sponsorship</title> 2573 2574 2575 <variablelist> 2576 <varlistentry> 2577 <term>$g_enable_sponsorship</term> 2578 <listitem> 2579 <para>enable/disable the whole issue sponsorship feature. The 2580 default os OFF. 2581 </para> 2582 </listitem> 2583 </varlistentry> 2584 <varlistentry> 2585 <term>$g_sponsorship_currency</term> 2586 <listitem> 2587 <para>The currency string used for all sponsorships. The default 2588 is 'US$'. 2589 </para> 2590 </listitem> 2591 </varlistentry> 2592 <varlistentry> 2593 <term>$g_minimum_sponsorship_amount</term> 2594 <listitem> 2595 <para>The minimum sponsorship amount that can be entered. If the 2596 user enters a value less than this, an error will be flagged. The 2597 default is 5. 2598 </para> 2599 </listitem> 2600 </varlistentry> 2601 <varlistentry> 2602 <term>$g_view_sponsorship_total_threshold</term> 2603 <listitem> 2604 <para>The access level threshold needed to view the total 2605 sponsorship for an issue by all users. The default is 2606 VIEWER. 2607 </para> 2608 </listitem> 2609 </varlistentry> 2610 <varlistentry> 2611 <term>$g_view_sponsorship_details_threshold</term> 2612 <listitem> 2613 <para>The access level threshold needed to view the details of the 2614 sponsorship (i.e., who will donate what) for an issue by all users. 2615 The default is VIEWER. 2616 </para> 2617 </listitem> 2618 </varlistentry> 2619 <varlistentry> 2620 <term>$g_sponsor_threshold</term> 2621 <listitem> 2622 <para>The access level threshold needed to allow user to sponsor 2623 issues. The default is REPORTER. Note that sponsoring user must 2624 have their email set in their profile. 2625 </para> 2626 </listitem> 2627 </varlistentry> 2628 <varlistentry> 2629 <term>$g_handle_sponsored_bugs_threshold</term> 2630 <listitem> 2631 <para>The access level required to be able to handle sponsored 2632 issues. The default is DEVELOPER. 2633 </para> 2634 </listitem> 2635 </varlistentry> 2636 <varlistentry> 2637 <term>$g_assign_sponsored_bugs_threshold</term> 2638 <listitem> 2639 <para>The access level required to be able to assign a sponsored 2640 issue to a user with access level greater or equal to 2641 'handle_sponsored_bugs_threshold'. The default is MANAGER. 2642 </para> 2643 </listitem> 2644 </varlistentry> 2645 </variablelist> 2646 2647 </section> 2648 2649 2650 <section id="admin.config.customfields"> 2651 <title>Custom Fields</title> 2652 2653 <variablelist> 2654 <varlistentry> 2655 <term>$g_manage_custom_fields_threshold</term> 2656 <listitem> 2657 <para>Access level needed to manage custom fields. The default is 2658 ADMINISTRATOR. 2659 </para> 2660 </listitem> 2661 </varlistentry> 2662 <varlistentry> 2663 <term>$g_custom_field_link_threshold</term> 2664 <listitem> 2665 <para>Access level needed to link a custom field to a project. The 2666 default is MANAGER. 2667 </para> 2668 </listitem> 2669 </varlistentry> 2670 <varlistentry> 2671 <term>$$g_custom_field_edit_after_create</term> 2672 <listitem> 2673 <para>This flag determines whether to start editing a custom field 2674 immediately after creating it, or return to the definition list. 2675 The default is ON (edit the custom field after creating). 2676 </para> 2677 </listitem> 2678 </varlistentry> 2679 </variablelist> 2680 2681 </section> 2682 2683 2684 <section id="admin.config.myview"> 2685 <title>My View Settings</title> 2686 2687 2688 <variablelist> 2689 <varlistentry> 2690 <term>$g_my_view_boxes</term> 2691 <listitem> 2692 <para>This is an array of values defining the order that the boxes 2693 to be shown. A box that is not to be shown can have its value set 2694 to 0. The default is: 2695 <programlisting>$g_my_view_boxes = array ( 'assigned' => '1', 2696 'unassigned' => '2', 2697 'reported' => '3', 2698 'resolved' => '4', 2699 'recent_mod' => '5', 2700 'monitored' => '6' 2701 ); 2702 </programlisting> 2703 If you want to change the definition, copy the default value and 2704 apply the changes. 2705 </para> 2706 </listitem> 2707 </varlistentry> 2708 <varlistentry> 2709 <term>$g_my_view_bug_count</term> 2710 <listitem> 2711 <para>Number of bugs shown in each box. The default is 10.</para> 2712 </listitem> 2713 </varlistentry> 2714 <varlistentry> 2715 <term>$g_default_home_page</term> 2716 <listitem> 2717 <para>Default page to transfer to after Login or Set Project. The 2718 default is 'my_view_page.php'. An alternative would be 2719 'view_all_bugs_page.php' or 'main_page.php'. 2720 </para> 2721 </listitem> 2722 </varlistentry> 2723 </variablelist> 2724 </section> 2725 2726 <section id="admin.config.relationship"> 2727 <title>Relationship Graphs</title> 2728 2729 <variablelist> 2730 <varlistentry> 2731 <term>$g_relationship_graph_enable</term> 2732 <listitem> 2733 <para> 2734 This enables the relationship graphs feature where issues are represented by 2735 nodes and relationships as links between such nodes. Possible values are ON or OFF. 2736 Default is OFF. 2737 </para> 2738 2739 <para> 2740 This feature requires installing <ulink url="http://www.research.att.com/sw/tools/graphviz/">GraphViz</ulink> 2741 (all OSes except Windows) or <ulink url="http://home.so-net.net.tw/oodtsen/wingraphviz/">WinGraphviz</ulink> (only Windows). 2742 Refer to the notes near the top of core/graphviz_api.php and 2743 core/relationship_graph_api.php for more information. 2744 </para> 2745 </listitem> 2746 </varlistentry> 2747 <varlistentry> 2748 <term>$g_relationship_graph_fontname</term> 2749 <listitem> 2750 <para> 2751 Font name and size, as required by Graphviz. If Graphviz fails to run 2752 for you, you are probably using a font name that gd PHP extension can't find. 2753 On Linux, try the name of the font file without the extension. The default 2754 value is 'Arial'. 2755 </para> 2756 </listitem> 2757 </varlistentry> 2758 <varlistentry> 2759 <term>$g_relationship_graph_fontsize</term> 2760 <listitem> 2761 <para> 2762 Font size, default is 8. 2763 </para> 2764 </listitem> 2765 </varlistentry> 2766 <varlistentry> 2767 <term>$g_relationship_graph_orientation</term> 2768 <listitem> 2769 <para> 2770 Default dependency orientation. If you have issues with lots of children 2771 or parents, leave as 'horizontal', otherwise, if you have lots of 2772 "chained" issue dependencies, change to 'vertical'. Default is 'horizontal'. 2773 </para> 2774 </listitem> 2775 </varlistentry> 2776 <varlistentry> 2777 <term>$g_relationship_graph_max_depth</term> 2778 <listitem> 2779 <para> 2780 Max depth for relation graphs. This only affects relationship graphs, 2781 dependency graphs are drawn to the full depth. The default value is 2. 2782 </para> 2783 </listitem> 2784 </varlistentry> 2785 <varlistentry> 2786 <term>$g_relationship_graph_view_on_click</term> 2787 <listitem> 2788 <para> 2789 If set to ON, clicking on an issue on the relationship graph will open 2790 the bug view page for that issue, otherwise, will navigate to the 2791 relationship graph for that issue. 2792 </para> 2793 </listitem> 2794 </varlistentry> 2795 <varlistentry> 2796 <term>$g_dot_tool</term> 2797 <listitem> 2798 <para> 2799 The full path for the dot tool. The webserver must have execute 2800 permission to this program in order to generate relationship graphs. 2801 This configuration option is not relevant for Windows. The default 2802 value is '/usr/bin/dot'. 2803 </para> 2804 </listitem> 2805 </varlistentry> 2806 <varlistentry> 2807 <term>$g_neato_tool</term> 2808 <listitem> 2809 <para> 2810 The full path for the neato tool. The webserver must have execute 2811 permission to this program in order to generate relationship graphs. 2812 This configuration option is not relevant for Windows. The default 2813 value is '/usr/bin/neato'. 2814 </para> 2815 </listitem> 2816 </varlistentry> 2817 </variablelist> 2818 </section> 2819 2820 <section id="admin.config.subprojects"> 2821 <title>Sub-Projects</title> 2822 2823 <variablelist> 2824 <varlistentry> 2825 <term>$g_subprojects_inherit_versions</term> 2826 <listitem> 2827 <para> 2828 Whether sub-projects should inherit versions from parent projects. For project X which 2829 is a sub-project of A and B, it will have versions from X, A and B. The default value is ON. 2830 </para> 2831 </listitem> 2832 </varlistentry> 2833 <varlistentry> 2834 <term>$g_subprojects_inherit_categories</term> 2835 <listitem> 2836 <para> 2837 Whether sub-projects should inherit categories from parent projects. For project X which 2838 is a sub-project of A and B, it will have categories from X, A and B. The default value is ON. 2839 </para> 2840 </listitem> 2841 </varlistentry> 2842 </variablelist> 2843 </section> 2844 2845 <section id="admin.config.fields"> 2846 <title>Field Visibility</title> 2847 2848 <variablelist> 2849 <varlistentry> 2850 <term>$g_enable_eta</term> 2851 <listitem> 2852 <para> 2853 Enable or disable usage of 'ETA' field. Default value is OFF. 2854 </para> 2855 </listitem> 2856 </varlistentry> 2857 <varlistentry> 2858 <term>$g_enable_projection</term> 2859 <listitem> 2860 <para> 2861 Enable or disable usage of 'Projection' field. Default value is OFF. 2862 </para> 2863 </listitem> 2864 </varlistentry> 2865 <varlistentry> 2866 <term>$g_show_product_build</term> 2867 <listitem> 2868 <para> 2869 Enable or disable usage of 'Product Build' field. Default is OFF. 2870 </para> 2871 </listitem> 2872 </varlistentry> 2873 <varlistentry> 2874 <term>$g_bug_report_page_fields</term> 2875 <listitem> 2876 <para> 2877 An array of optional fields to show on the bug report page. 2878 </para> 2879 <para> 2880 The following optional fields are allowed: 2881 additional_info, 2882 attachments, 2883 category_id, 2884 due_date, 2885 handler, 2886 os, 2887 os_version, 2888 platform, 2889 priority, 2890 product_build, 2891 product_version, 2892 reproducibility, 2893 severity, 2894 steps_to_reproduce, 2895 target_version, 2896 view_state. 2897 </para> 2898 <para> 2899 The summary and description fields are always shown 2900 and do not need to be listed in this option. Fields 2901 not listed above cannot be shown on the bug report 2902 page. Visibility of custom fields is handled via the 2903 Manage => Manage Custom Fields administrator page. 2904 </para> 2905 <para> 2906 This setting can be set on a per-project basis by 2907 using the Manage => Manage Configuration 2908 administrator page. 2909 </para> 2910 </listitem> 2911 </varlistentry> 2912 <varlistentry> 2913 <term>$g_bug_view_page_fields</term> 2914 <listitem> 2915 <para> 2916 An array of optional fields to show on the bug view page. 2917 </para> 2918 <para> 2919 The following optional fields are allowed: 2920 additional_info, 2921 attachments, 2922 category_id, 2923 date_submitted, 2924 description, 2925 due_date, 2926 eta, 2927 fixed_in_version, 2928 handler, 2929 id, 2930 last_updated, 2931 os, 2932 os_version, 2933 platform, 2934 priority, 2935 product_build, 2936 product_version, 2937 project, 2938 projection, 2939 reporter, 2940 reproducibility, 2941 resolution, 2942 severity, 2943 status, 2944 steps_to_reproduce, 2945 summary, 2946 tags, 2947 target_version, 2948 view_state. 2949 </para> 2950 <para> 2951 Fields not listed above cannot be shown on the bug 2952 view page. Visibility of custom fields is handled via 2953 the Manage => Manage Custom Fields administrator page. 2954 </para> 2955 <para> 2956 This setting can be set on a per-project basis by 2957 using the Manage => Manage Configuration 2958 administrator page. 2959 </para> 2960 </listitem> 2961 </varlistentry> 2962 <varlistentry> 2963 <term>$g_bug_print_page_fields</term> 2964 <listitem> 2965 <para> 2966 An array of optional fields to show on the bug print page. 2967 </para> 2968 <para> 2969 The following optional fields are allowed: 2970 additional_info, 2971 attachments, 2972 category_id, 2973 date_submitted, 2974 description, 2975 due_date, 2976 eta, 2977 fixed_in_version, 2978 handler, 2979 id, 2980 last_updated, 2981 os, 2982 os_version, 2983 platform, 2984 priority, 2985 product_build, 2986 product_version, 2987 project, 2988 projection, 2989 reporter, 2990 reproducibility, 2991 resolution, 2992 severity, 2993 status, 2994 steps_to_reproduce, 2995 summary, 2996 tags, 2997 target_version, 2998 view_state. 2999 </para> 3000 <para> 3001 Fields not listed above cannot be shown on the bug 3002 print page. All custom field values are shown on the 3003 bug print page. 3004 </para> 3005 <para> 3006 This setting can be set on a per-project basis by 3007 using the Manage => Manage Configuration 3008 administrator page. 3009 </para> 3010 </listitem> 3011 </varlistentry> 3012 <varlistentry> 3013 <term>$g_bug_update_page_fields</term> 3014 <listitem> 3015 <para> 3016 An array of optional fields to show on the bug update page. 3017 </para> 3018 <para> 3019 The following optional fields are allowed: 3020 additional_info, 3021 category_id, 3022 date_submitted, 3023 description, 3024 due_date, 3025 eta, 3026 fixed_in_version, 3027 handler, 3028 id, 3029 last_updated, 3030 os, 3031 os_version, 3032 platform, 3033 priority, 3034 product_build, 3035 product_version, 3036 project, 3037 projection, 3038 reporter, 3039 reproducibility, 3040 resolution, 3041 severity, 3042 status, 3043 steps_to_reproduce, 3044 summary, 3045 target_version, 3046 view_state. 3047 </para> 3048 <para> 3049 Fields not listed above cannot be shown on the bug 3050 update page. Visibility of custom fields is handled 3051 via the Manage => Manage Custom Fields administrator 3052 page. 3053 </para> 3054 <para> 3055 This setting can be set on a per-project basis by 3056 using the Manage => Manage Configuration 3057 administrator page. 3058 </para> 3059 </listitem> 3060 </varlistentry> 3061 <varlistentry> 3062 <term>$g_bug_change_status_page_fields</term> 3063 <listitem> 3064 <para> 3065 An array of optional fields to show on the bug change 3066 status page. This only changes the visibility of 3067 fields shown below the form used for updating the 3068 status of an issue. 3069 </para> 3070 <para> 3071 The following optional fields are allowed: 3072 additional_info, 3073 attachments, 3074 category_id, 3075 date_submitted, 3076 description, 3077 due_date, 3078 eta, 3079 fixed_in_version, 3080 handler, 3081 id, 3082 last_updated, 3083 os, 3084 os_version, 3085 platform, 3086 priority, 3087 product_build, 3088 product_version, 3089 project, 3090 projection, 3091 reporter, 3092 reproducibility, 3093 resolution, 3094 severity, 3095 status, 3096 steps_to_reproduce, 3097 summary, 3098 tags, 3099 target_version, 3100 view_state. 3101 </para> 3102 <para> 3103 Fields not listed above cannot be shown on the bug 3104 change status page. Visibility of custom fields is 3105 handled via the Manage => Manage Custom Fields 3106 administrator page (use the same settings as the bug 3107 view page). 3108 </para> 3109 <para> 3110 This setting can be set on a per-project basis by 3111 using the Manage => Manage Configuration 3112 administrator page. 3113 </para> 3114 </listitem> 3115 </varlistentry> 3116 </variablelist> 3117 </section> 3118 3119 <section id="admin.config.logging"> 3120 <title>System Logging</title> 3121 <para>The system logging interface is used to extract detailed 3122 debugging information for the MantisBT system. It can also serve as 3123 an audit trail for user actions. 3124 </para> 3125 3126 <variablelist> 3127 <varlistentry> 3128 <term>$g_log_level</term> 3129 <listitem> 3130 <para>This controls the type of logging information recorded. 3131 Possible values include: 3132 3133 <variablelist> 3134 <varlistentry> 3135 <term>LOG_EMAIL</term> 3136 <listitem> 3137 <para>logs issue id, message type and recipients for all emails 3138 sent 3139 </para> 3140 </listitem> 3141 </varlistentry> 3142 <varlistentry> 3143 <term>LOG_EMAIL_RECIPIENT</term> 3144 <listitem> 3145 <para>logs the details of email recipient determination. Each user 3146 id is listed as well as why they are added, or deleted from the 3147 recipient list 3148 </para> 3149 </listitem> 3150 </varlistentry> 3151 </variablelist> 3152 </para> 3153 </listitem> 3154 </varlistentry> 3155 <varlistentry> 3156 <term>$g_log_destination</term> 3157 <listitem> 3158 <para>specifies the file where the log data goes. This file must 3159 be writable by the web server userid running MantisBT. Right now, 3160 only "file:<file path>" is supported. For example, 3161 $g_log_destination = 'file:/tmp/mantis_log'; 3162 See http://www.php.net/error_log for details. 3163 </para> 3164 </listitem> 3165 </varlistentry> 3166 </variablelist> 3167 </section> 3168 3169 <section id="admin.config.timetracking"> 3170 <title>Time Tracking</title> 3171 3172 <variablelist> 3173 3174 <varlistentry> 3175 <term>$g_time_tracking_enabled</term> 3176 <listitem> 3177 <para> 3178 Turns Time Tracking features ON or OFF - Default is OFF 3179 </para> 3180 </listitem> 3181 </varlistentry> 3182 3183 <varlistentry> 3184 <term>$g_time_tracking_without_note</term> 3185 <listitem> 3186 <para> 3187 Allow time tracking to be recorded without writing some text in the associated bugnote - Default is ON 3188 </para> 3189 </listitem> 3190 </varlistentry> 3191 3192 <varlistentry> 3193 <term>$g_time_tracking_with_billing</term> 3194 <listitem> 3195 <para> 3196 Adds calculation links to workout how much time has been spent between a particular time frame. Currently it will allow you to enter a cost/hour and will work out some billing information. This will become more extensive in the future. Currently it is more of a proof of concept. 3197 </para> 3198 </listitem> 3199 </varlistentry> 3200 3201 <varlistentry> 3202 <term>$g_time_tracking_stopwatch</term> 3203 <listitem> 3204 <para> 3205 Instead of a text field turning this option on places a stopwatch on the page with <guibutton>Start/Stop</guibutton> and <guibutton>Reset</guibutton> buttons next to it. You must have $g_use_javascript switched on for this to take effect. A bit gimmicky, but who cares. 3206 </para> 3207 </listitem> 3208 </varlistentry> 3209 3210 <varlistentry> 3211 <term>$g_time_tracking_view_threshold</term> 3212 <listitem> 3213 <para> 3214 Access level required to view time tracking information - Default DEVELOPER. 3215 </para> 3216 </listitem> 3217 </varlistentry> 3218 3219 <varlistentry> 3220 <term>$g_time_tracking_edit_threshold</term> 3221 <listitem> 3222 <para> 3223 Access level required to add/edit time tracking information (If you give a user $g_time_tracking_edit_threshold you must give them $g_time_tracking_view_threshold as well) - Default DEVELOPER. 3224 </para> 3225 </listitem> 3226 </varlistentry> 3227 3228 <varlistentry> 3229 <term>$g_time_tracking_reporting_threshold</term> 3230 <listitem> 3231 <para> 3232 Access level required to run reports (not completed yet) - Default MANAGER. 3233 </para> 3234 </listitem> 3235 </varlistentry> 3236 3237 </variablelist> 3238 </section> 3239 3240 </chapter>
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Thu Jul 28 15:48:31 2011 | Cross-referenced by PHPXref 0.7 |