passenger 3.0.14 → 3.0.15

data/doc/Users guide Nginx.idmap.txt

@@ -106,83 +106,95 @@
 
 5.1. passenger_root <directory>	=>	passenger-root-directory--bqvhhz
 
-5.10. Rack-specific options	=>	rack-specific-options-13yvdxs
+5.10. Logging and debugging options	=>	logging-and-debugging-options-14e91ni
 
-5.10.1. rack_env <string>	=>	rack-env-string--tqmrt0
+5.10.1. passenger_log_level <integer>	=>	passenger-log-level-integer--17snhon
 
-5.11. Deprecated options	=>	deprecated-options-1dtzo0g
+5.10.2. passenger_debug_log_file <filename>	=>	passenger-debug-log-file-filename--21ubaj
 
-5.11.1. rails_spawn_method	=>	rails-spawn-method-17vdnpt
+5.10.3. passenger_debugger <on|off>	=>	passenger-debugger-on-off--1wkuq85
 
-5.2. passenger_ruby <filename>	=>	passenger-ruby-filename--1gnok5k
+5.11. Ruby on Rails-specific options	=>	ruby-on-rails-specific-options-12vfokt
 
-5.3. passenger_spawn_method <string>	=>	passenger-spawn-method-string--1sc6njl
+5.11.1. rails_env <string>	=>	rails-env-string--jlh7v9
+
+5.11.2. rails_framework_spawner_idle_time <integer>	=>	rails-framework-spawner-idle-time-integer--q5ljd5
 
-5.4. Important deployment options	=>	important-deployment-options-av567
+5.11.3. rails_app_spawner_idle_time <integer>	=>	rails-app-spawner-idle-time-integer--1xjqe4b
 
-5.4.1. passenger_enabled <on|off>	=>	passenger-enabled-on-off--1rpb2t7
+5.12. Rack-specific options	=>	rack-specific-options-13yvdxs
 
-5.4.2. passenger_base_uri <uri>	=>	passenger-base-uri-uri--1xtuo50
+5.12.1. rack_env <string>	=>	rack-env-string--tqmrt0
 
-5.5. Connection handling options	=>	connection-handling-options-8jgq90
+5.13. Deprecated options	=>	deprecated-options-1dtzo0g
 
-5.5.1. passenger_use_global_queue <on|off>	=>	passenger-use-global-queue-on-off--14h9n22
+5.13.1. rails_spawn_method	=>	rails-spawn-method-17vdnpt
 
-5.5.2. passenger_ignore_client_abort <on|off>	=>	passenger-ignore-client-abort-on-off--19bapt2
+5.2. passenger_ruby <filename>	=>	passenger-ruby-filename--1gnok5k
+
+5.3. passenger_spawn_method <string>	=>	passenger-spawn-method-string--1sc6njl
 
-5.5.3. passenger_set_cgi_param <CGI environment name> <value>	=>	passenger-set-cgi-param-cgi-environment-name-value--rx9gc0
+5.4. passenger_rolling_restarts <on|off>	=>	passenger-rolling-restarts
 
-5.5.4. passenger_pass_header <header name>	=>	passenger-pass-header-header-name--1cg31je
+5.5. passenger_resist_deployment_errors <on|off>	=>	passenger-resist-deployment-errors-on-off--k9yf1
 
-5.5.5. passenger_buffer_response <on|off>	=>	passenger-buffer-response-on-off--1twmh51
+5.6. Important deployment options	=>	important-deployment-options-av567
 
-5.5.6. passenger_buffer_size	=>	passenger-buffer-size-1jfkq87
+5.6.1. passenger_enabled <on|off>	=>	passenger-enabled-on-off--1rpb2t7
 
-5.5.7. passenger_buffers	=>	passenger-buffers-12q1he5
+5.6.2. passenger_base_uri <uri>	=>	passenger-base-uri-uri--1xtuo50
 
-5.5.8. passenger_busy_buffer_size	=>	passenger-busy-buffer-size-1gde265
+5.7. Connection handling options	=>	connection-handling-options-8jgq90
 
-5.6. Security options	=>	security-options-1bv93g4
+5.7.1. passenger_use_global_queue <on|off>	=>	passenger-use-global-queue-on-off--14h9n22
 
-5.6.1. passenger_user_switching <on|off>	=>	passenger-user-switching-on-off--1p37u3l
+5.7.2. passenger_ignore_client_abort <on|off>	=>	passenger-ignore-client-abort
 
-5.6.2. passenger_user <username>	=>	passenger-user-username--b06ur7
+5.7.3. passenger_set_cgi_param <CGI environment name> <value>	=>	passenger-set-cgi-param-cgi-environment-name-value--rx9gc0
 
