passenger 5.0.14 → 5.0.15

data/doc/Users guide.html

@@ -1073,161 +1073,19 @@ pre {
 <img src="images/phusion_banner.png" alt="images/phusion_banner.png">
 </a>
 </span></p></div>
-<div class="paragraph"><p><a href="https://www.phusionpassenger.com/">Phusion Passenger</a> is a web server and application server, designed to be fast, robust and lightweight. It runs your web apps with the least amount of hassle by taking care of almost all administrative heavy lifting for you. Advanced administration tools allow you to gain deep insight into your web applications' operations and to keep your servers healthy. Phusion Passenger is polyglot by design, and currently supports Ruby (Rack), Python (WSGI) and Node.js.</p></div>
-<div class="paragraph"><p>Phusion Passenger has several integration modes, each mode with its own documentation, covering <strong>installation</strong>, <strong>usage</strong>, <strong>troubleshooting</strong> and more.</p></div>
 </div>
 </div>
 <div id="toc">
 <div id="toctitle">Table of Contents</div>
-<div class="foo toclevel2"><a href="#overview">1. Overview</a></div>
-<div class="foo toclevel3"><a href="#_nginx_integration_mode">1.1. Nginx integration mode</a></div>
-<div class="foo toclevel3"><a href="#_apache_integration_mode">1.2. Apache integration mode</a></div>
-<div class="foo toclevel3"><a href="#_standalone_mode">1.3. Standalone mode</a></div>
-<div class="foo toclevel2"><a href="#installation">2. Installation and upgrade</a></div>
-<div class="foo toclevel2"><a href="#troubleshooting">3. Troubleshooting</a></div>
-<div class="foo toclevel2"><a href="#support">4. Where to get support</a></div>
-<div class="foo toclevel2"><a href="#_appendix_a_about_this_document">5. Appendix A: About this document</a></div>
+<div class="foo toclevel2"><a href="#_the_documentation_has_moved">1. The documentation has moved</a></div>
 </div>
 </div>
 <div id="content">
 
 <div class="sect1">
-<span class="anchor_helper" id="overview"></span><h2 data-anchor="overview">1. Overview</h2>
+<span class="anchor_helper" id="_the_documentation_has_moved"></span><h2 data-anchor="_the_documentation_has_moved">1. The documentation has moved</h2>
 <div class="sectionbody">
-<div class="sect2">
-<span class="anchor_helper" id="_nginx_integration_mode"></span><h3 data-anchor="_nginx_integration_mode">1.1. Nginx integration mode</h3>
-<div class="paragraph"><p>In this mode, Phusion Passenger integrates directly into Nginx as an Nginx module. You operate Phusion Passenger mostly through Nginx and through Nginx configuration files. The Nginx integration mode is, along with the Standalone mode, highly optimized for performance.</p></div>
-<div class="paragraph"><p><a href="Users%20guide%20Nginx.html"><strong>Read the documentation for the Nginx integration mode &gt;&gt;</strong></a></p></div>
-</div>
-<div class="sect2">
-<span class="anchor_helper" id="_apache_integration_mode"></span><h3 data-anchor="_apache_integration_mode">1.2. Apache integration mode</h3>
-<div class="paragraph"><p>In this mode, Phusion Passenger integrates directly into Apache as an Apache module. You operate Phusion Passenger mostly through Apache and through Apache configuration files.</p></div>
-<div class="paragraph"><p><a href="Users%20guide%20Apache.html"><strong>Read the documentation for the Apache integration mode &gt;&gt;</strong></a></p></div>
-</div>
-<div class="sect2">
-<span class="anchor_helper" id="_standalone_mode"></span><h3 data-anchor="_standalone_mode">1.3. Standalone mode</h3>
-<div class="paragraph"><p>In this mode, Phusion Passenger operates as a fully-featured, secure standalone HTTP server. You do not need to have an existing web server like Apache or Nginx. This mode is ideal…</p></div>
-<div class="ulist"><ul>
-<li>
-<p>
-…if you are not familiar with Apache or Nginx
-</p>
-</li>
-<li>
-<p>
-…when you want to quickly start up a server without editing configuration files (e.g. during development)
-</p>
-</li>
-<li>
-<p>
-…or when you want to decouple the web server from the application server, by setting up reverse proxies.
-</p>
-</li>
-</ul></div>
-<div class="paragraph"><p>Along with the Nginx mode, the Standalone mode is highly optimized for performance.</p></div>
-<div class="paragraph"><p><a href="Users%20guide%20Standalone.html"><strong>Read the documentation for the Standalone mode &gt;&gt;</strong></a></p></div>
-</div>
-</div>
-</div>
-<div class="sect1">
-<span class="anchor_helper" id="installation"></span><h2 data-anchor="installation">2. Installation and upgrade</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>Please refer to:</p></div>
-<div class="ulist"><ul>
-<li>
-<p>
-<a href="Users%20guide%20Nginx.html#installation"><strong>Nginx</strong> mode installation &amp; upgrade</a>
-</p>
-</li>
-<li>
-<p>
-<a href="Users%20guide%20Apache.html#installation"><strong>Apache</strong> mode installation &amp; upgrade</a>
-</p>
-</li>
-<li>
-<p>
-<a href="Users%20guide%20Standalone.html#installation"><strong>Standalone</strong> mode installation &amp; upgrade</a>
-</p>
-</li>
-</ul></div>
-</div>
-</div>
-<div class="sect1">
-<span class="anchor_helper" id="troubleshooting"></span><h2 data-anchor="troubleshooting">3. Troubleshooting</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>Please refer to:</p></div>
-<div class="ulist"><ul>
-<li>
-<p>
-<a href="Users%20guide%20Nginx.html#troubleshooting"><strong>Nginx</strong> mode troubleshooting</a>
-</p>
-</li>
-<li>
-<p>
-<a href="Users%20guide%20Apache.html#troubleshooting"><strong>Apache</strong> mode troubleshooting</a>
-</p>
-</li>
-<li>
-<p>
-<a href="Users%20guide%20Standalone.html#troubleshooting"><strong>Standalone</strong> mode troubleshooting</a>
-</p>
-</li>
-</ul></div>
-</div>
-</div>
-<div class="sect1">
-<span class="anchor_helper" id="support"></span><h2 data-anchor="support">4. Where to get support</h2>
-<div class="sectionbody">
-<div class="ulist"><ul>
-<li>
-<p>
-<a href="http://groups.google.com/group/phusion-passenger">Community discussion forum</a> - 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.
-</p>
-</li>
-<li>
-<p>
-<a href="https://github.com/phusion/passenger/issues">Issue tracker</a> - report
-  bugs here.
-</p>
-</li>
-<li>
-<p>
-Email <a href="mailto:support@phusion.nl">support@phusion.nl</a> if you are a <a href="https://www.phusionpassenger.com/enterprise">Phusion Passenger Enterprise</a> customer. Please mention your order reference. If you are not an Enterprise customer, we kindly redirect you to the community discussion forum instead.
-</p>
-</li>
-<li>
-<p>
-<a href="https://www.phusionpassenger.com/commercial_support">Commercial support contracts</a> are also available.
-</p>
-</li>
-<li>
-<p>
-Report security vulnerabilities to <a href="mailto:security@phusion.nl">security@phusion.nl</a>. We will do our best to respond to you as quickly as we can, so please do not disclose the vulnerability until then.
-</p>
-</li>
-</ul></div>
-<div class="paragraph"><p>Please consult <a href="https://www.phusionpassenger.com/support">the Phusion Passenger website</a> for a full list of support resources.</p></div>
-</div>
-</div>
-<div class="sect1">
-<span class="anchor_helper" id="_appendix_a_about_this_document"></span><h2 data-anchor="_appendix_a_about_this_document">5. Appendix A: About this document</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>The text of this document is licensed under the
-<a href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons
-Attribution-Share Alike 3.0 Unported License</a>.</p></div>
-<div class="paragraph"><p><span class="image">
-<a class="image" href="http://creativecommons.org/licenses/by-sa/3.0/">
-<img src="images/by_sa.png" alt="images/by_sa.png">
-</a>
-</span></p></div>
-<div class="paragraph"><p>Phusion Passenger is brought to you by <a href="http://www.phusion.nl/">Phusion</a>.</p></div>
-<div class="paragraph"><p><span class="image">
-<a class="image" href="http://www.phusion.nl/">
-<img src="images/phusion_banner.png" alt="images/phusion_banner.png">
-</a>
-</span></p></div>
-<div class="paragraph"><p>Phusion Passenger is a trademark of Hongli Lai &amp; Ninh Bui.</p></div>
+<div class="paragraph"><p>This is the old, deprecated Passenger Standalone documentation. Please visit <a href="https://www.phusionpassenger.com/library/">https://www.phusionpassenger.com/library/</a> for the new documentation.</p></div>
 </div>
 </div>
 </div>

data/doc/Users guide.txt

@@ -3,58 +3,6 @@ Phusion Passenger users guide index
 
 image:images/phusion_banner.png[link="http://www.phusion.nl/"]
 
-link:https://www.phusionpassenger.com/[Phusion Passenger] is a web server and application server, designed to be fast, robust and lightweight. It runs your web apps with the least amount of hassle by taking care of almost all administrative heavy lifting for you. Advanced administration tools allow you to gain deep insight into your web applications' operations and to keep your servers healthy. Phusion Passenger is polyglot by design, and currently supports Ruby (Rack), Python (WSGI) and Node.js.
+== The documentation has moved
 
-Phusion Passenger has several integration modes, each mode with its own documentation, covering *installation*, *usage*, *troubleshooting* and more.
-
-[[overview]]
-== Overview
-
-=== Nginx integration mode
-
-In this mode, Phusion Passenger integrates directly into Nginx as an Nginx module. You operate Phusion Passenger mostly through Nginx and through Nginx configuration files. The Nginx integration mode is, along with the Standalone mode, highly optimized for performance.
-
-link:Users%20guide%20Nginx.html[**Read the documentation for the Nginx integration mode >>**]
-
-=== Apache integration mode
-
-In this mode, Phusion Passenger integrates directly into Apache as an Apache module. You operate Phusion Passenger mostly through Apache and through Apache configuration files.
-
-link:Users%20guide%20Apache.html[**Read the documentation for the Apache integration mode >>**]
-
-=== Standalone mode
-
-In this mode, Phusion Passenger operates as a fully-featured, secure standalone HTTP server. You do not need to have an existing web server like Apache or Nginx. This mode is ideal...
-
- * ...if you are not familiar with Apache or Nginx
- * ...when you want to quickly start up a server without editing configuration files (e.g. during development)
- * ...or when you want to decouple the web server from the application server, by setting up reverse proxies.
-
-Along with the Nginx mode, the Standalone mode is highly optimized for performance.
-
-link:Users%20guide%20Standalone.html[**Read the documentation for the Standalone mode >>**]
-
-[[installation]]
-== Installation and upgrade
-
-Please refer to:
-
- * link:Users%20guide%20Nginx.html#installation[**Nginx** mode installation & upgrade]
- * link:Users%20guide%20Apache.html#installation[**Apache** mode installation & upgrade]
- * link:Users%20guide%20Standalone.html#installation[**Standalone** mode installation & upgrade]
-
-[[troubleshooting]]
-== Troubleshooting
-
-Please refer to:
-
- * link:Users%20guide%20Nginx.html#troubleshooting[**Nginx** mode troubleshooting]
- * link:Users%20guide%20Apache.html#troubleshooting[**Apache** mode troubleshooting]
- * link:Users%20guide%20Standalone.html#troubleshooting[**Standalone** mode troubleshooting]
-
-[[support]]
-== Where to get support
-
-include::users_guide_snippets/where_to_get_support.txt[]
-
-include::users_guide_snippets/appendix_a_about.txt[]
+This is the old, deprecated Passenger Standalone documentation. Please visit https://www.phusionpassenger.com/library/ for the new documentation.

data/doc/users_guide_snippets/analysis_and_system_maintenance.txt

@@ -1,128 +1,27 @@
-Phusion Passenger provides a set of tools, which are useful for system analysis,
-maintenance and troubleshooting.
-
-
 === Inspecting memory usage ===
 
-Process inspection tools such as `ps` and `top` are useful, but they
-link:http://groups.google.com/group/phusion-passenger/msg/1fd1c233456d3180[rarely show the correct memory usage].
-The real memory usage is usually lower than what `ps` and `top` report.
-
-There are many technical reasons why this is so, but an explanation is beyond
-the scope of this Users Guide. We kindly refer the interested reader to
-operating systems literature about 'virtual memory' and 'copy-on-write'.
-
-The tool `passenger-memory-stats` allows one to easily analyze Phusion Passenger's
-and the web server's real memory usage. For example:
-
--------------------------------------------------------
-[bash@localhost root]# passenger-memory-stats
-------------- Apache processes --------------.
-PID    PPID  Threads  VMSize   Private  Name
----------------------------------------------.
-5947   1     9        90.6 MB  0.5 MB   /usr/sbin/apache2 -k start
-5948   5947  1        18.9 MB  0.7 MB   /usr/sbin/fcgi-pm -k start
-6029   5947  1        42.7 MB  0.5 MB   /usr/sbin/apache2 -k start
-6030   5947  1        42.7 MB  0.5 MB   /usr/sbin/apache2 -k start
-6031   5947  1        42.5 MB  0.3 MB   /usr/sbin/apache2 -k start
-6033   5947  1        42.5 MB  0.4 MB   /usr/sbin/apache2 -k start
-6034   5947  1        50.5 MB  0.4 MB   /usr/sbin/apache2 -k start
-23482  5947  1        82.6 MB  0.4 MB   /usr/sbin/apache2 -k start
-### Processes: 8
-### Total private dirty RSS: 3.50 MB
-
------------ Nginx processes ------------.
-PID    PPID   VMSize     Resident  Name
-----------------------------------------.
-51766  51764  82.7 MB    3.9 MB    nginx: master process ./objs/nginx
-51773  51766  82.9 MB    0.9 MB    nginx: worker process
-
---------- Passenger processes ---------.
-PID    Threads  VMSize   Private  Name
----------------------------------------.
-6026   1        10.9 MB  4.7 MB   Passenger spawn server
-23481  1        26.7 MB  3.0 MB   Passenger FrameworkSpawner: 2.0.2
-23791  1        26.8 MB  2.9 MB   Passenger ApplicationSpawner: /var/www/projects/app1-foobar
-23793  1        26.9 MB  17.1 MB  Rails: /var/www/projects/app1-foobar
-### Processes: 4
-### Total private dirty RSS: 27.76 M
--------------------------------------------------------
-
-The 'Private' or 'private dirty RSS' field shows the *real* memory usage of processes. Here,
-we see that all the Apache and Nginx worker processes only take less than 1 MB memory each.
-This is a lot less than the 50-80 MB-ish memory usage as shown in the 'VMSize' column
-(which is what a lot of people think is the real memory usage, but is actually not).
-
-NOTE: Private dirty RSS reporting only works on Linux. Unfortunately other operating systems
-don't provide facilities for determining processes' private dirty RSS. On non-Linux systems,
-the Resident Set Size is reported instead.
+ifdef::apache[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/apache/overall_status_report.html
+endif::[]
+ifdef::nginx[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/nginx/overall_status_report.html
+endif::[]
+ifdef::standalone[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/standalone/overall_status_report.html
+endif::[]
 
 
 === Inspecting Phusion Passenger's internal status ===
 
-One can inspect Phusion Passenger's internal status with the tool `passenger-status`.
-This tool must typically be run as root. For example:
-
---------------------------------------------------
-[bash@localhost root]# passenger-status
------------ General information -----------
-max      = 6
-count    = 1
-active   = 0
-inactive = 1
-
------------ Domains -----------
-/var/www/projects/app1-foobar: 
-  PID: 9617      Sessions: 0    Processed: 7       Uptime: 2m 23s
---------------------------------------------------
-
-The 'general information' section shows the following information:
-
-max:: The maximum number of application instances that Phusion Passenger will
-spawn. This equals the value given for <<PassengerMaxPoolSize,PassengerMaxPoolSize>> (Apache)
-or <<PassengerMaxPoolSize,passenger_max_pool_size>> (Nginx).
-count:: The number of application instances that are currently alive. This value
-is always less than or equal to 'max'.
-active:: The number of application instances that are currently processing
-requests. This value is always less than or equal to 'count'.
-inactive:: The number of application instances that are currently *not* processing
-requests, i.e. are idle. Idle application instances will be shutdown after a while,
-as can be specified with <<PassengerPoolIdleTime,PassengerPoolIdleTime (Apache)>>/<<PassengerPoolIdleTime,passenger_pool_idle_time (Nginx)>> (unless this
-value is set to 0, in which case application instances are never shut down via idle
-time). The value of 'inactive' equals `count - active`.
-
-The 'domains' section shows, for each application directory, information about running
-application instances:
-
-Sessions:: Shows how many HTTP client are currently in the queue of that application
-Instance, waiting to be processed.
-Processed:: Indicates how many requests the instance has served until now. *Tip:* it's
-possible to limit this number with the <<PassengerMaxRequests,PassengerMaxRequests>>
-configuration directive.
-Uptime:: Shows for how long the application instance has been running.
-
-Since Phusion Passenger uses fair load balancing by default, the number of sessions for the
-application instances should be fairly close to each other. For example, this is fairly
-normal:
---------------------------------
-  PID: 4281      Sessions: 2      Processed: 7      Uptime: 5m 11s
-  PID: 4268      Sessions: 0      Processed: 5      Uptime: 4m 52s
-  PID: 4265      Sessions: 1      Processed: 6      Uptime: 5m 38s
-  PID: 4275      Sessions: 1      Processed: 7      Uptime: 3m 14s
---------------------------------
-
-But if you see a "spike", i.e. an application instance has an unusually high number of
-sessions compared to the others, then there might be a problem:
---------------------------------
-  PID: 4281      Sessions: 2      Processed: 7      Uptime: 5m 11s
-  PID: 17468     Sessions: 8 <-+  Processed: 2      Uptime: 4m 47s
-  PID: 4265      Sessions: 1   |  Processed: 6      Uptime: 5m 38s
-  PID: 4275      Sessions: 1   |  Processed: 7      Uptime: 3m 14s
-                               |
-                               +---- "spike"
---------------------------------
-
-The most likely reason why a spike occurs is because your application is frozen, i.e. it has stopped responding. See <<debugging_frozen,Debugging frozen applications>> for tips.
+ifdef::apache[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/apache/overall_status_report.html
+endif::[]
+ifdef::nginx[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/nginx/overall_status_report.html
+endif::[]
+ifdef::standalone[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/standalone/overall_status_report.html
+endif::[]
 
 
 [[debugging_frozen]]
@@ -139,62 +38,24 @@ a backtrace without aborting.
 
 === Accessing individual application processes ===
 
-When a request is sent to the web server, Phusion Passenger will automatically forward
-the request to the most suitable application process, but sometimes it is desirable to
-be able to directly access the individual application processes. Use cases include, but
-are not limited to:
-
-* One wants to debug a memory leak or memory bloat problem that only seems to appear on
-  certain URIs. One can send a request to a specific process to see whether that request
-  causes the process's memory usage to rise.
-* The application caches data in local memory, and one wants to tell a specific
-  application process to clear that local data.
-* Other debugging use cases.
-
-All individual application processes are accessible via HTTP, so you can use standard
-HTTP tools like 'curl'. The exact addresses can be obtained with the command
-`passenger-status --verbose`. These sockets are all bound to 127.0.0.1, but the port
-number is dynamically assigned. As a security measure, the sockets are also protected
-with a process-specific random password, which you can see in the
-`passenger-status --verbose` output. This password must be sent through the
-``X-Passenger-Connect-Password'' HTTP header.
-
-Example:
-
-[listing]
-......................................
-bash# passenger-status --verbose
------------ General information -----------
-max      = 6
-count    = 2
-active   = 0
-inactive = 2
-Waiting on global queue: 0
-
------------ Application groups -----------
-/Users/hongli/Sites/rack.test:
-  App root: /Users/hongli/Sites/rack.test
-  * PID: 24235   Sessions: 0    Processed: 7       Uptime: 17s
-      URL     : http://127.0.0.1:58122
-      Password: nFfVOX1F8LjZ90HJh28Sd_htJOsgRsNne2QXKf8NIXw
-  * PID: 24250   Sessions: 0    Processed: 4       Uptime: 1s
-      URL     : http://127.0.0.1:57933
-      Password: _RGXlQ9EGDGJKLevQ_qflUtF1KmxEo2UiRzMwIE1sBY
-......................................
-
-Here we see that the web application 'rack.test' has two processes.
-Process 24235 is accessible via http://127.0.0.1:58122, and
-process 24250 is accessible via http://127.0.0.1:57933.
-
-To access 24235 we must send its password, 'nFfVOX1F8LjZ90HJh28Sd_htJOsgRsNne2QXKf8NIXw',
-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/
--------------------------------------------
+ifdef::apache[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/apache/request_individual_processes.html
+endif::[]
+ifdef::nginx[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/nginx/request_individual_processes.html
+endif::[]
+ifdef::standalone[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/standalone/request_individual_processes.html
+endif::[]
 
 === Attaching an IRB console to an application process ===
-:version: 3.0.0
-include::enterprise_only.txt[]
 
-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.
+ifdef::apache[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/apache/debugging_console/
+endif::[]
+ifdef::nginx[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/nginx/debugging_console/
+endif::[]
+ifdef::standalone[]
+This documentation has moved. Please visit https://www.phusionpassenger.com/library/admin/standalone/debugging_console/
+endif::[]