X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FManual%2FInstallation.pod;fp=lib%2FCatalyst%2FManual%2FInstallation.pod;h=6fc70d9962809cc6569fa4ebfa6e667722e06e3f;hb=f984f5d78dfc0e47038fe6e7f8f7dd41cc5fecd0;hp=0000000000000000000000000000000000000000;hpb=3aa14091da530d6efdbe8e557c3f277f7a6ef7b8;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Manual/Installation.pod b/lib/Catalyst/Manual/Installation.pod new file mode 100644 index 0000000..6fc70d9 --- /dev/null +++ b/lib/Catalyst/Manual/Installation.pod @@ -0,0 +1,152 @@ +=head1 NAME + +Catalyst::Manual::Installation - Catalyst Installation + +=head1 DESCRIPTION + +How to install Catalyst. + +=head1 INSTALLATION + +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. 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 script + +Available at L, +C can be a quick and painless way to get Catalyst up and +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 + +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 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 * + +Pre-Built VMWare Images + +Under the VMWare community program, work is ongoing to develop a number +of VMWare images where an entire Catalyst development environment has +already been installed, complete with database engines and a full +complement of Catalyst plugins. + +=back + +=head2 OTHER METHODS + +In addition to the "all-in-one" approaches mentioned above, there are a +variety of other installation techniques: + +=over 4 + +=item * + +CPAN + +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 Catalyst::Devel' + +Unless you have a particularly complete set of Perl modules already +installed, be prepared for a large number of nested dependencies. + +=item * + +Gentoo Linux + +For users of Gentoo, see +C for automated +installations. In short, simply mount the portage overlay and type +C. + +=item * + +FreeBSD + +FreeBSD users can get up and running quickly by typing C, or C if C is installed on your system. + +=item * + +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. + +=item * + +Subversion Repository + +Catalyst uses Subversion for version control. To checkout the latest: + + $ svn co http://dev.catalyst.perl.org/repos/Catalyst/trunk/Catalyst-Runtime/ + +=back + +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 use Catalyst properly. When you start +the C