passenger 4.0.20 → 4.0.21

data/doc/users_guide_snippets/installation/run_installer.txt

@@ -0,0 +1,58 @@
+ifdef::apache[]
+The Phusion Passenger gem only contains source files. In this step we will use the installer to compile the Phusion Passenger binaries, which include the various Phusion Passenger agent executables and the Apache module.
+
+Run the following command and follow the on-screen instructions.
+
+ifdef::gem[]
+----------------------------------
+passenger-install-apache2-module
+----------------------------------
+endif::[]
+ifdef::tarball[]
+----------------------------------
+./bin/passenger-install-apache2-module
+----------------------------------
+endif::[]
+
+At the end of the installation process, you will be asked to copy and paste a configuration snippet (containing `LoadModule`, `PassengerRoot`, etc.) into your Apache configuration file. If you're upgrading, then you already had a similar configuration snippet. Be sure to remove the old one before pasting the new one.
+
+Different operating systems and Apache installations have different conventions with regard to where the Apache configuration file is and how it is organized. Please read <<working_with_apache_conf,Working with the Apache configuration file>> if you're not familiar with it. That section is especially of interest for OS X Server >= 10.8 users because the configuration file may not be at a surprising location.
+
+If compilation doesn't succeed, then please consult the <<troubleshooting,Troubleshooting>> section.
+
+.What does the installer do?
+
+Despite the name, this "installer" doesn't actually install anything. The installer checks whether all required dependencies are installed, invokes the compiler, and tells you how to modify the Apache
+configuration file. However, it doesn't copy any files to outside the Phusion Passenger source directory.
+
+`passenger-install-apache2-module` is actually just a user-friendly frontend around the command `rake apache2`, which performs the actual compilation of Phusion Passenger.
+endif::[]
+ifdef::nginx[]
+Nginx is a different from other web servers in that it does not support loadable modules. The only way to extend Nginx is to recompile it entirely from source. Since Phusion Passenger consists of some external executables plus an Nginx module, you must recompile Nginx when first installing Phusion Passenger, but also when upgrading Nginx itself or when upgrading the Phusion Passenger version.
+
+Recompiling Nginx and the Phusion Passenger executables is what we will do in this step. The good news is that Phusion Passenger provides a tool to make this easy for you.
+
+If you've already installed Nginx before, but without Phusion Passenger support, then you *should* uninstall it first. You don't have to, because you can also install another Nginx with Phusion Passenger support, in parallel to the existing Nginx. We merely recommend uninstalling the existing in order to avoid user confusion, but the choice is yours.
+
+If you had previously installed Nginx with Phusion Passenger support, and you are upgrading, then you don't have to uninstall your existing Nginx first. Instead we'll overwrite it this step. But it is important that you recompile Nginx with the configure parameters that you used last time.
+
+Here's how you can uninstall the original Nginx:
+
+- If you installed the existing Nginx through APT, run: `sudo apt-get remove nginx nginx-full nginx-light nginx-naxsi nginx-common`
+- If you installed the existing Nginx through YUM, run `yum remove nginx` as root.
+
+To proceed with installing or upgrading Phusion Passenger, run the Phusion Passenger Nginx installer and follow the on-screen instructions:
+
+ifdef::gem[]
+----------------------------------
+passenger-install-nginx-module
+----------------------------------
+endif::[]
+ifdef::tarball[]
+----------------------------------
+./bin/passenger-install-nginx-module
+----------------------------------
+endif::[]
+
+At some point it will ask you which prefix to install Nginx to. If you're upgrading, then specify the same prefix that you used last time, as well as the same configuration parameters that you used last time.
+endif::[]

data/doc/users_guide_snippets/installation/verify_running_epilogue.txt

@@ -0,0 +1,6 @@
+You should see the web server processes as well as a number of Phusion Passenger processes (e.g. PassengerWatchdog, PassengerHelperAgent). Congratulations, Phusion Passenger is now installed and running!
+ifdef::nginx[]
+At this point you may be interested in <<nginx_init_script,creating an Nginx init script>>.
+endif::[]
+
+If the output is not as expected, then please refer to the <<troubleshooting,Troubleshooting>> section.

data/doc/users_guide_snippets/support_information.txt

@@ -14,14 +14,7 @@ or
 link:http://groups.google.com/group/phusion-passenger[join our discussion forum]
 if it doesn't work on your POSIX-compliant operating system.
 
+[[where_to_get_support]]
 === Where to get support ===
 
