]> git.decadent.org.uk Git - maypole.git/blob - lib/Maypole/Manual/Install.pod
Reorganised pod in Maypole.pm, finished doc roadmap, various minor pod updates, moved...
[maypole.git] / lib / Maypole / Manual / Install.pod
1 \r
2 =head1 NAME\r
3 \r
4 Maypole::Manual::Install - installing Maypole\r
5 \r
6 =head1 Installing Maypole\r
7 \r
8 The first thing you're going to need to do to get Maypole running is to\r
9 install it. Maypole needs an absolute shedload of Perl modules from CPAN\r
10 to do its job. I am unrepentant about this. Maypole does a lot of work,\r
11 so that you don't have to. This is called code re-use, and if we're\r
12 serious about code re-use, then Maypole should be re-using as much code\r
13 as possible in terms of Perl modules. In another sense, this gives the\r
14 impression that Maypole doesn't actually do all that much itself,\r
15 because all it's doing is gluing together already-existing code. Well,\r
16 welcome to code re-use.\r
17 \r
18 The downside of code re-use is, of course, that you then have to install\r
19 a shedload of Perl modules from CPAN. If you're using OpenBSD or\r
20 FreeBSD, the wonderful ports system will be your friend. There's a\r
21 Maypole port in C<p5-Maypole>. Just type C<make install>.\r
22 \r
23 Debian users, hang in there. There's a package coming.\r
24 \r
25 For other Unices, the L<CPANPLUS> or C<CPAN> modules will help with\r
26 this. If you don't have C<CPANPLUS> installed, my recommendation is to\r
27 use C<perl -MCPAN -e install CPANPLUS> to install it and then throw\r
28 C<CPAN.pm> away. In any case, one of these two should get all that\r
29 Maypole needs:\r
30 \r
31     % perl -MCPANPLUS -e 'install Maypole'\r
32     % perl -MCPAN -e 'install Maypole'\r
33 \r
34     \r
35 Information on installing under Windows is available from the wiki - \r
36 http://maypole.perl.org/?WindowsInstall\r
37 \r
38 More information of installing under various Linux flavours is available on the\r
39 Wiki - http://maypole.perl.org/?LinuxInstall\r
40 \r
41 You're also going to need a database server and a web server. For\r
42 databases, I recommend SQLite (if you install the C<DBD::SQLite> module,\r
43 you get the SQLite library for free) for prototyping and mysql for\r
44 production; heavier duty users should use Postgresql or Oracle - Maypole\r
45 should be happy with them all. Maypole is happiest when running under\r
46 Apache C<mod_perl>, with the C<Apache::Request> module installed, but as\r
47 I said, it is a blank slate, and everything is customizable. There is a\r
48 C<CGI::Maypole> frontend available to run as a standalone CGI script.\r
49 \r
50 As well as the documentation embedded in the Perl modules the distribution\r
51 also includes the manual, of which this is a part. You can access it using the\r
52 perldoc command, the man command, or by browsing CPAN.\r