X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FManual%2FInstallation.pod;h=cb1343aa718b801b591b2c5ff3cf89af7049a2fe;hp=a942b7a371ad7b3f077db58e00d0226234c26290;hb=85d9fce671016c9040775c8b4458cf9c72ec2208;hpb=64ccd8a8bfbc16276c044c94702b1440c2897695 diff --git a/lib/Catalyst/Manual/Installation.pod b/lib/Catalyst/Manual/Installation.pod index a942b7a..cb1343a 100644 --- a/lib/Catalyst/Manual/Installation.pod +++ b/lib/Catalyst/Manual/Installation.pod @@ -2,43 +2,76 @@ Catalyst::Manual::Installation - Catalyst Installation - - =head1 DESCRIPTION -This section of the Catalyst tutorial looks at a number of items -required to first get going with Catalyst development. - - +How to install Catalyst. =head1 INSTALLATION -On one hand, Catalyst gains immediate power and flexibility through is -use of CPAN (the Comprehensive Perl Archive Network, an enormous global -repository containing over 10,000 free modules). On the other hand, -Catalyst's reliance on CPAN can complicate initial installations. +One of the frequent problems reported by new users of Catalyst is that +it can be extremely time-consuming and difficult to install. + +One of the great strengths of Perl as a programming language is its use +of CPAN, the Comprehensive Perl Archive Network, an enormous global +repository containing over 10,000 free modules. For almost any basic +task--and a very large number of non-basic ones--there is a module on +CPAN that will help you. Catalyst has taken advantage of this, and uses +a very large number of CPAN modules, rather than reinventing the wheel +over and over again. On the one hand, Catalyst gains power and +flexibility through this re-use of existing code. On the other hand, +Catalyst's reliance on CPAN can complicate initial installations, +especially in shared-hosting environments where you, the user, do not +have easy control over what versions of other modules are installed. + +It is worth stressing that the difficulties found in installing Catalyst +are caused not by anything intrinsic to Catalyst itself, but rather by +the interrelated dependencies of a large number of required modules. + Fortunately, there are a growing number of methods that can dramatically -ease this undertaking: +ease this undertaking. Note that for many of these, you will probably +need to install additional Catalyst-related modules (especially plugins) +to do the things you want. As of version 5.70, Catalyst has split into +two packages, L, which includes the core elements +necessary to deploy a Catalyst application, and L, +which includes the Helpers and other things necessary or useful for +developing Catalyst applications. In a purely deployment environment +you can omit L. =over 4 =item * -Matt Trout's C +Matt Trout's C script Available at L, C can be a quick and painless way to get Catalyst up and -running. Just download the script from the link above and type C. +running on your system. Just download the script from the link above +and type C. This script automates the process of +installing Catalyst itself and its dependencies, with bits of overriding +so that the process does not require user interaction. C +installs Catalyst and its dependencies using the L module, so that +modules are installed the same way you would probably install them +normally--it just makes it easier. This is a recommended solution for +installation. =item * Chris Laco's CatInABox -Download the tarball from +CatInABox is a complete version of Catalyst that is installed locally on +your system, so that you don't need to go through the effort of doing a +full install. Simply download the tarball from L and unpack it on your machine. Depending on your OS platform, either run C -or C. +or C to set your bin/PERLLIB paths. This tarball contains +everything needed to try out Catalyst including Catalyst itself, +Template Toolkit, several Authentication modules, StackTrace, and a few +other plugins. + +A special Win32 version is available upon request that contains many +more plugins and pre-compiled modules, including DBIx::Class, DBI, +SQLite, and Session support. If you are interested in this version, +please send e-mail to C. =item * @@ -51,7 +84,6 @@ complement of Catalyst plugins. =back - =head2 OTHER METHODS In addition to the "all-in-one" approaches mentioned above, there are a @@ -63,10 +95,11 @@ variety of other installation techniques: CPAN -The traditional way to install Catalyst is directly from CPAN using -C bundle: +The traditional way to install Catalyst is directly from CPAN using the +C bundle and C: - $ perl -MCPAN -e 'install Task::Catalyst' + $ perl -MCPAN -e 'install Task::Catalyst' + $ perl -MCPAN -e 'install Catalyst::Devel' Unless you have a particularly complete set of Perl modules already installed, be prepared for a large number of nested dependencies. @@ -80,12 +113,13 @@ C for automated installations. In short, simply mount the portage overlay and type C. -=items * +=item * FreeBSD FreeBSD users can get up and running quickly by typing C. +/usr/ports/www/p5-Catalyst-Devel && make install>, or C if C is installed on your system. =item * @@ -93,86 +127,26 @@ Windows ActivePerl Windows users can take advantage of the PPM tool that comes with ActivePerl to jumpstart their Catalyst environment. Directions are -available at L. +available at L. -=back +=item * -B Although all of the above methods can be used to install a base -Catalyst system, only the VMWare image is likely to have all of the -plugins and modules you need to complete this tutorial. When you start -the C