3 BEGIN { require 5.008006; }
4 use Catalyst::Runtime 5.80;
5 use namespace::autoclean;
17 our $VERSION = '0.001005';
18 $VERSION = eval $VERSION;
22 default_view => 'Default',
23 default_model => 'CollectionOfRepos',
28 after prepare_path => sub {
30 if ($ctx->req->param('a')) {
31 $ctx->request->uri->path('/legacy' . $ctx->request->uri->path);
35 around uri_for => sub {
36 my ($orig, $c) = (shift, shift);
37 my $uri = $c->$orig(@_);
38 $$uri =~ tr[&][;] if defined $uri;
42 around uri_for_action => sub {
43 my ($orig, $c) = (shift, shift);
44 my $uri = $c->$orig(@_);
45 $$uri =~ s[/fragment\b][] if defined $uri;
50 my ($self, @args) = @_;
51 my $uri = $self->request->uri_with(@args);
53 $uri =~ s[/fragment\b][];
63 Gitalist - A modern git web viewer
67 script/gitalist_server.pl --repo_dir /home/me/code/git
71 As Gitalist follows the usual Perl module format the usual approach
72 for installation should work e.g.
83 You can also check gitalist out from git and run it, in this case you'll additionally
84 need the author modules, but no configuration will be needed as it will default to looking
85 for repositories the directory above the checkout.
89 Gitalist is a web frontend for git repositories based on gitweb.cgi
90 and backed by Catalyst.
94 This project started off as an attempt to port gitweb.cgi to a
95 Catalyst app in a piecemeal fashion. As it turns out, thanks largely
96 to Florian Ragwitz's earlier effort, it was easier to use gitweb.cgi
97 as a template for building a new Catalyst application.
99 =head1 GETTING GITALIST
101 You can install Gitalist from CPAN in the usual way:
105 Alternatively, you can get Gitalist using git.
107 The canonical repository for the master branch is:
109 git://git.shadowcat.co.uk/catagits/Gitalist.git
111 Gitalist is also mirrored to github, and a number of people have active forks
112 with branches and/or new features in the master branch.
114 =head1 INITIAL CONFIGURATION
116 Gitalist is configured using L<Catalyst::Plugin::Configloader>. The supplied sample
117 configuration is in L<Config::General> format, however it is possible to configure
118 Gitalist using other config file formats (such as YAML) if you prefer.
120 =head2 WHEN CHECKING GITALIST OUT OF GIT
122 Gitalist from git includes a minimal C<gitalist_local.conf>, which sets the repository
123 directory to one directory higher than the Gitalist repository.
125 This means that if you check Gitalist out next to your other git checkouts, then starting
126 the demo server needs no parameters at all:
128 Gitalist [master]$ ./script/gitalist_server.pl
129 You can connect to your server at http://localhost:3000
131 =head2 FOR CPAN INSTALLS
133 Gitalist can be supplied with a config file by setting the C<< GITALIST_CONFIG >>
134 environment variable to point to a configuration file.
136 If you install Gitalist from CPAN, a default configuration is installed along with gitalist,
137 which is complete except for a repository directory. You can get a copy of this configuration
140 cp `perl -Ilib -MGitalist -e'print Gitalist->path_to("gitalist.conf")'` gitalist.conf
142 You can then edit this confg, adding a repo_dir path and customising other settings as desired.
144 You can then start the Gitalist demo server by setting C<< GITALIST_CONFIG >>. For example:
146 GITALIST_CONFIG=/usr/local/etc/gitalist.conf gitalist_server.pl
148 Alternatively, if you only want to set a repository directory and are otherwise happy with
149 the default configuration, then you can set the C<< GITALIST_REPO_DIR >> environment
150 variable, or pass the C<< --repo_dir >> flag to any of the scripts.
152 GITALIST_REPO_DIR=/home/myuser/code/git gitalist_server.pl
153 gitalist_server.pl --repo_dir home/myuser/code/git
155 The C<< GITALIST_REPO_DIR >> environment variable will override the repository directory set
156 in configuration, and will itself be overridden by he C<< --repo_dir >> flag.
160 Once you have followed the instructions above to install and configure Gitalist, you may want
161 to run it in a more production facing environment than using the single threaded developement
164 The recommended deployment method for Gitalist is FastCGI, although Gitalist can also be run
165 under mod_perl or as pure perl with L<Catalyst::Engine::PreFork>.
167 Assuming that you have installed Gitalist's dependencies into a L<local::lib>, and you
168 are running from a git checkout, adding a trivial FCGI script as C<script/gitalist.fcgi>
169 (this file is specifically in C<.gitignore> so you can have your own copy):
172 export PERL5LIB=/home/t0m/public_html/Gitalist/lib:/home/t0m/perl5/lib/perl5:$PERL5LIB
173 exec /home/t0m/public_html/Gitalist/script/gitalist_fastcgi.pl
175 This example can be seen live here:
177 http://goatse.co.uk/~bobtfish/Gitalist/script/gitalist.fcgi/
181 Patches are welcome, please feel free to fork on github and send pull requests, send patches
182 from git format-patch to the bug tracker, or host your own copy of gitalist somewhere and
183 ask us to pull from it.
187 Gitalist has an active irc community in C<#gitalist> on irc.perl.org, please feel free to stop
188 by and ask questions, report bugs or installation issues or generally for a chat about where
189 we plan to go with the project.
193 L<Gitalist::Controller::Root>
195 L<Gitalist::Git::Repository>
199 =head1 AUTHORS AND COPYRIGHT
201 Catalyst application:
202 (C) 2009 Venda Ltd and Dan Brook <broq@cpan.org>
203 (C) 2009, Tom Doran <bobtfish@bobtfish.net>
204 (C) 2009, Zac Stevens <zts@cryptocracy.com>
206 Original gitweb.cgi from which this was derived:
207 (C) 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
208 (C) 2005, Christian Gierke
210 Model based on http://github.com/rafl/gitweb
211 (C) 2008, Florian Ragwitz
215 Licensed under GNU GPL v2