passenger 4.0.23 → 4.0.24

data/doc/Users guide Standalone.idmap.txt

@@ -72,33 +72,37 @@
 
 4.1. Command line options	=>	command-line-options-1njv6kt
 
-4.2. Advanced configuration	=>	advanced-configuration-e3v4pk
+4.2. Configuration file	=>	configuration-file-xng7yp
 
-5. Troubleshooting	=>	troubleshooting-o7g75o
+4.3. Advanced configuration	=>	advanced-configuration-e3v4pk
 
-5.1. Generic troubleshooting tips	=>	generic-troubleshooting-tips-2vokcr
+5. Mass deployment	=>	mass-deployment-1xqriy4
 
-5.2. Upon uploading a file, Phusion Passenger reports "client_body_temp/00000000xx failed (2: No such file or directory)"	=>	upon-uploading-a-file-phusion-passenger-reports-client-body-temp-00000000xx-failed-2-no-such-file-or-directory--d01goe
+6. Troubleshooting	=>	troubleshooting-o7g75o
 
-6. Appendix: About environment variables	=>	appendix-about-environment-variables-1ct91x3
+6.1. Generic troubleshooting tips	=>	generic-troubleshooting-tips-2vokcr
 
-6.1. Working with environment variables	=>	working-with-environment-variables-11cmwlv
+6.2. Upon uploading a file, Phusion Passenger reports "client_body_temp/00000000xx failed (2: No such file or directory)"	=>	upon-uploading-a-file-phusion-passenger-reports-client-body-temp-00000000xx-failed-2-no-such-file-or-directory--d01goe
 
-6.2. The PATH environment variable	=>	the-path-environment-variable-yzfn3k
+7. Appendix: About environment variables	=>	appendix-about-environment-variables-1ct91x3
 
-6.2.1. Adding Phusion Passenger’s administration tools to PATH	=>	adding-phusion-passenger-s-administration-tools-to-path-d7k5mh
+7.1. Working with environment variables	=>	working-with-environment-variables-11cmwlv
 
-6.3. Making environment variables permanent	=>	making-environment-variables-permanent-mkq46d
+7.2. The PATH environment variable	=>	the-path-environment-variable-yzfn3k
 
-6.3.1. bash	=>	bash-hmcscc
+7.2.1. Adding Phusion Passenger’s administration tools to PATH	=>	adding-phusion-passenger-s-administration-tools-to-path-d7k5mh
 
-6.3.2. Apache	=>	apache-15y3bm0
+7.3. Making environment variables permanent	=>	making-environment-variables-permanent-mkq46d
 
-6.3.3. Nginx	=>	nginx-uarf27
+7.3.1. bash	=>	bash-hmcscc
 
-6.3.4. cron	=>	cron-6272ar
+7.3.2. Apache	=>	apache-15y3bm0
 
-6.3.5. Phusion Passenger-served apps	=>	phusion-passenger-served-apps-127wbl2
+7.3.3. Nginx	=>	nginx-uarf27
 
-6.4. Environment variables and sudo	=>	environment-variables-and-sudo-znzmif
+7.3.4. cron	=>	cron-6272ar
+
+7.3.5. Phusion Passenger-served apps	=>	phusion-passenger-served-apps-127wbl2
+
+7.4. Environment variables and sudo	=>	environment-variables-and-sudo-znzmif
 

data/doc/Users guide Standalone.txt

