Bugzilla:FAQ: Difference between revisions

→‎Do users have to have any particular type of email application?: Email is no longer necessarily plaintext. credit to Zangune on irc
(Move "General Questions" into Bugzilla:FAQ)
(→‎Do users have to have any particular type of email application?: Email is no longer necessarily plaintext. credit to Zangune on irc)
 
(41 intermediate revisions by 9 users not shown)
Line 1: Line 1:
This is a list of the most-frequently-asked questions about Bugzilla.
If you edit this page, please only add questions that are '''frequently asked'''. Questions that are less-commonly-asked should just get their own Wiki page.
=General Questions=
=General Questions=
==Can I try out Bugzilla somewhere?==
==Can I try out Bugzilla somewhere?==
If you want to take a test ride, there are test installations at http://landfill.bugzilla.org/, ready to play with directly from your browser.
If you want to take a test ride, there are test installations at http://landfill.bugzilla.org/, ready to play with directly from your browser.


==What license is Bugzilla distributed under?==
==What license is Bugzilla distributed under?==
Bugzilla is covered by the Mozilla Public License.
Bugzilla is covered by the Mozilla Public License.
See details at http://www.mozilla.org/MPL/.
See details at http://www.mozilla.org/MPL/.


==How do I get commercial support for Bugzilla?==
==How do I get commercial support for Bugzilla?==
http://www.bugzilla.org/support/consulting.html is a list of companies and individuals who have asked us to list them as consultants for Bugzilla.
http://www.bugzilla.org/support/consulting.html is a list of companies and individuals who have asked us to list them as consultants for Bugzilla.
There are several experienced Bugzilla hackers on the mailing list/newsgroup who are willing to make themselves available for generous compensation.
Try sending a message to the mailing list asking for a volunteer.


