From d41a0a76217ebbfd18807128e8bd552d5276e87a Mon Sep 17 00:00:00 2001 From: Gervase Markham Date: Fri, 5 Dec 2014 16:52:48 -0500 Subject: Bug 1067416 - reorganize and update Bugzilla docs --- docs/en/rst/installing/linux.rst | 215 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 215 insertions(+) create mode 100644 docs/en/rst/installing/linux.rst (limited to 'docs/en/rst/installing/linux.rst') diff --git a/docs/en/rst/installing/linux.rst b/docs/en/rst/installing/linux.rst new file mode 100644 index 000000000..97192fac3 --- /dev/null +++ b/docs/en/rst/installing/linux.rst @@ -0,0 +1,215 @@ +.. _linux: + +Linux +##### + +Some Linux distributions include Bugzilla and its dependencies in their +package management systems. If you have root access, installing Bugzilla on +any Linux system could be as simple as finding the Bugzilla package in the +package management application and installing it. There may be a small bit +of additional configuration required. + +If you are installing your machine from scratch, :ref:`quick-start` may be +the best instructions for you. + +.. _linux-install-packages: + +Install Packages +================ + +Use your distribution's package manager to install Perl, your preferred +database engine (MySQL if in doubt), and a webserver (Apache if in doubt). +Some distributions even have a Bugzilla package, although that will vary +in age. + +The commands below will install those things and some of Bugzilla's other +prerequisites as well. If you find a package doesn't install or the name +is not found, just remove it from the list and reissue the command. If you +want to use a different database or webserver, substitute the package +names as appropriate. + +Fedora and Red Hat +------------------ + +The following command will install Red Hat's packaged version of Bugzilla: + +:command:`yum install bugzilla httpd mysql-server` + +However, if you go this route, you need to read :bug:`415605`, which details +some problems with the Email::Send package. Then, you can skip to +:ref:`configuring your database `. It may be useful to +know that Fedora stores the Bugzilla files in :file:`/usr/share/bugzilla`, so +that's where you'll run :file:`checksetup.pl`. + +If you want to install a version of Bugzilla from the Bugzilla project, you +will instead need: + +:command:`yum install httpd mysql-server mod_perl mod_perl-devel httpd-devel +graphviz patchutils gcc 'perl(Apache2::SizeLimit)' 'perl(Authen::Radius)' +'perl(Authen::SASL)' 'perl(Cache::Memcached)' 'perl(CGI)' 'perl(Chart::Lines)' +'perl(Daemon::Generic)' 'perl(Date::Format)' 'perl(DateTime)' +'perl(DateTime::TimeZone)' 'perl(DBI)' 'perl(Digest::SHA)' 'perl(Email::MIME)' +'perl(Email::MIME::Attachment::Stripper)' 'perl(Email::Reply)' +'perl(Email::Sender)' 'perl(Encode)' 'perl(Encode::Detect)' +'perl(File::MimeInfo::Magic)' 'perl(File::Slurp)' '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(JSON::XS)' +'perl(List::MoreUtils)' 'perl(LWP::UserAgent)' 'perl(Math::Random::ISAAC)' +'perl(MIME::Parser)' 'perl(mod_perl2)' 'perl(Net::LDAP)' 'perl(Net::SMTP::SSL)' +'perl(PatchReader)' 'perl(SOAP::Lite)' 'perl(Template)' +'perl(Template::Plugin::GD::Image)' 'perl(Test::Taint)' 'perl(TheSchwartz)' +'perl(URI)' 'perl(XMLRPC::Lite)' 'perl(XML::Twig)'` + +If you are running RHEL6, you will have to enable the "RHEL Server Optional" +channel in RHN to get some of those packages. + +If you plan to use SQlite as your database, you will need to also install +the appropriate packages for that. + +Ubuntu and Debian +----------------- + +:command:`apt-get install git nano` + +:command:`apt-get install apache2 mysql-server libappconfig-perl +libdate-calc-perl libtemplate-perl libmime-perl build-essential +libdatetime-timezone-perl libdatetime-perl libemail-sender-perl +libemail-mime-perl libemail-mime-modifier-perl libdbi-perl libdbd-mysql-perl +libcgi-pm-perl libmath-random-isaac-perl libmath-random-isaac-xs-perl +apache2-mpm-prefork libapache2-mod-perl2 libapache2-mod-perl2-dev +libchart-perl libxml-perl libxml-twig-perl perlmagick libgd-graph-perl +libtemplate-plugin-gd-perl libsoap-lite-perl libhtml-scrubber-perl +libjson-rpc-perl libdaemon-generic-perl libtheschwartz-perl +libtest-taint-perl libauthen-radius-perl libfile-slurp-perl +libencode-detect-perl libmodule-build-perl libnet-ldap-perl +libauthen-sasl-perl libtemplate-perl-doc libfile-mimeinfo-perl +libhtml-formattext-withlinks-perl libgd-dev lynx-cur graphviz` + +If you plan to use SQlite as your database, you will need to also install +the appropriate packages for that. + +Gentoo +------ + +:command:`emerge -av bugzilla` + +will install Bugzilla and all its dependencies. If you don't have the vhosts +USE flag enabled, Bugzilla will end up in :file:`/var/www/localhost/bugzilla`. + +Then, you can skip to :ref:`configuring your database +`. + +.. _linux-install-perl: + +Perl +==== + +Test which version of Perl you have installed with: +:: + + $ perl -v + +Bugzilla requires at least Perl |min-perl-ver|. + +.. _linux-install-bzfiles: + +Bugzilla +======== + +The best way to get Bugzilla is to check it out from git: + +:command:`git clone --branch bugzilla-X.X-stable https://git.mozilla.org/bugzilla/bugzilla` + +Run the above command in your home directory, replacing "X.X" with the 2-digit +version number of the stable release of Bugzilla that you want - e.g. "4.4". + +If that's not possible, you can +`download a tarball of Bugzilla `_. + +Place Bugzilla in a suitable directory, accessible by the default web server +user (probably ``apache`` or ``www-data``). +Good locations are either directly in the web server's document directory +(often :file:`/var/www/html`) or in :file:`/usr/local`, either with a +symbolic link to the web server's document directory or an alias in the web +server's configuration. + +.. warning:: The default Bugzilla distribution is NOT designed to be placed + in a :file:`cgi-bin` directory. This + includes any directory which is configured using the + ``ScriptAlias`` directive of Apache. + +.. _linux-install-perl-modules: + +Perl Modules +============ + +Bugzilla requires a number of Perl modules. You can install these globally +using your system's package manager, or install Bugzilla-only copies. At +times, Bugzilla may require a version of a Perl module newer than the one +your distribution packages, in which case you will need to install a +Bugzilla-only copy of the newer version. + +At this point you probably need to become ``root``, e.g. by using +:command:`su`. You should remain as root until the end of the install. This +can be avoided in some circumstances if you are a member of your webserver's +group, but being root is easier and will always work. + +To check whether you have all the required modules, run: + +:command:`./checksetup.pl --check-modules` + +You can run this command as many times as necessary. + +If you have not already installed the necessary modules, and want to do it +system-wide, invoke your package manager appropriately at this point. +Alternatively, you can install all missing modules locally (i.e. just for +Bugzilla) like this: + +:command:`./install-module.pl --all` + +Or, you can pass an individual module name: + +:command:`./install-module.pl ` + +.. note:: If you are using a package-based distribution, and attempting to + install the Perl modules from CPAN (e.g. by using + :file:`install-module.pl`), you may need to install the "development" + packages for MySQL and GD before attempting to install the related Perl + modules. The names of these packages will vary depending on the specific + distribution you are using, but are often called + :file:`-devel`. + + .. todo:: Give examples for Debian/Ubuntu and RedHat. + Convert this item to a bug after checkin. + +.. _linux-config-webserver: + +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` + +.. _linux-config-database: + +Database Engine +=============== + +Bugzilla supports MySQL, PostgreSQL, Oracle and SQLite as database servers. +You only require one of these systems to make use of Bugzilla. MySQL is +most commonly used. SQLite is good for trial installations as it requires no +setup. Configure your server according to the instructions below: + +* :ref:`mysql` +* :ref:`postgresql` +* :ref:`oracle` +* :ref:`sqlite` + +.. |checksetupcommand| replace:: :command:`./checksetup.pl` +.. |testservercommand| replace:: :command:`./testserver.pl http:///` + +.. include:: installing-end.inc.rst + +Next, do the :ref:`essential-post-install-config`. -- cgit v1.2.3-24-g4f1b