Yet another formatting fix to the README...

[catagits/Gitalist.git] / README

diff --git a/README b/README
index 06c2cc2..f4f522d 100644 (file)
--- a/README
+++ b/README
@@ -41,11 +41,33 @@ GETTING GITALIST
 
     The canonical repository for the master branch is:
 
-        it://git.shadowcat.co.uk/catagits/Gitalist.git
+        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.
 
+BOOTSTRAPPING
+    As of 0.002001 Gitalist can now be bootstrapped to run out of its own
+    directory by installing its prerequisites locally with the help of
+    local::lib. So instead of installing the prerequisites to the system
+    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:
+
+        http://github.com/broquaint/Gitalist/downloads
+
+    With the source acquired and unpacked run the following from within the
+    Gitalist directory:
+
+        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
@@ -73,7 +95,7 @@ INITIAL CONFIGURATION
 
       cp `perl -Ilib -MGitalist -e'print Gitalist->path_to("gitalist.conf")'` gitalist.conf
 
-    You can then edit this confg, adding a repos_dir path and customising
+    You can then edit this confg, adding a repo_dir path and customising
     other settings as desired.
 
     You can then start the Gitalist demo server by setting
@@ -83,15 +105,15 @@ INITIAL CONFIGURATION
 
     Alternatively, if you only want to set a repository directory and are
     otherwise happy with the default configuration, then you can set the
-    "GITALIST_REPOS_DIR" environment variable, or pass the "--repos_dir"
-    flag to any of the scripts.
+    "GITALIST_REPO_DIR" environment variable, or pass the "--repo_dir" flag
+    to any of the scripts.
 
-        GITALIST_REPOS_DIR=/home/myuser/code/git gitalist_server.pl
-        gitalist_server.pl --repos_dir home/myuser/code/git
+        GITALIST_REPO_DIR=/home/myuser/code/git gitalist_server.pl
+        gitalist_server.pl --repo_dir home/myuser/code/git
 
-    The "GITALIST_REPOS_DIR" environment variable will override the
+    The "GITALIST_REPO_DIR" environment variable will override the
     repository directory set in configuration, and will itself be overridden
-    by he "--repos_dir" flag.
+    by he "--repo_dir" flag.
 
 RUNNING
     Once you have followed the instructions above to install and configure
@@ -108,12 +130,48 @@ RUNNING
     ".gitignore" so you can have your own copy):
 
         #!/bin/sh
-        export PERL5LIB=/home/t0m/public_html/Gitalist/lib:/home/t0m/perl5/lib/perl5:$PERL5LIB
         exec /home/t0m/public_html/Gitalist/script/gitalist_fastcgi.pl
-
+        
     This example can be seen live here:
 
-        http://goatse.co.uk/~bobtfish/Gitalist/script/gitalist.fcgi/
+        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
@@ -129,7 +187,7 @@ SUPPORT
 SEE ALSO
     Gitalist::Controller::Root
 
-    Gitalist::Git::Project
+    Gitalist::Git::Repository
 
     Catalyst