-* link:http://groups.google.com/group/phusion-passenger[Discussion forum] - post a
-  message here if you're experiencing problems. Support on this forum is provided by the community on a best-effort basis, so a (timely) response is not guaranteed.
-* link:http://code.google.com/p/phusion-passenger/issues/list[Issue tracker] - report
-  bugs here.
-* Email support@phusion.nl if you are a link:https://www.phusionpassenger.com/enterprise[Phusion Passenger Enterprise] customer. Please mention your order reference. If you are not an Enterprise customer, we kindly redirect you to the community discussion forum instead.
-* link:https://www.phusionpassenger.com/commercial_support[Commercial support contracts] are also available.
-* Report security vulnerabilities to security@phusion.nl. We will do our best to respond to you as quickly as we can, so please do not disclose the vulnerability until then.
-
-Please consult link:https://www.phusionpassenger.com/support[the Phusion Passenger website] for a full list of support resources.
+include::where_to_get_support.txt[]

data/doc/users_guide_snippets/troubleshooting/default.txt

@@ -0,0 +1,112 @@
+=== Generic troubleshooting tips
+
+One of the first things you should do upon encountering a problem, is to check
+ifdef::apache[]
+the *global* (not the per-vhost) Apache error log file. This is typically located in /var/log/apache2/error_log. You can find out the exact location of the error log by running `passenger-config --detect-apache2`.
+endif::[]
+ifdef::nginx[]
+the global Nginx error log file. This is one specified by the `error_log` directive in the main context (*not* the one inside the `http` context). The file is typically located in /var/log/nginx/error.log.
+endif::[]
+ifdef::standalone[]
+Phusion Passenger Standalone log file. This is typically located in `log/passenger.[PORT NUMBER].log`.
+endif::[]
+Most problems are logged to this file.
+
+ifndef::standalone[]
+If you're using Ruby on Rails, then you should be aware that Phusion Passenger runs your app under the 'production' environment by default, not 'development'. You can change this using the
+ifdef::apache[]
+<<RailsEnv,RailsEnv>>
+endif::[]
+ifdef::nginx[]
+<<RailsEnv,rails_env>>
+endif::[]
+option.
+endif::[]
+
+If neither the logs nor this troubleshooting guide can help you, then please check out our <<where_to_get_support,support resources>>.
+
+
+ifndef::standalone[]
+=== Why does the first request take a long time?
+
+**Symptoms**::
+	The first request to your application takes more time than usual. Subsequent requests have the normal speed.
+
+**Cause**::
+	Phusion Passenger starts your application the first time it is accessed, not during web server startup. Some applications can take several seconds to start. If you're using Ruby on Rails, then needing 10 seconds to start your application is normal. On slow or heavily loaded servers, or in case of large and heavy applications, the startup time may be even longer.
+
+**Solution**::
+	Use the
+ifdef::nginx[]
+<<PassengerPreStart,passenger_pre_start>>
+endif::[]
+ifdef::apache[]
+<<PassengerPreStart,PassengerPreStart>>
+endif::[]
+configuration option.
+endif::[]
+
+
+ifdef::nginx[]
+=== Upon accessing the web app, Nginx reports a "Permission denied" error
+
+**Symptoms**::
+	A typical error message looks like this:
++
+---------------------------------------------
+2013/10/21 17:16:03 [alert] 98687#0: *1 Cannot stat
+'/Users/phusion/Sites/rack.test/config.ru': Permission denied (errno=13); This
+error means that the Nginx worker process (PID 99064, running as UID 70) does
+not have permission to access this file. Please read the manual to learn how to
+fix this problem: section 'Troubleshooting' -> 'Upon accessing the web app,
+Nginx reports a "Permission denied" error'; Extra info, client: 127.0.0.1,
+server: www.foo.com, request: "GET / HTTP/1.1", host: "www.foo.com"
+---------------------------------------------
+
+**Cause**::
+	Phusion Passenger tries to access your application directory in order to find out what language it's written in. This access is initiated from inside an Nginx worker process. This error indicates that the Nginx worker process does not have the proper permissions to access your application's root directory.
+
+**Solution**::
+	You need to relax permissions to that the Nginx worker process can access your application directory, by making the directory group- and world-*executable*:
++
+---------------------------------------------------
+sudo chmod g+x,o+x /Users/phusion/Sites/rack.test
+---------------------------------------------------
++
+You *also* need to ensure that all parent directories are also 'executable' by the Nginx process:
++
+---------------------------------------------------
+sudo chmod g+x,o+x /Users/phusion/Sites
+sudo chmod g+x,o+x /Users/phusion
+sudo chmod g+x,o+x /Users
+---------------------------------------------------
++
+.Why 'executable' permission and not 'readable'?
+[NOTE]
+On Unix, the 'executable' permission on directories dictates whether a process is allowed to *access* files or subdirectories within that directory. The 'readable' permission dictates whether a process is allowed to see what files are inside the directory, but does not necessarily allow access to them. You can learn more at link:http://en.wikipedia.org/wiki/File_system_permissions#Permissions[Wikipedia].
+endif::[]
+
+
+ifdef::standalone[]
+=== Upon uploading a file, Phusion Passenger reports "client_body_temp/00000000xx failed (2: No such file or directory)"
+
+**Symptoms**::
+	When performing an HTTP POST call, the request sometimes fails, with Phusion Passenger reporting an error along the lines of:
++
+-------------------------
+/tmp/passenger-standalone.8583/client_body_temp/0000000022" failed (2: No such
+file or directory), client: 127.0.0.1, server: www.foo.com
+-------------------------
+
+**Cause**::
+	Phusion Passenger buffers HTTP POST bodies (file uploads) to a temporary directory, by default `/tmp/passenger-standalone.xxx`. This error means that Phusion Passenger that that directory has been removed, probably by some other program.
+
+**Solution**::
+	Tell Phusion Passenger to use a different directory to store its temporary files passing the `--temp-dir` command line option. For example:
++
+---------------------------------------
+mkdir $HOME/tmp
+cd /path-to-your-app
+passenger start --temp-dir=$HOME/tmp
+---------------------------------------
+endif::[]

