X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FGitalist.git;a=blobdiff_plain;f=README;h=e7e9663a2bbb7217d68e4bfad50ea90d44609fa4;hp=2e7feaa5aec7800b57ec1df5832fe3acab7bb1c8;hb=8f7296d0b564f052d4b17dddbd553dc355b04f88;hpb=67388737e8fb8d1e066cf18248b538cacf016b4c diff --git a/README b/README index 2e7feaa..e7e9663 100644 --- a/README +++ b/README @@ -2,35 +2,35 @@ NAME Gitalist - A modern git web viewer SYNOPSIS - script/gitalist_server.pl --repo_dir /home/me/code/git + perl script/gitalist_server.pl --repo_dir /home/me/code/git INSTALL As Gitalist follows the usual Perl module format the usual approach for - installation should work e.g. + installation should work, e.g.: - perl Makefile.PL - make - make test - make install + perl Makefile.PL + make + make test + make install or - cpan -i Gitalist + 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 for repositories the directory - above the checkout. + You can also check Gitalist out from its git repository 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. 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 gitweb.cgi + and backed by Catalyst. History - This project started off as an attempt to port gitweb.cgi 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 as a template - for building a new Catalyst application. + This project started off as an attempt to port *gitweb.cgi* 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* as a + template for building a new Catalyst application. GETTING GITALIST You can install Gitalist from CPAN in the usual way: @@ -43,8 +43,9 @@ GETTING GITALIST git://git.shadowcat.co.uk/catagits/Gitalist.git - Gitalist is also mirrored to github, and a number of people have active - forks with branches and/or new features in the master branch. + Gitalist is also mirrored to GitHub at + , and a number of people have + active forks with branches and/or new features in the master branch. BOOTSTRAPPING As of 0.002001 Gitalist can now be bootstrapped to run out of its own @@ -53,9 +54,9 @@ BOOTSTRAPPING path with CPAN they are installed under the Gitalist directory. To do this clone Gitalist from the Shadowcat repository mentioned above - or grab a snapshot from broquaint's github repository: + or grab a snapshot from broquaint's GitHub repository: - http://github.com/broquaint/Gitalist/downloads + https://github.com/broquaint/Gitalist/downloads With the source acquired and unpacked run the following from within the Gitalist directory: @@ -65,7 +66,7 @@ BOOTSTRAPPING This will install the necessary modules for the build process which in turn installs the prerequisites locally. - *NB* The relevant bootstrap scripts aren't available in the CPAN dist as + NB: The relevant bootstrap scripts aren't available in the CPAN dist as the bootstrap scripts should not be installed. INITIAL CONFIGURATION @@ -82,7 +83,7 @@ INITIAL CONFIGURATION This means that if you check Gitalist out next to your other git checkouts, then starting the demo server needs no parameters at all: - Gitalist [master]$ ./script/gitalist_server.pl + Gitalist [master]$ perl script/gitalist_server.pl You can connect to your server at http://localhost:3000 FOR CPAN INSTALLS @@ -95,8 +96,8 @@ INITIAL CONFIGURATION 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 "repo_dir" path and + customising other settings as desired. You can then start the Gitalist demo server by setting "GITALIST_CONFIG". For example: @@ -121,8 +122,8 @@ RUNNING than using the single threaded developement server. The recommended deployment method for Gitalist is FastCGI, although - Gitalist can also be run under mod_perl or as pure perl with - Catalyst::Engine::PreFork. + Gitalist can also be run under mod_perl or as + pure Perl with Catalyst::Engine::PreFork. Assuming that you have installed Gitalist's dependencies into a local::lib, and you are running from a git checkout, adding a trivial @@ -131,50 +132,105 @@ RUNNING #!/bin/sh exec /home/t0m/public_html/Gitalist/script/gitalist_fastcgi.pl - + This example can be seen live here: - http://example.gitalist.com - - FASTCGI - Running Gitalist in FastCGI mode requires a webserver with FastCGI - support (such as apache with mod_fcgi or fcgid). Below is a sample - configuration using Apache2 with fcgid in a dynamic configuration - (as opposed to static or standalone mode). More information on these modes and - their configuration can be found at - http://search.cpan.org/~bobtfish/Catalyst-Runtime-5.80025/lib/Catalyst/Engine/FastCGI.pm#Standalone_server_mode - - In Apache's mime.conf, add AddHandler fcgid-script .fcgi (or AddHandler fastcgi-script .fcgi for mod_fcgi) - - And a quick VirtualHost configuration: - + http://example.gitalist.com + + Plack + If you would like to run Gitalist under Plack then one need only make + use of plackup and the ".psgi" found under "scripts/": + + plackup script/gitalist_app.psgi + +CONFIGURATION + The Gitalist config is loaded with Catalyst::Plugin::ConfigLoader and + the available config options are: + + no_gravatars + If true don't display gravatars. May be desirable if you are worried + about leaking repo names via the browser referer headers. + + Model::CollectionOfRepos + repo_dir + A directory containing the directories to show. + + repos + A list of directories containing repositories to show. + + search_recursively + A boolean indicating whether to always search recursively for + repositories within "repo_dir". + + whitelist + Path a file containing a list of repositories that can be shown. + Each line in the file will represent the name of a repo to show e.g + + Gitalist + some-bare-repo.git + + This is compatible with "gitweb"'s "projects.list". + + export_ok + If provided every must contain a file of the same name to be + visible. This is similar to "gitweb"'s functionality. + + paging + log The number of commits to show in the summary, shortlog and longlog + views. + + FASTCGI + Running Gitalist in FastCGI mode requires a webserver with FastCGI + support (such as apache with mod_fcgi + or mod_fcgid + ). Below is a sample configuration + using Apache2 with mod_fcgid in a dynamic configuration (as opposed to + static or standalone mode). More information on these modes and their + configuration can be found at "Standalone server mode" in + Catalyst::Engine::FastCGI. + + In Apache's mime.conf, add "AddHandler fcgid-script .fcgi" (or + "AddHandler fastcgi-script .fcgi" for mod_fcgi). + + And a quick VirtualHost configuration: + - ServerName gitalist.yourdomain.com - DocumentRoot /path/to/gitalist.fcgi - - AllowOverride all - Options +ExecCGI -MultiViews +SymLinksIfOwnerMatch - Order allow,deny - Allow from all - - - # Tell Apache this is a FastCGI application - - #change the below to fastcgi-script if using mod_fcgi - SetHandler fcgid-script - - - - Now to access your gitalist instance, you'll go to gitalist.yourdomain.com/gitalist.fcgi/ - (DO NOT FORGET THAT TRAILING /). If you'd like a different URL, of course, you'll likely want to use - mod_rewrite or equivalent - - If you find the need to do some troubleshooting, you can call http://url_to_gitalist.fcgi?dump_info=1 - and/or add export GITALIST_DEBUG=1 to the top of you gitalist.fcgi file (just below the shebang line). - - Also, note that Apache will refuse %2F in Gitalist URL's unless configured otherwise. Make sure - "AllowEncodedSlashes On" is in your httpd.conf file in order for this to run smoothly. - + ServerName gitalist.yourdomain.com + DocumentRoot /path/to/gitalist.fcgi + + AllowOverride all + Options +ExecCGI -MultiViews +SymLinksIfOwnerMatch + Order allow,deny + Allow from all + + + # Tell Apache this is a FastCGI application + + #change the below to fastcgi-script if using mod_fcgi + SetHandler fcgid-script + + + + Now to access your Gitalist instance, you'll go to + "gitalist.yourdomain.com/gitalist.fcgi/" (do not forget that trailing + "/"). If you'd like a different URL, of course, you'll likely want to + use mod_rewrite or + equivalent. + + If you find the need to do some troubleshooting, you can call + "http://url_to_gitalist.fcgi?dump_info=1" and/or add export + "GITALIST_DEBUG=1" to the top of your gitalist.fcgi file (just below the + shebang line). + + Apache config + Apache will refuse %2F in Gitalist URLs unless configured otherwise. + Make sure "AllowEncodedSlashes On" is in your httpd.conf file in order + for this to run smoothly. + + To have the static content served statically by Apache, instead of + Gitalist, then add something like following line to your httpd.conf: + + Alias /static /usr/local/share/perl/5.10.1/Gitalist/root/static CONTRIBUTING Patches are welcome, please feel free to fork on github and send pull @@ -196,16 +252,16 @@ SEE ALSO AUTHORS AND COPYRIGHT Catalyst application: - (C) 2009 Venda Ltd and Dan Brook - (C) 2009, Tom Doran - (C) 2009, Zac Stevens + © 2009 Venda Ltd and Dan Brook + © 2009, Tom Doran + © 2009, Zac Stevens Original gitweb.cgi from which this was derived: - (C) 2005-2006, Kay Sievers - (C) 2005, Christian Gierke + © 2005-2006, Kay Sievers + © 2005, Christian Gierke Model based on http://github.com/rafl/gitweb - (C) 2008, Florian Ragwitz + © 2008, Florian Ragwitz LICENSE Licensed under GNU GPL v2