@@ -47,9 +47,52 @@ Most configuration is done by customizing the arguments passed to the `passenger
 	When set to "smart" (the default), Phusion Passenger preloads your app and utilizes copy-on-write in order to save memory. You can disable this by setting this option to "direct". Preloading is only supported for Ruby apps. For apps written in other languages, it is as if "direct" is always used.
 `--no-friendly-error-pages`::
 	If your app fails to start, Phusion Passenger will tell you by showing a friendly error page in the browser. This option disables it.
+`--ssl`::
+	Enables SSL support. If this is set, you must also set `--ssl-certificate` and `--ssl-certificate-key` to the SSL certificate and key files, respectively.
 
 See `--help` for all available options.
 
+
+[[config_file]]
+=== Configuration file
+:version: 4.0.24
+include::users_guide_snippets/since_version.txt[]
+
+It is possible to store some options in a configuration file `passenger-standalone.json` in the application directory. Configuration in this file overrides command line options. The configuration file format is JSON.
+
+In case Passenger Standalone is in <<mass_deployment,mass deployment mode>>, such a configuration file allows customizing options on a per-application basis.
+
+The following configuration options are supported:
+
+`port`::
+	Equivalent to the `--port` command line option.
+`environment`::
+	Equivalent to the `--environment` command line option.
+`max_pool_size`::
+	Equivalent to the `--max-pool-size` command line option. But when in mass deployment mode, this option in the configuration file has no effect; the command line option should be used to customize this.
+`min_instances`::
+	Equivalent to the `--min-instances` command line option.
+`spawn_method`::
+	Equivalent to the `--spawn-method` command line option.
+`ssl`::
+	Equivalent to the `--ssl` command line option. When given, you must also set `ssl_certificate` and `ssl_certificate_key` in the configuration file.
++
+When in mass deployment mode, you will probably want to set a different `port` too. If you don't, and you end up in a situation in which a port is used for both HTTP and HTTPS traffic, then the builtin Nginx core will abort with an error.
+
+Here is an example configuration file:
+
+[source,javascript]
+------------------
+{
+	"port": 8000,
+	"environment": "production",
+	"ssl": true,
+	"ssl_certificate": "/path-to-cert.crt",
+	"ssl_certificate_key": "/path-to-cert.key"
+}
+------------------
+
+
 === Advanced configuration
 
 Phusion Passenger Standalone is built on the same technology that powers link:Users%20guide%20Nginx.html[Phusion Passenger for Nginx], so any configuration option supported by Phusion Passenger for Nginx can be applied to Standalone as well. You can do this by editing the Standalone configuration template directly.
@@ -67,6 +110,55 @@ NOTE: If you installed Phusion Passenger using the Debian or Ubuntu packages, th
 Please note that changes to this file only last until you reinstall or upgrade Phusion Passenger. We are currently working on a mechanism for permanently editing the configuration file.
 
 
+[[mass_deployment]]
+== Mass deployment
+:version: 3.0.0
+include::users_guide_snippets/enterprise_only.txt[]
+
+Mass deployment is a special mode in Phusion Passenger Standalone that allows you to deploy multiple web applications without having to create configuration entries for each one of them. Given a directory with multiple web applications, Passenger Standalone will automatically give each web application its own virtual host entry, and serve all of them from a single server. The virtual host's server name is equal to the web application's directory name. Whenever a new web application is added or removed, Passenger Standalone automatically reconfigures itself without administrator intervention. This makes the mass deployment mode especially useful when there are a large number of web applications.
+
+For example, suppose we have a directory `/webapps` with three web applications: Ruby app, a Python app and a Node.js app.
+
+----------------------------
+/webapps
+  |
+  +-- rubyapp.com
+  |    |
+  |    +-- config.ru
+  |
+  +-- pythonapp.com
+  |    |
+  |    +-- passenger_wsgi.py
+  |
+  +-- nodeapp.com
+       |
+       +-- app.js
+----------------------------
+
+You can activate Passenger Standalone in mass deployment mode by changing the working directory to `/webapps` and running `passenger start`:
+
+----------------------------
+$ cd /webapps
+$ passenger start
+=============== Phusion Passenger Standalone web server started ===============
+PID file: /webapps/passenger.3000.pid
+Log file: /webapps/passenger.3000.log
+Environment: development
+
+Serving these applications on 0.0.0.0 port 3000:
+ Host name                     Directory
+.-----------------------------------------------------------
+ rubyapp.com                   /webapps/rubyapp.com
+ pythonapp.com                 /webapps/pythonapp.com
+ nodeapp.com                   /webapps/nodeapp.com
+.-----------------------------------------------------------
+----------------------------
+
+If you for example remove `/webapps/rubyapp.com`, Passenger Standalone will reconfigure itself without that web application. Or if you add a new web applications `/webapps/newapp.org`, Passenger Standalone will reconfigure itself with that web application.
+
+Any options that you pass to the `passenger` command will affect all deployed web applications. It is also possible to change options on a per-application basis through the use of <<config_file,a `passenger-standalone.json` file inside each application's directory>>.
+
+
 [[troubleshooting]]
 == Troubleshooting
 

data/doc/users_guide_snippets/environment_variables.txt

@@ -247,6 +247,8 @@ os.environ['FOO'] = 'bar'
 [[env_vars_and_sudo]]
 === Environment variables and sudo
 
+NOTE: RVM users should always use the `rvmsudo` command instead of `sudo`. However all information in this section apply to `rvmsudo` as well.
+
 The `sudo` command resets all environment variables before running the specified command, for security reasons. So if you set environment variables before running `sudo passenger-install-xxx-module`, `sudo passenger-status` or any other commands, then the environment variables are not correctly passed to the command. You can solve this by running sudo with `-E` (preserve environment variables):
 
 [source,sh]
@@ -263,3 +265,12 @@ Password: ...
 root@localhost bash# export APXS2=/usr/sbin/apxs2
 root@localhost bash# passenger-install-apache2-module
 -------------------------
+
+Note that for security reasons, `sudo` **always resets the `PATH` environment variable**, even if you pass `-E`! You can get around this problem by obtaining a root prompt first, and then set the environment variables:
+
+-------------------------
+user@localhost bash$ sudo -s
+Password: ...
+root@localhost bash# export PATH=$PATH:/opt/myruby/bin
+root@localhost bash# passenger-install-apache2-module
+-------------------------

data/doc/users_guide_snippets/installation.txt

@@ -101,18 +101,18 @@ deb https://oss-binaries.phusionpassenger.com/apt/passenger squeeze main
 [source,sh]
 --------------------------------------------------------------
 # Ubuntu 13.10
-deb https://YOUR_ORDER_REFERENCE:YOUR_PASSWORD@www.phusionpassenger.com/enterprise_apt saucy main
+deb https://download:YOUR_DOWNLOAD_TOKEN@www.phusionpassenger.com/enterprise_apt saucy main
 # Ubuntu 12.04
-deb https://YOUR_ORDER_REFERENCE:YOUR_PASSWORD@www.phusionpassenger.com/enterprise_apt precise main
+deb https://download:YOUR_DOWNLOAD_TOKEN@www.phusionpassenger.com/enterprise_apt precise main
 # Ubuntu 10.04
-deb https://YOUR_ORDER_REFERENCE:YOUR_PASSWORD@www.phusionpassenger.com/enterprise_apt lucid main
+deb https://download:YOUR_DOWNLOAD_TOKEN@www.phusionpassenger.com/enterprise_apt lucid main
 # Debian 7
-deb https://YOUR_ORDER_REFERENCE:YOUR_PASSWORD@www.phusionpassenger.com/enterprise_apt wheezy main
+deb https://download:YOUR_DOWNLOAD_TOKEN@www.phusionpassenger.com/enterprise_apt wheezy main
 # Debian 6
-deb https://YOUR_ORDER_REFERENCE:YOUR_PASSWORD@www.phusionpassenger.com/enterprise_apt squeeze main
+deb https://download:YOUR_DOWNLOAD_TOKEN@www.phusionpassenger.com/enterprise_apt squeeze main
 --------------------------------------------------------------
 +
-Please replace 'YOUR_ORDER_REFERENCE' and 'YOUR_PASSWORD' with your link:https://www.phusionpassenger.com/orders[Customer Area] login credentials.
+You can find the correct value for 'YOUR_DOWNLOAD_TOKEN' in the link:https://www.phusionpassenger.com/orders[Customer Area].
 
 4. Secure `passenger.list` and update your APT cache:
 +
@@ -323,10 +323,10 @@ First, download the *license key* from the link:https://www.phusionpassenger.com
 Next, add the Phusion Passenger Enterprise gem server to your RubyGems source list:
 +
 ------------------------------------------
-gem source --add https://YOUR_ORDER_REFERENCE:YOUR_PASSWORD@www.phusionpassenger.com/enterprise_gems/
+gem source --add https://download:YOUR_DOWNLOAD_TOKEN@www.phusionpassenger.com/enterprise_gems/
 ------------------------------------------
 +
-Substitute 'YOUR_ORDER_REFERENCE' and 'YOUR_PASSWORD' with your link:https://www.phusionpassenger.com/orders[Customer Area] login credentials. And notice the **trailing slash** in the URL! It is very important.
+Substitute 'YOUR_DOWNLOAD_TOKEN' with the one you find in the link:https://www.phusionpassenger.com/orders[Customer Area]. And notice the **trailing slash** in the URL! It is very important.
 +
 Finally, install the latest gem to obtain the files for the latest stable version of the open source Phusion Passenger:
 +

data/doc/users_guide_snippets/troubleshooting/default.txt

@@ -2,18 +2,26 @@
 
 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`.
