5. Integration and Customization Guide

You may find that Bugzilla already does what you want it to do, you just need to configure it correctly. Read the Administration Guide sections carefully to see if that’s the case for you. If not, then this chapter explains how to use the available mechanisms for integration and customization.

• 5.1. Customization FAQ
• 5.2. Languages
• 5.3. Skins
• 5.4. Templates
  • 5.4.1. Template Directory Structure
  • 5.4.2. Choosing a Customization Method
  • 5.4.3. How To Edit Templates
  • 5.4.4. Template Formats and Types
  • 5.4.5. Particular Templates
• 5.5. Extensions
  • 5.5.1. Adding A New Page to Bugzilla
  • 5.5.2. Altering Data On An Existing Page
  • 5.5.3. Adding New Fields To Bugs
  • 5.5.4. Adding New Fields To Other Things
  • 5.5.5. Adding Admin Configuration Panels
  • 5.5.6. Adding User Preferences
  • 5.5.7. Altering Who Can Change What
  • 5.5.8. Checking Syntax
• 5.6. APIs
  • 5.6.1. Core Module API
  • 5.6.2. Ad-Hoc APIs
  • 5.6.3. XML-RPC
  • 5.6.4. JSON-RPC
  • 5.6.5. REST
  • 5.6.6. BzAPI/BzAPI-Compatible REST
  • 5.6.7. REST v2
