passenger 5.1.10 → 5.1.11

data/doc/users_guide_snippets/environment_variables.txt

@@ -1,44 +0,0 @@
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/indepth/environment_variables.html
-
-=== Working with environment variables
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/indepth/environment_variables.html#working-with-environment-variables
-
-[[the_path_env_var]]
-=== The PATH environment variable
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/indepth/environment_variables.html#the-path-environment-variable
-
-==== Adding Phusion Passenger's administration tools to PATH
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/indepth/environment_variables.html#adding-passenger-s-administration-tools-to-path
-
-=== Making environment variables permanent
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/indepth/environment_variables.html#making-environment-variables-permanent
-
-==== bash
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/indepth/environment_variables.html#bash
-
-==== Apache
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/indepth/environment_variables.html#apache
-
-==== Nginx
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/indepth/environment_variables.html#nginx
-
-==== cron
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/indepth/environment_variables.html#cron
-
-[[env_vars_passenger_apps]]
-==== Phusion Passenger-served apps
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/indepth/environment_variables.html#passenger-served-apps
-
-[[env_vars_and_sudo]]
-=== Environment variables and sudo
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/indepth/environment_variables.html#environment-variables-and-sudo

data/doc/users_guide_snippets/global_queueing_explained.txt

@@ -1,74 +0,0 @@
-.What does this option do?
-
-Recall that Phusion Passenger spawns multiple backend processes (e.g. multiple
-Ruby on Rails processes), each which processes HTTP requests serially. One of
-Phusion Passenger's jobs is to forward HTTP requests to a suitable backend
-process. A backend process may take an arbitrary amount of time to process a
-specific HTTP request. If the websites are (temporarily) under high load, and
-the backend processes cannot process the requests fast enough, then some
-requests may have to be queued.
-
-If global queuing is turned off, then Phusion Passenger will use 'fair load
-balancing'. This means that each backend process will have its own private
-queue. Phusion Passenger will forward an HTTP request to the backend process
-that has the least amount of requests in its queue.
-
-If global queuing is turned on, then Phusion Passenger will use a global queue
-that's shared between all backend processes. If an HTTP request comes in, and
-all the backend processes are still busy, then Phusion Passenger will wait until
-at least one backend process is done, and will then forward the request to that
-process.
-
-.When to turn on global queuing?
-
-You should turn on global queuing if one of your web applications may have
-long-running requests.
-
-For example suppose that:
-
-- global queuing is turned off.
-- we're currently in a state where all backend processes have 3 requests in
-  their queue, except for a single backend process, which has 1 request in its
-  queue.
-
-The situation looks like this:
-
---------------------------------------------------
-Backend process A:  [*     ]  (1 request in queue)
-Backend process B:  [***   ]  (3 requests in queue)
-Backend process C:  [***   ]  (3 requests in queue)
-Backend process D:  [***   ]  (3 requests in queue)
---------------------------------------------------
-
-Each process is currently serving short-running requests.
-
-Phusion Passenger will forward the next request to backend process A. A will
-now have 2 items in its queue. We'll mark this new request with an X:
-
---------------------------------------------------
-Backend process A:  [*X    ]  (2 request in queue)
-Backend process B:  [***   ]  (3 requests in queue)
-Backend process C:  [***   ]  (3 requests in queue)
-Backend process D:  [***   ]  (3 requests in queue)
---------------------------------------------------
-
-Assuming that B, C and D still aren't done with their current request, the next
-HTTP request - let's call this Y - will be forwarded to backend process A as
-well, because it has the least number of items in its queue:
-
---------------------------------------------------
-Backend process A:  [*XY   ]  (3 requests in queue)
-Backend process B:  [***   ]  (3 requests in queue)
-Backend process C:  [***   ]  (3 requests in queue)
-Backend process D:  [***   ]  (3 requests in queue)
---------------------------------------------------
-
-But if request X happens to be a long-running request that needs 60 seconds to
-complete, then we'll have a problem. Y won't be processed for at least 60
-seconds. It would have been a better idea if Y was forward to processes B, C or
-D instead, because they only have short-living requests in their queues.
-
-This problem will be avoided entirely if you turn global queuing on. With global
-queuing, all backend processes will share the same queue. The first backend
-process that becomes available will take from the queue, and so this
-``queuing-behind-long-running-request'' problem will never occur.

data/doc/users_guide_snippets/installation.txt

