passenger 2.2.4 → 2.2.5

data/NEWS

@@ -0,0 +1,137 @@
+Release 2.2.5
+-------------
+
+ * [Apache] Small file uploads are now buffered; fixes potential DoS attack
+   Phusion Passenger buffers large file uploads to temp files so that it
+   doesn't block applications while an upload is in progress, but it sent
+   small uploads directly to the application without buffering it. This could
+   result in a potential DoS attack: the client can send many small, incomplete
+   file uploads to the server, and this would block all application processes
+   until a timeout occurs. In order to solve this problem, Phusion Passenger
+   now buffers small file uploads in memory. Bug #356.
+
+ * [Apache] Fixed support for mod_rewrite passthrough rules
+   Mod_rewrite passthrough rules were not properly supported because of a bug
+   fix for supporting encoded slashes (%2f) in URLs. Unfortunately, due to
+   bugs/limitations in Apache, we can support either encoded slashes or
+   mod_rewrite passthrough rules, but not both; supporting one will break the
+   other.
+
+   Support for mod_rewrite passthrough rules is now enabled by default; that
+   is, support for encoded slashes is disabled by default. A new configuration
+   option, "PassengerAllowEncodedSlashes", has been added. Turning this option
+   on will enable support for encoded slashes and disable support for
+   mod_rewrite passthrough rules.
+
+   Issue #113 and issue #230.
+
+ * [Apache] Added a configuration option for resolving symlinks in the document root path
+   Phusion Passenger 2.2.0 and higher no longer resolves symlinks in
+   the document root path in order to properly support Capistrano-style
+   directory structures. The exact behavior is documented in the Users Guide,
+   section "How Phusion Passenger detects whether a virtual host is a web
+   application".
+
+   However, some people relied on the old behavior. A new configuration option,
+   PassengerResolveSymlinksInDocumentRoot, has been added to allow reverting
+   back to the old behavior.
+
+   Patch contributed by Locaweb (http://www.locaweb.com.br/).
+
+ * [Apache] mod_env variables are now also passed through CGI environment headers
+   Prior to version 2.2.3, environment variables set by mod_env are passed to
+   the application as CGI environment headers, not through Ruby's ENV variable.
+   In the last release we introduced support for setting ENV environment
+   variables with mod_env, and got rid of the code for setting CGI environment
+   headers. It turns out that some people relied on the old behavior, we so now
+   environment variables set with mod_env are set in both ENV and in the CGI
+   environment.
+   
+   Fixes bug #335.
+
+ * [Apache] Fixed compilation problems on some Linux systems with older versions of Apache
+   If you used to see compilation errors like this:
+
+       ext/apache2/Configuration.cpp:554: error: expected primary-expression before '.' token
+
+   then this version should compile properly.
+
+ * [Apache] Fixed I/O timeouts for communication with backend processes
+   Got rid of the code for enforcing I/O timeouts when reading from or writing to
+   a backend process. This caused more problems than it solved.
+
+ * [Nginx] Support for streaming responses (e.g. Comet or HTTP push)
+   Buffering of backend responses is now disabled. This fixes support for
+   streaming responses, something which the Apache version has supported
+   for a while now. One can generate streaming responses in Ruby on Rails
+   like this:
+
+       render :text => lambda { |response, output|
+           10_000.times do |i|
+               output.write("hello #{i}!\n")
+           end
+       }
+
+ * [Nginx] Installer now installs Nginx 0.7.61 by default
+   Previously it installed 0.6.37 by default.
+
+ * [Nginx] Fixed the installer's --extra-configure-flags flag when combined with --auto-download
+   Arguments passed to --extra-configure-flags were not being passed to the
+   Nginx configure script when --auto-download is given. This has been
+   fixed: bug #349.
+
+ * [Nginx] Fixed unnecessary download of PCRE
+   The installer now checks whether PCRE is installed in /opt/local (e.g.
+   MacPorts) as well before concluding that it isn't installed and going ahead
+   with downloading PCRE.
+
+ * Fixed STDERR capturing
+   While spawning an application, Phusion Passenger captures any output written
+   to STDERR so that it can show them later if the application failed to start.
+   This turns out to be much more difficult than expected, with all kinds of
+   corner cases that can mess up this feature.
+
+   For example, if the Rails log file is not writable, then this can cause
+   Rails to crash with a bizarre and unhelpful error message whenever it tries
+   to write to STDERR:
+
+       /!\ FAILSAFE /!\  Thu Aug 20 14:58:39 +1000 2009
+       Status: 500 Internal Server Error
+       undefined method `[]' for nil:NilClass
+
+   Some applications reopen STDERR to a log file. This didn't work.
+
+   Of all of these problems have been fixed now. (Bug #332)
+
+ * Fixed some bugs in application sources preloading
+   Rails >= 2.2 already preloads the application sources, in which case Phusion
+   Passenger wasn't supposed to perform it's own preloading, but the Rails
+   >= 2.2 detection code was bugged. This has been fixed.
+
+   Rails < 2.2 doesn't preload the application sources by itself, but there
+   should be a certain order with which the sources are preloaded, otherwise
+   preloading could fail in some applications. We now enforce a specific load
+   order: first models, then controllers, then helpers.
+
+   Bug #359.
+ 
+ * Fixed a few bugs in WSGI compliance
+   PATH_INFO is supposed to be set to the request URI, but without the query
+   string and without the base URI. This has been fixed: bug #360.
+
+ * Fixed some Ruby 1.9-specific crashes caused by encoding issues. Bug #354.
+ * Fixed loading of config/environment.rb on Ruby 1.9.2, because Ruby 1.9.2
+   no longer has "." in the default load path. Patch by metaljastix, issue #368.
+ * The Users Guide for Apache now mentions something about correct permissions
+   for application directories.
+ * Fixed compilation problems on IA-64 (bug #118). We also reduced the stack
+   sizes for the threads by half, so Phusion Passenger should use even less
+   virtual memory now.
+ * Fixed compilation problems on Linux systems with ARM CPU.
+ * Fixed a few compatibility problems with 64-bit OpenBSD.
+ * Fixed a few typos and minor bugs.
+
+
+Older releases
+--------------
+Please consult the blog posts on http://blog.phusion.nl/ for the information about older releases.

data/Rakefile

@@ -95,7 +95,7 @@ end
 
 ##### Boost and OXT static library
 
-def define_libboost_oxt_task(output_dir, extra_compiler_flags = nil)
+def define_libboost_oxt_task(namespace, output_dir, extra_compiler_flags = nil)
 	output_file = "#{output_dir}/libboost_oxt.a"
 	output_dir_base = "#{output_dir}/libboost_oxt"
 	flags = "-Iext #{extra_compiler_flags} #{PlatformInfo.portability_cflags} #{EXTRA_CXXFLAGS}"
@@ -136,7 +136,7 @@ def define_libboost_oxt_task(output_dir, extra_compiler_flags = nil)
 			"#{output_dir_base}/oxt/*.o")
 	end
 	
-	task :clean do
+	task "#{namespace}:clean" do
 		sh "rm -rf #{output_file} #{output_dir_base}"
 	end
 	
@@ -147,7 +147,7 @@ end
 ##### Static library for Passenger source files that are shared between
 ##### the Apache module and the Nginx helper server.
 
-def define_common_library_task(output_dir, extra_compiler_flags = nil,
+def define_common_library_task(namespace, output_dir, extra_compiler_flags = nil,
                                with_application_pool_server_exe = false,
                                boost_oxt_library = nil,
                                extra_compiler_flags_for_server_exe = nil,
@@ -214,7 +214,7 @@ def define_common_library_task(output_dir, extra_compiler_flags = nil,
 		end
 	end
 	
-	task :clean do
+	task "#{namespace}:clean" do
 		sh "rm -rf #{targets.join(' ')} #{objects_output_dir}"
 	end
 	
@@ -255,9 +255,9 @@ end
 	
 	# NOTE: APACHE2_BOOST_OXT_LIBRARY is a task name, while APACHE2_COMMON_LIBRARY
 	# is an array of task names.
-	APACHE2_BOOST_OXT_LIBRARY = define_libboost_oxt_task("ext/apache2",
+	APACHE2_BOOST_OXT_LIBRARY = define_libboost_oxt_task("apache2", "ext/apache2",
 		PlatformInfo.apache2_module_cflags)
-	APACHE2_COMMON_LIBRARY    = define_common_library_task("ext/apache2",
+	APACHE2_COMMON_LIBRARY    = define_common_library_task("apache2", "ext/apache2",
 		PlatformInfo.apache2_module_cflags,
 		true, APACHE2_BOOST_OXT_LIBRARY)
 	
@@ -314,8 +314,7 @@ end
 	end
 
 	task :clean => 'apache2:clean'
-
-	# Remove generated files for the Apache 2 module
+	desc "Clean all compiled Apache 2 files"
 	task 'apache2:clean' do
 		files = [APACHE2_OBJECTS, %w(ext/apache2/mod_passenger.o
 			ext/apache2/mod_passenger.so)]
@@ -327,8 +326,8 @@ end
 
 	# NOTE: NGINX_BOOST_OXT_LIBRARY is a task name, while NGINX_COMMON_LIBRARY
 	# is an array of task names.
-	NGINX_BOOST_OXT_LIBRARY = define_libboost_oxt_task("ext/nginx")
-	NGINX_COMMON_LIBRARY    = define_common_library_task("ext/nginx")
+	NGINX_BOOST_OXT_LIBRARY = define_libboost_oxt_task("nginx", "ext/nginx")
+	NGINX_COMMON_LIBRARY    = define_common_library_task("nginx", "ext/nginx")
 	
 	desc "Build Nginx helper server"
 	task :nginx => ['ext/nginx/HelperServer', :native_support]
@@ -355,8 +354,7 @@ end
 	end
 	
 	task :clean => 'nginx:clean'
-	
-	# Remove Nginx helper server
+	desc "Clean all compiled Nginx files"
 	task 'nginx:clean' do
 		sh("rm", "-rf", "ext/nginx/HelperServer")
 	end
@@ -364,8 +362,8 @@ end
 
 ##### Unit tests
 
-	TEST_BOOST_OXT_LIBRARY = define_libboost_oxt_task("test")
-	TEST_COMMON_LIBRARY    = define_common_library_task("test",
+	TEST_BOOST_OXT_LIBRARY = define_libboost_oxt_task("test", "test")
+	TEST_COMMON_LIBRARY    = define_common_library_task("test", "test",
 		nil, true, TEST_BOOST_OXT_LIBRARY)
 	
 	TEST_COMMON_CFLAGS = "-DTESTING_SPAWN_MANAGER -DTESTING_APPLICATION_POOL " <<
@@ -571,7 +569,9 @@ end
 		end
 	end
 	
-	task :clean do
+	task :clean => 'test:clean'
+	desc "Clean all compiled test files"
+	task 'test:clean' do
 		sh("rm -rf test/oxt/oxt_test_main test/oxt/*.o test/CxxTests test/*.o")
 	end
 
@@ -641,7 +641,7 @@ Rake::RDocTask.new(:clobber_rdoc => "rdoc:clobber", :rerdoc => "rdoc:force") do
 end
 
 
-##### Gem
+##### Packaging
 
 spec = Gem::Specification.new do |s|
 	s.platform = Gem::Platform::RUBY
@@ -735,9 +735,6 @@ Rake::Task['package:gem'].prerequisites.unshift(:doc)
 Rake::Task['package:force'].prerequisites.unshift(:doc)
 task :clobber => :'package:clean'
 
-
-##### Misc
-
 desc "Create a fakeroot, useful for building native packages"
 task :fakeroot => [:apache2, :native_support, :doc] do
 	require 'rbconfig'
@@ -834,3 +831,88 @@ task :sloccount do
 		system "rm -rf #{tmpdir}"
 	end
 end
+
+desc "Convert the NEWS items for the latest release to HTML"
+task :news_as_html do
+	# The text is in the following format:
+	#
+	#   Release x.x.x
+	#   -------------
+	#
+	#    * Text.
+	#    * More text.
+	# * A header.
+	#      With yet more text.
+	#   
+	#   Release y.y.y
+	#   -------------
+	#   .....
+	require 'cgi'
+	contents = File.read("NEWS")
+	
+	# We're only interested in the latest release, so extract the text for that.
+	contents =~ /\A(Release.*?)^(Release|Older releases)/m
+	
+	# Now split the text into individual items.
+	items = $1.split(/^ \*/)
+	items.shift  # Delete the 'Release x.x.x' header.
+	
+	puts "<dl>"
+	items.each do |item|
+		item.strip!
+		
+		# Does this item have a header? It does if it consists of multiple lines, and
+		# the next line is capitalized.
+		lines = item.split("\n")
+		if lines.size > 1 && lines[1].strip[0..0] == lines[1].strip[0..0].upcase
+			puts "<dt>#{lines[0]}</dt>"
+			lines.shift
+			item = lines.join("\n")
+			item.strip!
+		end
+		
+		# Split into paragraphs. Empty lines are paragraph dividers.
+		paragraphs = item.split(/^ *$/m)
+		
+		def format_paragraph(text)
+			# Get rid of newlines: convert them into spaces.
+			text.gsub!("\n", ' ')
+			while text.index('  ')
+				text.gsub!('  ', ' ')
+			end
+			
+			# Auto-link to issue tracker.
+			text.gsub!(/(bug|issue) #(\d+)/i) do
+				url = "http://code.google.com/p/phusion-passenger/issues/detail?id=#{$2}"
+				%Q(<{a href="#{url}"}>#{$1} ##{$2}<{/a}>)
+			end
+			
+			text.strip!
+			text = CGI.escapeHTML(text)
+			text.gsub!(%r(&lt;\{(.*?)\}&gt;(.*?)&lt;\{/(.*?)\}&gt;)) do
+				"<#{CGI.unescapeHTML $1}>#{$2}</#{CGI.unescapeHTML $3}>"
+			end
+			text
+		end
+		
+		if paragraphs.size > 1
+			STDOUT.write("<dd>")
+			paragraphs.each do |paragraph|
+				paragraph.gsub!(/\A\n+/, '')
+				paragraph.gsub!(/\n+\Z/, '')
+				
+				if (paragraph =~ /\A       /)
+					# Looks like a code block.
+					paragraph.gsub!(/^       /m, '')
+					puts "<pre lang=\"ruby\">#{CGI.escapeHTML(paragraph)}</pre>"
+				else
+					puts "<p>#{format_paragraph(paragraph)}</p>"
+				end
+			end
+			STDOUT.write("</dd>\n")
+		else
+			puts "<dd>#{format_paragraph(item)}</dd>"
+		end
+	end
+	puts "</dl>"
+end

data/bin/passenger-install-nginx-module

@@ -36,7 +36,7 @@ include PlatformInfo
 class Installer < PhusionPassenger::AbstractInstaller
 	include PhusionPassenger
 	
-	NGINX_VERSION = "0.6.37"
+	NGINX_VERSION = "0.7.61"
 	
 	def dependencies
 		result = [
@@ -77,7 +77,11 @@ class Installer < PhusionPassenger::AbstractInstaller
 				exit(1)
 			end
 			nginx_prefix = ask_for_nginx_install_prefix
-			extra_nginx_configure_flags = nil
+			if @extra_configure_flags == "none"
+				extra_nginx_configure_flags = nil
+			else
+				extra_nginx_configure_flags = @extra_configure_flags
+			end
 		else
 			nginx_source_dir = ask_for_nginx_source_dir
 			nginx_prefix = ask_for_nginx_install_prefix
@@ -392,7 +396,10 @@ private
 					f.puts("#include <pcre.h>")
 				end
 				Dir.chdir('/tmp') do
-					system("(gcc -c passenger-check.c) >/dev/null 2>/dev/null")
+					# Nginx checks for PCRE in multiple places...
+					system("(gcc -I/usr/local/include -I/usr/include/pcre " <<
+						"-I/usr/pkg/include -I/opt/local/include " <<
+						"-c passenger-check.c) >/dev/null 2>/dev/null")
 				end
 			ensure
 				File.unlink('/tmp/passenger-check.c') rescue nil

data/bin/passenger-make-enterprisey

@@ -75,7 +75,7 @@ else
 	end
 	if system("touch", enterprise_file)
 		puts "Congratulations! Your Passenger Enterprise License has been activated!"
-		puts "Please restart Apache to take full advantage of your Enterprise License."
+		puts "Please restart Apache or Nginx to take full advantage of your Enterprise License."
 	else
 		STDERR.puts "Could not write to the Passenger folder. Please run this tool as root."
 		exit 1

data/doc/Users guide Apache.html

@@ -808,6 +808,25 @@ For example:</p></div>
     DocumentRoot /webapps/mycook/public
 &lt;/VirtualHost&gt;</tt></pre>
 </div></div>
+<div class="paragraph"><p>You may also need to tweak your file/folder permissions. Make sure that the
+following folders are readable and executable by Apache:</p></div>
+<div class="ulist"><ul>
+<li>
+<p>
+this <em>public</em> folder.
+</p>
+</li>
+<li>
+<p>
+the application&#8217;s <em>config</em> folder.
+</p>
+</li>
+<li>
+<p>
+all parent folders. That is, /webapps/mycook and /webapps must also be readable and executable by Apache.
+</p>
+</li>
+</ul></div>
 <div class="paragraph"><p>Then restart Apache. The application has now been deployed.</p></div>
 <h3 id="deploying_rails_to_sub_uri">3.2. Deploying to a sub URI</h3>
 <div class="paragraph"><p>Suppose that you already have a virtual host:</p></div>
@@ -997,6 +1016,25 @@ For example:</p></div>
     DocumentRoot /webapps/rackapp/public
 &lt;/VirtualHost&gt;</tt></pre>
 </div></div>
+<div class="paragraph"><p>You may also need to tweak your file/folder permissions. Make sure that the
+following folders are readable and executable by Apache:</p></div>
+<div class="ulist"><ul>
+<li>
+<p>
+this <em>public</em> folder.
+</p>
+</li>
+<li>
+<p>
+the application&#8217;s <em>config</em> folder.
+</p>
+</li>
+<li>
+<p>
+all parent folders. That is, /webapps/rackapp and /webapps must also be readable and executable by Apache.
+</p>
+</li>
+</ul></div>
 <div class="paragraph"><p>Then restart Apache. The application has now been deployed.</p></div>
 <h3 id="deploying_rack_to_sub_uri">4.3. Deploying to a sub URI</h3>
 <div class="paragraph"><p>Suppose that you already have a virtual host:</p></div>
@@ -1328,83 +1366,7 @@ This configuration option allows one to specify which user Rails/Rack
 applications must run as, if user switching fails or is disabled.</p></div>
 <div class="paragraph"><p>This option may only occur once, in the global server configuration.
 The default value is <em>nobody</em>.</p></div>
-<h3 id="PassengerHighPerformance">5.8. PassengerHighPerformance &lt;on|off&gt;</h3>
-<div class="paragraph"><p>By default, Phusion Passenger is compatible with mod_rewrite and most other
-Apache modules. However, a lot of effort is required in order to be compatible.
-If you turn <em>PassengerHighPerformance</em> to <em>on</em>, then Phusion Passenger will be
-a little faster, in return for reduced compatibility with other Apache modules.</p></div>
-<div class="paragraph"><p>In places where <em>PassengerHighPerformance</em> is turned on, mod_rewrite rules will
-likely not work. mod_autoindex (the module which displays a directory index)
-will also not work. Other Apache modules may or may not work, depending on what
-they exactly do. We recommend you to find out how other modules behave in high
-performance mode via testing.</p></div>
-<div class="paragraph"><p>This option is <strong>not</strong> an all-or-nothing global option: you can enable high
-performance mode for certain virtual hosts or certain URLs only.
-The <em>PassengerHighPerformance</em> option may occur in the following places:</p></div>
-<div class="ulist"><ul>
-<li>
-<p>
-In the global server configuration.
-</p>
-</li>
-<li>
-<p>
-In a virtual host configuration block.
-</p>
-</li>
-<li>
-<p>
-In a <tt>&lt;Directory&gt;</tt> or <tt>&lt;Location&gt;</tt> block.
-</p>
-</li>
-<li>
-<p>
-In <em>.htaccess</em>.
-</p>
-</li>
-</ul></div>
-<div class="paragraph"><p>In each place, it may be specified at most once. The default value is <em>off</em>,
-so high performance mode is disabled by default, and you have to explicitly
-enable it.</p></div>
-<div class="paragraph"><div class="title">When to enable high performance mode?</div><p>If you do not use mod_rewrite or other Apache modules then it might make
-sense to enable high performance mode.</p></div>
-<div class="paragraph"><p>It&#8217;s likely that some of your applications depend on mod_rewrite or other
-Apache modules, while some do not. In that case you can enable high performance
-for only those applications that don&#8217;t use other Apache modules. For example:</p></div>
-<div class="listingblock">
-<div class="content">
-<pre><tt>&lt;VirtualHost *:80&gt;
-    ServerName www.foo.com
-    DocumentRoot /apps/foo/public
-    .... mod_rewrite rules or options for other Apache modules here ...
-&lt;/VirtualHost&gt;
-
-&lt;VirtualHost *:80&gt;
-    ServerName www.bar.com
-    DocumentRoot /apps/bar/public
-    PassengerHighPerformance on
-&lt;/VirtualHost&gt;</tt></pre>
-</div></div>
-<div class="paragraph"><p>In the above example, high performance mode is only enabled for www.bar.com.
-It is disabled for everything else.</p></div>
-<div class="paragraph"><p>If your application generally depends on mod_rewrite or other Apache modules,
-but a certain URL that&#8217;s accessed often doesn&#8217;t depend on those other modules,
-then you can enable high performance mode for a certain URL only. For example:</p></div>
-<div class="listingblock">
-<div class="content">
-<pre><tt>&lt;VirtualHost *:80&gt;
-    ServerName www.foo.com
-    DocumentRoot /apps/foo/public
-    .... mod_rewrite rules or options for other Apache modules here ...
-
-    &lt;Location /chatroom/ajax_update_poll&gt;
-        PassengerHighPerformance on
-    &lt;/Location&gt;
-&lt;/VirtualHost&gt;</tt></pre>
-</div></div>
-<div class="paragraph"><p>This enables high performance mode for
-<a href="http://www.foo.com/chatroom/ajax_update_poll">http://www.foo.com/chatroom/ajax_update_poll</a> only.</p></div>
-<h3 id="_passengerenabled_lt_on_off_gt">5.9. PassengerEnabled &lt;on|off&gt;</h3>
+<h3 id="_passengerenabled_lt_on_off_gt">5.8. PassengerEnabled &lt;on|off&gt;</h3>
 <div class="paragraph"><p>You can set this option to <em>off</em> to completely disable Phusion Passenger for
 a certain location. This is useful if, for example, you want to integrate a PHP
 application into the same virtual host as a Rails application.</p></div>
@@ -1448,7 +1410,7 @@ In <em>.htaccess</em>.
 </li>
 </ul></div>
 <div class="paragraph"><p>In each place, it may be specified at most once. The default value is <em>on</em>.</p></div>
-<h3 id="PassengerTempDir">5.10. PassengerTempDir &lt;directory&gt;</h3>
+<h3 id="PassengerTempDir">5.9. PassengerTempDir &lt;directory&gt;</h3>
 <div class="paragraph"><p>Specifies the directory that Phusion Passenger should use for storing temporary
 files. This includes things such as Unix socket files, buffered file uploads
 (see also <a href="#PassengerUploadBufferDir">PassengerUploadBufferDir</a>), etc.</p></div>
@@ -1471,7 +1433,7 @@ environment variable, like this:</p></div>
 sudo -E passenger-status
 # The -E option tells 'sudo' to preserve environment variables.</tt></pre>
 </div></div>
-<h3 id="PassengerUploadBufferDir">5.11. PassengerUploadBufferDir &lt;directory&gt;</h3>
+<h3 id="PassengerUploadBufferDir">5.10. PassengerUploadBufferDir &lt;directory&gt;</h3>
 <div class="paragraph"><p>Phusion Passenger buffers large file uploads to disk in order prevent slow file
 uploads from blocking web applications. By default, a subdirectory in the
 system&#8217;s temporary files directory (or a subdirectory in the directory specified
@@ -1512,7 +1474,7 @@ In <em>.htaccess</em>, if <tt>AllowOverrides Options</tt> is enabled.
 </li>
 </ul></div>
 <div class="paragraph"><p>In each place, it may be specified at most once.</p></div>
-<h3 id="_passengerrestartdir_lt_directory_gt">5.12. PassengerRestartDir &lt;directory&gt;</h3>
+<h3 id="_passengerrestartdir_lt_directory_gt">5.11. PassengerRestartDir &lt;directory&gt;</h3>
 <div class="paragraph"><p>As described in the deployment chapters of this document, Phusion Passenger
 checks the file <em>tmp/restart.txt</em> in the applications'
 <a href="#application_root">root directory</a> for restarting applications. Sometimes it
@@ -1580,8 +1542,8 @@ security flaw which allows an attacker to touch restart.txt, then that will
 allow the attacker to cause a Denial-of-Service.</p></div>
 <div class="paragraph"><p>You can prevent this from happening by pointing PassengerRestartDir to a
 directory that&#8217;s readable by Apache, but only writable by administrators.</p></div>
-<h3 id="_resource_control_and_optimization_options">5.13. Resource control and optimization options</h3>
-<h4 id="_passengermaxpoolsize_lt_integer_gt">5.13.1. PassengerMaxPoolSize &lt;integer&gt;</h4>
+<h3 id="_resource_control_and_optimization_options">5.12. Resource control and optimization options</h3>
+<h4 id="_passengermaxpoolsize_lt_integer_gt">5.12.1. PassengerMaxPoolSize &lt;integer&gt;</h4>
 <div class="paragraph"><p>The maximum number of Ruby on Rails or Rack application instances that may
 be simultaneously active. A larger number results in higher memory usage,
 but improved ability to handle concurrent HTTP clients.</p></div>
@@ -1606,7 +1568,7 @@ The default value is <em>6</em>.</p></div>
 by about 33%. And it&#8217;s not hard to install.</td>
 </tr></table>
 </div>
-<h4 id="_passengermaxinstancesperapp_lt_integer_gt">5.13.2. PassengerMaxInstancesPerApp &lt;integer&gt;</h4>
+<h4 id="_passengermaxinstancesperapp_lt_integer_gt">5.12.2. PassengerMaxInstancesPerApp &lt;integer&gt;</h4>
 <div class="paragraph"><p>The maximum number of application instances that may be simultaneously active
 for a single application. This helps to make sure that a single application
 will not occupy all available slots in the application pool.</p></div>
@@ -1616,7 +1578,7 @@ may use, i.e. only the global limit of <a href="#PassengerMaxPoolSize">Passenger
 will be enforced.</p></div>
 <div class="paragraph"><p>This option may only occur once, in the global server configuration.
 The default value is <em>0</em>.</p></div>
-<h4 id="PassengerPoolIdleTime">5.13.3. PassengerPoolIdleTime &lt;integer&gt;</h4>
+<h4 id="PassengerPoolIdleTime">5.12.3. PassengerPoolIdleTime &lt;integer&gt;</h4>
 <div class="paragraph"><p>The maximum number of seconds that an application instance may be idle. That is,
 if an application instance hasn&#8217;t received any traffic after the given number of
 seconds, then it will be shutdown in order to conserve memory.</p></div>
@@ -1636,7 +1598,7 @@ recommended if you&#8217;re on a non-shared host that&#8217;s only running a few
 applications, each which must be available at all times.</p></div>
 <div class="paragraph"><p>This option may only occur once, in the global server configuration.
 The default value is <em>300</em>.</p></div>
-<h4 id="PassengerMaxRequests">5.13.4. PassengerMaxRequests &lt;integer&gt;</h4>
+<h4 id="PassengerMaxRequests">5.12.4. PassengerMaxRequests &lt;integer&gt;</h4>
 <div class="paragraph"><p>The maximum number of requests an application instance will process. After
 serving that many requests, the application instance will be shut down and
 Phusion Passenger will restart it. A value of 0 means that there is no maximum:
@@ -1682,7 +1644,7 @@ measure to avoid memory leaks.</p></div>
 </td>
 </tr></table>
 </div>
-<h4 id="_passengerstatthrottlerate_lt_integer_gt">5.13.5. PassengerStatThrottleRate &lt;integer&gt;</h4>
+<h4 id="_passengerstatthrottlerate_lt_integer_gt">5.12.5. PassengerStatThrottleRate &lt;integer&gt;</h4>
 <div class="paragraph"><p>By default, Phusion Passenger performs several filesystem checks (or, in
 programmers jargon, <em>stat() calls</em>) each time a request is processed:</p></div>
 <div class="ulist"><ul>
@@ -1732,6 +1694,175 @@ In <em>.htaccess</em>, if <tt>AllowOverride Limits</tt> is on.
 </li>
 </ul></div>
 <div class="paragraph"><p>In each place, it may be specified at most once. The default value is <em>0</em>.</p></div>
+<h4 id="PassengerHighPerformance">5.12.6. PassengerHighPerformance &lt;on|off&gt;</h4>
+<div class="paragraph"><p>By default, Phusion Passenger is compatible with mod_rewrite and most other
+Apache modules. However, a lot of effort is required in order to be compatible.
+If you turn <em>PassengerHighPerformance</em> to <em>on</em>, then Phusion Passenger will be
+a little faster, in return for reduced compatibility with other Apache modules.</p></div>
+<div class="paragraph"><p>In places where <em>PassengerHighPerformance</em> is turned on, mod_rewrite rules will
+likely not work. mod_autoindex (the module which displays a directory index)
+will also not work. Other Apache modules may or may not work, depending on what
+they exactly do. We recommend you to find out how other modules behave in high
+performance mode via testing.</p></div>
+<div class="paragraph"><p>This option is <strong>not</strong> an all-or-nothing global option: you can enable high
+performance mode for certain virtual hosts or certain URLs only.
+The <em>PassengerHighPerformance</em> option may occur in the following places:</p></div>
+<div class="ulist"><ul>
+<li>
+<p>
+In the global server configuration.
+</p>
+</li>
+<li>
+<p>
+In a virtual host configuration block.
+</p>
+</li>
+<li>
+<p>
+In a <tt>&lt;Directory&gt;</tt> or <tt>&lt;Location&gt;</tt> block.
+</p>
+</li>
+<li>
+<p>
+In <em>.htaccess</em>.
+</p>
+</li>
+</ul></div>
+<div class="paragraph"><p>In each place, it may be specified at most once. The default value is <em>off</em>,
+so high performance mode is disabled by default, and you have to explicitly
+enable it.</p></div>
+<div class="paragraph"><div class="title">When to enable high performance mode?</div><p>If you do not use mod_rewrite or other Apache modules then it might make
+sense to enable high performance mode.</p></div>
+<div class="paragraph"><p>It&#8217;s likely that some of your applications depend on mod_rewrite or other
+Apache modules, while some do not. In that case you can enable high performance
+for only those applications that don&#8217;t use other Apache modules. For example:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>&lt;VirtualHost *:80&gt;
+    ServerName www.foo.com
+    DocumentRoot /apps/foo/public
+    .... mod_rewrite rules or options for other Apache modules here ...
+&lt;/VirtualHost&gt;
+
+&lt;VirtualHost *:80&gt;
+    ServerName www.bar.com
+    DocumentRoot /apps/bar/public
+    PassengerHighPerformance on
+&lt;/VirtualHost&gt;</tt></pre>
+</div></div>
+<div class="paragraph"><p>In the above example, high performance mode is only enabled for www.bar.com.
+It is disabled for everything else.</p></div>
+<div class="paragraph"><p>If your application generally depends on mod_rewrite or other Apache modules,
+but a certain URL that&#8217;s accessed often doesn&#8217;t depend on those other modules,
+then you can enable high performance mode for a certain URL only. For example:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>&lt;VirtualHost *:80&gt;
+    ServerName www.foo.com
+    DocumentRoot /apps/foo/public
+    .... mod_rewrite rules or options for other Apache modules here ...
+
+    &lt;Location /chatroom/ajax_update_poll&gt;
+        PassengerHighPerformance on
+    &lt;/Location&gt;
+&lt;/VirtualHost&gt;</tt></pre>
+</div></div>
+<div class="paragraph"><p>This enables high performance mode for
+<a href="http://www.foo.com/chatroom/ajax_update_poll">http://www.foo.com/chatroom/ajax_update_poll</a> only.</p></div>
+<h3 id="_compatibility_options">5.13. Compatibility options</h3>
+<h4 id="PassengerResolveSymlinksInDocumentRoot">5.13.1. PassengerResolveSymlinksInDocumentRoot &lt;on|off&gt;</h4>
+<div class="paragraph"><p>Configures whether Phusion Passenger should resolve symlinks in the document root.
+Please refer to <a href="#application_detection">How Phusion Passenger detects whether a virtual host is a web application</a> for more information.</p></div>
+<div class="paragraph"><p>This option may occur in the following places:</p></div>
+<div class="ulist"><ul>
+<li>
+<p>
+In the global server configuration.
+</p>
+</li>
+<li>
+<p>
+In a virtual host configuration block.
+</p>
+</li>
+<li>
+<p>
+In a <tt>&lt;Directory&gt;</tt> or <tt>&lt;Location&gt;</tt> block.
+</p>
+</li>
+<li>
+<p>
+In <em>.htaccess</em>, if <tt>AllowOverride Options</tt> is on.
+</p>
+</li>
+</ul></div>
+<div class="paragraph"><p>In each place, it may be specified at most once. It is off by default.</p></div>
+<h4 id="_passengerallowencodedslashes_lt_on_off_gt">5.13.2. PassengerAllowEncodedSlashes &lt;on|off&gt;</h4>
+<div class="paragraph"><p>By default, Apache doesn&#8217;t support URLs with encoded slashes (%2f), e.g. URLs like
+this: <tt>/users/fujikura%2fyuu</tt>. If you access such an URL then Apache will return a
+404 Not Found error. This can be solved by turning on PassengerAllowEncodedSlashes
+as well as Apache&#8217;s
+<a href="http://httpd.apache.org/docs/2.0/mod/core.html#allowencodedslashes">AllowEncodedSlashes</a>.</p></div>
+<div class="paragraph"><p>Is it important that you turn on both AllowEncodedSlashes <strong>and</strong> PassengerAllowEncodedSlashes,
+otherwise this feature will not work properly.</p></div>
+<div class="paragraph"><p>PassengerAllowEncodedSlashes may occur in the following places:</p></div>
+<div class="ulist"><ul>
+<li>
+<p>
+In the global server configuration.
+</p>
+</li>
+<li>
+<p>
+In a virtual host configuration block.
+</p>
+</li>
+<li>
+<p>
+In a <tt>&lt;Directory&gt;</tt> or <tt>&lt;Location&gt;</tt> block.
+</p>
+</li>
+<li>
+<p>
+In <em>.htaccess</em>, if <tt>AllowOverride Options</tt> is on.
+</p>
+</li>
+</ul></div>
+<div class="paragraph"><p>In each place, it may be specified at most once. It is off by default.</p></div>
+<div class="paragraph"><p>Please note however that turning on support for encoded slashes will break support for
+mod_rewrite passthrough rules. Because of bugs/limitations in Apache, Phusion Passenger
+can support either encoded slashes or mod_rewrite passthrough rules, but not both at the
+same time. Luckily this option can be specified anywhere, so you can enable it only for
+virtual hosts or URLs that need it:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>&lt;VirtualHost *:80&gt;
+    ServerName www.example.com
+    DocumentRoot /webapps/example/public
+    AllowEncodedSlashes on
+    RewriteEngine on
+
+    # Check for maintenance file and redirect all requests
+    RewriteCond %{DOCUMENT_ROOT}/system/maintenance.html -f
+    RewriteCond %{SCRIPT_FILENAME} !maintenance.html
+    RewriteRule ^.*$ /system/maintenance.html [L]
+
+    # Make /about an alias for /info/about.
+    RewriteRule ^/about$ /info/about [PT,L]
+
+    &lt;Location ~ "^/users/"&gt;
+        # In a location block so that it doesn't interfere with the
+        # above /about mod_rewrite rule.
+        PassengerAllowEncodedSlashes on
+    &lt;/Location&gt;
+&lt;/VirtualHost&gt;</tt></pre>
+</div></div>
+<div class="paragraph"><p>With this, <a href="http://www.example.com/users/fujikura%2fyuu">http://www.example.com/users/fujikura%2fyuu</a> will work properly, and
+accessing <a href="http://www.example.com/about">http://www.example.com/about</a> will properly display the result of
+<a href="http://www.example.com/info/about">http://www.example.com/info/about</a>. Notice that PassengerAllowEncodedSlashes only
+interferes with passthrough rules, not with any other mod_rewrite rules. The rules for
+displaying maintenance.html will work fine even URLs starting with "/users".</p></div>
 <h3 id="_ruby_on_rails_specific_options">5.14. Ruby on Rails-specific options</h3>
 <h4 id="_railsautodetect_lt_on_off_gt">5.14.1. RailsAutoDetect &lt;on|off&gt;</h4>
 <div class="paragraph"><p>Whether Phusion Passenger should automatically detect whether a virtual host&#8217;s
@@ -2926,7 +3057,7 @@ If <em>foo/bar.html</em> doesn&#8217;t exist either, then Phusion Passenger will
 application uses a non-standard page cache directory, i.e. if it doesn&#8217;t cache to
 the <em>public</em> directory. In that case you&#8217;ll need to use mod_rewrite to serve such
 page cache files.</p></div>
-<h3 id="_how_phusion_passenger_detects_whether_a_virtual_host_is_a_web_application">9.3. How Phusion Passenger detects whether a virtual host is a web application</h3>
+<h3 id="application_detection">9.3. How Phusion Passenger detects whether a virtual host is a web application</h3>
 <div class="paragraph"><p>After you&#8217;ve read the deployment instructions you might wonder how Phusion Passenger
 knows that the DocumentRoot points to a web application that Phusion Passenger is
 able to serve, and how it knows what kind of web application it is (e.g. Rails or Rack).</p></div>
@@ -2953,8 +3084,9 @@ Append the text "/config/environment.rb" to the result, and check whether the re
 </ol></div>
 <div class="paragraph"><p>So suppose that your document root is <em>/webapps/foo/public</em>. Phusion Passenger will check
 whether the file <em>/webapps/foo/config/environment.rb</em> exists.</p></div>
-<div class="paragraph"><p>Note that Phusion Passenger does <strong>not</strong> resolve any symlinks in the document root path since
-version 2.2.0&#8201;&#8212;&#8201;in contrast to versions earlier than 2.2.0, which does resolve symlinks.
+<div class="paragraph"><p>Note that Phusion Passenger does <strong>not</strong> resolve any symlinks in the document root path by
+default since version 2.2.0&#8201;&#8212;&#8201;in contrast to versions earlier than 2.2.0, which do resolve
+symlinks.
 So for example, suppose that your DocumentRoot points to <em>/home/www/example.com</em>, which in
 turn is a symlink to <em>/webapps/example.com/public</em>. In versions earlier than 2.2.0, Phusion
 Passenger will check whether <em>/webapps/example.com/config/environment.rb</em> exists because it
@@ -2962,8 +3094,11 @@ resolves all symlinks. Phusion Passenger 2.2.0 and later however will check for
 <em>/home/www/config/environment.rb</em>. This file of course doesn&#8217;t exist, and as a result Phusion
 Passenger will not activate itself for this virtual host, and you&#8217;ll most likely see an Apache
 mod_dirindex directory listing.</p></div>
-<div class="paragraph"><p>If you&#8217;re running into this problem, you can explicitly tell Phusion Passenger what the
-correct application root is through the <a href="#PassengerAppRoot">PassengerAppRoot</a> configuration directive.</p></div>
+<div class="paragraph"><p>If you need the old symlink-resolving behavior for whatever reason, then you can turn on
+<a href="#PassengerResolveSymlinksInDocumentRoot">PassengerResolveSymlinksInDocumentRoot</a>.</p></div>
+<div class="paragraph"><p>Another way to solve this situation is to explicitly tell Phusion Passenger what the
+correct application root is through the <a href="#PassengerAppRoot">PassengerAppRoot</a> configuration
+directive.</p></div>
 <div class="paragraph"><p>Autodetection of Rack applications happens through the same mechanism, exception that
 Phusion Passenger will look for <em>config.ru</em> instead of <em>config/environment.rb</em>.</p></div>
 </div>
@@ -3347,7 +3482,7 @@ has no effect.</p></div>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2009-06-16 23:49:41 CEST
+Last updated 2009-08-31 15:39:27 CEST
 </div>
 </div>
 </body>