-5.6.3. passenger_user <group name>	=>	passenger-user-group-name--1fco4j7
+5.7.4. passenger_pass_header <header name>	=>	passenger-pass-header-header-name--1cg31je
 
-5.6.4. passenger_default_user <username>	=>	passenger-default-user-username--1h6cdmf
+5.7.5. passenger_buffer_response <on|off>	=>	passenger-buffer-response
 
-5.6.5. Passenger_default_group <group name>	=>	passenger-default-group-group-name--1qxn2qa
+5.7.6. passenger_buffer_size	=>	passenger-buffer-size-1jfkq87
 
-5.6.6. passenger_friendly_error_pages <on|off>	=>	passenger-friendly-error-pages-on-off--27mews
+5.7.7. passenger_buffers	=>	passenger-busy-buffers
 
-5.7. Resource control and optimization options	=>	resource-control-and-optimization-options-xd7evs
+5.7.8. passenger_busy_buffer_size	=>	passenger-busy-buffer-size-124sj61
 
-5.7.1. passenger_max_pool_size <integer>	=>	passenger-max-pool-size-integer--3jzefs
+5.8. Security options	=>	security-options-1bv93g4
 
-5.7.2. passenger_min_instances <integer>	=>	passenger-min-instances-integer--uclykt
+5.8.1. passenger_user_switching <on|off>	=>	passenger-user-switching-on-off--1p37u3l
 
-5.7.3. passenger_max_instances_per_app <integer>	=>	passenger-max-instances-per-app-integer--1p7q3cf
+5.8.2. passenger_user <username>	=>	passenger-user-username--b06ur7
 
-5.7.4. passenger_pool_idle_time <integer>	=>	passenger-pool-idle-time-integer--xcw65o
+5.8.3. passenger_group <group name>	=>	passenger-user-group-name--1fco4j7
 
-5.7.5. passenger_max_requests <integer>	=>	passenger-max-requests-integer--sgzint
+5.8.4. passenger_default_user <username>	=>	passenger-default-user-username--1h6cdmf
 
-5.7.6. passenger_pre_start <url>	=>	passenger-pre-start-url--qeevln
+5.8.5. Passenger_default_group <group name>	=>	passenger-default-group-group-name--1qxn2qa
 
-5.8. Logging and debugging options	=>	logging-and-debugging-options-14e91ni
+5.8.6. passenger_friendly_error_pages <on|off>	=>	passenger-friendly-error-pages-on-off--1ti1a0e
 
-5.8.1. passenger_log_level <integer>	=>	passenger-log-level-integer--17snhon
+5.9. Resource control and optimization options	=>	resource-control-and-optimization-options-xd7evs
 
-5.8.2. passenger_debug_log_file <filename>	=>	passenger-debug-log-file-filename--21ubaj
+5.9.1. passenger_max_pool_size <integer>	=>	passenger-max-pool-size-integer--3jzefs
 
-5.9. Ruby on Rails-specific options	=>	ruby-on-rails-specific-options-12vfokt
+5.9.2. passenger_min_instances <integer>	=>	passenger-min-instances-integer--uclykt
 
-5.9.1. rails_env <string>	=>	rails-env-string--jlh7v9
+5.9.3. passenger_max_instances <integer>	=>	passenger-max-instances
 
-5.9.2. rails_framework_spawner_idle_time <integer>	=>	rails-framework-spawner-idle-time-integer--q5ljd5
+5.9.4. passenger_max_instances_per_app <integer>	=>	passenger-max-instances-per-app-integer--1xhbbne
 
-5.9.3. rails_app_spawner_idle_time <integer>	=>	rails-app-spawner-idle-time-integer--1xjqe4b
+5.9.5. passenger_pool_idle_time <integer>	=>	passenger-pool-idle-time-integer--xcw65o
+
+5.9.6. passenger_max_requests <integer>	=>	passenger-max-requests
+
+5.9.7. passenger_max_request_time <seconds>	=>	passenger-max-request-time-seconds--1qod9kg
+
+5.9.8. passenger_memory_limit <integer>	=>	passenger-memory-limit-integer--1ry7dwx
+
+5.9.9. passenger_pre_start <url>	=>	passenger-pre-start-url--1f2phk7
 
 6. Analysis and system maintenance	=>	analysis-and-system-maintenance-1nnlnj8
 
@@ -194,6 +206,8 @@
 
 6.4. Accessing individual application processes	=>	accessing-individual-application-processes-1qe4fqk
 
