passenger 5.0.14 → 5.0.15

data/doc/users_guide_snippets/troubleshooting/default.txt

@@ -1,162 +1,48 @@
 === 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`.
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/apache/troubleshooting/
 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::[]
-ifndef::standalone[]
-This log file contains:
-
- * Phusion Passenger error messages.
- * Everything that the application writes to STDERR. This typically consists of errors that the application encounters during startup, but not errors that it encounters when it's handling requests.
-
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/nginx/troubleshooting/
 endif::[]
 ifdef::standalone[]
-Phusion Passenger Standalone log file. This is typically located in `log/passenger.[PORT NUMBER].log`. Most problems are logged to this log file.
-endif::[]
-
-ifndef::standalone[]
-If you're using Ruby on Rails, then you should also check out `log/development.log` and `log/production.log`. When an error occurs during request handling, it is typically logged here. This file does **not** contain errors that Rails encounters during startup.
-
-Finally, you should be aware that Phusion Passenger runs your application 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.
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/standalone/troubleshooting/
 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>>
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/nginx/troubleshooting/?a=why-does-the-first-request-take-a-long-time
 endif::[]
 ifdef::apache[]
-<<PassengerPreStart,PassengerPreStart>>
-endif::[]
-configuration option.
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/apache/troubleshooting/?a=why-does-the-first-request-take-a-long-time
 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].
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/nginx/troubleshooting/?a=upon-accessing-the-web-app-nginx-reports-a-permission-denied-error
 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
----------------------------------------
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/standalone/troubleshooting/?a=upon-uploading-a-file-passenger-reports-client_body_temp-00000000xx-failed-2-no-such-file-or-directory
 endif::[]
 
 === I get "command not found" when running a Phusion Passenger command through sudo
 
-**Symptoms**::
-	Phusion Passenger commands can be found as a normal user, but not when run through sudo:
-+
--------------------------
-$ passenger-status
-...some output, but no "command not found" error...
-$ passenger-install-apache2-module
-...some output, but no "command not found" error...
-$ sudo passenger-status
-sudo: passenger-status: command not found
-$ sudo passenger-install-apache2-module
-sudo: passenger-install-apache2-module: command not found
--------------------------
-
-**Cause**::
-	The operating system looks up commands using <<the_path_env_var,the PATH environment variable>>. However, sudo resets all environment variables to a default value, dictated by sudo. If Phusion Passenger was installed to a location that is not in the default sudo PATH value, then sudo will not be able to find the Phusion Passenger commands.
-+
-In addition, if you installed Phusion Passenger using a Ruby interpreter that was installed through RVM, then you **must** use rvmsudo instead of sudo. As a rule, when you're an RVM user, always use rvmsudo instead of sudo.
-
-**Solution**::
-	Execute the command using its full path. You can use `which` as a normal user to lookup the full path:
-+
----------------------------------------
-$ which passenger-status
-/somewhere/bin/passenger-status
----------------------------------------
-+
-Next, run full path of the command using either sudo or rvmsudo:
-+
----------------------------------------
-$ sudo /somewhere/bin/passenger-status
-
-# -OR, if you're using RVM:-
-
-$ rvmsudo /somewhere/bin/passenger-status
----------------------------------------
-
-**Recommended reading**::
-	When using sudo, you will probably run into similar "command not found" issues in the future, with components other than Phusion Passenger. We **strongly recommend** you to <<about_environment_variables,learn about environment variables>> so that you know what to do in the future.
+ifdef::apache[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/apache/troubleshooting/?a=i-get-command-not-found-when-running-a-passenger-command-through-sudo
+endif::[]
+ifdef::nginx[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/nginx/troubleshooting/?a=i-get-command-not-found-when-running-a-passenger-command-through-sudo
+endif::[]
+ifdef::standalone[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/standalone/troubleshooting/?a=i-get-command-not-found-when-running-a-passenger-command-through-sudo
+endif::[]

data/doc/users_guide_snippets/troubleshooting/rails.txt

@@ -2,26 +2,29 @@
 
 ==== 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>>
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/apache/troubleshooting/ruby/#the-about-your-application-s-environment-link-does-not-work
 endif::[]
 ifdef::nginx[]
-<<RailsEnv,rails_env>>
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/nginx/troubleshooting/ruby/#the-about-your-application-s-environment-link-does-not-work
+endif::[]
+ifdef::standalone[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/standalone/troubleshooting/ruby/#the-about-your-application-s-environment-link-does-not-work
 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).
+==== The Rails application reports that it's unable to start because of a permission error
 
-Please read <<user_switching,User switching (security)>> for details.
+ifdef::apache[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/apache/troubleshooting/ruby/#the-rails-application-reports-that-it-s-unable-to-start-because-of-a-permission-error
+endif::[]
+ifdef::nginx[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/nginx/troubleshooting/ruby/#the-rails-application-reports-that-it-s-unable-to-start-because-of-a-permission-error
+endif::[]
+ifdef::standalone[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/standalone/troubleshooting/ruby/#the-rails-application-reports-that-it-s-unable-to-start-because-of-a-permission-error
+endif::[]
 
 
 ==== The Rails application's log file is not being written to

data/doc/users_guide_snippets/under_the_hood/relationship_with_ruby.txt

@@ -3,119 +3,8 @@
 
 ==== How Ruby is used
 
-Phusion Passenger's core is written in C++ for performance and memory efficiency. It supports web applications written in any language. Phusion Passenger requires Ruby, its usage of Ruby is minimal in order to maximize performance and to minimize memory usage.
-
- * Phusion Passenger's installer, build system and administration tools are written in Ruby.
- * Certain internally used tools, such as the crash handler (which generates a backtrace in case Phusion Passenger crash) and the prespawn script (used to implement
-ifdef::apache[]
-<<PassengerPreStart,PassengerPreStart>>)
-endif::[]
-ifdef::nginx[]
-<<PassengerPreStart,passenger_pre_start>>)
-endif::[]
-ifdef::standalone[]
-<<PassengerPreStart,passenger_pre_start>>)
-endif::[]
-are written in Ruby as well.
-
- * Ruby web application support is implemented in Ruby.
- * If you use <<flying_passenger,Flying Passenger>>, then the Flying Passenger daemon is written in Ruby. The daemon is a small (less than 500 lines of code) and offloads most tasks to the C++ core.
- * If you use link:Users%20guide%20Standalone.html[Phusion Passenger Standalone], then the frontend (the `passenger` command) is written in Ruby. The frontend is small (less than 1500 lines of code) and offloads most tasks to the C++ core.
-
-Other than the aforementioned aspects, Phusion Passenger does not use Ruby during normal operation. For example, if you run Python WSGI web applications on Phusion Passenger, then there will be (almost) no Ruby code running on the system.
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/indepth/lightweight_ruby_dependency.html
 
 ==== When the system has multiple Ruby interpreters
 
-Phusion Passenger may be installed with any Ruby interpreter. Once installed, you can run Phusion Passenger's Ruby parts under any Ruby interpreter you want, even if that Ruby interpreter was not the one you originally installed Phusion Passenger with.
-
-The reason for this is that Phusion Passenger does not dynamically link to Ruby: Phusion Passenger uses Ruby entirely out-of-process. Thus you can switch to any Ruby interpreter you want during runtime, without recompiling Phusion Passenger, and without worrying about what Ruby you used to install Phusion Passenger.
-
-Phusion Passenger is also capable of running Ruby web applications under any Ruby interpreter you want. So it is not important which Ruby you use to install Phusion Passenger: it will work regardless. Please refer to the documentation for the
-ifdef::apache[]
-<<PassengerRuby,PassengerRuby>>
-endif::[]
-ifdef::nginx[]
-<<PassengerRuby,passenger_ruby>>
-endif::[]
-ifdef::standalone[]
-<<PassengerRuby,passenger_ruby>>
-endif::[]
-directive to learn how run different web applications under different Ruby interpreters.
-
-.Caveat: RVM and RVM gemsets
-
-There is however one caveat if you happen to be using RVM or RVM gemsets. When you `gem install` Phusion Passenger using RVM, then RVM will install Phusion Passenger into the *currently active RVM Ruby and gemset*. This means that Phusion Passenger commands - such as `passenger`, `passenger-install-xxx-module` and `passenger-status` - are available in that same RVM Ruby and gemset only. When you switch Ruby interpreter, or when you switch gemset, the Phusion Passenger commands will no longer be available, and you will get a `command not found` error. Here's an example which demonstrates the problem.
-
-."Command not found" problem demonstration
-[source,sh]
-------------------------
-## Install Phusion Passenger (open source edition) using Ruby 1.9.3
-## and the 'business' gemset
-$ rvm use 1.9.3
-Using /home/phusion/.rvm/gems/ruby-1.9.3-p429
-$ rvm gemset create business
-$ rvm gemset use business
-Using ruby-1.9.3-p429 with gemset business
-$ curl -O https://s3.amazonaws.com/phusion-passenger/releases/gem_bootstrap.sh
-$ eval "`sh gem_bootstrap.sh`"
-$ gem install passenger
-
-## Verify that passenger works
-$ passenger --version
-Phusion Passenger version 4.0.14
-
-## Switch to a different RVM gemset. You will get a `command not found`
-$ rvm gemset use default
-Using ruby-1.9.3-p429 with gemset default
-$ passenger --version
-bash: passenger: command not found
-
-## Switch to a different Ruby interpreter. You will also get
-## a `command not found`
-$ rvm use 2.0.0
-Using /home/phusion/.rvm/gems/ruby-2.0.0-p195
-$ passenger --version
-bash: passenger: command not found
-
-## Switch back to the Ruby and gemset that you installed Phusion
-## Passenger with, and verify that it works again
-$ rvm use 1.9.3
-Using /home/phusion/.rvm/gems/ruby-2.0.0-p195
-$ rvm gemset use business
-Using ruby-1.9.3-p429 with gemset business
-$ passenger --version
-Phusion Passenger version 4.0.14
-------------------------
-
-.Solutions
-There are several ways to solve this problem:
-
- 1. Permanently add Phusion Passenger's command directory to your PATH, so that your shell can always find them even when you switch RVM Ruby or gemset. If you don't know what PATH means, please read <<about_environment_variable,About environment variables>> first.
-+
-The drawback is that you have to redo this every time you upgrade Phusion Passenger, because the Phusion Passenger directory filename is dependent on the version number.
-+
-First, identify the location of the Phusion Passenger command directory, like this:
-+
-------------------------------------------------------------------
-$ echo `passenger-config --root`/bin
-/home/phusion/.rvm/gems/ruby-1.9.3-p429/gems/passenger-4.0.15/bin
-------------------------------------------------------------------
-+
-Next, add the directory that you've found to your current shell's PATH:
-+
-------------------------------------------------------------------
-$ export PATH=/home/phusion/.rvm/gems/ruby-1.9.3-p429/gems/passenger-4.0.15/bin:$PATH
-------------------------------------------------------------------
-+
-Finally, make the change permanent by appending the above command to your bash startup file:
-+
-------------------------------------------------------------------
-$ echo 'export PATH=/home/phusion/.rvm/gems/ruby-1.9.3-p429/gems/passenger-4.0.15/bin:$PATH' >> ~/.bashrc
-------------------------------------------------------------------
- 2. Switch back to the RVM Ruby and gemset that you installed Phusion Passenger with, before running any Phusion Passenger command.
- 3. Prepend any Phusion Passenger command with `rvm-exec RUBY_NAME@GEMSET_NAME ruby -S`. If the relevant Phusion Passenger command also needs root privileges, then prepend `rvmsudo` before that. For example:
-+
-------------------------------------------------------------------
-rvm-exec 1.9.3@business ruby -S passenger --version
-rvmsudo rvm-exec 1.9.3@business ruby -S passenger-install-apache2-module
-------------------------------------------------------------------
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/indepth/ruby/multiple_rubies.html

data/ext/apache2/Configuration.hpp

@@ -75,8 +75,8 @@ struct DirConfig : GeneratedDirConfigPart {
 	const char *appRoot;
 
 	/** Whether symlinks in the document root path should be resolved.
-	 * The implication of this is documented in the users guide, section
-	 * "How Phusion Passenger detects whether a virtual host is a web application".
+	 * The implication of this is documented at
+	 * https://www.phusionpassenger.com/library/indepth/ruby/app_autodetection/apache/.
 	 */
 	Threeway resolveSymlinksInDocRoot;
 

data/ext/apache2/Hooks.cpp

@@ -153,8 +153,8 @@ private:
 					if (selinuxIsEnforcing()) {
 						ap_rputs("<p>", r);
 						ap_rputs("The permission problems may also be caused by SELinux restrictions. ", r);
-						ap_rputs("Please read " APACHE2_DOC_URL "#apache_selinux_permissions to learn ", r);
-						ap_rputs("how to fix SELinux permission issues. ", r);
+						ap_rputs("Please read https://www.phusionpassenger.com/library/admin/apache/troubleshooting/?a=apache-cannot-access-my-app-s-files-because-of-selinux-errors ", r);
+						ap_rputs("to learn how to fix SELinux permission issues. ", r);
 						ap_rputs("</p>", r);
 					}
 				#endif

data/ext/common/AgentsStarter.h

@@ -210,18 +210,26 @@ private:
 	}
 
 	void throwEnrichedWatchdogFailReason(string simpleReason) {
-		string passengerRootConfig;
-		string docURL;
-		if (type == AS_APACHE) {
-			passengerRootConfig = "PassengerRoot";
-			docURL = APACHE2_DOC_URL "#PassengerRoot";
+		if (type == AS_STANDALONE) {
+			throw RuntimeException("Unable to start " PROGRAM_NAME ": " + simpleReason +
+				". This probably means that your " SHORT_PROGRAM_NAME
+				" installation is broken or incomplete. Please try reinstalling " SHORT_PROGRAM_NAME);
 		} else {
-			passengerRootConfig = "passenger_root";
-			docURL = NGINX_DOC_URL "#PassengerRoot";
+			string passengerRootConfig;
+			string docURL;
+			if (type == AS_APACHE) {
+				passengerRootConfig = "PassengerRoot";
+				docURL = "https://www.phusionpassenger.com/library/config/apache/reference/#passengerroot";
+			} else {
+				passengerRootConfig = "passenger_root";
+				docURL = "https://www.phusionpassenger.com/library/config/nginx/reference/#passenger_root";
+			}
+			throw RuntimeException("Unable to start " PROGRAM_NAME ": " + simpleReason +
+				". This probably means that your " SHORT_PROGRAM_NAME
+				" installation is broken or incomplete, or that your '" + passengerRootConfig +
+				"' setting contains the wrong value. Please reinstall " SHORT_PROGRAM_NAME
+				" or, or see " + docURL + " to learn how to adjust the setting.");
 		}
-		throw RuntimeException("Unable to start Phusion Passenger: " + simpleReason + ". This probably means that your " PROGRAM_NAME
-			" installation is broken or incomplete, or that your '" + passengerRootConfig + "' setting contains the wrong value."
-			" Please reinstall " PROGRAM_NAME " or adjust the setting (see: " + docURL + ").");
 	}
 
 	static void killProcessGroupAndWait(pid_t *pid, unsigned long long timeout = 0) {

data/ext/common/ApplicationPool2/ErrorRenderer.h

@@ -104,9 +104,6 @@ public:
 		StringMap<StaticString> params;
 
 		params.set("PROGRAM_NAME", PROGRAM_NAME);
-		params.set("NGINX_DOC_URL", NGINX_DOC_URL);
-		params.set("APACHE2_DOC_URL", APACHE2_DOC_URL);
-		params.set("STANDALONE_DOC_URL", STANDALONE_DOC_URL);
 
 		return Template::apply(readAll(templateFile), params);
 	}

data/ext/common/ApplicationPool2/Options.h

@@ -102,6 +102,8 @@ private:
 		result.push_back(&options.preexecChroot);
 		result.push_back(&options.postexecChroot);
 
+		result.push_back(&options.integrationMode);
+
 		result.push_back(&options.ruby);
 		result.push_back(&options.python);
 		result.push_back(&options.nodejs);
@@ -244,6 +246,8 @@ public:
 	StaticString preexecChroot;
 	StaticString postexecChroot;
 
+	StaticString integrationMode;
+
 	/**
 	 * Path to the Ruby interpreter to use, in case the application to spawn
 	 * is a Ruby app.
@@ -460,6 +464,7 @@ public:
 		  baseURI("/", 1),
 		  spawnMethod(DEFAULT_SPAWN_METHOD, sizeof(DEFAULT_SPAWN_METHOD) - 1),
 		  defaultUser(PASSENGER_DEFAULT_USER, sizeof(PASSENGER_DEFAULT_USER) - 1),
+		  integrationMode(DEFAULT_INTEGRATION_MODE, sizeof(DEFAULT_INTEGRATION_MODE) - 1),
 		  ruby(DEFAULT_RUBY, sizeof(DEFAULT_RUBY) - 1),
 		  python(DEFAULT_PYTHON, sizeof(DEFAULT_PYTHON) - 1),
 		  nodejs(DEFAULT_NODEJS, sizeof(DEFAULT_NODEJS) - 1),
@@ -593,6 +598,7 @@ public:
 			appendKeyValue (vec, "restart_dir",        restartDir);
 			appendKeyValue (vec, "preexec_chroot",     preexecChroot);
 			appendKeyValue (vec, "postexec_chroot",    postexecChroot);
+			appendKeyValue (vec, "integration_mode",   integrationMode);
 			appendKeyValue (vec, "ruby",               ruby);
 			appendKeyValue (vec, "python",             python);
 			appendKeyValue (vec, "nodejs",             nodejs);
@@ -602,7 +608,6 @@ public:
 			appendKeyValue (vec, "ust_router_password", ustRouterPassword);
 			appendKeyValue4(vec, "debugger",           debugger);
 			appendKeyValue4(vec, "analytics",          analytics);
-
 			appendKeyValue (vec, "api_key",            apiKey);
 
 			/*********************************/
@@ -612,6 +617,8 @@ public:
 			appendKeyValue3(vec, "max_processes",       maxProcesses);
 			appendKeyValue2(vec, "max_preloader_idle_time", maxPreloaderIdleTime);
 			appendKeyValue3(vec, "max_out_of_band_work_instances", maxOutOfBandWorkInstances);
+		}
+		if ((fields & SPAWN_OPTIONS) || (fields & PER_GROUP_POOL_OPTIONS)) {
 			appendKeyValue (vec, "union_station_key",   unionStationKey);
 		}