2 Gitalist - A modern git web viewer
5 script/gitalist_server.pl --repo_dir /home/me/code/git
8 As Gitalist follows the usual Perl module format the usual approach for
9 installation should work e.g.
20 You can also check gitalist out from git and run it, in this case you'll
21 additionally need the author modules, but no configuration will be
22 needed as it will default to looking for repositories the directory
26 Gitalist is a web frontend for git repositories based on gitweb.cgi and
30 This project started off as an attempt to port gitweb.cgi to a Catalyst
31 app in a piecemeal fashion. As it turns out, thanks largely to Florian
32 Ragwitz's earlier effort, it was easier to use gitweb.cgi as a template
33 for building a new Catalyst application.
36 You can install Gitalist from CPAN in the usual way:
40 Alternatively, you can get Gitalist using git.
42 The canonical repository for the master branch is:
44 git://git.shadowcat.co.uk/catagits/Gitalist.git
46 Gitalist is also mirrored to github, and a number of people have active
47 forks with branches and/or new features in the master branch.
50 Gitalist is configured using Catalyst::Plugin::Configloader. The
51 supplied sample configuration is in Config::General format, however it
52 is possible to configure Gitalist using other config file formats (such
53 as YAML) if you prefer.
55 WHEN CHECKING GITALIST OUT OF GIT
56 Gitalist from git includes a minimal "gitalist_local.conf", which sets
57 the repository directory to one directory higher than the Gitalist
60 This means that if you check Gitalist out next to your other git
61 checkouts, then starting the demo server needs no parameters at all:
63 Gitalist [master]$ ./script/gitalist_server.pl
64 You can connect to your server at http://localhost:3000
67 Gitalist can be supplied with a config file by setting the
68 "GITALIST_CONFIG" environment variable to point to a configuration file.
70 If you install Gitalist from CPAN, a default configuration is installed
71 along with gitalist, which is complete except for a repository
72 directory. You can get a copy of this configuration by running:
74 cp `perl -Ilib -MGitalist -e'print Gitalist->path_to("gitalist.conf")'` gitalist.conf
76 You can then edit this confg, adding a repo_dir path and customising
77 other settings as desired.
79 You can then start the Gitalist demo server by setting
80 "GITALIST_CONFIG". For example:
82 GITALIST_CONFIG=/usr/local/etc/gitalist.conf gitalist_server.pl
84 Alternatively, if you only want to set a repository directory and are
85 otherwise happy with the default configuration, then you can set the
86 "GITALIST_REPO_DIR" environment variable, or pass the "--repo_dir" flag
87 to any of the scripts.
89 GITALIST_REPO_DIR=/home/myuser/code/git gitalist_server.pl
90 gitalist_server.pl --repo_dir home/myuser/code/git
92 The "GITALIST_REPO_DIR" environment variable will override the
93 repository directory set in configuration, and will itself be overridden
94 by he "--repo_dir" flag.
97 Once you have followed the instructions above to install and configure
98 Gitalist, you may want to run it in a more production facing environment
99 than using the single threaded developement server.
101 The recommended deployment method for Gitalist is FastCGI, although
102 Gitalist can also be run under mod_perl or as pure perl with
103 Catalyst::Engine::PreFork.
105 Assuming that you have installed Gitalist's dependencies into a
106 local::lib, and you are running from a git checkout, adding a trivial
107 FCGI script as "script/gitalist.fcgi" (this file is specifically in
108 ".gitignore" so you can have your own copy):
111 export PERL5LIB=/home/t0m/public_html/Gitalist/lib:/home/t0m/perl5/lib/perl5:$PERL5LIB
112 exec /home/t0m/public_html/Gitalist/script/gitalist_fastcgi.pl
114 This example can be seen live here:
116 http://goatse.co.uk/~bobtfish/Gitalist/script/gitalist.fcgi/
119 Patches are welcome, please feel free to fork on github and send pull
120 requests, send patches from git format-patch to the bug tracker, or host
121 your own copy of gitalist somewhere and ask us to pull from it.
124 Gitalist has an active irc community in "#gitalist" on irc.perl.org,
125 please feel free to stop by and ask questions, report bugs or
126 installation issues or generally for a chat about where we plan to go
130 Gitalist::Controller::Root
132 Gitalist::Git::Repository
136 AUTHORS AND COPYRIGHT
137 Catalyst application:
138 (C) 2009 Venda Ltd and Dan Brook <broq@cpan.org>
139 (C) 2009, Tom Doran <bobtfish@bobtfish.net>
140 (C) 2009, Zac Stevens <zts@cryptocracy.com>
142 Original gitweb.cgi from which this was derived:
143 (C) 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
144 (C) 2005, Christian Gierke
146 Model based on http://github.com/rafl/gitweb
147 (C) 2008, Florian Ragwitz
150 Licensed under GNU GPL v2