+6.5. Attaching an IRB console to an application process	=>	attaching-an-irb-console-to-an-application-process-d36enw
+
 7. Tips	=>	tips-n4c22d
 
 7.1. User switching (security)	=>	user-switching-security--zmsy9o

data/doc/Users guide Nginx.txt

@@ -643,6 +643,72 @@ This option may occur in the following places:
 
 In each place, it may be specified at most once. The default value is 'smart-lv2'.
 
+[[PassengerRollingRestarts]]
+=== passenger_rolling_restarts <on|off> ===
+**Available in Phusion Passenger Enterprise since version 3.0.0.**
+
+Enables or disables support for rolling restarts. Normally when you
+restart an application (by touching restart.txt), Phusion Passenger would
+shut down all application processes and spawn a new one. The spawning
+of a new application process could take a while, and any requests that
+come in during this time will be blocked until this first application
+process has spawned.
+
+But when rolling restarts are enabled, Phusion Passenger Enterprise will:
+
+1. Spawn a new process in the background.
+2. When it's done spawning, Phusion Passenger Enterprise will replace one of the old processes with this newly spawned one.
+3. Step 1 and 2 are repeated until all processes have been replaced.
+
+This way, visitors will not experience any delays when you are restarting your application. This allows you to, for example, upgrade your application often without degrading user experience.
+
+Rolling restarts have a few caveat however that you should be aware of:
+
+- Upgrading an application sometimes involves upgrading the database schema.
+  With rolling restarts, there may be a point in time during which processes
+  belonging to the previous version and processes belonging to the new version
+  both exist at the same time. Any database schema upgrades you perform must
+  therefore be backwards-compatible with the old application version.
+- Because there's no telling which process will serve a request, users may
+  not see changes brought about by the new version until all processes have
+  been restarted. It is for this reason that you should not use rolling
+  restarts in development, only in production.
+
+This option may occur in the following places:
+
+ * In the 'http' configuration block.
+ * In a 'server' configuration block.
+ * In a 'location' configuration block.
+ * In an 'if' configuration scope.
+
+In each place, it may be specified at most once. The default value is 'off'.
+
+=== passenger_resist_deployment_errors <on|off> ===
+**Available in Phusion Passenger Enterprise since version 3.0.0.**
+
+Enables or disables resistance against deployment errors.
+
+Suppose you've upgraded your application and you've issues a command to restart it (by touching restart.txt), but the application code contains an error that prevents Phusion Passenger from successfully spawning a process (e.g. a syntax error). Phusion Passenger would normally display an error message in response to this.
+
+By enabling deployment error resistance, Phusion Passenger Enterprise would instead do this:
+
+- It passes the request to one of the existing application processes (that belong to the previous version of the application). The visitor will not see a Phusion Passenger process spawning error message.
+- It logs the error to the global web server error log file.
+- It sets an internal flag so that no processes for this application will be spawned (even when the current traffic would normally result in more processes being spawned) and no processes will be idle cleaned. Processes *could* still be shutdown because of other events, e.g. because their <<PassengerMemoryLimit,memory limit>> have been reached.
+
+This way, visitors will suffer minimally from deployment errors. Phusion Passenger will attempt to restart the application again next time restart.txt is touched.
+
+Enabling deployment error resistance only works if <<PassengerRollingRestarts,rolling restart>> is also enabled.
+
+This option may occur in the following places:
+
+ * In the 'http' configuration block.
+ * In a 'server' configuration block.
+ * In a 'location' configuration block.
+ * In an 'if' configuration scope.
+
+In each place, it may be specified at most once. The default value is 'off'.
+
 === Important deployment options ===
 ==== passenger_enabled <on|off> ====
 This option may be specified in the 'http' configuration block, a
@@ -856,7 +922,7 @@ This option may occur in the following places:
 
 In each place, it may be specified at most once.
 
-==== passenger_user <group name> ====
+==== passenger_group <group name> ====
 If <<user_switching,user switching support>> is enabled, then Phusion Passenger will
 by default run the web application as the primary group of the owner of the file
 'config/environment.rb' (for Rails apps) or 'config.ru' (for Rack apps). This option
@@ -993,6 +1059,38 @@ The passenger_min_instances option may occur in the following places:
 
 In each place, it may be specified at most once. The default value is '1'.
 
