diff --git a/docs/en/rst/about/index.rst b/docs/en/rst/about/index.rst index 8c0c326d82..4eb1b218d1 100644 --- a/docs/en/rst/about/index.rst +++ b/docs/en/rst/about/index.rst @@ -17,12 +17,10 @@ The most current version of this document can always be found on the Evaluating Bugzilla ################### -If you want to try out Bugzilla to see if it meets your needs, you can do so on -`Mozilla’s Bugzilla (BMO) test server `_, -though it comes with various Mozilla-specific customizations. The easiest way to -explore the admin tools and more is :ref:`running a minimum local copy of -BMO ` using Vagrant or Docker. We are not offering a generic -test environment at this time. +If you want to try out Bugzilla to see if it meets your needs, the easiest +way to explore it, including the admin tools, is :ref:`running a local copy +` using Docker. We are not offering a public test environment at +this time. The `Bugzilla FAQ `_ may also be helpful, as it answers a number of questions people sometimes have about whether Bugzilla @@ -33,12 +31,9 @@ is for them. Getting More Help ################# -If this document does not answer your questions, we run a -`Mozilla forum `_ -which can be accessed as a newsgroup, mailing list, or over the web as a -Google Group. Please -`search it `_ -first, and then ask your question there. +If this document does not answer your questions, see the +`Bugzilla support page `_ for the +current mailing lists and chat channels. If you need a guaranteed response, commercial support is `available `_ for Bugzilla diff --git a/docs/en/rst/api/core/v1/flag-activity.rst b/docs/en/rst/api/core/v1/flag-activity.rst index 4a8a2cb7f1..4596cbdd3b 100644 --- a/docs/en/rst/api/core/v1/flag-activity.rst +++ b/docs/en/rst/api/core/v1/flag-activity.rst @@ -82,13 +82,13 @@ For example, to get the first 100 flag-activity entries that occurred on or afte "id": 1449303, "requestee": { "id": 123, - "name": "user@mozilla.com", + "name": "user@example.com", "nick": "user", "real_name": "J. Random User" }, "setter": { "id": 123, - "name": "user@mozilla.com", + "name": "user@example.com", "nick": "user", "real_name": "J. Random User" }, diff --git a/docs/en/rst/api/core/v1/general.rst b/docs/en/rst/api/core/v1/general.rst index 8e70ace8cf..ebcf65f9ee 100644 --- a/docs/en/rst/api/core/v1/general.rst +++ b/docs/en/rst/api/core/v1/general.rst @@ -108,7 +108,7 @@ Preferences pages. API keys may also be requested via :ref:`Authentication Delegation `. -**WARNING**: It should be noted that additional authentication methods exist, but they are **not recommended** for use and are likely to be deprecated in future versions of BMO, due to security concerns. These additional methods include the following: +**WARNING**: It should be noted that additional authentication methods exist, but they are **not recommended** for use and are likely to be deprecated in future versions of Bugzilla, due to security concerns. These additional methods include the following: - username and password via ``Bugzilla_login`` and ``Bugzilla_password`` or simply ``login`` and ``password`` respectively in query parameters. - username and password via ``X-BUGZILLA-LOGIN`` and ``X-BUGZILLA-PASSWORD`` headers respectively. diff --git a/docs/en/rst/installing/linux.rst b/docs/en/rst/installing/linux.rst index 49639e1f51..b3279cb1b4 100644 --- a/docs/en/rst/installing/linux.rst +++ b/docs/en/rst/installing/linux.rst @@ -47,8 +47,8 @@ in the `installation instructions `_ Run the following to install the base Bugzilla dependencies: -:command:`dnf install git httpd httpd-devel mariadb-devel gcc -mariadb-server mod_perl mod_perl-devel 'perl(autodie)' 'perl(CGI)' +:command:`dnf install git httpd mariadb-devel gcc +mariadb-server 'perl(autodie)' 'perl(CGI)' 'perl(Date::Format)' 'perl(DateTime)' 'perl(DateTime::TimeZone)' 'perl(DBI)' 'perl(DBD::mysql)' 'perl(DBIx::Connector)' 'perl(Digest::SHA)' 'perl(Email::MIME)' 'perl(Email::Sender)' 'perl(fields)' 'perl(JSON::XS)' @@ -65,7 +65,7 @@ On Fedora, all the optional dependencies are available: 'perl(File::Which)' 'perl(GD)' 'perl(GD::Graph)' 'perl(GD::Text)' 'perl(HTML::FormatText::WithLinks)' 'perl(HTML::Parser)' 'perl(HTML::Scrubber)' 'perl(IO::Scalar)' 'perl(JSON::RPC)' -'perl(LWP::UserAgent)' 'perl(MIME::Parser)' 'perl(mod_perl2)' +'perl(LWP::UserAgent)' 'perl(MIME::Parser)' 'perl(Net::LDAP)' 'perl(Net::SMTP::SSL)' 'perl(PatchReader)' 'perl(SOAP::Lite)' 'perl(Template::Plugin::GD::Image)' 'perl(Test::Taint)' 'perl(TheSchwartz)' 'perl(XMLRPC::Lite)' @@ -81,7 +81,7 @@ repositories, so use the following instead: 'perl(File::Which)' 'perl(GD)' 'perl(GD::Graph)' 'perl(GD::Text)' 'perl(HTML::Parser)' 'perl(HTML::Scrubber)' 'perl(IO::Scalar)' 'perl(JSON::RPC)' 'perl(LWP::UserAgent)' 'perl(MIME::Parser)' -'perl(mod_perl2)' 'perl(Net::LDAP)' 'perl(Net::SMTP::SSL)' +'perl(Net::LDAP)' 'perl(Net::SMTP::SSL)' 'perl(SOAP::Lite)' 'perl(Test::Taint)' 'perl(XMLRPC::Lite)' 'perl(XML::Twig)'` @@ -111,8 +111,8 @@ the appropriate packages for that (in the command above, the packages required for MariaDB are ``libdbd-mysql-perl``, ``libmariadb-dev-compat`` and ``mariadb-server``). You can install optional packages with: -:command:`apt install graphviz libapache2-mod-perl2 -libapache2-mod-perl2-dev libauthen-radius-perl libauthen-sasl-perl +:command:`apt install graphviz +libauthen-radius-perl libauthen-sasl-perl libcache-memcached-perl libchart-perl libdaemon-generic-perl libemail-reply-perl libencode-detect-perl libencode-perl libfile-copy-recursive-perl libfile-mimeinfo-perl libfile-which-perl diff --git a/docs/en/rst/installing/mac-os-x.rst b/docs/en/rst/installing/mac-os-x.rst index 37a1d36104..a9954f7c9c 100644 --- a/docs/en/rst/installing/mac-os-x.rst +++ b/docs/en/rst/installing/mac-os-x.rst @@ -93,19 +93,8 @@ Install all missing modules locally like this: Web Server ========== -Any web server that is capable of running CGI scripts can be made to work. -We have specific configuration instructions for the following: - -* :ref:`apache` - -You'll need to create a symbolic link so the webserver can see Bugzilla: - -:command:`cd /Library/WebServer/Documents` - -:command:`sudo ln -s $HOME/bugzilla bugzilla` - -In :guilabel:`System Preferences` --> :guilabel:`Sharing`, enable the -:guilabel:`Web Sharing` checkbox to start Apache. +Bugzilla runs as its own web app. For production use, put a web server in +front of it as a reverse proxy; see :ref:`web_server`. .. _macosx-config-database: diff --git a/docs/en/rst/installing/multiple-bugzillas.rst b/docs/en/rst/installing/multiple-bugzillas.rst index 1e2d7951fa..fb76d7f13b 100644 --- a/docs/en/rst/installing/multiple-bugzillas.rst +++ b/docs/en/rst/installing/multiple-bugzillas.rst @@ -25,17 +25,15 @@ result in a file called :file:`localconfig.foo` instead of reference to a new database, and re-run :command:`checksetup.pl` to populate it. That's all. -Now you have to configure the web server to pass this environment -variable when accessed via an alternate URL, such as virtual host for -instance. The following is an example of how you could do it in Apache, -other Webservers may differ. +Each instance runs as its own Bugzilla web app process. Start it with +``PROJECT`` set and on its own port: -.. code-block:: apache +.. code-block:: console - - ServerName bugzilla.example.com - SetEnv PROJECT foo - + PROJECT=foo PORT=3002 MOJO_REVERSE_PROXY=1 ./bugzilla.pl daemon + +Then configure your web server to proxy the instance's hostname to that +port, as described in :ref:`web_server`. Don't forget to also export this variable before accessing Bugzilla by other means, such as repeating tasks like those above. diff --git a/docs/en/rst/installing/oracle.rst b/docs/en/rst/installing/oracle.rst index 860b61fe63..ccedce0b01 100644 --- a/docs/en/rst/installing/oracle.rst +++ b/docs/en/rst/installing/oracle.rst @@ -55,15 +55,15 @@ as above. .. _oracle_webserver: -Configure the Web Server -======================== +Configure the Environment +========================= -If you use Apache, append these lines to :file:`httpd.conf` -to set ORACLE_HOME and LD_LIBRARY_PATH. For instance: +Set ORACLE_HOME and LD_LIBRARY_PATH in the environment of the Bugzilla web +app before starting it. For instance: -.. code-block:: apache +.. code-block:: console - SetEnv ORACLE_HOME /u01/app/oracle/product/10.2.0/ - SetEnv LD_LIBRARY_PATH /u01/app/oracle/product/10.2.0/lib/ + export ORACLE_HOME=/u01/app/oracle/product/10.2.0/ + export LD_LIBRARY_PATH=/u01/app/oracle/product/10.2.0/lib/ -When this is done, restart your web server. +Then restart the Bugzilla web app. diff --git a/docs/en/rst/installing/windows.rst b/docs/en/rst/installing/windows.rst index d756077b06..ddcb4fbdd8 100644 --- a/docs/en/rst/installing/windows.rst +++ b/docs/en/rst/installing/windows.rst @@ -119,8 +119,6 @@ installed: * HTML-FormatText-WithLinks * TheSchwartz * Daemon-Generic -* mod_perl -* Apache-SizeLimit * File-MimeInfo * IO-stringy * Cache-Memcached @@ -141,11 +139,8 @@ below. Web Server ========== -Any web server that is capable of running CGI scripts can be made to work. -We have specific instructions for the following: - -* :ref:`apache-windows` -* :ref:`iis` +Bugzilla runs as its own web app. For production use, put a web server in +front of it as a reverse proxy; see :ref:`web_server`. .. windows-config-database: @@ -168,16 +163,4 @@ setup. Configure your server according to the instructions below: .. include:: installing-end.inc.rst -If you don't see the main Bugzilla page, but instead see "It works!!!", -then somehow your Apache has not picked up your modifications to -:file:`httpd.conf`. If you are on Windows 7 or later, this could be due to a -new feature called "VirtualStore". `This blog post -`_ -may help to solve the problem. - -If you get an "Internal Error..." message, it could be that -``ScriptInterpreterSource Registry-Strict`` is not set in your -:ref:`Apache configuration `. Check again if it is set -properly. - Next, do the :ref:`essential-post-install-config`. diff --git a/docs/en/rst/integrating/auth-delegation.rst b/docs/en/rst/integrating/auth-delegation.rst index b905f5c05a..c0cd10e132 100644 --- a/docs/en/rst/integrating/auth-delegation.rst +++ b/docs/en/rst/integrating/auth-delegation.rst @@ -10,20 +10,22 @@ a result very powerful. Because of this power, this feature is disabled by defau Authentication Flow ------------------- -The authentication process begins by directing the user to th the Bugzilla site's auth.cgi. +The authentication process begins by directing the user to the Bugzilla site's auth.cgi. For the sake of this example, our application's URL is `http://app.example.org` -and the Bugzilla site is `http://bugzilla.mozilla.org`. +and the Bugzilla site is `https://bugzilla.example.org`. -1. Provide a link or redirect the user to `https://bugzilla.mozilla.org/auth.cgi?callback=http://app.example.org/callback&description=app%description` +1. Provide a link or redirect the user to `https://bugzilla.example.org/auth.cgi?callback=http://app.example.org/callback&description=app%description` 2. Assuming the user is agreeable, the following will happen: - 1. Bugzilla will issue a POST request to `http://app.example.org/callback` - with a the request body data being a JSON object with keys `client_api_key` and `client_api_login`. - 2. The callback, when responding to the POST request must return a JSON object with a key `result`. This result - is intended to be a unique token used to identify this transaction. - 3. Bugzilla will then cause the user agent to redirect (using a GET request) to `http://app.example.org/callback` - with additional query string parameters `client_api_login` and `callback_result`. - 4. At this point, the consumer now has the api key and login information. Be sure to compare the `callback_result` to whatever result was initially sent back - to Bugzilla. + + 1. Bugzilla will issue a POST request to `http://app.example.org/callback` + with the request body data being a JSON object with keys `client_api_key` and `client_api_login`. + 2. The callback, when responding to the POST request must return a JSON object with a key `result`. This result + is intended to be a unique token used to identify this transaction. + 3. Bugzilla will then cause the user agent to redirect (using a GET request) to `http://app.example.org/callback` + with additional query string parameters `client_api_login` and `callback_result`. + 4. At this point, the consumer now has the api key and login information. Be sure to compare the `callback_result` to whatever result was initially sent back + to Bugzilla. + 3. Finally, you should check that the API key and login are valid, using the :ref:`rest_user_whoami` REST resource. diff --git a/docs/en/rst/integrating/auth0.rst b/docs/en/rst/integrating/auth0.rst index e3fa76ba3a..fcf187db3f 100644 --- a/docs/en/rst/integrating/auth0.rst +++ b/docs/en/rst/integrating/auth0.rst @@ -11,8 +11,8 @@ Parameter Example(s) Notes Name Bugzilla-Stage Memorable name for the connection Client ID aaaaaaaaaaaaaaaaaaaa Ask your Bugzilla admin to create one for you. Client Secret aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Same as above. -Authorization URL https://bugzilla.allizom.org/oauth/authorize Note the HTTP client must use the correct HOST header. -Token URL https://bugzilla.allizom.org/oauth/access_token (none) +Authorization URL https://bugzilla.example.org/oauth/authorize Note the HTTP client must use the correct HOST header. +Token URL https://bugzilla.example.org/oauth/access_token (none) Scope user:read As of this writing, this is the only scope available. Fetch User Profile (see below) (none) ==================== =============================================== ====================================================== @@ -20,7 +20,7 @@ Fetch User Profile (see below) (none) .. code-block:: js function (access_token, ctx, callback) { - request.get('https://bugzilla.allizom.org/api/user/profile', { + request.get('https://bugzilla.example.org/api/user/profile', { 'headers': { 'Authorization': 'Bearer ' + access_token, 'User-Agent': 'Auth0' diff --git a/docs/en/rst/integrating/skins.rst b/docs/en/rst/integrating/skins.rst index 92bf60dfc0..5eb76acb99 100644 --- a/docs/en/rst/integrating/skins.rst +++ b/docs/en/rst/integrating/skins.rst @@ -4,11 +4,9 @@ Skins ===== Bugzilla supports skins - ways of changing the look of the UI without altering -its underlying structure. It ships with two - "Classic" and "Dusk". You can +its underlying structure. It ships with only the default skin; additional skins go in :file:`skins/contrib`. You can find some more listed -`on the wiki `_, and there -are a couple more which are part of -`bugzilla.mozilla.org `_. +`on the wiki `_. However, in each case you may need to check that the skin supports the version of Bugzilla you have. diff --git a/docs/en/rst/integrating/templates.rst b/docs/en/rst/integrating/templates.rst index e17e839012..bdf617b950 100644 --- a/docs/en/rst/integrating/templates.rst +++ b/docs/en/rst/integrating/templates.rst @@ -231,11 +231,10 @@ customizing for your installation. such as drop-down lists or textboxes, to the bug entry page and have their values appear formatted in the initial comment. - An example of this is the `guided bug submission form - `_. + An example of this is the guided bug submission form. The code for this comes with the Bugzilla distribution as an example for you to copy. It can be found in the files - :file:`create-guided.html.tmpl` and :file:`comment-guided.html.tmpl`. + :file:`create-guided.html.tmpl` and :file:`comment-guided.txt.tmpl`. A hidden field that indicates the format should be added inside the form in order to make the template functional. Its value should diff --git a/docs/en/rst/using/creating-an-account.rst b/docs/en/rst/using/creating-an-account.rst index 3d70096f55..529f2dc650 100644 --- a/docs/en/rst/using/creating-an-account.rst +++ b/docs/en/rst/using/creating-an-account.rst @@ -6,8 +6,7 @@ Creating an Account If you want to use a particular installation of Bugzilla, first you need to create an account. Ask the administrator responsible for your installation for the URL you should use to access it. If you're test-driving Bugzilla, -you can use one of the installations on `Mozilla’s Bugzilla (BMO) test server -`_. +you can :ref:`run a local copy `. The process of creating an account is similar to many other websites. diff --git a/docs/en/rst/using/filing.rst b/docs/en/rst/using/filing.rst index a76e3faed8..725ced41cc 100644 --- a/docs/en/rst/using/filing.rst +++ b/docs/en/rst/using/filing.rst @@ -16,7 +16,7 @@ Platform, and Operating System you were using at the time of the failure go a long way toward ensuring accurate, responsible fixes for the bug that bit you. .. note:: If you want to file a test bug to see how Bugzilla works, you can do - so on `Mozilla’s Bugzilla (BMO) test server `_. + so on a :ref:`local copy `. Please don’t do it on any production Bugzilla installation. The procedure for filing a bug is as follows: diff --git a/docs/en/rst/using/finding.rst b/docs/en/rst/using/finding.rst index dcd2ec7ce9..14d07b89a7 100644 --- a/docs/en/rst/using/finding.rst +++ b/docs/en/rst/using/finding.rst @@ -43,8 +43,7 @@ Advanced Search =============== The Advanced Search page is used to produce a list of all bugs fitting -exact criteria. You can play with it on `Mozilla’s Bugzilla (BMO) test server -`_. +exact criteria. Advanced Search has controls for selecting different possible values for all of the fields in a bug, as described above. For some @@ -205,7 +204,7 @@ This restriction is mostly used for security-related bugs, or internal tickets. In order to search for bugs restricted to a group, you must be a member of the group. -Visit `the Permissions page `_ +Visit the :guilabel:`Permissions` tab in :guilabel:`Preferences` to find the groups you belong to, then search using the clause Group is equal to "%group.groupname%"