data/doc/users_guide_snippets/troubleshooting/rails.txt

@@ -0,0 +1,56 @@
+=== Ruby on Rails-specific troubleshooting
+
+==== The "About your application's environment" link does not work
+
+The "About your application's environment" link only works if the application is started in the 'development' environment. Phusion Passenger starts the application in the 'production' environment by default. Please use
+ifdef::apache[]
+<<RailsEnv,RailsEnv>>
+endif::[]
+ifdef::nginx[]
+<<RailsEnv,rails_env>>
+endif::[]
+to change it.
+
+
+==== The Rails application reports that it's unable to start because of a permission error
+
+Please check whether your Rails application's folder has the correct
+permissions. By default, Rails applications are started as the owner of the
+file `config.ru`, except if the file is owned by root. If the
+file is owned by root, then the Rails application will be started as 'nobody'
+(or as the user specify by <<RailsDefaultUser,RailsDefaultUser>>, if that's
+specified).
+
+Please read <<user_switching,User switching (security)>> for details.
+
+
+==== The Rails application's log file is not being written to
+
+There are a couple things that you should be aware of:
+
+- By default, Phusion Passenger runs Rails applications in 'production' mode,
+  so please be sure to check `production.log` instead of `development.log`.
++
+See
+ifdef::apache[]
+<<RailsEnv,RailsEnv>>
+endif::[]
+ifdef::nginx[]
+<<RailsEnv,rails_env>>
+endif::[]
+for configuration.
+- By default, Phusion Passenger runs Rails applications as the owner of `config.ru`.
+  So the log file can only be written to if that user has write permission to the
+  log file. Please `chmod` or `chown` your log file accordingly.
++
+See <<User_switching,User switching (security)>> for details.
+
+If you're using a RedHat-derived Linux distribution (such as Fedora or CentOS)
+then it is link:http://code.google.com/p/phusion-passenger/issues/detail?id=4[possible
+that SELinux is interfering]. RedHat's SELinux policy only allows Apache to read/write
+directories that have the 'httpd_sys_content_t' security context. Please run the
+following command to give your Rails application folder that context:
+
+-----------------------------------------------------------
+chcon -R -h -t httpd_sys_content_t /path/to/your/rails/app
+-----------------------------------------------------------

data/doc/users_guide_snippets/where_to_get_support.txt

@@ -0,0 +1,9 @@
+* link:http://groups.google.com/group/phusion-passenger[Community discussion forum] - post a
+  message here if you're experiencing problems. Support on this forum is provided by the community on a best-effort basis, so a (timely) response is not guaranteed.
+* link:http://code.google.com/p/phusion-passenger/issues/list[Issue tracker] - report
+  bugs here.
+* Email support@phusion.nl if you are a link:https://www.phusionpassenger.com/enterprise[Phusion Passenger Enterprise] customer. Please mention your order reference. If you are not an Enterprise customer, we kindly redirect you to the community discussion forum instead.
+* link:https://www.phusionpassenger.com/commercial_support[Commercial support contracts] are also available.
+* Report security vulnerabilities to security@phusion.nl. We will do our best to respond to you as quickly as we can, so please do not disclose the vulnerability until then.
+
+Please consult link:https://www.phusionpassenger.com/support[the Phusion Passenger website] for a full list of support resources.

