From dc4c71e715e4bb125c1015d46e08bc674bdb387b Mon Sep 17 00:00:00 2001 From: "travis%sedsystems.ca" <> Date: Mon, 10 Jan 2005 14:31:33 +0000 Subject: Bug 239852 - Documentation changes for Windows support Patch by bruce.armstrong@teamsybase.com, cleaned up by travis@sedsystems.ca r=bugzilla@glob.com.au --- docs/xml/installation.xml | 267 ++++++++++++++++++++++++++++++++-------------- docs/xml/modules.xml | 126 ++++++++++++++++------ 2 files changed, 279 insertions(+), 114 deletions(-) (limited to 'docs') diff --git a/docs/xml/installation.xml b/docs/xml/installation.xml index 2a0d0c29a..737207c3f 100644 --- a/docs/xml/installation.xml +++ b/docs/xml/installation.xml @@ -1,5 +1,5 @@ - + Installing Bugzilla @@ -639,8 +639,8 @@ By default, MySQL will limit the size of a table to 4GB. This limit is present even if the underlying filesystem - has no such limit or if you are using RAID. To set a higher - limit, follow these instructions. + has no such limit. To set a higher limit, follow these + instructions. @@ -795,20 +795,82 @@
Microsoft <productname>Internet Information Services</productname> - If you need, or for some reason even want, to use Microsoft's - Internet Information Services or - Personal Web Server you should be able - to. You will need to configure them to know how to run CGI scripts. - This is described in Microsoft Knowledge Base article - Q245225 - for Internet Information Services and - Q231998 - for Personal Web Server. + + If you are running Bugzilla on Windows and choose to use + Microsoft's Internet Information Services + or Personal Web Server you will need + to perform a number of other configuration steps as explained below. + You may also want to refer to the following Microsoft Knowledge + Base articles: + 245225 + HOW TO: Configure and Test a PERL Script with IIS 4.0, + 5.0, and 5.1 (for Internet Information + Services) and + 231998 + HOW TO: FP2000: How to Use Perl with Microsoft Personal Web + Server on Windows 95/98 (for Personal Web + Server). + + + + You will need to create a virtual directory for the Bugzilla + install. Put the Bugzilla files in a directory that is named + something other than what you want your + end-users accessing. That is, if you want your users to access + your Bugzilla installation through + http://<yourdomainname>/Bugzilla, then do + not put your Bugzilla files in a directory + named Bugzilla. Instead, place them in a different + location, and then use the IIS Administration tool to create a + Virtual Directory named "Bugzilla" that acts as an alias for the + actual location of the files. When creating that virtual directory, + make sure you add the Execute (such as ISAPI applications or + CGI) access permission. + + + + You will also need to tell IIS how to handle Bugzilla's + .cgi files. Using the IIS Administration tool again, open up + the properties for the new virtual directory and select the + Configuration option to access the Script Mappings. Create an + entry mapping .cgi to: + + + +<full path to perl.exe >\perl.exe -x<full path to Bugzilla> -wT "%s" %s + + + + For example: + + + +c:\perl\bin\perl.exe -xc:\bugzilla -wT "%s" %s + + + + + The ActiveState install may have already created an entry for + .pl files that is limited to GET,HEAD,POST. If + so, this mapping should be removed as + Bugzilla's .pl files are not designed to be run via a webserver. + + + + + IIS will also need to know that the index.cgi should be treated + as a default document. On the Documents tab page of the virtual + directory properties, you need to add index.cgi as a default + document type. If you wish, you may remove the other default + document types for this particular virtual directory, since Bugzilla + doesn't use any of them. - Also, and this can't be stressed enough, make sure that files such as - localconfig and your data - directory are secured as described in . + + Also, and this can't be stressed enough, make sure that files + such as localconfig and your + data directory are + secured as described in .
@@ -946,8 +1008,19 @@ 5 0 * * * cd <your-bugzilla-directory> ; ./collectstats.pl - After two days have passed you'll be able to view bug graphs from - the Reports page. + + After two days have passed you'll be able to view bug graphs from + the Reports page. + + + + + Windows does not have 'cron', but it does have the Task + Scheduler, which performs the same duties. There are also + third-party tools that can be used to implement cron, such as + nncron. + +
@@ -1007,14 +1080,21 @@ which leave their bugs in the NEW or REOPENED state without triaging them. - - This can be done by - adding the following command as a daily crontab entry, in the same manner - as explained above for bug graphs. This example runs it at 12.55am. + This can be done by adding the following command as a daily + crontab entry, in the same manner as explained above for bug + graphs. This example runs it at 12.55am. 55 0 * * * cd <your-bugzilla-directory> ; ./whineatnews.pl - + + + + Windows does not have 'cron', but it does have the Task + Scheduler, which performs the same duties. There are also + third-party tools that can be used to implement cron, such as + nncron. + +
@@ -1205,25 +1285,26 @@ AddType text/xml .rdf
Microsoft Windows - - Making Bugzilla work on Windows is still a painful processes. - The Bugzilla Team is working to make it easier, but that goal is not - considered a top priority. If you wish to run Bugzilla, we still - recommend doing so on a Unix based system such as GNU/Linux. As of this - writing, all members of the Bugzilla team and all known large installations - run on Unix based systems. - - - If after hearing all that, you have enough pain tolerance to attempt - installing Bugzilla on Win32, here are some pointers. - + + Making Bugzilla work on Windows is more difficult than making it + work on Unix. For that reason, we still recommend doing so on a Unix + based system such as GNU/Linux. That said, if you do want to get + Bugzilla running on Windows, you will need to make the following + adjustments. +
+ Win32 Perl + + Perl for Windows can be obtained from + ActiveState. + You should be able to find a compiled binary at . + The following instructions assume that you are using version + 5.8.1 of ActiveState. + +
+
Win32 Perl @@ -1237,47 +1318,60 @@ AddType text/xml .rdf
Perl Modules on Win32 - Bugzilla on Windows requires the same perl modules found in - . The main difference is that - windows uses PPM instead of - CPAN. + + Bugzilla on Windows requires the same perl modules found in + . The main difference is that + windows uses PPM instead + of CPAN. C:\perl> ppm install <module name> - - The above syntax should work for all modules with the exception - of Template Toolkit. The Template Toolkit website - suggests using the instructions on OpenInteract's website. - - - The following commands will install the required packages - missing from the ActivePerl default installation: - + + The best source for the Windows PPM modules needed for Bugzilla + is probably the the Bugzilla Test Server (aka 'Landfill'), so + you should add the Landfill package repository as follows: + - -ppm repository add oi http://openinteract.sourceforge.net/ppmpackages -ppm install DBD-mysql -ppm install Template-Toolkit -ppm install TimeDate - + +ppm repository add landfill http://www.landfill.bugzilla.org/ppm/ + + + + The PPM repository stores modules in 'packages' that may have + a slightly different name than the module. If retrieving these + modules from there, you will need to pay attention to the information + provided when you run checksetup.pl as it will + tell you what package you'll need to install. + -
+ + + If you are behind a corporate firewall, you will need to let the + ActiveState PPM utility know how to get through it to acccess + the repositories by setting the HTTP_proxy system environmental + variable. For more information on setting that variable, see + the ActiveState documentation. + + +
+
Code changes required to run on win32 - Bugzilla on win32 is mostly supported out of the box; one remaining issue is - related to bug email. To make bug email work on Win32 (until - bug - 84876 lands), the - simplest way is to have the Net::SMTP Perl module installed and - change this line in the file Bugzilla/Bugmail.pm: + + Bugzilla on win32 is mostly supported out of the box; one + remaining issue is related to bug email. To make bug email + work on Win32 (until + bug + 49893 lands), the + simplest way is to have the Net::SMTP Perl module installed and + change this line in the file Bugzilla/Bugmail.pm: + open(SENDMAIL, "|/usr/lib/sendmail $sendmailparam -t -i") || @@ -1286,7 +1380,11 @@ open(SENDMAIL, "|/usr/lib/sendmail $sendmailparam -t -i") || print SENDMAIL trim($msg) . "\n"; close SENDMAIL; - to + + + to + + use Net::SMTP; my $smtp_server = 'smtp.mycompany.com'; # change this @@ -1304,28 +1402,33 @@ $smtp->dataend(); $smtp->quit; - Don't forget to change the name of your SMTP server and the - domain of the sending email address (after the '@') in the above - lines of code. + + Don't forget to change the name of your SMTP server and the + domain of the sending email address (after the '@') in the + above lines of code. +
Serving the web pages - As is the case on Unix based systems, any web server should be - able to handle Bugzilla; however, the Bugzilla Team still recommends - Apache whenever asked. No matter what web server you choose, be sure - to pay attention to the security notes in . - More information on configuring specific web servers can be found in - . + + As is the case on Unix based systems, any web server should + be able to handle Bugzilla; however, the Bugzilla Team still + recommends Apache whenever asked. No matter what web server + you choose, be sure to pay attention to the security notes + in . More + information on configuring specific web servers can be found + in . - If using Apache on windows, you can set the ScriptInterpreterSource - directive in your Apache config to avoid having - to modify the first line of every script to contain your path to - perl instead of /usr/bin/perl. + + If using Apache on windows, you can set the ScriptInterpreterSource + directive in your Apache config to avoid having to modify + the first line of every script to contain your path to perl + perl instead of /usr/bin/perl. diff --git a/docs/xml/modules.xml b/docs/xml/modules.xml index c7624d639..81a12d7f5 100644 --- a/docs/xml/modules.xml +++ b/docs/xml/modules.xml @@ -4,9 +4,10 @@
Instructions - If you need to install Perl modules manually, here's how it's done. - Download the module using the link given in the next section, and then - apply this magic incantation, as root: + + If you need to install Perl modules manually, here's how it's done. + Download the module using the link given in the next section, and then + apply this magic incantation, as root: @@ -17,127 +18,188 @@ bash# make test bash# make install + + + In order to compile source code under Windows you will need to obtain + a 'make' utility. The nmake utility provided with + Microsoft Visual C++ may be used. As an alternative, there is a + utility called dmake available from CPAN which is + written entirely in Perl. The majority of the links given below, however, + are to pre-compiled versions of the modules, which can be installed + on Windows simply by issuing the following command once you have + downloaded the PPD file (which may be packaged within a ZIP file): + + + + > ppm install <filename.ppd> + + +
Download Locations - Note: some modules are in the core distribution of - ActiveState Perl for Windows. Others are not available. - No PPM links have been provided in either of these two cases. + + + Running Bugzilla on Windows requires the use of ActiveState + Perl 5.8.1 or higher. Some modules already exist in the core + distribution of ActiveState Perl so no PPM link is given. + (This is noted where it occurs.) + + + + + AppConfig: + + CPAN Download Page: + PPM Download Link: + Documentation: + - CGI: + + CGI: CPAN Download Page: - PPM Download Link: + PPM Download Link: Part of core distribution. Documentation: - TimeDate: + + Data-Dumper: + + CPAN Download Page: + PPM Download Page: Part of core distribution. + Documentation: + + + + + Date::Format (part of TimeDate): CPAN Download Page: - PPM Download Link: + PPM Download Link: Documentation: - DBI: + + DBI: CPAN Download Page: - PPM Download Link: + PPM Download Link: Documentation: - DBD::mysql: + + DBD::mysql: CPAN Download Page: - PPM Download Link: + PPM Download Link: Documentation: - File::Spec: + + File::Spec: CPAN Download Page: - PPM Download Page: + PPM Download Page: Part of core distribution. Documentation: - File::Temp: + + File::Temp: CPAN Download Page: + PPM Download Page: Part of core distribution. Documentation: - Template Toolkit: + + Template-Toolkit: CPAN Download Page: - PPM Download Link: + PPM Download Link: Documentation: - Text::Wrap: + + Text::Wrap: CPAN Download Page: + PPM Download Link: Part of core distribution. Documentation: - GD: + + GD: CPAN Download Page: - PPM Download Link: + PPM Download Link: Documentation: - Chart::Base: - + Optional Modules + + + Chart::Base: CPAN Download Page: + PPM Download Page: + Documentation: - GD::Graph: + + GD::Graph: CPAN Download Page: - PPM Download Link: + PPM Download Link: Documentation: - GD::Text::Align: + + GD::Text::Align (part of GD::Text::Util): CPAN Download Page: - PPM Download Page: + PPM Download Page: Documentation: - MIME::Parser: + + MIME::Parser (part of MIME-tools): CPAN Download Page: - PPM Download Link: + PPM Download Link: Documentation: - XML::Parser: + + XML::Parser: CPAN Download Page: + PPM Download Link: Part of core distribution. Documentation: - PatchReader: + + PatchReader: CPAN Download Page: + PPM Download Link: Documentation: -- cgit v1.2.3-24-g4f1b