Updated formatting in Gitalist.pm

[catagits/Gitalist.git] / README

diff --git a/README b/README
index 95fec81..e0c80c7 100644 (file)
--- a/README
+++ b/README
@@ -53,18 +53,21 @@ 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 download from CPAN or broquaint's github repository:
+    or grab a snapshot from broquaint's github repository:
 
         http://github.com/broquaint/Gitalist/downloads
 
     With the source acquired and unpacked run the following from within the
     Gitalist directory:
 
-        perl script/bootstrap
+        perl script/bootstrap.pl
 
     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
+    the bootstrap scripts should not be installed.
+
 INITIAL CONFIGURATION
     Gitalist is configured using Catalyst::Plugin::Configloader. The
     supplied sample configuration is in Config::General format, however it
@@ -128,10 +131,47 @@ RUNNING
 
         #!/bin/sh
         exec /home/t0m/public_html/Gitalist/script/gitalist_fastcgi.pl
-
+        
     This example can be seen live here:
 
-        http://example.gitalist.com
+        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:
+                       
+        <VirtualHost *:80>
+          ServerName gitalist.yourdomain.com
+          DocumentRoot /path/to/gitalist.fcgi
+          <Directory "/path/to/gitalist.fcgi">
+            AllowOverride all
+            Options +ExecCGI -MultiViews +SymLinksIfOwnerMatch
+            Order allow,deny
+            Allow from all
+          </Directory>
+
+        # Tell Apache this is a FastCGI application
+        <Files gitalist.fcgi>
+            #change the below to fastcgi-script if using mod_fcgi
+            SetHandler fcgid-script
+        </Files>
+                       </VirtualHost>
+                       
+        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).
+               
 
 CONTRIBUTING
     Patches are welcome, please feel free to fork on github and send pull