+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::[]
+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.
+
 endif::[]
 ifdef::standalone[]
-Phusion Passenger Standalone log file. This is typically located in `log/passenger.[PORT NUMBER].log`.
+Phusion Passenger Standalone log file. This is typically located in `log/passenger.[PORT NUMBER].log`. Most problems are logged to this log file.
 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
+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::[]

data/ext/apache2/Configuration.cpp

@@ -189,7 +189,6 @@ passenger_config_create_dir(apr_pool_t *p, char *dirspec) {
 	
 	#include "CreateDirConfig.cpp"
 
-	config->python = NULL;
 	config->environment = NULL;
 	config->appRoot = NULL;
 	config->spawnMethod = DirConfig::SM_UNSET;
@@ -220,7 +219,6 @@ passenger_config_merge_dir(apr_pool_t *p, void *basev, void *addv) {
 		config->baseURIs.insert(*it);
 	}
 	
-	MERGE_STR_CONFIG(python);
 	MERGE_STR_CONFIG(environment);
 	MERGE_STR_CONFIG(appRoot);
 	MERGE_STRING_CONFIG(appGroupName);
@@ -282,7 +280,6 @@ cmd_passenger_pre_start(cmd_parms *cmd, void *pcfg, const char *arg) {
 
 #include "ConfigurationSetters.cpp"
 
-DEFINE_DIR_STR_CONFIG_SETTER(cmd_passenger_python, python)
 DEFINE_DIR_STR_CONFIG_SETTER(cmd_environment, environment)
 DEFINE_DIR_INT_CONFIG_SETTER(cmd_passenger_stat_throttle_rate, statThrottleRate, unsigned long, 0)
 DEFINE_DIR_STR_CONFIG_SETTER(cmd_passenger_app_root, appRoot)
@@ -650,13 +647,6 @@ const command_rec passenger_commands[] = {
 		OR_OPTIONS | ACCESS_CONF | RSRC_CONF,
 		"The environment under which a Rack app must run."),
 	
-	// WSGI-specific settings.
-	AP_INIT_TAKE1("PassengerPython",
-		(Take1Func) cmd_passenger_python,
-		NULL,
-		OR_OPTIONS | ACCESS_CONF | RSRC_CONF,
-		"The Python interpreter to use."),
-	
 	// Backwards compatibility options.
 	AP_INIT_TAKE1("RailsRuby",
 		(Take1Func) cmd_passenger_ruby,

data/ext/apache2/Configuration.hpp

@@ -70,9 +70,6 @@ struct DirConfig {
 
 	std::set<std::string> baseURIs;
 	
-	/** The Python interpreter to use. */
-	const char *python;
-	
 	/** The environment (RAILS_ENV/RACK_ENV/WSGI_ENV) under which
 	 * applications should operate. */
 	const char *environment;

data/ext/apache2/ConfigurationCommands.cpp

@@ -45,6 +45,18 @@
 		OR_OPTIONS | ACCESS_CONF | RSRC_CONF,
 		"The Ruby interpreter to use."),
 
+	AP_INIT_TAKE1("PassengerPython",
+		(Take1Func) cmd_passenger_python,
+		NULL,
+		OR_OPTIONS | ACCESS_CONF | RSRC_CONF,
+		"The Python interpreter to use."),
+
+	AP_INIT_TAKE1("PassengerNodejs",
+		(Take1Func) cmd_passenger_nodejs,
+		NULL,
+		OR_OPTIONS | ACCESS_CONF | RSRC_CONF,
+		"The Node.js command to use."),
+
 	AP_INIT_TAKE1("PassengerMinInstances",
 		(Take1Func) cmd_passenger_min_instances,
 		NULL,
@@ -63,6 +75,12 @@
 		ACCESS_CONF | RSRC_CONF,
 		"The group that Ruby applications must run as."),
 
+	AP_INIT_FLAG("PassengerErrorOverride",
+		(FlagFunc) cmd_passenger_error_override,
+		NULL,
+		OR_ALL,
+		"Allow Apache to handle error response."),
+
 	AP_INIT_TAKE1("PassengerMaxRequests",
 		(Take1Func) cmd_passenger_max_requests,
 		NULL,

data/ext/apache2/ConfigurationFields.hpp

@@ -38,12 +38,14 @@
 
 
 
-	/** Whether to load environment variables from the shell before running the application. */
-	Threeway loadShellEnvvars;
-	/** Enable or disable Passenger's high performance mode. */
-	Threeway highPerformance;
 	/** Enable or disable Phusion Passenger. */
 	Threeway enabled;
+	/** Allow Apache to handle error response. */
+	Threeway errorOverride;
+	/** Enable or disable Passenger's high performance mode. */
+	Threeway highPerformance;
+	/** Whether to load environment variables from the shell before running the application. */
+	Threeway loadShellEnvvars;
 	/** The maximum number of queued requests. */
 	int maxRequestQueueSize;
 	/** The maximum number of requests that an application instance may process. */
@@ -54,8 +56,12 @@
 	int startTimeout;
 	/** The group that Ruby applications must run as. */
 	const char *group;
-	/** The user that Ruby applications must run as. */
-	const char *user;
+	/** The Node.js command to use. */
+	const char *nodejs;
+	/** The Python interpreter to use. */
+	const char *python;
 	/** The Ruby interpreter to use. */
 	const char *ruby;
+	/** The user that Ruby applications must run as. */
+	const char *user;
 

data/ext/apache2/ConfigurationFields.hpp.erb

@@ -62,11 +62,11 @@ def definition_for(option)
 	field = struct_field_for(option)
 	case option[:type]
 	when :string
-		result = ["const char *#{field}", 8 + 4]
+		result = ["const char *#{field}", 8 + 4, field, option[:desc]]
 	when :integer
-		result = ["int #{field}", 4]
+		result = ["int #{field}", 4, field, option[:desc]]
 	when :flag
-		result = ["Threeway #{field}", 1]
+		result = ["Threeway #{field}", 1, field, option[:desc]]
 	else
 		raise "Unknown option type #{option[:type].inspect} for option #{option[:name]}"
 	end
@@ -79,11 +79,16 @@ definitions = eligible_options.map { |o| definition_for(o) }
 # It's possible to make it even smaller with a smarter algorithm but for now
 # I don't bother.
 definitions.sort! do |d1, d2|
-	d1[1] <=> d2[1]
+	if d1[1] == d2[1]
+		# After sorting on size, sort alphabetically.
+		d1[2] <=> d2[2]
+	else
+		d1[1] <=> d2[1]
+	end
 end
 %>
 
 <% for definition in definitions -%>
-	/** <%= definition[2] %> */
+	/** <%= definition[3] %> */
 	<%= definition[0] %>;
 <% end %>

data/ext/apache2/ConfigurationSetters.cpp

@@ -47,6 +47,22 @@
 		}
 	
 	
+		static const char *
+		cmd_passenger_python(cmd_parms *cmd, void *pcfg, const char *arg) {
+			DirConfig *config = (DirConfig *) pcfg;
+			config->python = arg;
+			return NULL;
+		}
+	
+	
+		static const char *
+		cmd_passenger_nodejs(cmd_parms *cmd, void *pcfg, const char *arg) {
+			DirConfig *config = (DirConfig *) pcfg;
+			config->nodejs = arg;
+			return NULL;
+		}
+	
+	
 		static const char *
 		cmd_passenger_min_instances(cmd_parms *cmd, void *pcfg, const char *arg) {
 			DirConfig *config = (DirConfig *) pcfg;
@@ -97,6 +113,17 @@
 		}
 	
 	
+		static const char *
+		cmd_passenger_error_override(cmd_parms *cmd, void *pcfg, const char *arg) {
+			DirConfig *config = (DirConfig *) pcfg;
+			config->errorOverride =
+				arg ?
+				DirConfig::ENABLED :
+				DirConfig::DISABLED;
+			return NULL;
+		}
+	
+	
 		static const char *
 		cmd_passenger_max_requests(cmd_parms *cmd, void *pcfg, const char *arg) {
 			DirConfig *config = (DirConfig *) pcfg;

data/ext/apache2/CreateDirConfig.cpp

@@ -39,9 +39,12 @@
 
 
 			config->ruby = NULL;
+				config->python = NULL;
+				config->nodejs = NULL;
 				config->minInstances = UNSET_INT_VALUE;
 				config->user = NULL;
 				config->group = NULL;
+				config->errorOverride = DirConfig::UNSET;
 				config->maxRequests = UNSET_INT_VALUE;
 				config->startTimeout = UNSET_INT_VALUE;
 				config->highPerformance = DirConfig::UNSET;