+==== passenger_max_instances <integer> ====
+**Available in Phusion Passenger Enterprise since version 3.0.0.**
+
+The maximum number of application processes that may simultaneously exist
+for an application. This helps to make sure that a single application
+will not occupy all available slots in the application pool.
+
+This value must be less than <<PassengerMaxPoolSize,passenger_max_pool_size>>. A value of 0
+means that there is no limit placed on the number of processes a single application
+may spawn, i.e. only the global limit of <<PassengerMaxPoolSize,passenger_max_pool_size>>
+will be enforced.
+
+This option may occur in the following places:
+
+ * In the 'http' configuration block.
+ * In a 'server' configuration block.
+ * In a 'location' configuration block.
+ * In an 'if' configuration scope.
+
+In each place, it may be specified at most once. The default value is '0'.
+
+.Practical usage example
+[TIP]
+===========================================================================
+Suppose that you're hosting two web applications on your server, a personal
+blog and an e-commerce website. You've set <<PassengerMaxPoolSize,passenger_max_pool_size>>
+to 10. The e-commerce website is more important to you. You can then set
+'passenger_max_instances' to 3 for your blog, so that it will never spawn more
+than 3 processes, even if it suddenly gets a lot of traffic. Your e-commerce website
+on the other hand will be free to spawn up to 10 processes if it gets a lot of traffic.
+===========================================================================
+
 ==== passenger_max_instances_per_app <integer> ====
 The maximum number of application processes that may simultaneously exist
 for a single application. This helps to make sure that a single application
@@ -1061,6 +1159,114 @@ problem in your application rather than relying on these directives as a
 measure to avoid memory leaks.
 =====================================================
 
+[[PassengerMaxRequestTime]]
+==== passenger_max_request_time <seconds> ====
+**Available in Phusion Passenger Enterprise since version 3.0.0.**
+
+The maximum amount of time, in seconds, that an application process may take
+to process a request. If the request takes longer than this amount of time,
+then the application process will be forcefully shut down, and possibly
+restarted upon the next request. A value of 0 means that there is no time limit.
+
+This option is useful for preventing your application from freezing for an
+indefinite period of time.
+
+This option may occur in the following places:
+
+ * In the 'http' configuration block.
+ * In a 'server' configuration block.
+ * In a 'location' configuration block.
+ * In an 'if' configuration scope.
+
+In each place, it may be specified at most once. The default value is '0'.
+
+.Example
+Suppose that most of your requests are known to finish within 2 seconds.
+However, there is one URI, '/expensive_computation', which is known to take up
+to 10 seconds. You can then configure Phusion Passenger as follows:
+
+----------------------------------------------
+server {
+    listen 80;
+    server_name www.example.com;
+    root /webapps/my_app/public;
+    passenger_enabled on;
+    passenger_max_request_time 2;
+    location /expensive_compuation {
+        passenger_enabled on;
+        passenger_max_request_time 10;
+    }
+}
+----------------------------------------------
+
+If a request to '/expensive_computation' takes more than 10 seconds,
+or if a request to any other URI takes more than 2 seconds,
+then the corresponding application process will be forced to shutdown.
+
+[CAUTION]
+=====================================================
+The <<PassengerMaxRequestTime,passenger_max_request_time>> directive should be
+considered as a workaround for misbehaving applications. It is advised that you
+fix the problem in your application rather than relying on these directives as a
+measure to avoid freezing applications.
+=====================================================
+
+[[PassengerMemoryLimit]]
+==== passenger_memory_limit <integer> ====
+The maximum amount of memory that an application process may use, in megabytes.
+Once an application process has surpassed its memory limit, it will process
+all the requests currently present in its queue and then shut down.
+A value of 0 means that there is no maximum: the application's memory usage
+will not be checked.
+
+This option is useful if your application is leaking memory. By shutting
+it down, all of its memory is guaranteed to be freed by the operating system.
+
+This option may occur in the following places:
+
+ * In the 'http' configuration block.
+ * In a 'server' configuration block.
+ * In a 'location' configuration block.
+ * In an 'if' configuration scope.
+
+In each place, it may be specified at most once. The default value is '200'.
+
+[NOTE]
+.A word about permissions
+=====================================================
+The <<PassengerMemoryLimit,passenger_memory_limit>> directive requires that the
+user that the application is running as (see <<PassengerUserSwitching,passenger_user_switching>>)
+to have access to the `/proc` file system, or to be able to inspect its status
+with `ps` (which on Linux and FreeBSD systems basically means the same thing, since `ps`
+reads process information from `/proc`). Therefore, on servers running with
+tight permissions on `/proc`, this directive may not work. If you wish to use
+this directive and your `/proc` permissions are too tight, then please consider
+untightening the permissions.
+=====================================================
+
+[TIP]
+.FreeBSD and `/proc`
+=====================================================
+On many FreeBSD systems, `/proc` is not mounted by default. `/proc` *must* be
+mounted in order for <<PassengerMemoryLimit,passenger_memory_limit>> to work.
+
+It is also advised that you mount `/proc` with the `linprocfs` filesystem type
+instead of the regular FreeBSD `proc` filesystem type. The `linprocfs` filesystem
+type allows Phusion Passenger to read memory information from `/proc` directly,
+which is very fast. If you mount `/proc` with a different filesystem type, then
+Phusion Passenger must resort to querying memory information from the `ps` command,
+which is a lot slower.
+=====================================================
+
+[CAUTION]
+=====================================================
+The <<PassengerMaxRequests,passenger_max_requests>> and
+<<PassengerMemoryLimit,passenger_memory_limit>> directives should be considered
+as workarounds for misbehaving applications. It is advised that you fix the
+problem in your application rather than relying on these directives as a
+measure to avoid memory leaks.
+=====================================================
+
 [[PassengerPreStart]]
 ==== passenger_pre_start <url> ====
 By default, Phusion Passenger does not start any application processes until said
