Skip to content

bugzilla
bugzilla
Commit 7cd83664 authored by lpsolit%gmail.com's avatar lpsolit%gmail.com
Browse files
Options

Docs for bug 284629: maildeliverymethod -> mail_delivery_method

parent 1f90cd07
Hide whitespace changes
Inline Side-by-side
Showing with 322 additions and 132 deletions
docs/en/xml/administration.xml
View file @ 7cd83664
...@@ -82,7 +82,7 @@ ...@@ -82,7 +82,7 @@
<varlistentry> <varlistentry>
<term> <term>
maildeliverymethod mail_delivery_method
</term> </term>
<listitem> <listitem>
<para> <para>
......
docs/en/xml/installation.xml
View file @ 7cd83664
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> --> <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> -->
<!-- $Id: installation.xml,v 1.124 2008/04/04 06:47:54 mozilla%colinogilvie.co.uk Exp $ --> <!-- $Id: installation.xml,v 1.134 2008/04/04 06:48:04 lpsolit%gmail.com Exp $ -->
<chapter id="installing-bugzilla"> <chapter id="installing-bugzilla">
<title>Installing Bugzilla</title> <title>Installing Bugzilla</title>
...@@ -258,7 +258,7 @@ ...@@ -258,7 +258,7 @@
<para>Many people complain that Perl modules will not install for <para>Many people complain that Perl modules will not install for
them. Most times, the error messages complain that they are missing a them. Most times, the error messages complain that they are missing a
file in file in
<quote>@INC</quote>. <quote>@INC</quote>.
Virtually every time, this error is due to permissions being set too Virtually every time, this error is due to permissions being set too
restrictively for you to compile Perl modules or not having the restrictively for you to compile Perl modules or not having the
necessary Perl development libraries installed on your system. necessary Perl development libraries installed on your system.
...@@ -287,24 +287,12 @@ ...@@ -287,24 +287,12 @@
<listitem> <listitem>
<para> <para>
AppConfig (&min-appconfig-ver;) CGI &min-cgi-ver; or CGI &min-mp-cgi-ver; if using mod_perl
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
CGI (&min-cgi-ver;)
</para>
</listitem>
<listitem>
<para>
Data::Dumper (&min-data-dumper-ver;)
</para>
</listitem>
<listitem>
<para>
Date::Format (&min-date-format-ver;) Date::Format (&min-date-format-ver;)
</para> </para>
</listitem> </listitem>
...@@ -336,12 +324,6 @@ ...@@ -336,12 +324,6 @@
<listitem> <listitem>
<para> <para>
File::Temp (&min-file-temp-ver;)
</para>
</listitem>
<listitem>
<para>
<link linkend="install-modules-template">Template</link> <link linkend="install-modules-template">Template</link>
(&min-template-ver;) (&min-template-ver;)
</para> </para>
...@@ -349,41 +331,42 @@ ...@@ -349,41 +331,42 @@
<listitem> <listitem>
<para> <para>
Text::Wrap (&min-text-wrap-ver;) MIME::Base64 (&min-mime-base64-ver;)
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Mail::Mailer (&min-mail-mailer-ver;) MIME::Parser (&min-mime-parser-ver;)
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
MIME::Base64 (&min-mime-base64-ver;) Email::Send (&min-email-send-ver;)
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
MIME::Parser (&min-mime-parser-ver;) Email::MIME::Modifier (&min-email-mime-modifier-ver;)
</para> </para>
</listitem> </listitem>
</orderedlist>
Optional Perl modules:
<orderedlist>
<listitem> <listitem>
<para> <para>
Storable (&min-storable-ver;) <link linkend="install-modules-gd">GD</link>
(&min-gd-ver;) for bug charting
</para> </para>
</listitem> </listitem>
</orderedlist>
Optional Perl modules:
<orderedlist>
<listitem> <listitem>
<para> <para>
<link linkend="install-modules-gd">GD</link> Template::Plugin::GD::Image
(&min-gd-ver;) for bug charting (&min-gd-ver;) for Graphical Reports
</para> </para>
</listitem> </listitem>
...@@ -403,8 +386,8 @@ ...@@ -403,8 +386,8 @@
<listitem> <listitem>
<para> <para>
<link linkend="install-modules-gd-text-align">GD::Text::Align</link> <link linkend="install-modules-gd-text">GD::Text</link>
(&min-gd-text-align-ver;) for bug charting (&min-gd-text-ver;) for bug charting
</para> </para>
</listitem> </listitem>
...@@ -417,6 +400,13 @@ ...@@ -417,6 +400,13 @@
<listitem> <listitem>
<para> <para>
LWP::UserAgent
(&min-lwp-useragent-ver;) for Automatic Update Notifications
</para>
</listitem>
<listitem>
<para>
<link linkend="install-modules-patchreader">PatchReader</link> <link linkend="install-modules-patchreader">PatchReader</link>
(&min-patchreader-ver;) for pretty HTML view of patches (&min-patchreader-ver;) for pretty HTML view of patches
</para> </para>
...@@ -427,7 +417,70 @@ ...@@ -427,7 +417,70 @@
Image::Magick (&min-image-magick-ver;) for converting BMP image attachments to PNG Image::Magick (&min-image-magick-ver;) for converting BMP image attachments to PNG
</para> </para>
</listitem> </listitem>
</orderedlist>
<listitem>
<para>
Net::LDAP
(&min-net-ldap-ver;) for LDAP Authentication
</para>
</listitem>
<listitem>
<para>
<link linkend="install-modules-soap-lite">SOAP::Lite</link>
(&min-soap-lite-ver;) for the web service interface
</para>
</listitem>
<listitem>
<para>
HTML::Parser
(&min-html-parser-ver;) for More HTML in Product/Group Descriptions
</para>
</listitem>
<listitem>
<para>
HTML::Scrubber
(&min-html-scrubber-ver;) for More HTML in Product/Group Descriptions
</para>
</listitem>
<listitem>
<para>
Email::MIME::Attachment::Stripper
(&min-email-mime-attachment-stripper-ver;) for Inbound Email
</para>
</listitem>
<listitem>
<para>
Email::Reply
(&min-email-reply-ver;) for Inbound Email
</para>
</listitem>
<listitem>
<para>
mod_perl2
(&min-mod_perl2-ver;) for mod_perl
</para>
</listitem>
<listitem>
<para>
CGI
(&min-cgi-ver;) for mod_perl
</para>
</listitem>
<listitem>
<para>
Apache::DBI
(&min-apache-dbi-ver;) for mod_perl2
</para>
</listitem>
</orderedlist>
</para> </para>
<section id="install-modules-dbd-mysql"> <section id="install-modules-dbd-mysql">
...@@ -500,10 +553,10 @@ ...@@ -500,10 +553,10 @@
</para> </para>
</section> </section>
<section id="install-modules-gd-text-align"> <section id="install-modules-gd-text">
<title>GD::Text::Align (&min-gd-text-align-ver;)</title> <title>GD::Text (&min-gd-text-ver;)</title>
<para>The GD::Text::Align module is only required if you want graphical <para>The GD::Text module is only required if you want graphical
reports. reports.
</para> </para>
</section> </section>
...@@ -518,6 +571,14 @@ ...@@ -518,6 +571,14 @@
</para> </para>
</section> </section>
<section id="install-modules-soap-lite">
<title>SOAP::Lite (&min-soap-lite-ver;)</title>
<para>Installing SOAP::Lite enables your Bugzilla installation to be
accessible at a standardized Web Service interface (SOAP/XML-RPC)
by third-party applications via HTTP(S).
</para>
</section>
<section id="install-modules-patchreader"> <section id="install-modules-patchreader">
<title>PatchReader (&min-patchreader-ver;)</title> <title>PatchReader (&min-patchreader-ver;)</title>
...@@ -547,8 +608,8 @@ ...@@ -547,8 +608,8 @@
</para> </para>
<para> <para>
For more information, see the "maildeliverymethod" parameter in For more information, see the <quote>mail_delivery_method</quote> parameter
<xref linkend="parameters" />. in <xref linkend="parameters" />.
</para> </para>
</note> </note>
...@@ -582,7 +643,23 @@ ...@@ -582,7 +643,23 @@
</para> </para>
</section> </section>
<section id="using-mod_perl-with-bugzilla">
<title>Installing Bugzilla on mod_perl</title>
<para>It is now possible to run the Bugzilla software under <literal>mod_perl</literal> on
Apache. <literal>mod_perl</literal> has some additional requirements to that of running
Bugzilla under <literal>mod_cgi</literal> (the standard and previous way).</para>
<para>Bugzilla requires <literal>mod_perl</literal> to be installed, which can be
obtained from <ulink url="http://perl.apache.org"/> - Bugzilla requires
version &min-mod_perl2-ver; (AKA 2.0.0-RC5) to be installed.</para>
<para>Bugzilla also requires a more up-to-date version of the CGI
perl module to be installed, version &min-mp-cgi-ver; as opposed to &min-cgi-ver;
</para>
<para>Finally, Bugzilla also requires <literal>Apache::DBI</literal>
(&min-apache-dbi-ver;) to be installed as well.</para>
</section>
</section> </section>
...@@ -653,7 +730,7 @@ ...@@ -653,7 +730,7 @@
<section id="database-engine"> <section id="database-engine">
<title>Database Server</title> <title>Database Server</title>
<para>This section deals with configuring your database server for use <para>This section deals with configuring your database server for use
with Bugzilla. Currently <xref linkend="mysql"/> and with Bugzilla. Currently <xref linkend="mysql"/> and
<xref linkend="postgresql"/> are available.</para> <xref linkend="postgresql"/> are available.</para>
<section id="mysql"> <section id="mysql">
...@@ -880,107 +957,220 @@ ...@@ -880,107 +957,220 @@
<para> <para>
Configure your web server according to the instructions in the Configure your web server according to the instructions in the
appropriate section. (If it makes a difference in your choice, appropriate section. (If it makes a difference in your choice,
the Bugzilla Team recommends Apache.) Regardless of which webserver the Bugzilla Team recommends Apache.) To check whether your web server
is correctly configured, try to access <filename>testagent.cgi</filename>
from your web server. If "OK" is displayed, then your configuration
is successful. Regardless of which web server
you are using, however, ensure that sensitive information is you are using, however, ensure that sensitive information is
not remotely available by properly applying the access controls in not remotely available by properly applying the access controls in
<xref linkend="security-webserver-access"/>. <xref linkend="security-webserver-access"/>. You can run
<filename>testserver.pl</filename> to check if your web server serves
Bugzilla files as expected.
</para> </para>
<section id="http-apache"> <section id="http-apache">
<title>Apache <productname>httpd</productname></title> <title>Bugzilla using Apache</title>
<para>You have two options for running Bugzilla under Apache -
<para> <link linkend="http-apache-mod_cgi">mod_cgi</link> (the default) and
To configure your Apache web server to work with Bugzilla, <link linkend="http-apache-mod_perl">mod_perl</link> (new in Bugzilla
do the following: 2.23)
</para> </para>
<section id="http-apache-mod_cgi">
<procedure> <title>Apache <productname>httpd</productname> with mod_cgi</title>
<step>
<para>
Load <filename>httpd.conf</filename> in your editor.
In Fedora and Red Hat Linux, this file is found in
<filename class="directory">/etc/httpd/conf</filename>.
</para>
</step>
<step>
<para>
Apache uses <computeroutput>&lt;Directory&gt;</computeroutput>
directives to permit fine-grained permission setting. Add the
following lines to a directive that applies to the location
of your Bugzilla installation. (If such a section does not
exist, you'll want to add one.) In this example, Bugzilla has
been installed at
<filename class="directory">/var/www/html/bugzilla</filename>.
</para>
<programlisting>
&lt;Directory /var/www/html/bugzilla&gt;
AddHandler cgi-script .cgi
Options +Indexes +ExecCGI
DirectoryIndex index.cgi
AllowOverride Limit
&lt;/Directory&gt;
</programlisting>
<para> <para>
These instructions: allow apache to run .cgi files found To configure your Apache web server to work with Bugzilla while using
within the bugzilla directory; instructs the server to look mod_cgi, do the following:
for a file called <filename>index.cgi</filename> if someone
only types the directory name into the browser; and allows
Bugzilla's <filename>.htaccess</filename> files to override
global permissions.
</para> </para>
<procedure>
<step>
<para>
Load <filename>httpd.conf</filename> in your editor.
In Fedora and Red Hat Linux, this file is found in
<filename class="directory">/etc/httpd/conf</filename>.
</para>
</step>
<step>
<para>
Apache uses <computeroutput>&lt;Directory&gt;</computeroutput>
directives to permit fine-grained permission setting. Add the
following lines to a directive that applies to the location
of your Bugzilla installation. (If such a section does not
exist, you'll want to add one.) In this example, Bugzilla has
been installed at
<filename class="directory">/var/www/html/bugzilla</filename>.
</para>
<programlisting>
&lt;Directory /var/www/html/bugzilla&gt;
AddHandler cgi-script .cgi
Options +Indexes +ExecCGI
DirectoryIndex index.cgi
AllowOverride Limit
&lt;/Directory&gt;
</programlisting>
<para>
These instructions: allow apache to run .cgi files found
within the bugzilla directory; instructs the server to look
for a file called <filename>index.cgi</filename> if someone
only types the directory name into the browser; and allows
Bugzilla's <filename>.htaccess</filename> files to override
global permissions.
</para>
<note>
<para>
It is possible to make these changes globally, or to the
directive controlling Bugzilla's parent directory (e.g.
<computeroutput>&lt;Directory /var/www/html/&gt;</computeroutput>).
Such changes would also apply to the Bugzilla directory...
but they would also apply to many other places where they
may or may not be appropriate. In most cases, including
this one, it is better to be as restrictive as possible
when granting extra access.
</para>
</note>
</step>
<step>
<para>
<filename>checksetup.pl</filename> can set tighter permissions
on Bugzilla's files and directories if it knows what group the
webserver runs as. Find the <computeroutput>Group</computeroutput>
line in <filename>httpd.conf</filename>, place the value found
there in the <replaceable>$webservergroup</replaceable> variable
in <filename>localconfig</filename>, then rerun
<filename>checksetup.pl</filename>.
</para>
</step>
<step>
<para>
Optional: If Bugzilla does not actually reside in the webspace
directory, but instead has been symbolically linked there, you
will need to add the following to the
<computeroutput>Options</computeroutput> line of the Bugzilla
<computeroutput>&lt;Directory&gt;</computeroutput> directive
(the same one as in the step above):
</para>
<programlisting>
+FollowSymLinks
</programlisting>
<para>
Without this directive, Apache will not follow symbolic links
to places outside its own directory structure, and you will be
unable to run Bugzilla.
</para>
</step>
</procedure>
</section>
<section id="http-apache-mod_perl">
<title>Apache <productname>httpd</productname> with mod_perl</title>
<para>Some configuration is required to make Bugzilla work with Apache
and mod_perl</para>
<procedure>
<step>
<para>
Load <filename>httpd.conf</filename> in your editor.
In Fedora and Red Hat Linux, this file is found in
<filename class="directory">/etc/httpd/conf</filename>.
</para>
</step>
<step>
<para>Add the following information to your httpd.conf file, substituting
where appropriate with your own local paths.</para>
<note>
<para>This should be used instead of the &lt;Directory&gt; block
shown above. This should also be above any other <literal>mod_perl</literal>
directives within the <filename>httpd.conf</filename> and must be specified
in the order as below.</para>
</note>
<warning>
<para>You should also ensure that you have disabled <literal>KeepAlive</literal>
support in your Apache install when utilizing Bugzilla under mod_perl</para>
</warning>
<programlisting>
PerlSwitches -I/var/www/html/bugzilla -w -T
PerlConfigRequire /var/www/html/bugzilla/mod_perl.pl
</programlisting>
</step>
<step>
<para>
<filename>checksetup.pl</filename> can set tighter permissions
on Bugzilla's files and directories if it knows what group the
webserver runs as. Find the <computeroutput>Group</computeroutput>
line in <filename>httpd.conf</filename>, place the value found
there in the <replaceable>$webservergroup</replaceable> variable
in <filename>localconfig</filename>, then rerun
<filename>checksetup.pl</filename>.
</para>
</step>
</procedure>
<para>On restarting Apache, Bugzilla should now be running within the
mod_perl environment. Please ensure you have run checksetup.pl to set
permissions before you restart Apache.</para>
<note> <note>
<para> <para>Please bear the following points in mind when looking at using
It is possible to make these changes globally, or to the Bugzilla under mod_perl:
directive controlling Bugzilla's parent directory (e.g. <itemizedlist>
<computeroutput>&lt;Directory /var/www/html/&gt;</computeroutput>). <listitem>
Such changes would also apply to the Bugzilla directory... <para>
but they would also apply to many other places where they mod_perl support in Bugzilla can take up a HUGE amount of RAM. You could be
may or may not be appropriate. In most cases, including lookng at 30MB per httpd child, easily. Basically, you just need a lot of RAM.
this one, it is better to be as restrictive as possible The more RAM you can get, the better. mod_perl is basically trading RAM for
when granting extra access. speed. At least 2GB total system RAM is recommended for running Bugzilla under
</para> mod_perl.
</note> </para>
</step> </listitem>
<listitem>
<step> <para>
<para> Under mod_perl, you have to restart Apache if you make any manual change to
<filename>checksetup.pl</filename> can set tighter permissions any Bugzilla file. You can't just reload--you have to actually
on Bugzilla's files and directories if it knows what group the <emphasis>restart</emphasis> the server (as in make sure it stops and starts
webserver runs as. Find the <computeroutput>Group</computeroutput> again). You <emphasis>can</emphasis> change localconfig and the params file
line in <filename>httpd.conf</filename>, place the value found manually, if you want, because those are re-read every time you load a page.
there in the <replaceable>$webservergroup</replaceable> variable </para>
in <filename>localconfig</filename>, then rerun </listitem>
<filename>checksetup.pl</filename>. <listitem>
</para> <para>
</step> You must run in Apache's Prefork MPM (this is the default). The Worker MPM
may not work--we haven't tested Bugzilla's mod_perl support under threads.
<step> (And, in fact, we're fairly sure it <emphasis>won't</emphasis> work.)
<para> </para>
Optional: If Bugzilla does not actually reside in the webspace </listitem>
directory, but instead has been symbolically linked there, you <listitem>
will need to add the following to the <para>
<computeroutput>Options</computeroutput> line of the Bugzilla Bugzilla generally expects to be the only mod_perl application running on
<computeroutput>&lt;Directory&gt;</computeroutput> directive your entire server. It may or may not work if there are other applications also
(the same one as in the step above): running under mod_perl. It does try its best to play nice with other mod_perl
applications, but it still may have conflicts.
</para>
</listitem>
<listitem>
<para>
It is recommended that you have one Bugzilla instance running under mod_perl
on your server. Bugzilla has not been tested with more than one instance running.
</para>
</listitem>
</itemizedlist>
</para> </para>
</note>
<programlisting> </section>
+FollowSymLinks
</programlisting>
<para>
Without this directive, Apache will not follow symbolic links
to places outside its own directory structure, and you will be
unable to run Bugzilla.
</para>
</step>
</procedure>
</section> </section>
<section id="http-iis"> <section id="http-iis">
<title>Microsoft <productname>Internet Information Services</productname></title> <title>Microsoft <productname>Internet Information Services</productname></title>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment