From 7cd836648744bfae6a6307bc6bdaea3450e878f2 Mon Sep 17 00:00:00 2001 From: "lpsolit%gmail.com" <> Date: Fri, 4 Apr 2008 11:47:55 +0000 Subject: Docs for bug 284629: maildeliverymethod -> mail_delivery_method --- docs/en/xml/administration.xml | 2 +- docs/en/xml/installation.xml | 452 +++++++++++++++++++++++++++++------------ 2 files changed, 322 insertions(+), 132 deletions(-) diff --git a/docs/en/xml/administration.xml b/docs/en/xml/administration.xml index f96882e3b..284b9da98 100644 --- a/docs/en/xml/administration.xml +++ b/docs/en/xml/administration.xml @@ -82,7 +82,7 @@ - maildeliverymethod + mail_delivery_method diff --git a/docs/en/xml/installation.xml b/docs/en/xml/installation.xml index 7faa1619c..0dce1992f 100644 --- a/docs/en/xml/installation.xml +++ b/docs/en/xml/installation.xml @@ -1,5 +1,5 @@ - + Installing Bugzilla @@ -258,7 +258,7 @@ Many people complain that Perl modules will not install for them. Most times, the error messages complain that they are missing a file in - @INC. + @INC. Virtually every time, this error is due to permissions being set too restrictively for you to compile Perl modules or not having the necessary Perl development libraries installed on your system. @@ -287,22 +287,10 @@ - AppConfig (&min-appconfig-ver;) + CGI &min-cgi-ver; or CGI &min-mp-cgi-ver; if using mod_perl - - - CGI (&min-cgi-ver;) - - - - - - Data::Dumper (&min-data-dumper-ver;) - - - Date::Format (&min-date-format-ver;) @@ -334,12 +322,6 @@ - - - File::Temp (&min-file-temp-ver;) - - - Template @@ -349,41 +331,42 @@ - Text::Wrap (&min-text-wrap-ver;) + MIME::Base64 (&min-mime-base64-ver;) - Mail::Mailer (&min-mail-mailer-ver;) + MIME::Parser (&min-mime-parser-ver;) - MIME::Base64 (&min-mime-base64-ver;) + Email::Send (&min-email-send-ver;) - MIME::Parser (&min-mime-parser-ver;) + Email::MIME::Modifier (&min-email-mime-modifier-ver;) + + Optional Perl modules: + - Storable (&min-storable-ver;) + GD + (&min-gd-ver;) for bug charting - - Optional Perl modules: - - GD - (&min-gd-ver;) for bug charting + Template::Plugin::GD::Image + (&min-gd-ver;) for Graphical Reports @@ -403,8 +386,8 @@ - GD::Text::Align - (&min-gd-text-align-ver;) for bug charting + GD::Text + (&min-gd-text-ver;) for bug charting @@ -415,6 +398,13 @@ + + + LWP::UserAgent + (&min-lwp-useragent-ver;) for Automatic Update Notifications + + + PatchReader @@ -427,7 +417,70 @@ Image::Magick (&min-image-magick-ver;) for converting BMP image attachments to PNG - + + + + Net::LDAP + (&min-net-ldap-ver;) for LDAP Authentication + + + + + + SOAP::Lite + (&min-soap-lite-ver;) for the web service interface + + + + + + HTML::Parser + (&min-html-parser-ver;) for More HTML in Product/Group Descriptions + + + + + + HTML::Scrubber + (&min-html-scrubber-ver;) for More HTML in Product/Group Descriptions + + + + + + Email::MIME::Attachment::Stripper + (&min-email-mime-attachment-stripper-ver;) for Inbound Email + + + + + + Email::Reply + (&min-email-reply-ver;) for Inbound Email + + + + + + mod_perl2 + (&min-mod_perl2-ver;) for mod_perl + + + + + + CGI + (&min-cgi-ver;) for mod_perl + + + + + + Apache::DBI + (&min-apache-dbi-ver;) for mod_perl2 + + +
@@ -500,10 +553,10 @@
-
- GD::Text::Align (&min-gd-text-align-ver;) +
+ GD::Text (&min-gd-text-ver;) - The GD::Text::Align module is only required if you want graphical + The GD::Text module is only required if you want graphical reports.
@@ -518,6 +571,14 @@
+
+ SOAP::Lite (&min-soap-lite-ver;) + 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). + +
+
PatchReader (&min-patchreader-ver;) @@ -547,8 +608,8 @@ - For more information, see the "maildeliverymethod" parameter in - . + For more information, see the mail_delivery_method parameter + in . @@ -582,7 +643,23 @@
- +
+ Installing Bugzilla on mod_perl + It is now possible to run the Bugzilla software under mod_perl on + Apache. mod_perl has some additional requirements to that of running + Bugzilla under mod_cgi (the standard and previous way). + + Bugzilla requires mod_perl to be installed, which can be + obtained from - Bugzilla requires + version &min-mod_perl2-ver; (AKA 2.0.0-RC5) to be installed. + + 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; + + + Finally, Bugzilla also requires Apache::DBI + (&min-apache-dbi-ver;) to be installed as well. +
@@ -653,7 +730,7 @@
Database Server This section deals with configuring your database server for use - with Bugzilla. Currently and + with Bugzilla. Currently and are available.
@@ -880,107 +957,220 @@ Configure your web server according to the instructions in the 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 testagent.cgi + 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 not remotely available by properly applying the access controls in - . + . You can run + testserver.pl to check if your web server serves + Bugzilla files as expected.
- Apache <productname>httpd</productname> - - - To configure your Apache web server to work with Bugzilla, - do the following: + Bugzilla using Apache + You have two options for running Bugzilla under Apache - + mod_cgi (the default) and + mod_perl (new in Bugzilla + 2.23) - - - - - Load httpd.conf in your editor. - In Fedora and Red Hat Linux, this file is found in - /etc/httpd/conf. - - - - - - Apache uses <Directory> - 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 - /var/www/html/bugzilla. - - - -<Directory /var/www/html/bugzilla> - AddHandler cgi-script .cgi - Options +Indexes +ExecCGI - DirectoryIndex index.cgi - AllowOverride Limit -</Directory> - - +
+ Apache <productname>httpd</productname> with mod_cgi + - These instructions: allow apache to run .cgi files found - within the bugzilla directory; instructs the server to look - for a file called index.cgi if someone - only types the directory name into the browser; and allows - Bugzilla's .htaccess files to override - global permissions. + To configure your Apache web server to work with Bugzilla while using + mod_cgi, do the following: - + + + + + Load httpd.conf in your editor. + In Fedora and Red Hat Linux, this file is found in + /etc/httpd/conf. + + + + + + Apache uses <Directory> + 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 + /var/www/html/bugzilla. + + + + <Directory /var/www/html/bugzilla> + AddHandler cgi-script .cgi + Options +Indexes +ExecCGI + DirectoryIndex index.cgi + AllowOverride Limit + </Directory> + + + + These instructions: allow apache to run .cgi files found + within the bugzilla directory; instructs the server to look + for a file called index.cgi if someone + only types the directory name into the browser; and allows + Bugzilla's .htaccess files to override + global permissions. + + + + + It is possible to make these changes globally, or to the + directive controlling Bugzilla's parent directory (e.g. + <Directory /var/www/html/>). + 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. + + + + + + + checksetup.pl can set tighter permissions + on Bugzilla's files and directories if it knows what group the + webserver runs as. Find the Group + line in httpd.conf, place the value found + there in the $webservergroup variable + in localconfig, then rerun + checksetup.pl. + + + + + + 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 + Options line of the Bugzilla + <Directory> directive + (the same one as in the step above): + + + + +FollowSymLinks + + + + Without this directive, Apache will not follow symbolic links + to places outside its own directory structure, and you will be + unable to run Bugzilla. + + + +
+
+ Apache <productname>httpd</productname> with mod_perl + + Some configuration is required to make Bugzilla work with Apache + and mod_perl + + + + + Load httpd.conf in your editor. + In Fedora and Red Hat Linux, this file is found in + /etc/httpd/conf. + + + + + Add the following information to your httpd.conf file, substituting + where appropriate with your own local paths. + + + This should be used instead of the <Directory> block + shown above. This should also be above any other mod_perl + directives within the httpd.conf and must be specified + in the order as below. + + + You should also ensure that you have disabled KeepAlive + support in your Apache install when utilizing Bugzilla under mod_perl + + + + PerlSwitches -I/var/www/html/bugzilla -w -T + PerlConfigRequire /var/www/html/bugzilla/mod_perl.pl + + + + + + checksetup.pl can set tighter permissions + on Bugzilla's files and directories if it knows what group the + webserver runs as. Find the Group + line in httpd.conf, place the value found + there in the $webservergroup variable + in localconfig, then rerun + checksetup.pl. + + + + + 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. + - - It is possible to make these changes globally, or to the - directive controlling Bugzilla's parent directory (e.g. - <Directory /var/www/html/>). - 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. - - - - - - - checksetup.pl can set tighter permissions - on Bugzilla's files and directories if it knows what group the - webserver runs as. Find the Group - line in httpd.conf, place the value found - there in the $webservergroup variable - in localconfig, then rerun - checksetup.pl. - - - - - - 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 - Options line of the Bugzilla - <Directory> directive - (the same one as in the step above): + Please bear the following points in mind when looking at using + Bugzilla under mod_perl: + + + + mod_perl support in Bugzilla can take up a HUGE amount of RAM. You could be + lookng at 30MB per httpd child, easily. Basically, you just need a lot of RAM. + The more RAM you can get, the better. mod_perl is basically trading RAM for + speed. At least 2GB total system RAM is recommended for running Bugzilla under + mod_perl. + + + + + Under mod_perl, you have to restart Apache if you make any manual change to + any Bugzilla file. You can't just reload--you have to actually + restart the server (as in make sure it stops and starts + again). You can change localconfig and the params file + manually, if you want, because those are re-read every time you load a page. + + + + + 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. + (And, in fact, we're fairly sure it won't work.) + + + + + Bugzilla generally expects to be the only mod_perl application running on + your entire server. It may or may not work if there are other applications also + running under mod_perl. It does try its best to play nice with other mod_perl + applications, but it still may have conflicts. + + + + + 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. + + + - - - +FollowSymLinks - - - - Without this directive, Apache will not follow symbolic links - to places outside its own directory structure, and you will be - unable to run Bugzilla. - - - + +
- +
Microsoft <productname>Internet Information Services</productname> -- cgit v1.2.3-24-g4f1b