@@ -1278,6 +1484,30 @@ error messages should be written to instead.
 
 This option may only occur once, in the 'http' configuration block.
 
+==== passenger_debugger <on|off> ====
+**Available in Phusion Passenger Enterprise since version 3.0.0.**
+
+Turns support for application debugging on or off. In case of Ruby applications,
+turning this option on will cause them to load the `ruby-debug` gem (when on Ruby 1.8)
+or the `debugger` gem (when on Ruby 1.9). If you're using Bundler, you should add
+this to your Gemfile:
+
+-------------------------------------------
+gem 'ruby-debug', :platforms => :ruby_18
+gem 'debugger', :platforms => :ruby_19
+-------------------------------------------
+
+Once debugging is turned on, you can use the command `passenger-irb --debug <PID>` to attach an rdebug console to the application process with the given PID. Attaching will succeed once the application process executes a `debugger` command.
+
+This option may occur in the following places:
+
+ * In the 'http' configuration block.
+ * In a 'server' configuration block.
+ * In a 'location' configuration block.
+ * In an 'if' configuration scope.
+
+In each place, it may be specified at most once. The default value is 'off'.
+
 
 === Ruby on Rails-specific options ===
 [[RailsEnv]]

data/doc/users_guide_snippets/analysis_and_system_maintenance.txt

@@ -198,4 +198,9 @@ through the 'X-Passenger-Connect-Password' HTTP header, like this:
 
 -------------------------------------------
 bash# curl -H "X-Passenger-Connect-Password: nFfVOX1F8LjZ90HJh28Sd_htJOsgRsNne2QXKf8NIXw" http://127.0.0.1:58122/
--------------------------------------------
+-------------------------------------------
+
+=== Attaching an IRB console to an application process ===
+**Available in Phusion Passenger Enterprise since version 3.0.0.**
+
+You can attach an IRB console to any application process and inspect its state by executing arbitrary Ruby code. Do this by invoking `passenger-irb <PID>` where '<PID>' is the PID of the application process you wish to inspect. Note that the IRB console is currently only available for Ruby apps, not for apps in any other languages.

data/ext/common/Constants.h

@@ -26,7 +26,7 @@
 #define _PASSENGER_CONSTANTS_H_
 
 /* Don't forget to update lib/phusion_passenger.rb too. */
-#define PASSENGER_VERSION "3.0.14"
+#define PASSENGER_VERSION "3.0.15"
 
 #define FEEDBACK_FD 3
 

data/lib/phusion_passenger.rb

@@ -25,7 +25,7 @@ module PhusionPassenger
 	###### Version numbers ######
 	
 	# Phusion Passenger version number. Don't forget to edit ext/common/Constants.h too.
-	VERSION_STRING = '3.0.14'
+	VERSION_STRING = '3.0.15'
 	
 	PREFERRED_NGINX_VERSION = '1.2.2'
 	PREFERRED_PCRE_VERSION  = '8.30'

data/lib/phusion_passenger/abstract_installer.rb

@@ -43,7 +43,7 @@ module PhusionPassenger
 #   installer = ConcereteInstallerClass.new(options...)
 #   installer.start
 class AbstractInstaller
-	PASSENGER_WEBSITE = "http://www.modrails.com/"
+	PASSENGER_WEBSITE = "https://www.phusionpassenger.com"
 	PHUSION_WEBSITE = "www.phusion.nl"
 
 	# Create an AbstractInstaller. All options will be stored as instance

data/lib/phusion_passenger/packaging.rb

@@ -42,8 +42,7 @@ module Packaging
 	
 	SUPER_USER_EXECUTABLES = [
 		'passenger-status',
-		'passenger-memory-stats',
-		'passenger-make-enterprisey'
+		'passenger-memory-stats'
 	]
 	
 	# A list of globs which match all files that should be packaged