X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FGitalist.pm;h=435f7e1751f4f5c57108578a6734693ac38b0f42;hb=4916e60728a5d9642e45cf6957758f110b94803b;hp=94bf8b91dd1607cd6c6681b2cd26796394987187;hpb=e77519b1f2935e65c74dd1980a13feb831696fd0;p=catagits%2FGitalist.git diff --git a/lib/Gitalist.pm b/lib/Gitalist.pm index 94bf8b9..435f7e1 100644 --- a/lib/Gitalist.pm +++ b/lib/Gitalist.pm @@ -14,7 +14,7 @@ use Catalyst qw/ SubRequest /; -our $VERSION = '0.001007'; +our $VERSION = '0.002007'; $VERSION = eval $VERSION; __PACKAGE__->config( @@ -60,6 +60,8 @@ sub uri_with { __END__ +=encoding UTF-8 + =head1 NAME Gitalist - A modern git web viewer @@ -71,7 +73,7 @@ Gitalist - A modern git web viewer =head1 INSTALL As Gitalist follows the usual Perl module format the usual approach -for installation should work e.g. +for installation should work, e.g.: perl Makefile.PL make @@ -82,20 +84,22 @@ or cpan -i Gitalist -You can also check gitalist out from git and run it, in this case you'll additionally -need the author modules, but no configuration will be needed as it will default to looking +You can also L +and run it, in this case you'll additionally need the author modules, +but no configuration will be needed as it will default to looking for repositories the directory above the checkout. =head1 DESCRIPTION -Gitalist is a web frontend for git repositories based on gitweb.cgi -and backed by Catalyst. +Gitalist is a web frontend for git repositories based on +L and backed by +L. =head2 History -This project started off as an attempt to port gitweb.cgi to a +This project started off as an attempt to port I to a Catalyst app in a piecemeal fashion. As it turns out, thanks largely -to Florian Ragwitz's earlier effort, it was easier to use gitweb.cgi +to Florian Ragwitz's earlier effort, it was easier to use I as a template for building a new Catalyst application. =head1 GETTING GITALIST @@ -110,9 +114,33 @@ The canonical repository for the master branch is: git://git.shadowcat.co.uk/catagits/Gitalist.git -Gitalist is also mirrored to github, and a number of people have active forks +Gitalist is also mirrored to GitHub at L, +and a number of people have active forks with branches and/or new features in the master branch. +=head1 BOOTSTRAPPING + +As of C<0.002001> Gitalist can now be bootstrapped to run out of its +own directory by installing its prerequisites locally with the help of +L. So instead of installing the prerequisites to the +system path with CPAN they are installed under the Gitalist directory. + +To do this clone Gitalist from the L or grab a snapshot from broquaint's GitHub repository: + + https://github.com/broquaint/Gitalist/downloads + +With the source acquired and unpacked run the following from within the +Gitalist directory: + + perl script/bootstrap.pl + +This will install the necessary modules for the build process which in +turn installs the prerequisites locally. + +B The relevant bootstrap scripts aren't available in the CPAN dist +as the bootstrap scripts should not be installed. + =head1 INITIAL CONFIGURATION Gitalist is configured using L. The supplied sample @@ -141,7 +169,8 @@ by running: cp `perl -Ilib -MGitalist -e'print Gitalist->path_to("gitalist.conf")'` gitalist.conf -You can then edit this confg, adding a repo_dir path and customising other settings as desired. +You can then edit this configuration, adding a C path and customising +other settings as desired. You can then start the Gitalist demo server by setting C<< GITALIST_CONFIG >>. For example: @@ -164,19 +193,63 @@ to run it in a more production facing environment than using the single threaded server. The recommended deployment method for Gitalist is FastCGI, although Gitalist can also be run -under mod_perl or as pure perl with L. +under L or as pure Perl with L. Assuming that you have installed Gitalist's dependencies into a L, and you are running from a git checkout, adding a trivial FCGI script as C