X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=README;h=5af42e7526f7ea3936ec29e2e7144acc1d59bdc1;hb=2c910294ec50b5a27a9d5d8783ad389e3627789c;hp=88201d2369d45dbd9f18e7206add0075c02e58b8;hpb=0556ab269dff444de064d2ef8d484b948435ff6a;p=catagits%2FGitalist.git

diff --git a/README b/README
index 88201d2..5af42e7 100644
--- a/README
+++ b/README
@@ -2,20 +2,20 @@ 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.:
 
-      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 its git repository and run it, in
     this case you'll additionally need the author modules, but no
@@ -83,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
@@ -137,6 +137,50 @@ RUNNING
 
         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
+    git Path to the "git" binary.
+
+    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
@@ -177,9 +221,15 @@ RUNNING
     "GITALIST_DEBUG=1" to the top of your gitalist.fcgi file (just below the
     shebang line).
 
-    Also, note that 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.
+  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