data/ext/apache2/Bucket.h

@@ -62,7 +62,7 @@ struct PassengerBucketState {
 	}
 };
 
-typedef shared_ptr<PassengerBucketState> PassengerBucketStatePtr;
+typedef boost::shared_ptr<PassengerBucketState> PassengerBucketStatePtr;
 
 /**
  * We used to use an apr_bucket_pipe for forwarding the backend process's

data/ext/apache2/Configuration.hpp

@@ -158,22 +158,6 @@ struct DirConfig {
 		return enabled != DISABLED;
 	}
 	
-	StaticString getUser() const {
-		if (user != NULL) {
-			return user;
-		} else {
-			return "";
-		}
-	}
-	
-	StaticString getGroup() const {
-		if (group != NULL) {
-			return group;
-		} else {
-			return "";
-		}
-	}
-	
 	StaticString getEnvironment() const {
 		if (environment != NULL) {
 			return environment;
@@ -201,34 +185,6 @@ struct DirConfig {
 		}
 	}
 
-	bool getLoadShellEnvvars() const {
-		return loadShellEnvvars != DISABLED;
-	}
-	
-	unsigned long getMinInstances() const {
-		if (minInstances != UNSET_INT_VALUE) {
-			return minInstances;
-		} else {
-			return 1;
-		}
-	}
-
-	unsigned long getMaxRequests() const {
-		if (maxRequests != UNSET_INT_VALUE) {
-			return maxRequests;
-		} else {
-			return 0;
-		}
-	}
-
-	unsigned long getStartTimeout() const {
-		if (startTimeout != UNSET_INT_VALUE) {
-			return startTimeout;
-		} else {
-			return DEFAULT_START_TIMEOUT / 1000;
-		}
-	}
-	
 	bool highPerformanceMode() const {
 		return highPerformance == ENABLED;
 	}

data/ext/apache2/CreateDirConfig.cpp

@@ -48,4 +48,4 @@
 				config->enabled = DirConfig::UNSET;
 				config->maxRequestQueueSize = UNSET_INT_VALUE;
 				config->loadShellEnvvars = DirConfig::UNSET;
-	
+	

data/ext/apache2/CreateDirConfig.cpp.erb

@@ -68,4 +68,4 @@ end
 	<% else
 		raise "Unknown option type #{option[:type].inspect} for option #{option[:name]}"
 	end -%>
-<% end %>
+<% end %>

data/ext/apache2/Hooks.cpp

@@ -542,7 +542,7 @@ private:
 			this_thread::disable_syscall_interruption dsi;
 			bool expectingUploadData;
 			string uploadDataMemory;
-			shared_ptr<BufferedUpload> uploadDataFile;
+			boost::shared_ptr<BufferedUpload> uploadDataFile;
 			const char *contentLength;
 			
 			expectingUploadData = ap_should_client_block(r);
@@ -641,7 +641,7 @@ private:
 			/* Setup the bucket brigade. */
 			bb = apr_brigade_create(r->connection->pool, r->connection->bucket_alloc);
 			
-			bucketState = make_shared<PassengerBucketState>(conn);
+			bucketState = boost::make_shared<PassengerBucketState>(conn);
 			b = passenger_bucket_create(bucketState, r->connection->bucket_alloc, config->getBufferResponse());
 			APR_BRIGADE_INSERT_TAIL(bb, b);
 			
@@ -884,6 +884,26 @@ private:
 			headers.append(1, '\0');
 		}
 	}
