Added notes regarding slash encoding in Catalyst

[catagits/Gitalist.git] / lib / Gitalist.pm

diff --git a/lib/Gitalist.pm b/lib/Gitalist.pm
index 9f427ba..499ac7b 100644 (file)
--- a/lib/Gitalist.pm
+++ b/lib/Gitalist.pm
@@ -201,40 +201,44 @@ This example can be seen live here:
     http://example.gitalist.com
     
 =head2 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
+        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)
+        In Apache's mime.conf, add AddHandler fcgid-script .fcgi (or AddHandler fastcgi-script .fcgi for mod_fcgi)
                        
-                       And a quick VirtualHost configuration:
+        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>
+        <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
+            #change the below to fastcgi-script if using mod_fcgi
             SetHandler fcgid-script
         </Files>
-                       </VirtualHost>
+      </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
+        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).
+        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.
+
 
 =head1 CONTRIBUTING