README

   1 NAME
   2     Gitalist - A modern git web viewer
   3
   4 SYNOPSIS
   5         perl script/gitalist_server.pl --repo_dir /home/me/code/git
   6
   7 INSTALL
   8     As Gitalist follows the usual Perl module format the usual approach for
   9     installation should work, e.g.:
  10
  11         perl Makefile.PL
  12         make
  13         make test
  14         make install
  15
  16     or
  17
  18         cpan -i Gitalist
  19
  20     You can also check Gitalist out from its git repository and run it, in
  21     this case you'll additionally need the author modules, but no
  22     configuration will be needed as it will default to looking for
  23     repositories the directory above the checkout.
  24
  25 DESCRIPTION
  26     Gitalist is a web frontend for git repositories based on gitweb.cgi
  27     <https://git.wiki.kernel.org/index.php/Gitweb> and backed by Catalyst.
  28
  29   History
  30     This project started off as an attempt to port *gitweb.cgi* to a
  31     Catalyst app in a piecemeal fashion. As it turns out, thanks largely to
  32     Florian Ragwitz's earlier effort, it was easier to use *gitweb.cgi* as a
  33     template for building a new Catalyst application.
  34
  35 GETTING GITALIST
  36     You can install Gitalist from CPAN in the usual way:
  37
  38         cpan -i Gitalist
  39
  40     Alternatively, you can get Gitalist using git.
  41
  42     The canonical repository for the master branch is:
  43
  44         git://git.shadowcat.co.uk/catagits/Gitalist.git
  45
  46     Gitalist is also mirrored to GitHub at
  47     <https://github.com/broquaint/Gitalist>, and a number of people have
  48     active forks with branches and/or new features in the master branch.
  49
  50 BOOTSTRAPPING
  51     As of 0.002001 Gitalist can now be bootstrapped to run out of its own
  52     directory by installing its prerequisites locally with the help of
  53     local::lib. So instead of installing the prerequisites to the system
  54     path with CPAN they are installed under the Gitalist directory.
  55
  56     To do this clone Gitalist from the Shadowcat repository mentioned above
  57     or grab a snapshot from broquaint's GitHub repository:
  58
  59         https://github.com/broquaint/Gitalist/downloads
  60
  61     With the source acquired and unpacked run the following from within the
  62     Gitalist directory:
  63
  64         perl script/bootstrap.pl
  65
  66     This will install the necessary modules for the build process which in
  67     turn installs the prerequisites locally.
  68
  69     NB: The relevant bootstrap scripts aren't available in the CPAN dist as
  70     the bootstrap scripts should not be installed.
  71
  72 INITIAL CONFIGURATION
  73     Gitalist is configured using Catalyst::Plugin::Configloader. The
  74     supplied sample configuration is in Config::General format, however it
  75     is possible to configure Gitalist using other config file formats (such
  76     as YAML) if you prefer.
  77
  78   WHEN CHECKING GITALIST OUT OF GIT
  79     Gitalist from git includes a minimal "gitalist_local.conf", which sets
  80     the repository directory to one directory higher than the Gitalist
  81     repository.
  82
  83     This means that if you check Gitalist out next to your other git
  84     checkouts, then starting the demo server needs no parameters at all:
  85
  86         Gitalist [master]$ perl script/gitalist_server.pl
  87         You can connect to your server at http://localhost:3000
  88
  89   FOR CPAN INSTALLS
  90     Gitalist can be supplied with a config file by setting the
  91     "GITALIST_CONFIG" environment variable to point to a configuration file.
  92
  93     If you install Gitalist from CPAN, a default configuration is installed
  94     along with gitalist, which is complete except for a repository
  95     directory. You can get a copy of this configuration by running:
  96
  97       cp `perl -Ilib -MGitalist -e'print Gitalist->path_to("gitalist.conf")'` gitalist.conf
  98
  99     You can then edit this configuration, adding a "repo_dir" path and
 100     customising other settings as desired.
 101
 102     You can then start the Gitalist demo server by setting
 103     "GITALIST_CONFIG". For example:
 104
 105         GITALIST_CONFIG=/usr/local/etc/gitalist.conf gitalist_server.pl
 106
 107     Alternatively, if you only want to set a repository directory and are
 108     otherwise happy with the default configuration, then you can set the
 109     "GITALIST_REPO_DIR" environment variable, or pass the "--repo_dir" flag
 110     to any of the scripts.
 111
 112         GITALIST_REPO_DIR=/home/myuser/code/git gitalist_server.pl
 113         gitalist_server.pl --repo_dir home/myuser/code/git
 114
 115     The "GITALIST_REPO_DIR" environment variable will override the
 116     repository directory set in configuration, and will itself be overridden
 117     by he "--repo_dir" flag.
 118
 119 RUNNING
 120     Once you have followed the instructions above to install and configure
 121     Gitalist, you may want to run it in a more production facing environment
 122     than using the single threaded developement server.
 123
 124     The recommended deployment method for Gitalist is FastCGI, although
 125     Gitalist can also be run under mod_perl <https://perl.apache.org/> or as
 126     pure Perl with Catalyst::Engine::PreFork.
 127
 128     Assuming that you have installed Gitalist's dependencies into a
 129     local::lib, and you are running from a git checkout, adding a trivial
 130     FCGI script as "script/gitalist.fcgi" (this file is specifically in
 131     ".gitignore" so you can have your own copy):
 132
 133         #!/bin/sh
 134         exec /home/t0m/public_html/Gitalist/script/gitalist_fastcgi.pl
 135
 136     This example can be seen live here:
 137
 138         http://example.gitalist.com
 139
 140   Plack
 141     If you would like to run Gitalist under Plack then one need only make
 142     use of plackup and the ".psgi" found under "scripts/":
 143
 144         plackup script/gitalist_app.psgi
 145
 146 CONFIGURATION
 147     The Gitalist config is loaded with Catalyst::Plugin::ConfigLoader and
 148     the available config options are:
 149
 150   Model::CollectionOfRepos
 151     git Path to the "git" binary.
 152
 153     repo_dir
 154         A directory containing the directories to show.
 155
 156     repos
 157         A list of directories containing repositories to show.
 158
 159     search_recursively
 160         A boolean indicating whether to always search recursively for
 161         repositories within "repo_dir".
 162
 163     whitelist
 164         Path a file containing a list of repositories that can be shown.
 165         Each line in the file will represent the name of a repo to show e.g
 166
 167           Gitalist
 168           some-bare-repo.git
 169
 170         This is compatible with "gitweb"'s "projects.list".
 171
 172     export_ok
 173         If provided every must contain a file of the same name to be
 174         visible. This is similar to "gitweb"'s functionality.
 175
 176   paging
 177     log The number of commits to show in the summary, shortlog and longlog
 178         views.
 179
 180   FASTCGI
 181     Running Gitalist in FastCGI mode requires a webserver with FastCGI
 182     support (such as apache with mod_fcgi
 183     <http://www.fastcgi.com/drupal/node/3> or mod_fcgid
 184     <https://httpd.apache.org/mod_fcgid/>). Below is a sample configuration
 185     using Apache2 with mod_fcgid in a dynamic configuration (as opposed to
 186     static or standalone mode). More information on these modes and their
 187     configuration can be found at "Standalone server mode" in
 188     Catalyst::Engine::FastCGI.
 189
 190     In Apache's mime.conf, add "AddHandler fcgid-script .fcgi" (or
 191     "AddHandler fastcgi-script .fcgi" for mod_fcgi).
 192
 193     And a quick VirtualHost configuration:
 194
 195         <VirtualHost *:80>
 196             ServerName gitalist.yourdomain.com
 197             DocumentRoot /path/to/gitalist.fcgi
 198             <Directory "/path/to/gitalist.fcgi">
 199                 AllowOverride all
 200                 Options +ExecCGI -MultiViews +SymLinksIfOwnerMatch
 201                 Order allow,deny
 202                 Allow from all
 203             </Directory>
 204
 205             # Tell Apache this is a FastCGI application
 206             <Files gitalist.fcgi>
 207                 #change the below to fastcgi-script if using mod_fcgi
 208                 SetHandler fcgid-script
 209             </Files>
 210         </VirtualHost>
 211
 212     Now to access your Gitalist instance, you'll go to
 213     "gitalist.yourdomain.com/gitalist.fcgi/" (do not forget that trailing
 214     "/"). If you'd like a different URL, of course, you'll likely want to
 215     use mod_rewrite <https://httpd.apache.org/docs/mod/mod_rewrite.html> or
 216     equivalent.
 217
 218     If you find the need to do some troubleshooting, you can call
 219     "http://url_to_gitalist.fcgi?dump_info=1" and/or add export
 220     "GITALIST_DEBUG=1" to the top of your gitalist.fcgi file (just below the
 221     shebang line).
 222
 223     Also, note that Apache will refuse %2F in Gitalist URLs unless
 224     configured otherwise. Make sure "AllowEncodedSlashes On" is in your
 225     httpd.conf file in order for this to run smoothly.
 226
 227 CONTRIBUTING
 228     Patches are welcome, please feel free to fork on github and send pull
 229     requests, send patches from git format-patch to the bug tracker, or host
 230     your own copy of gitalist somewhere and ask us to pull from it.
 231
 232 SUPPORT
 233     Gitalist has an active irc community in "#gitalist" on irc.perl.org,
 234     please feel free to stop by and ask questions, report bugs or
 235     installation issues or generally for a chat about where we plan to go
 236     with the project.
 237
 238 SEE ALSO
 239     Gitalist::Controller::Root
 240
 241     Gitalist::Git::Repository
 242
 243     Catalyst
 244
 245 AUTHORS AND COPYRIGHT
 246       Catalyst application:
 247         © 2009 Venda Ltd and Dan Brook <broq@cpan.org>
 248         © 2009, Tom Doran <bobtfish@bobtfish.net>
 249         © 2009, Zac Stevens <zts@cryptocracy.com>
 250
 251       Original gitweb.cgi from which this was derived:
 252         © 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
 253         © 2005, Christian Gierke
 254
 255       Model based on http://github.com/rafl/gitweb
 256         © 2008, Florian Ragwitz
 257
 258 LICENSE
 259     Licensed under GNU GPL v2
 260