+
+	void addHeader(request_rec *r, string &headers, const char *name, int value) {
+		if (value != UNSET_INT_VALUE) {
+			headers.append(name);
+			headers.append(1, '\0');
+			headers.append(apr_psprintf(r->pool, "%d", value));
+			headers.append(1, '\0');
+		}
+	}
+
+	void addHeader(request_rec *r, string &headers, const char *name, DirConfig::Threeway value) {
+		if (value != DirConfig::UNSET) {
+			headers.append(name);
+			if (value == DirConfig::ENABLED) {
+				headers.append("\0true\0", 6);
+			} else {
+				headers.append("\0false\0", 7);
+			}
+		}
+	}
 	
 	unsigned int constructHeaders(request_rec *r, DirConfig *config,
 		vector<StaticString> &requestData, DirectoryMapper &mapper,
@@ -898,7 +918,7 @@ private:
 		 */
 		size_t uriLen = strlen(r->uri);
 		unsigned int escaped = escapeUri(NULL, (const unsigned char *) r->uri, uriLen);
-		char escapedUri[uriLen + 2 * escaped + 1];
+		char *escapedUri = (char *) apr_palloc(r->pool, uriLen + 2 * escaped + 1);
 		escapeUri((unsigned char *) escapedUri, (const unsigned char *) r->uri, uriLen);
 		escapedUri[uriLen + 2 * escaped] = '\0';
 		
@@ -984,29 +1004,16 @@ private:
 		addHeader(output, "PASSENGER_STATUS_LINE", "false");
 		addHeader(output, "PASSENGER_APP_ROOT", mapper.getAppRoot());
 		addHeader(output, "PASSENGER_APP_GROUP_NAME", config->getAppGroupName(mapper.getAppRoot()));
-		addHeader(output, "PASSENGER_RUBY", config->ruby ? config->ruby : serverConfig.defaultRuby);
+		#include "SetHeaders.cpp"
 		addHeader(output, "PASSENGER_PYTHON", config->python);
 		addHeader(output, "PASSENGER_ENV", config->getEnvironment());
 		addHeader(output, "PASSENGER_SPAWN_METHOD", config->getSpawnMethodString());
-		addHeader(output, "PASSENGER_USER", config->getUser());
-		addHeader(output, "PASSENGER_GROUP", config->getGroup());
-		if (config->maxRequestQueueSize != UNSET_INT_VALUE) {
-			addHeader(output, "PASSENGER_MAX_REQUEST_QUEUE_SIZE",
-				apr_psprintf(r->pool, "%d", config->maxRequestQueueSize));
-		}
+		addHeader(r, output, "PASSENGER_MAX_REQUEST_QUEUE_SIZE", config->maxRequestQueueSize);
 		addHeader(output, "PASSENGER_APP_TYPE", mapper.getApplicationTypeName());
-		addHeader(output, "PASSENGER_MIN_INSTANCES",
-			apr_psprintf(r->pool, "%ld", config->getMinInstances()));
 		addHeader(output, "PASSENGER_MAX_PRELOADER_IDLE_TIME",
 			apr_psprintf(r->pool, "%ld", config->maxPreloaderIdleTime));
-		addHeader(output, "PASSENGER_LOAD_SHELL_ENVVARS",
-			config->getLoadShellEnvvars() ? "true" : "false");
 		addHeader(output, "PASSENGER_DEBUGGER", "false");
 		addHeader(output, "PASSENGER_SHOW_VERSION_IN_HEADER", "true");
-		addHeader(output, "PASSENGER_MAX_REQUESTS",
-			apr_psprintf(r->pool, "%ld", config->getMaxRequests()));
-		addHeader(output, "PASSENGER_START_TIMEOUT",
-			apr_psprintf(r->pool, "%ld", config->getStartTimeout()));
 		addHeader(output, "PASSENGER_STAT_THROTTLE_RATE",
 			apr_psprintf(r->pool, "%ld", config->getStatThrottleRate()));
 		addHeader(output, "PASSENGER_RESTART_DIR", config->getRestartDir());
@@ -1200,10 +1207,10 @@ private:
 	 * @throws SystemException
 	 * @throws IOException
 	 */
-	shared_ptr<BufferedUpload> receiveRequestBody(request_rec *r) {
+	boost::shared_ptr<BufferedUpload> receiveRequestBody(request_rec *r) {
 		TRACE_POINT();
 		DirConfig *config = getDirConfig(r);
-		shared_ptr<BufferedUpload> tempFile;
+		boost::shared_ptr<BufferedUpload> tempFile;
 		try {
 			ServerInstanceDir::GenerationPtr generation = agentsStarter.getGeneration();
 			string uploadBufferDir = config->getUploadBufferDir(generation);
@@ -1259,7 +1266,7 @@ private:
 		}
 	}
 	
-	void sendRequestBody(const FileDescriptor &fd, shared_ptr<BufferedUpload> &uploadData) {
+	void sendRequestBody(const FileDescriptor &fd, boost::shared_ptr<BufferedUpload> &uploadData) {
 		TRACE_POINT();
 		rewind(uploadData->handle);
 		while (!feof(uploadData->handle)) {