3 Catalyst::Manual::Installation - Catalyst Installation
7 How to install Catalyst.
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.
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.
24 Fortunately, there are a growing number of methods that can
25 dramatically ease this undertaking:
31 Matt Trout's C<cat-install>
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
40 Chris Laco's CatInABox
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>
49 Pre-Built VMWare Images
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.
60 In addition to the "all-in-one" approaches mentioned above, there are a
61 variety of other installation techniques:
69 The traditional way to install Catalyst is directly from CPAN using
70 C<Task::Catalyst> bundle:
72 $ perl -MCPAN -e 'install Task::Catalyst'
74 Unless you have a particularly complete set of Perl modules already
75 installed, be prepared for a large number of nested dependencies.
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>.
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.
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>.
104 Subversion Repository
106 Catalyst uses Subversion for version control. To checkout the latest:
108 $ svn co http://dev.catalyst.perl.org/repos/Catalyst/trunk/Catalyst/
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):
122 # perl -MCPAN -e 'install Catalyst::Model::DBIC::Schema'