From: Jesse Sheidlower <jester@panix.com>
Date: Fri, 28 Nov 2008 04:10:52 +0000 (+0000)
Subject: Added details of Aliasing filesystem paths to Using with Apache docs section
X-Git-Tag: v0.21~8
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Plugin-Static-Simple.git;a=commitdiff_plain;h=6e89d83c40a25202d31ac9f9d8386ddab1f1c0a4

Added details of Aliasing filesystem paths to Using with Apache docs section
---

diff --git a/lib/Catalyst/Plugin/Static/Simple.pm b/lib/Catalyst/Plugin/Static/Simple.pm
index 7dbf37e..e15a9de 100644
--- a/lib/Catalyst/Plugin/Static/Simple.pm
+++ b/lib/Catalyst/Plugin/Static/Simple.pm
@@ -278,7 +278,7 @@ Catalyst::Plugin::Static::Simple - Make serving static pages painless.
     # things or bypass Catalyst entirely in a production environment
     #
     # one caveat: the files must be served from an absolute path
-    # (ie. /images/foo.png)
+    # (i.e. /images/foo.png)
 
 =head1 DESCRIPTION
 
@@ -440,13 +440,14 @@ is automatically enabled when running Catalyst in -Debug mode.
     
 =head1 USING WITH APACHE
 
-While Static::Simple will work just fine serving files through Catalyst in
-mod_perl, for increased performance, you may wish to have Apache handle the
-serving of your static files.  To do this, simply use a dedicated directory
-for your static files and configure an Apache Location block for that
-directory.  This approach is recommended for production installations.
+While Static::Simple will work just fine serving files through Catalyst
+in mod_perl, for increased performance you may wish to have Apache
+handle the serving of your static files directly. To do this, simply use
+a dedicated directory for your static files and configure an Apache
+Location block for that directory  This approach is recommended for
+production installations.
 
-    <Location /static>
+    <Location /myapp/static>
         SetHandler default-handler
     </Location>
 
@@ -455,6 +456,25 @@ through Catalyst. You can leave Static::Simple as part of your
 application, and it will continue to function on a development server,
 or using Catalyst's built-in server.
 
+In practice, your Catalyst application is probably (i.e. should be)
+structured in the recommended way (i.e., that generated by bootstrapping
+the application with the C<catalyst.pl> script, with a main directory
+under which is a C<lib/> directory for module files and a C<root/>
+directory for templates and static files). Thus, unless you break up
+this structure when deploying your app by moving the static files to a
+different location in your filesystem, you will need to use an Alias
+directive in Apache to point to the right place. You will then need to
+add a Directory block to give permission for Apache to serve these
+files. The final configuration will look something like this:
+
+    Alias /myapp/static /filesystem/path/to/MyApp/root/static
+    <Directory /filesystem/path/to/MyApp/root/static>
+        allow from all
+    </Directory>
+    <Location /myapp/static>
+        SetHandler default-handler
+    </Location>
+
 =head1 PUBLIC METHODS
 
 =head2 serve_static_file $file_path