• 5.7. API Documentation
  • 5.7.1. Bugzilla
  • 5.7.2. Bugzilla::Attachment
  • 5.7.3. Bugzilla::Attachment::PatchReader
  • 5.7.4. Bugzilla::Auth
  • 5.7.5. Bugzilla::Auth::Login
  • 5.7.6. Bugzilla::Auth::Verify
  • 5.7.7. Bugzilla::Bug
  • 5.7.8. Bugzilla::BugMail
  • 5.7.9. Bugzilla::BugUrl
  • 5.7.10. Bugzilla::BugUserLastVisit
  • 5.7.11. Bugzilla::CGI
  • 5.7.12. Bugzilla::Chart
  • 5.7.13. Bugzilla::Classification
  • 5.7.14. Bugzilla::Comment
  • 5.7.15. Bugzilla::Comment::TagWeights
  • 5.7.16. Bugzilla::Component
  • 5.7.17. Bugzilla::Config
  • 5.7.18. Bugzilla::Config::Common
  • 5.7.19. Bugzilla::Constants
  • 5.7.20. Bugzilla::DB
  • 5.7.21. Bugzilla::DB::Mysql
  • 5.7.22. Bugzilla::DB::Oracle
  • 5.7.23. Bugzilla::DB::Pg
  • 5.7.24. Bugzilla::DB::Schema
  • 5.7.25. Bugzilla::DB::Schema::Mysql
  • 5.7.26. Bugzilla::DB::Schema::Oracle
  • 5.7.27. Bugzilla::DB::Schema::Pg
  • 5.7.28. Bugzilla::DB::Schema::Sqlite
  • 5.7.29. Bugzilla::DB::Sqlite
  • 5.7.30. Bugzilla::Error
  • 5.7.31. Bugzilla::Extension
  • 5.7.32. Bugzilla::Field
  • 5.7.33. Bugzilla::Field::Choice
  • 5.7.34. Bugzilla::Field::ChoiceInterface
  • 5.7.35. Bugzilla::Flag
  • 5.7.36. Bugzilla::FlagType
  • 5.7.37. Bugzilla::Group
  • 5.7.38. Bugzilla::Hook
  • 5.7.39. Bugzilla::Install
  • 5.7.40. Bugzilla::Install::CPAN
  • 5.7.41. Bugzilla::Install::DB
  • 5.7.42. Bugzilla::Install::Filesystem
  • 5.7.43. Bugzilla::Install::Localconfig
  • 5.7.44. Bugzilla::Install::Requirements
  • 5.7.45. Bugzilla::Install::Util
  • 5.7.46. Bugzilla::JobQueue
  • 5.7.47. Bugzilla::JobQueue::Runner
  • 5.7.48. Bugzilla::Keyword
  • 5.7.49. Bugzilla::MIME
  • 5.7.50. Bugzilla::Mailer
  • 5.7.51. Bugzilla::Memcached
  • 5.7.52. Bugzilla::Migrate
  • 5.7.53. Bugzilla::Migrate::Gnats
  • 5.7.54. Bugzilla::Milestone
  • 5.7.55. Bugzilla::ModPerl
  • 5.7.56. Bugzilla::Object
  • 5.7.57. Bugzilla::Product
  • 5.7.58. Bugzilla::RNG
  • 5.7.59. Bugzilla::Release
  • 5.7.60. Bugzilla::Report
  • 5.7.61. Bugzilla::Search
  • 5.7.62. Bugzilla::Search::Clause
  • 5.7.63. Bugzilla::Search::ClauseGroup
  • 5.7.64. Bugzilla::Search::Condition
  • 5.7.65. Bugzilla::Search::Quicksearch
  • 5.7.66. Bugzilla::Search::Recent
  • 5.7.67. Bugzilla::Search::Saved
  • 5.7.68. Bugzilla::Sender::Transport::Sendmail
  • 5.7.69. Bugzilla::Series
  • 5.7.70. Bugzilla::Status
  • 5.7.71. Bugzilla::Template
  • 5.7.72. Bugzilla::Template::Context
  • 5.7.73. Bugzilla::Template::Plugin::Bugzilla
  • 5.7.74. Bugzilla::Template::Plugin::Hook
  • 5.7.75. Bugzilla::Template::PreloadProvider
  • 5.7.76. Bugzilla::Token
  • 5.7.77. Bugzilla::Update
  • 5.7.78. Bugzilla::User
  • 5.7.79. Bugzilla::User::APIKey
  • 5.7.80. Bugzilla::User::Session
  • 5.7.81. Bugzilla::User::Setting
  • 5.7.82. Bugzilla::User::Setting::Lang
  • 5.7.83. Bugzilla::User::Setting::Skin
  • 5.7.84. Bugzilla::User::Setting::Timezone
  • 5.7.85. Bugzilla::UserAgent
  • 5.7.86. Bugzilla::Util
  • 5.7.87. Bugzilla::Version
  • 5.7.88. Bugzilla::WebService
  • 5.7.89. Bugzilla::WebService::Bug
  • 5.7.90. Bugzilla::WebService::BugUserLastVisit
  • 5.7.91. Bugzilla::WebService::Bugzilla
  • 5.7.92. Bugzilla::WebService::Classification
  • 5.7.93. Bugzilla::WebService::Component
  • 5.7.94. Bugzilla::WebService::Constants
  • 5.7.95. Bugzilla::WebService::FlagType
  • 5.7.96. Bugzilla::WebService::Group
  • 5.7.97. Bugzilla::WebService::Product
  • 5.7.98. Bugzilla::WebService::Server
  • 5.7.99. Bugzilla::WebService::Server::JSONRPC
  • 5.7.100. Bugzilla::WebService::Server::REST
  • 5.7.101. Bugzilla::WebService::Server::REST::Resources::Bug
  • 5.7.102. Bugzilla::WebService::Server::REST::Resources::BugUserLastVisit
  • 5.7.103. Bugzilla::WebService::Server::REST::Resources::Bugzilla
  • 5.7.104. Bugzilla::WebService::Server::REST::Resources::Classification
  • 5.7.105. Bugzilla::WebService::Server::REST::Resources::Component
  • 5.7.106. Bugzilla::WebService::Server::REST::Resources::FlagType
  • 5.7.107. Bugzilla::WebService::Server::REST::Resources::Group
  • 5.7.108. Bugzilla::WebService::Server::REST::Resources::Product
  • 5.7.109. Bugzilla::WebService::Server::REST::Resources::User
  • 5.7.110. Bugzilla::WebService::Server::XMLRPC
  • 5.7.111. Bugzilla::WebService::User
  • 5.7.112. Bugzilla::WebService::Util
  • 5.7.113. Bugzilla::Whine
  • 5.7.114. Bugzilla::Whine::Query
  • 5.7.115. Bugzilla::Whine::Schedule
  • 5.7.116. checksetup
  • 5.7.117. clean-bug-user-last-visit
  • 5.7.118. collectstats
  • 5.7.119. contrib::bz_webservice_demo
  • 5.7.120. contrib::bzdbcopy
  • 5.7.121. contrib::console
  • 5.7.122. contrib::extension-convert
  • 5.7.123. contrib::merge-users
  • 5.7.124. contrib::recode
  • 5.7.125. email_in
  • 5.7.126. Bugzilla::Extension::ActivityReport::WebService
  • 5.7.127. Bugzilla::Extension::AgileTools
  • 5.7.128. Bugzilla::Extension::AgileTools::Backlog
  • 5.7.129. Bugzilla::Extension::AgileTools::Burn
  • 5.7.130. Bugzilla::Extension::AgileTools::Constants
  • 5.7.131. Bugzilla::Extension::AgileTools::Pages
  • 5.7.132. Bugzilla::Extension::AgileTools::Pages::Scrum
  • 5.7.133. Bugzilla::Extension::AgileTools::Pages::Team
  • 5.7.134. Bugzilla::Extension::AgileTools::Params
  • 5.7.135. Bugzilla::Extension::AgileTools::Pool
  • 5.7.136. Bugzilla::Extension::AgileTools::Role
  • 5.7.137. Bugzilla::Extension::AgileTools::Schema
  • 5.7.138. Bugzilla::Extension::AgileTools::Sprint
  • 5.7.139. Bugzilla::Extension::AgileTools::Team
  • 5.7.140. Bugzilla::Extension::AgileTools::Util
  • 5.7.141. Bugzilla::Extension::AgileTools::WebService::Backlog
  • 5.7.142. Bugzilla::Extension::AgileTools::WebService::Pool
  • 5.7.143. Bugzilla::Extension::AgileTools::WebService::Sprint
  • 5.7.144. Bugzilla::Extension::AgileTools::WebService::Team
  • 5.7.145. Bugzilla::Extension::AgileTools::WebService::Util
  • 5.7.146. Bugzilla::Extension::AntiSpam::Config
  • 5.7.147. Bugzilla::Extension::AuthJWT
  • 5.7.148. Bugzilla::Extension::AuthJWT::Source
  • 5.7.149. Bugzilla::Extension::BayotBase::Config
  • 5.7.150. Bugzilla::Extension::BotWatching
  • 5.7.151. Bugzilla::Extension::BugViewPlus::Params
  • 5.7.152. Bugzilla::Extension::BugViewPlus::Template
  • 5.7.153. Bugzilla::Extension::ComponentWatching::WebService
  • 5.7.154. Bugzilla::Extension::DependentProducts
  • 5.7.155. Bugzilla::Extension::DependentProducts::Bug
  • 5.7.156. Bugzilla::Extension::DependentProducts::Contact
  • 5.7.157. Bugzilla::Extension::DependentProducts::Record
  • 5.7.158. Bugzilla::Extension::DependentProducts::Util
  • 5.7.159. Bugzilla::Extension::DependentProducts::WebService
  • 5.7.160. Bugzilla::Extension::ExternalBugs
  • 5.7.161. Bugzilla::Extension::ExternalBugs::Bug
  • 5.7.162. Bugzilla::Extension::ExternalBugs::Config
  • 5.7.163. Bugzilla::Extension::ExternalBugs::Type
  • 5.7.164. Bugzilla::Extension::ExternalBugs::Type::Bugzilla
  • 5.7.165. Bugzilla::Extension::ExternalBugs::Type::Gerrit
  • 5.7.166. Bugzilla::Extension::ExternalBugs::Type::GitHub
  • 5.7.167. Bugzilla::Extension::ExternalBugs::Type::GitLab
  • 5.7.168. Bugzilla::Extension::ExternalBugs::Type::JIRA
  • 5.7.169. Bugzilla::Extension::ExternalBugs::Type::KBase
  • 5.7.170. Bugzilla::Extension::ExternalBugs::Type::Redmine
  • 5.7.171. Bugzilla::Extension::ExternalBugs::Type::SFDC
  • 5.7.172. Bugzilla::Extension::ExternalBugs::Util
  • 5.7.173. Bugzilla::Extension::ExternalBugs::WebService
  • 5.7.174. Bugzilla::Extension::ListOfBugs
  • 5.7.175. Bugzilla::Extension::ListOfBugs::WebService
  • 5.7.176. Bugzilla::Extension::PlotlyReports
  • 5.7.177. Bugzilla::Extension::PlotlyReports::Graphs::BugSeverity
  • 5.7.178. Bugzilla::Extension::PlotlyReports::Graphs::BugStatus
  • 5.7.179. Bugzilla::Extension::PlotlyReports::Graphs::NonDefaults
  • 5.7.180. Bugzilla::Extension::PlotlyReports::Util
  • 5.7.181. Bugzilla::Extension::Push
  • 5.7.182. Bugzilla::Extension::Push::bin::bugzilla-pushd
  • 5.7.183. Bugzilla::Extension::RedHat
  • 5.7.184. Bugzilla::Extension::RedHat::bin::bz-expire-cookies
  • 5.7.185. Bugzilla::Extension::RedHat::bin::bz-schema-audit
  • 5.7.186. Bugzilla::Extension::RedHat::bin::cert_alert
  • 5.7.187. Bugzilla::Extension::RedHat::bin::clear_needinfo
  • 5.7.188. Bugzilla::Extension::RedHat::bin::group-member-audit
  • 5.7.189. Bugzilla::Extension::RedHat::bin::idps
  • 5.7.190. Bugzilla::Extension::RedHat::bin::jwts
  • 5.7.191. Bugzilla::Extension::RedHat::bin::ldap-audit
  • 5.7.192. Bugzilla::Extension::RedHat::bin::pushd
  • 5.7.193. Bugzilla::Extension::RedHat::bin::reauthorize
  • 5.7.194. Bugzilla::Extension::RedHat::bin::release
  • 5.7.195. Bugzilla::Extension::RedHat::bin::remove_invalid_group
  • 5.7.196. Bugzilla::Extension::RedHat::bin::sitemap
  • 5.7.197. Bugzilla::Extension::RedHat::bin::sync-internal-groups
  • 5.7.198. Bugzilla::Extension::RedHat::Config
  • 5.7.199. Bugzilla::Extension::RedHat::WebService::Bugzilla
  • 5.7.200. Bugzilla::Extension::RedHat::WebService::Component
  • 5.7.201. Bugzilla::Extension::RedHat::WebService::Field
  • 5.7.202. Bugzilla::Extension::RedHat::WebService::Flag
  • 5.7.203. Bugzilla::Extension::Releases::ACKCustomSearch
  • 5.7.204. Bugzilla::Extension::Releases::ACKList
  • 5.7.205. Bugzilla::Extension::Releases::ACKView
  • 5.7.206. Bugzilla::Extension::Releases::Components
  • 5.7.207. Bugzilla::Extension::Releases::Release
  • 5.7.208. Bugzilla::Extension::Releases::Schedule
  • 5.7.209. Bugzilla::Extension::Releases::Util
  • 5.7.210. Bugzilla::Extension::Releases::WebService
  • 5.7.211. Bugzilla::Extension::RuleEngine
  • 5.7.212. Bugzilla::Extension::RuleEngine::add_bugs_to_queue
  • 5.7.213. Bugzilla::Extension::RuleEngine::FlagGroup
  • 5.7.214. Bugzilla::Extension::RuleEngine::FlagGroupDetail
  • 5.7.215. Bugzilla::Extension::RuleEngine::Rule
  • 5.7.216. Bugzilla::Extension::RuleEngine::RuleDetail
  • 5.7.217. Bugzilla::Extension::RuleEngine::RuleGroup
  • 5.7.218. Bugzilla::Extension::RuleEngine::RuleState
  • 5.7.219. Bugzilla::Extension::RuleEngine::WebService
  • 5.7.220. Bugzilla::Extension::RuleEngine::WebService::RuleGroup
  • 5.7.221. Bugzilla::Extension::RuleEngine::WebService::Util
  • 5.7.222. Bugzilla::Extension::SAML2Auth
  • 5.7.223. Bugzilla::Extension::SAML2Auth::bin::import-metadata
  • 5.7.224. Bugzilla::Extension::SAML2Auth::IDP
  • 5.7.225. Bugzilla::Extension::SAML2Auth::Login
  • 5.7.226. Bugzilla::Extension::SAML2Auth::Params
  • 5.7.227. Bugzilla::Extension::SAML2Auth::Util
  • 5.7.228. Bugzilla::Extension::SAML2Auth::Verify
  • 5.7.229. Bugzilla::Extension::SecureMail
  • 5.7.230. Bugzilla::Extension::SecureMail::Params
  • 5.7.231. Bugzilla::Extension::SubComponents
  • 5.7.232. Bugzilla::Extension::SubComponents::Config
  • 5.7.233. Bugzilla::Extension::SubComponents::RHSubComponent
  • 5.7.234. Bugzilla::Extension::SubComponents::WebService
  • 5.7.235. Bugzilla::Extension::TreeViewPlus::Util
  • 5.7.236. Bugzilla::Extension::Voting::WebService
  • 5.7.237. Bugzilla::Extension::Workflows
  • 5.7.238. Bugzilla::Extension::Workflows::bin::check_apikeys
  • 5.7.239. Bugzilla::Extension::Workflows::APIKeyExpiry
  • 5.7.240. Bugzilla::Extension::Workflows::CreateBotAccount
  • 5.7.241. Bugzilla::Extension::Workflows::GroupApproval
  • 5.7.242. Bugzilla::Extension::Workflows::GroupInvite
  • 5.7.243. Bugzilla::Extension::Workflows::GroupRequest
  • 5.7.244. Bugzilla::Extension::Workflows::GroupReview
  • 5.7.245. Bugzilla::Extension::Workflows::ManageComponents
  • 5.7.246. Bugzilla::Extension::Workflows::WebService::GroupInvite
  • 5.7.247. Bugzilla::Extension::Workflows::WebService::GroupRequest
  • 5.7.248. Bugzilla::Extension::Workflows::WebService::GroupReview
  • 5.7.249. Bugzilla::Extension::Workflows::WebService::ManageComponents
  • 5.7.250. Bugzilla::Extension::create
  • 5.7.251. importxml
  • 5.7.252. install-module
  • 5.7.253. jobqueue
  • 5.7.254. migrate
  • 5.7.255. sanitycheck

---

This documentation undoubtedly has bugs; if you find some, please file them here.