==What major companies or projects are currently using Bugzilla for bug-tracking?==
==What major companies or projects are currently using Bugzilla for bug-tracking?==
Line 26: Line 31:
Wikipedia maintains a [http://en.wikipedia.org/wiki/Comparison_of_issue_tracking_systems "comparison of issue tracking systems"].
Wikipedia maintains a [http://en.wikipedia.org/wiki/Comparison_of_issue_tracking_systems "comparison of issue tracking systems"].


In the experience of Matthew Barnson (the original author of this FAQ), though,
We think that compared to other bug-tracking systems, Bugzilla offers superior performance on commodity hardware, better price (free!), more developer-friendly features (such as stored queries, email integration, and platform independence), improved scalability, greater flexibility, and superior ease-of-use under long-term usage.
Bugzilla offers superior performance on commodity hardware, better price (free!),
 
more developer-friendly features (such as stored queries, email integration,
==Which versions support MySQL, PostgreSQL, Oracle and SQLite? What about Sybase/Msql/MSSQL?==
and platform independence), improved scalability, greater flexibility,
 
and superior ease-of-use when compared to commercial bug-tracking software.
Bugzilla 3.2 and above support MySQL, PostgreSQL and Oracle. Since Bugzilla 4.2, SQLite is also supported, but its support remains experimental. Support for MS-SQL is currently under way for a future version of Bugzilla.
 
Sybase support is no longer being worked on, and most likely will never happen, as Sybase lacks many features Bugzilla needs.
 
==My perl is located at /usr/local/bin/perl  and not /usr/bin/perl. Is there an easy to change that in all the files that have this hard-coded?==
 
The easiest way to get around this is to create a link from one to the other:
 
  ln -s /usr/local/bin/perl /usr/bin/perl
 
If that's not an option for you, the following bit of perl magic will change
all the shebang lines (that is to say,
the line at the top of each file that starts with '#!' and contains the path)
to something else:
 
  perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl contrib/*pl extensions/*pl
 
If your perl path is something else again,
just follow the above examples and replace /usr/local/bin/perl with your own perl path.
 
==Is there an easy way to change the Bugzilla cookie name?==
 
No.
 
==Can bugzilla run under mod_perl?==
 
Yes. You need to run Bugzilla 3.0 or newer. Later versions of Bugzilla generally have even better performance under mod_perl.
 
==Does Bugzilla work under SELinux?==
 
On most modern versions of Fedora and RHEL, Bugzilla will work fine under SELinux as long as it is underneath the <code>/var/www/html/</code> directory. You may have to run this command to make it work properly, though:
 
  restorecon -Rv /var/www/html/
 
=Managerial Questions=
 
==Is it possible to delete bug reports?==
 
Yes. You have to turn on the 'allowbugdeletion' parameter, which is off by default. Note that you cannot delete bug reports one by one. You have to move them in a product or component, e.g. named "Trash", and then delete this product or component. The reason we make it hard is that you generally don't want to delete bug reports; they're supposed to be a permanent historical record.
 
==Is Bugzilla web-based, or do you have to have specific software or a specific operating system on your machine?==
 
Bugzilla is web-based, and it sends emails.
 
==Does Bugzilla allow us to define our own priorities, levels, and other values?==
 
Yes. You can edit the values of hardcoded fields but not their label. Since Bugzilla 3.0, you can even edit the list of valid resolutions and since Bugzilla 3.2, the list of legal bug statuses and transitions among them.
 
Moreover, Bugzilla 3.0 and newer allow you to add custom fields to Bugzilla from the UI.
 
==Does Bugzilla provide any reporting features, metrics, graphs, etc?==
 
Yes. Look at http://landfill.bugzilla.org/bugzilla-tip/report.cgi for samples of what Bugzilla can do in reporting and graphing. Fuller documentation is provided in [http://www.bugzilla.org/docs/tip/html/reporting.html Section 6.11].
 
There are also [[Bugzilla:Addons#Data_harvesting|various third-party tools]] that do reporting for Bugzilla.
 
==Is there email notification? If so, what do you see when you get an email?==
 
Email notification is user-configurable. By default, the bug id and summary of the bug report accompany each email notification, along with a list of the changes made.
 
==Do users have to have any particular type of email application?==


If you happen to be a vendor for commercial bug-tracking software,
No. Bugzilla can send email in plain text, the most compatible mail format on the planet. HTML email is available for people who want it formatted in a more readable fashion. The site admin can choose which format is default, but each user can change it from the default also.
and would like to submit a list of advantages your product has over Bugzilla,
simply send it to <documentation@bugzilla.org>
and we'd be happy to include the comparison in our documentation.


==Why doesn't Bugzilla offer this or that feature or compatibility with this other tracking software?==
==Does Bugzilla allow data to be imported and exported? (Say, from/to Word or Excel.) ==
It may be that the support has not been built yet,
or that you have not yet found it.
While Bugzilla makes strides in usability, customizability, scalability,
and user interface with each release,
that doesn't mean it can't still use improvement!


The best way to make an enhancement request is to file a bug at
Bugzilla can output buglists as HTML (the default), CSV, XML, and Atom. A link for each of these formats can be found at the bottom of your search results. The CSV format can easily be imported into MS Excel or other spreadsheet applications.
[https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla bugzilla.mozilla.org]
and set the Severity to 'enhancement'.
Your 'request for enhancement' (RFE) will start out in the UNCONFIRMED state,
and will stay there until someone with the ability to CONFIRM the bug reviews it.
If that person feels it to be a good request that fits in
with Bugzilla's overall direction, the status will be changed to NEW;
if not, they will probably explain why and set the bug to RESOLVED/WONTFIX.
If someone else has made the same (or almost the same) request before,
your request will be marked RESOLVED/DUPLICATE,
and a pointer to the previous RFE will be added.


Even if your RFE gets approved,
Currently the only script included with Bugzilla that can import data is
that doesn't mean it's going to make it right into the next release;
importxml.pl. It imports bugs as XML. If you want to see the XML format it expects, view a bug and select the "XML" link on the page (it's small, you might have to search for it).
there are a limited number of developers,
and a whole lot of RFEs... some of which are quite complex.
If you're a code-hacking sort of person,
you can help the project along by making a patch yourself
that supports the functionality you require.
If you have never contributed anything to Bugzilla before,
please be sure to read the Developers' Guide and Contributors' Guide
before going ahead.  


==Which versions support MySQL, PostgreSQL and Oracle? What about Sybase/Msql/MSSQL?==
==Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable?==
MySQL was originally chosen because it is free, easy to install,
and was available for the hardware Netscape intended to run it on. This means all Bugzilla versions support MySQL.


Bugzilla 2.20 contains experimental support for PostgreSQL.
Yes, Bugzilla is fully localizable, and many languages are already available. For more information including available translated templates, see http://www.bugzilla.org/download/#localizations.


Bugzilla 2.22 contains complete, stable support for PostgreSQL. As of this release, using PostgreSQL with Bugzilla should be as stable as using MySQL. If you experience any problems with PostgreSQL compatibility, they will be taken as seriously as if you were running MySQL.
==Are there any backup features provided?==


Red Hat once ran a version of Bugzilla that worked on Oracle,
You should use the commands included with your database software to run the backups of your Bugzilla data.
but that was long, long ago; that version (Bugzilla 2.8) is now obsolete,
You can find strategies for dealing with backup considerations at
insecure, and totally unsupported. In August of 2005, Wim Coekaerts (Director of Linux Engineering at Oracle Corporation) wrote to Dave Miller confirming that Oracle intended to implement and support Bugzilla. Thanks to the help of some Oracle engineers, Bugzilla 3.2 is the first release to support Oracle.
https://dev.mysql.com/doc/mysql-enterprise-backup/en/mysqlbackup.tasks.html for MySQL and at
http://www.postgresql.org/docs/8.0/static/backup.html for PostgreSQL.


Sybase support is no longer being worked on. Even if it eventually happens, it's VERY unlikely to work without the end-user-company having to stick a few developers on making several manual changes. Sybase is just NOT very standards-compliant (despite all the hype), and it turned out that way too much had to be changed to make it work -- like moving half of the application logic into stored procedures to get any kind of decent performance out of it.
==What skills do you need to install and maintain Bugzilla?==
[https://bugzilla.mozilla.org/show_bug.cgi?id=173130 Bug 173130] is the relevant bug.


[https://bugzilla.mozilla.org/show_bug.cgi?id=237862 Bug 237862] is a good bug to read through if you'd like to see what progress is being made on general database compatibility.
If Bugzilla is set up correctly from the start, continuing maintenance needs are minimal and can be done easily using the web interface.


==What is /usr/bonsaitools/bin/perl?==
For installation or upgrades, it helps to understand Perl, Apache, and MySQL. Also, the installer should have a solid grasp of the platform (Windows, OS X, Linux, etc.) that Bugzilla is being installed on.
Bugzilla used to have the path to perl on the shebang line
set to /usr/bonsaitools/bin/perl because when Terry first started
writing the code for mozilla.org he needed a version of Perl
and other tools that were completely under his control.
This location was abandoned for the 2.18 release in favor of
the more sensible /usr/bin/perl.
If you installed an older version of Bugzilla
and created the symlink we suggested, you can remove it now
(provided that you don't have anything else, such as Bonsai,
using it and you don't intend to reinstall an older version of Bugzilla).


==My perl is located at /usr/local/bin/perl  and not /usr/bin/perl. Is there an easy to change that in all the files that have this hard-coded?==
==How much time does it take to install and maintain Bugzilla?==
The easiest way to get around this is to create a link from one to the other:
 
'''ln -s /usr/local/bin/perl /usr/bin/perl'''.
It all depends on what you need out of Bugzilla, and how much you plan to customize it.
If that's not an option for you, the following bit of perl magic will change
 
all the shebang lines (that is to say,
Someone with a lot of Bugzilla experience can get you up and running in a few hours, and your Bugzilla install can run untended for years. Less-experienced administrators sometimes need a few days to set up Bugzilla.
the line at the top of each file that starts with '#!' and contains the path)
 
to something else:
If you plan to customize the code or user interface of your Bugzilla, then the amount of maintenance time increases. First, there's the time to customize (which depends on how much customization you want to do). Then, after you've customized, any time you want to upgrade, you may have to do some work to bring your customizations forward into the new version.
 
==Is there any licensing fee or other fees for using Bugzilla?==
 
No. Bugzilla and all the supporting software it needs (Apache, Perl, MySQL, etc.) are free.
 
==We don't like referring to problems as 'bugs'. Can we change that?==
 
Yes! You can edit the file <code>template/en/default/global/variables.none.tmpl</code> to change the word "bug" in all of Bugzilla.
 
=Administrative Questions=
 
==Does Bugzilla provide record locking when there is simultaneous access to the same bug? Does the second person get a notice that the bug is in use or how are they notified?==
Bugzilla does not lock records. It provides "mid-air collision" detection, which means that it warns a user when a commit is about to conflict with commits recently made by another user, and offers the second user a choice of options to deal with the conflict.
 
==Can users be on the system while a backup is in progress?==
Yes. You should use the commands included with your database software to run the backups of your Bugzilla data. You can find strategies for dealing with backup considerations at http://www.mysql.com/doc/B/a/Backup.html for MySQL and at http://www.postgresql.org/docs/8.0/static/backup.html for PostgreSQL.
 
==Can I restrict a user's ability to edit certain bug fields?==
Users can only edit bugs if they are the Assignee, the QA Contact, or are in the '''editbugs''' group. (Certain fields can also be edited by the Reporter. Also, all users can ''always'' comment and CC themselves on bugs.) However, note that by default, '''all users are in the editbugs group'''. If you want to change this default, go to Administration -> Groups, choose "editbugs" and clear the "userregexp" field. Then you can use Administration -> Users to explicitly add back certain users into the "editbugs" group, if you want them to be able to edit every field on every bug in the system. (Also, you can use Administration -> Products -> (select product) -> Group Controls to give groups of users "editbugs" for specific products.)
 
If you want any finer-grained control than that, it requires code changes. You have to edit the <code>check_can_change_field</code> subroutine in the file <tt>Bugzilla/Bug.pm</tt>. The file has many comments to help guide your edits.
 
==How do I make it so that bugs can have an UNCONFIRMED status?==
 
'''Bugzilla 3.6 or later:''' For each product that you want to enable <code>UNCONFIRMED</code> in, visit that product's admin page using editproducts.cgi (Administration > Products) and enable the UNCONFIRMED status using a checkbox there.
 
'''Before Bugzilla 3.6:''' To use the UNCONFIRMED status, you must have the 'usevotes' parameter set to "On". Then, using editproducts.cgi, you have to set the "Number of votes a bug in this product needs to automatically get out of the unconfirmed state" to a non-zero number. You will have to do this for each product that wants to use the UNCONFIRMED state.
 
If you do not actually want users to be able to vote for bugs entered
against this product, leave the "Maximum votes per person" value at '0'.
 
== How do I move a Bugzilla installation from one machine to another?==
 
See [[Bugzilla:Move Installation]].
 
== I restricted a product to be visible to more than one group, and now only users who are members of all of those groups can see it.  How do I make it visible to someone who's a member of any of those groups (but not all of them)? ==
 
Bugzilla treats all of the group restrictions on a product as an AND comparison.  That is, if you put group controls for more than one group on the same product, then users must be a member of ALL of those groups to be able to perform the restricted action.
 
If you want OR groups (a member of any of the groups can do it), all is not lost.  The way to do this is to create two different sets of groups.
 
The first set of groups defines groups of people.  These groups are not used for group controls on products.  In fact, you can leave the "use for bugs" setting turned off on them.  These are the groups you will make users be members of.  Groupings such as "engineering" or "QA" or "security-team" or "marketing" or similar.
 
The second set of groups has no users in its membership.  You use these groups to define things you want to use group restrictions on, and these will be the groups that you set up in the Group Controls in the product editor.  For example, if you have a product (or a set of 3 or 4 products) that you wish to secure to the same set of people, create a group for it.  These groups will need to have "use for bugs" checkmarked.  Then in the "Groups That Are a Member of This Group" section, add the people groups you created above that you want to be able to access things secured with this group.
 
=Email=
 
==How do I stop email entirely for one user?==
 
The user can stop Bugzilla from sending any mail by clicking "Disable All Mail" on the Preferences > Email Preferences page, and then submitting the form.
 
Alternately, an administrator can disable all bugmails for a user from the Administration > Users page. This will override that user's personal preferences, and they will never be sent mail again.
 
==I'm evaluating/testing Bugzilla, and don't want it to send email to anyone. How do I do it?==
 
Go to Administration > Parameters. In the "Email" section of the parameters, set <code>mail_delivery_method</code> to "Test". Then all emails will go to a file on the disk (<code>data/mailer.testfile</code> in the Bugzilla directory) instead of being sent out.
 
=Windows=
 
==Can Bugzilla run on Windows? How?==
 
Yes, Bugzilla can run on Windows. See the [[Bugzilla:Win32Install]] page for information about how to install and configure Bugzilla on 32-bit Windows. See the [[Bugzilla:WindowsServer2008Install]] page for information about how to install on configure Bugzilla on Windows Server 2008 64-bit.
 
=For Users=
 
==How do I change my user name (email address) in Bugzilla?==
 
Go to the Name and Password section of the Preferences screen. You will be emailed at both addresses for confirmation.
 
If you don't see the option to change your email address on this page, then your Bugzilla administrator hasn't enabled the <code>allowemailchange</code> parameter.
 
==The search page is very confusing. Is there a simpler way to search?==
 
The "Find a Specific Bug" page (one of the tabs when you go to the Search page) is simpler than the Advanced Search form.
 
Also, there is a type of search called "Quicksearch" available in the header and footer of every page. See the "Quicksearch Help" link on the front page of Bugzilla for information on using Quicksearch.
 
==Why can't I close bugs from the "Change Several Bugs at Once" page?==


perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl
You can, but ''all'' the bugs in your search results have to be in a status that can validly change to CLOSED. In Bugzilla 3.2 and later, this means that you have to have set a valid transition to CLOSED from the bugs' statuses, using Administration > Status Workflow. For versions of Bugzilla before 3.2, only VERIFIED bugs can transition to CLOSED.


Sadly, this command-line won't work on Windows unless you also have Cygwin.
==How do I search for public bugs (bugs that aren't restricted to a group)?==
However, MySQL comes with a binary called replace which can do the job:


C:\mysql\bin\replace "#!/usr/bin/perl" "#!C:\perl\bin\perl" -- *.cgi *.pl
You can search for bugs without a group by using Boolean Charts at the bottom of the Advanced Search page: "Not (negate this whole chart)" + "Group" + "matches regular expression" + "."


If your perl path is something else again,
=Troubleshooting=
just follow the above examples and replace /usr/local/bin/perl with your own perl path.


Once you've modified all your files,
==Bugzilla can't connect to the database==
you'll also need to modify the t/002goodperl.t test,
as it tests that all shebang lines are equal to /usr/bin/perl.
(For more information on the test suite, please check out
the appropriate section in the Developers' Guide.)
Having done this, run the test itself:


perl runtests.pl 2 --verbose
Here's some things to check:


# Make sure that the <tt>$db_user</tt> and <tt>$db_pass</tt> settings in the <tt>localconfig</tt> file are correct.
# If you're using MySQL, make sure that DBD::mysql was compiled against the version of MySQL that you're using. For example, a DBD::mysql compiled against MySQL 4.0 won't work with MySQL 5.1. In versions of Bugzilla 3.2 or greater, you can re-install DBD::mysql by doing: <pre>./install-module.pl DBD::mysql</pre> in your Bugzilla directory.


to ensure that you've modified all the relevant files.
==I tried to move my Bugzilla from one machine to another, and now there's something wrong with the data.==


If using Apache on Windows, you can avoid the whole problem
Make sure that you followed the instructions on [[Bugzilla:Move Installation]]. In particular, when you import a database dump, your database has to be '''totally empty''', meaning that it must have no tables in it at all.
by setting the ScriptInterpreterSource directive to 'Registry'.
(If using Apache 2 or higher, set it to 'Registry-Strict'.)
ScriptInterperterSource requires a registry entry
"HKEY_CLASSES_ROOT\.cgi\Shell\ExecCGI\Command" to associate .cgi files
with your perl executable.
If one does not already exist,
create it with a default value of "<full path to perl> -T %*",
e.g. "C:\Perl\bin\perl.exe -T %*".


Make sure you close out the registry before trying it again.
==I get the error "MySQL server has gone away"==
An export of the registry entry is:
Windows Registry Editor Version 5.00


[HKEY_CLASSES_ROOT\.cgi\Shell\ExecCGI\Command]
This usually means that the <tt>max_allowed_packet</tt> setting in your MySQL configuration is too small. It needs to be set larger than the largest piece of data you're trying to insert in to the database. (Usually, this means it has to be larger than your <tt>maxattachmentsize</tt> parameter.) The MySQL configuration is usually in <tt>/etc/my.cnf</tt>.
@="c:\\perl\\bin\\perl.exe -T %*"


<Put that in a .reg file and import it into your registry>
==I have Apache's mod_security installed, and Bugzilla is not functioning.==


==Is there an easy way to change the Bugzilla cookie name?==
Bugzilla is not compatible with mod_security. You will have to uninstall mod_security or disable it for Bugzilla.
At present, no.


==Does bugzilla run under mod_perl?==
==My parameters don't update when using editparams.cgi, what am I doing wrong?==
Yes. You need to run Bugzilla 3.0 or newer. We recommend Bugzilla 3.0.3 or higher as significant improvements have been made in memory consumption.


==How can Bugzilla be made to work under SELinux?==
Bugzilla's parameters are stored in the <tt>data/params</tt> file.
Unfortunately there are no step-by-step instructions, but the following URL contains hints on how to do it: http://fedora.redhat.com/docs/selinux-apache-fc3/sn-debugging-and-customizing.html
In order to update parameters, the '''user that your web server runs Bugzilla's scripts as''' needs permission to:


[[category:Bugzilla|F]]
* create, alter and delete files in Bugzilla's <tt>data/</tt> directory
* alter and delete the <tt>params</tt> file in Bugzilla's <tt>data/</tt> directory


==Old Charts complain about "Unable to open the chart datafile ./data/mining/-All-"==


See http://www.bugzilla.org/docs/tip/html/extraconfig.html for information on how to set up the <tt>collectstats.pl</tt> script to enable the Old Charts and New Charts.


'''The Bugzilla FAQ'''
==My problem isn't listed here==


#[[Bugzilla:FAQ:Managerial_Questions|Managerial Questions]]
If all else fails, check out places you can get [http://www.bugzilla.org/support/ support for Bugzilla].
#[[Bugzilla:FAQ:Administrative_Questions|Administrative Questions]]
#[[Bugzilla:FAQ:Software_Matrix|Software Matrix]]
#[[Bugzilla:FAQ:Bugzilla_Security|Bugzilla Security]]
#[[Bugzilla:FAQ:Bugzilla_Email|Bugzilla Email]]
#[[Bugzilla:FAQ:Bugzilla_Database|Bugzilla Database]]
#[[Bugzilla:FAQ:Bugzilla_and_Win32|Bugzilla and Win32]]
#[[Bugzilla:FAQ:Bugzilla_Usage|Bugzilla Usage]]
#[[Bugzilla:FAQ:Bugzilla_Hacking|Bugzilla Hacking]]
#[[Bugzilla:FAQ:Bugzilla_Troubleshooting|Bugzilla Troubleshooting]]


[[category:Bugzilla|F]]
[[category:Bugzilla|F]]
Confirmed users, Bureaucrats and Sysops emeriti
674

edits