lib/Catalyst/Manual/Installation.pod

   1 head1 NAME
   2
   3 Catalyst::Manual::Installation - Catalyst Installation
   4
   5 =head1 DESCRIPTION
   6
   7 How to install Catalyst.
   8
   9 =head1 INSTALLATION
  10
  11 On one hand, Catalyst gains immediate power and flexibility
  12 through its use of CPAN (the Comprehensive Perl Archive
  13 Network, an enormous global repository containing over 10,000
  14 free modules).  On the other hand, Catalyst's reliance on CPAN
  15 can complicate initial installations, especially in
  16 shared-hosting environments where you, the user, do not have
  17 easy control over what versions other modules are installed.
  18
  19 It is worth stressing that the difficulties found in installing
  20 Catalyst are caused not by anything intrinsic to Catalyst
  21 itself, but rather by the interrelated dependencies of a large
  22 number of required modules.
  23
  24 Fortunately, there are a growing number of methods that can
  25 dramatically ease this undertaking:
  26
  27 =over 4
  28
  29 =item *
  30
  31 Matt Trout's C<cat-install>
  32
  33 Available at L<http://www.shadowcatsystems.co.uk/static/cat-install>,
  34 C<cat-install> can be a quick and painless way to get Catalyst up and
  35 running.  Just download the script from the link above and type C<perl
  36 cat-install>.
  37
  38 =item *
  39
  40 Chris Laco's CatInABox
  41
  42 Download the tarball from
  43 L<http://handelframework.com/downloads/CatInABox.tar.gz> and unpack it
  44 on your machine.  Depending on your OS platform, either run C<start.bat>
  45 or C<start.sh>.
  46
  47 =item *
  48
  49 Pre-Built VMWare Images
  50
  51 Under the VMWare community program, work is ongoing to develop a number
  52 of VMWare images where an entire Catalyst development environment has
  53 already been installed, complete with database engines and a full
  54 complement of Catalyst plugins.
  55
  56 =back
  57
  58 =head2 OTHER METHODS
  59
  60 In addition to the "all-in-one" approaches mentioned above, there are a
  61 variety of other installation techniques:
  62
  63 =over 4
  64
  65 =item *
  66
  67 CPAN
  68
  69 The traditional way to install Catalyst is directly from CPAN using
  70 C<Task::Catalyst> bundle:
  71
  72         $ perl -MCPAN -e 'install Task::Catalyst'
  73
  74 Unless you have a particularly complete set of Perl modules already
  75 installed, be prepared for a large number of nested dependencies.
  76
  77 =item *
  78
  79 Gentoo Linux
  80
  81 For users of Gentoo, see
  82 C<http://gentoo-wiki.com/HOWTO_Catalyst_Framework> for automated
  83 installations.  In short, simply mount the portage overlay and type
  84 C<emerge catalystframework>.
  85
  86 =item *
  87
  88 FreeBSD
  89
  90 FreeBSD users can get up and running quickly by typing C<cd
  91 /usr/ports/www/p5-Catalyst && make install>, or C<portinstall
  92 p5-Catalyst> if C<portinstall> is installed on your system.
  93
  94 =item *
  95
  96 Windows ActivePerl
  97
  98 Windows users can take advantage of the PPM tool that comes with
  99 ActivePerl to jumpstart their Catalyst environment.  Directions are
 100 available at L<http://catalyst.infogami.com/katalytes/cat_on_windows>.
 101
 102 =item *
 103
 104 Subversion Repository
 105
 106 Catalyst uses Subversion for version control. To checkout the latest:
 107
 108     $ svn co http://dev.catalyst.perl.org/repos/Catalyst/trunk/Catalyst/
 109
 110 =back
 111
 112 B<NOTE:> Although all of the above methods can be used to
 113 install a base Catalyst system, only the VMWare image is
 114 likely to have all of the plugins and modules you need to use
 115 Catalyst properly, and to complete the tutorial.  When you
 116 start the C<script/myapp_server.pl> development server, it
 117 will tell you about any modules that are missing.  To add
 118 them, type something along the lines of the following
 119 (C<Catalyst::Model::DBIC::Schema> is used here as a
 120 representative example):
 121
 122     # perl -MCPAN -e 'install Catalyst::Model::DBIC::Schema'
 123     ...
 124