Merge branch 'branch-selector-fix'

[catagits/Gitalist.git] / README

diff --git a/README b/README
index 33e62bd..9ba448a 100644 (file)
--- a/README
+++ b/README
@@ -147,9 +147,11 @@ CONFIGURATION
     The Gitalist config is loaded with Catalyst::Plugin::ConfigLoader and
     the available config options are:
 
-  Model::CollectionOfRepos
-    git Path to the "git" binary.
+    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.
 
@@ -173,6 +175,16 @@ CONFIGURATION
         If provided every must contain a file of the same name to be
         visible. This is similar to "gitweb"'s functionality.
 
+    class
+        If you want a different way of surfacing repositories you can use
+        your own model (i.e something that composes
+        Gitalist::Git::CollectionOfRepositories) and specify the class name
+        with this config option.
+
+    args
+        Any additional arguments to be passed into the Model constructor,
+        only of use when used in conjunction with "class" (see above).
+
   paging
     log The number of commits to show in the summary, shortlog and longlog
         views.
@@ -220,9 +232,15 @@ CONFIGURATION
     "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