@@ -1,228 +0,0 @@
-=== Synopsis
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/
-
-
-[[install_osx_homebrew]]
-=== Installing or upgrading on Mac OS X with Homebrew
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/
-
-
-[[install_on_debian_ubuntu]]
-=== Installing or upgrading on Debian or Ubuntu
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/apt_repo/
-
-[[install_add_apt_repo]]
-==== Adding our APT repository
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/apt_repo/
-
-==== Installing packages
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/apt_repo/
-
-ifdef::nginx[]
-[[inserting_passenger_root_for_apt]]
-==== Inserting `passenger_root` into nginx.conf
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/config/nginx/reference/#passenger_root
-
-endif::nginx[]
-
-
-[[installing_or_upgrading_on_red_hat]]
-=== Installing or upgrading on Red Hat or CentOS
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/yum_repo/
-
-[[install_add_yum_repo]]
-==== Adding our YUM repository
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/yum_repo/
-
-==== Installing packages
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/yum_repo/
-
-
-=== Installing or upgrading on Heroku
-
-Please refer to our link:https://github.com/phusion/passenger-ruby-heroku-demo#readme[Heroku Ruby demo] for installation and upgrade instructions for Heroku.
-
-
-[[rubygems_generic_install]]
-=== Generic installation, upgrade and downgrade method: via RubyGems
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/
-
-
-[[tarball_generic_install]]
-=== Generic installation, upgrade and downgrade method: via tarball
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/
-
-
-=== Upgrading from open source to Enterprise
-
-ifdef::apache[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/nginx/upgrading_from_oss_to_enterprise.html
-endif::[]
-ifdef::nginx[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/apache/upgrading_from_oss_to_enterprise.html
-endif::[]
-ifdef::standalone[]
-This documentation has moved. https://www.phusionpassenger.com/library/install/standalone/upgrading_from_oss_to_enterprise.html
-endif::[]
-
-
-=== Cryptographic verification of installation files
-
-==== Synopsis
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/crypto_verify_install.html
-
-==== Importing the Phusion Software Signing key
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/crypto_verify_install.html
-
-==== Verifying the Phusion Software Signing key
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/crypto_verify_install.html
-
-==== Verifying the gem and tarball
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/crypto_verify_install.html
-
-==== Verifying Git signatures
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/crypto_verify_install.html
-
-==== Verifying Debian packages
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/crypto_verify_install.html
-
-==== Verifying RPM packages
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/crypto_verify_install.html
-
-==== Revocation
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/crypto_verify_install.html
-
-
-ifndef::standalone[]
-=== Non-interactive, automatic, headless installs or upgrades
-
-ifdef::apache[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/apache/noninteractive_install.html
-endif::[]
-ifdef::nginx[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/nginx/noninteractive_install.html
-endif::[]
-endif::[]
-
-
-=== Customizing the compilation process
-
-ifdef::apache[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/apache/customizing_compilation_process.html
-endif::[]
-ifdef::nginx[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/nginx/customizing_compilation_process.html
-endif::[]
-
-==== Setting the compiler
-
-ifdef::apache[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/apache/customizing_compilation_process.html
-endif::[]
-ifdef::nginx[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/nginx/customizing_compilation_process.html
-endif::[]
-
-==== Adding additional compiler or linker flags
-
-ifdef::apache[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/apache/customizing_compilation_process.html
-endif::[]
-ifdef::nginx[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/nginx/customizing_compilation_process.html
-endif::[]
-
-[[forcing_location_of_command_line_tools_and_dependencies]]
-==== Forcing location of command line tools and dependencies
-
-ifdef::apache[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/apache/customizing_compilation_process.html
-endif::[]
-ifdef::nginx[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/nginx/customizing_compilation_process.html
-endif::[]
-
-
-ifdef::apache[]
-[[multiple_apache_installs]]
-=== Dealing with multiple Apache installations
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/apache/multiple_apache_installs.html
-
-[[working_with_apache_conf]]
-=== Working with the Apache configuration file
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/apache/working_with_the_apache_config_file.html
-endif::[]
-
-
-ifdef::nginx[]
-=== Installing as a normal Nginx module without using the installer
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/nginx/install_as_nginx_module.html
-
-
-[[nginx_init_script]]
-=== Creating an Nginx init script
-
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/nginx/nginx_init_script.html
-endif::[]
-
-
-ifndef::standalone[]
-=== Disabling without uninstalling
-
-ifdef::apache[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/apache/disable.html
-endif::[]
-ifdef::nginx[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/nginx/disable.html
-endif::[]
-endif::[]
-
-[[uninstalling]]
-=== Uninstalling
-
-ifdef::apache[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/apache/uninstall/
-endif::[]
-ifdef::nginx[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/nginx/uninstall/
-endif::[]
-ifdef::standalone[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/standalone/uninstall/
-endif::[]
-
-
-[[moving_phusion_passenger]]
-=== Moving to a different directory
-
-
-ifdef::apache[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/apache/moving.html
-endif::[]
-ifdef::nginx[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/nginx/moving.html
-endif::[]
-ifdef::standalone[]
-This documentation has moved. Please visit https://www.phusionpassenger.com/library/install/standalone/moving.html
-endif::[]

data/doc/users_guide_snippets/installation/run_installer.txt

@@ -1,58 +0,0 @@
-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

@@ -1,6 +0,0 @@
-You should see the web server processes as well as a number of Phusion Passenger processes (e.g. PassengerAgent watchdog, PassengerAgent core). 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/passenger_spawn_method.txt

@@ -1,37 +0,0 @@
-Internally, Phusion Passenger spawns multiple Ruby application processes in order to handle
-requests. But there are multiple ways with which processes can be spawned, each having
-its own set of pros and cons. Supported spawn methods are:
-
-'smart'::
-This spawning method caches code using the app preloader. Framework code is not
-cached between multiple applications, although it is cached within
-instances of the same application. Please read
-<<spawning_methods_explained,Spawning methods explained>> for a more detailed
-explanation of what smart spawning exactly does.
-+
-*Pros:*
-Smart spawning caches code where possible to speed up the respawn process
-and is compatible with most applications
-+
-*Cons:*
-It is possible that it may be incompatible with some applications
-
-'direct'::
-This spawning method is similar to the one used in Mongrel Cluster. It does not
-perform any code caching at all. Please read
-<<spawning_methods_explained,Spawning methods explained>> for a more detailed
-explanation of what direct spawning exactly does.
-+
-*Pros:*
-Direct spawning is guaranteed to be compatible with all applications
-and libraries.
-+
-*Cons:*
-Much slower than smart spawning. Every spawn action will be equally slow, though no slower than
-the startup time of a single server in Mongrel Cluster. Direct spawning will also
-render <<reducing_memory_usage,Ruby Enterprise Edition's memory reduction technology>> useless.
-
-************************************************
-As of Phusion Passenger 4.0, 'conservative' spawning was renamed to 'direct' and 'smart-lv2' was renamed
-to 'smart'. The old 'smart' spawning has been removed in favor of the new version.
-************************************************