-
Notifications
You must be signed in to change notification settings - Fork 547
/
Users guide Apache.txt
2390 lines (1810 loc) · 97.3 KB
/
Users guide Apache.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
Phusion Passenger users guide, Apache version
=============================================
image:images/phusion_banner.png[link="http://www.phusion.nl/"]
Phusion Passenger is an application server which can directly integrate into Apache. It is designed to be easy to use, fast, stable and reliable and is used by link:http://trends.builtwith.com/Web-Server/Phusion-Passenger[hundreds of thousands of websites] all over the world.
Phusion Passenger is a so-called polyglot application server because it supports applications written in multiple programming languages. At this time, Ruby and Python are supported.
This users guide will teach you:
- How to install Phusion Passenger.
- How to configure Phusion Passenger.
- How to deploy Ruby and Python applications.
- How to solve common problems.
This guide assumes that the reader is somewhat familiar with Apache and with
using the command line.
== Support information
include::users_guide_snippets/support_information.txt[]
== Installation
include::users_guide_snippets/installation.txt[]
== Deploying a Ruby on Rails 1.x or 2.x (but NOT Rails >= 3.x) application ==
Suppose you have a Ruby on Rails application in '/webapps/mycook', and you own
the domain 'www.mycook.com'. You can either deploy your application to the
virtual host's root (i.e. the application will be accessible from the root URL,
'http://www.mycook.com/'), or in a sub URI (i.e. the application will be
accessible from a sub URL, such as 'http://www.mycook.com/railsapplication').
NOTE: The default `RAILS_ENV` environment in which deployed Rails applications
are run, is ``production''. You can change this by changing the
<<rails_env,'RailsEnv'>> configuration option.
=== Deploying to a virtual host's root ===
Add a virtual host entry to your Apache configuration file. Make sure that the
following conditions are met:
- The virtual host's document root must point to your Ruby on Rails application's
'public' folder.
- The Apache per-directory permissions must allow access to this folder.
- MultiViews must be disabled for this folder.
For example:
-------------------------------------------
<VirtualHost *:80>
ServerName www.mycook.com
DocumentRoot /webapps/mycook/public
<Directory /webapps/mycook/public>
Allow from all
Options -MultiViews
</Directory>
</VirtualHost>
-------------------------------------------
You may also need to tweak your file/folder permissions. Make sure that the
following folders are readable and executable by Apache:
* this 'public' folder.
* the application's 'config' folder.
* all parent folders. That is, /webapps/mycook and /webapps must also be readable and executable by Apache.
Then restart Apache. The application has now been deployed.
[[deploying_rails_to_sub_uri]]
=== Deploying to a sub URI ===
Suppose that you already have a virtual host:
-------------------------------------------
<VirtualHost *:80>
ServerName www.phusion.nl
DocumentRoot /websites/phusion
<Directory /websites/phusion>
Allow from all
</Directory>
</VirtualHost>
-------------------------------------------
And you want your Ruby on Rails application to be accessible from the URL
'http://www.phusion.nl/rails'.
To do this, make a symlink in the virtual host's document root, and have it
point to your Ruby on Rails application's 'public' folder. For example:
-------------------------------------------
ln -s /webapps/mycook/public /websites/phusion/rails
-------------------------------------------
Next, add a <<RailsBaseURI,RailsBaseURI>> option to the virtual host configuration,
and also make sure that:
- The Apache per-directory permissions allow access to this folder.
- MultiViews is disabled for this folder.
For example:
-------------------------------------------
<VirtualHost *:80>
ServerName www.phusion.nl
DocumentRoot /websites/phusion
<Directory /websites/phusion>
Allow from all
</Directory>
RailsBaseURI /rails # <-- These lines have
<Directory /websites/phusion/rails> # <-- been added.
Options -MultiViews # <--
</Directory> # <--
</VirtualHost>
-------------------------------------------
Then restart Apache. The application has now been deployed.
NOTE: If you're deploying to a sub-URI then please make sure that your view
templates correctly handles references to sub-URI static assets! Otherwise
you may find broken links to images, CSS files, JavaScripts, etc. Please read
<<sub_uri_deployment_uri_fix,How to fix broken images/CSS/JavaScript URIs in sub-URI deployments>>
for more information.
[TIP]
======================================
You can deploy multiple Rails applications under a virtual host, by specifying
<<RailsBaseURI,RailsBaseURI>> multiple times. For example:
---------------------------------
<VirtualHost *:80>
....
RailsBaseURI /app1
RailsBaseURI /app2
RailsBaseURI /app3
</VirtualHost>
---------------------------------
======================================
=== Redeploying (restarting the Ruby on Rails application) ===
Deploying a new version of a Ruby on Rails application is as simple as
re-uploading the application files, and restarting the application.
There are two ways to restart the application:
1. By restarting Apache.
2. By creating or modifying the file 'tmp/restart.txt' in the Rails
application's <<application_root,root folder>>. Phusion Passenger will
automatically restart the application during the next request.
For example, to restart our example MyCook application, we type this in the
command line:
-------------------------------------------
touch /webapps/mycook/tmp/restart.txt
-------------------------------------------
Please note that, unlike earlier versions of Phusion Passenger, 'restart.txt'
is not automatically deleted. Phusion Passenger checks whether the timestamp
of this file has changed in order to determine whether the application should
be restarted.
=== Migrations ===
Phusion Passenger is not related to Ruby on Rails migrations in any way. To
run migrations on your deployment server, please login to your deployment
server (e.g. with 'ssh') and type `rake db:migrate RAILS_ENV=production` in
a shell console, just like one would normally run migrations.
=== Capistrano integration ===
See <<capistrano,Capistrano recipe>>.
== Deploying a Rack-based Ruby application (including Rails >= 3) ==
Phusion Passenger supports arbitrary Ruby web applications that follow the
link:http://rack.rubyforge.org/[Rack] interface.
Phusion Passenger assumes that Rack application directories have a certain layout.
Suppose that you have a Rack application in '/webapps/rackapp'. Then that
folder must contain at least three entries:
- 'config.ru', a Rackup file for starting the Rack application. This file must contain
the complete logic for initializing the application.
- 'public/', a folder containing public static web assets, like images and stylesheets.
- 'tmp/', used for 'restart.txt' (our application restart mechanism). This will
be explained in a following subsection.
So '/webapps/rackapp' must, at minimum, look like this:
----------------------
/webapps/rackapp
|
+-- config.ru
|
+-- public/
|
+-- tmp/
----------------------
Suppose you own the domain 'www.rackapp.com'. You can either deploy your application
to the virtual host's root (i.e. the application will be accessible from the root URL,
'http://www.rackapp.com/'), or in a sub URI (i.e. the application will be
accessible from a sub URL, such as 'http://www.rackapp.com/rackapp').
NOTE: The default `RACK_ENV` environment in which deployed Rack applications
are run, is ``production''. You can change this by changing the
<<rack_env,'RackEnv'>> configuration option.
=== Tutorial/example: writing and deploying a Hello World Rack application ===
First we create a Phusion Passenger-compliant Rack directory structure:
-------------------------------------------
$ mkdir /webapps/rack_example
$ mkdir /webapps/rack_example/public
$ mkdir /webapps/rack_example/tmp
-------------------------------------------
Next, we write a minimal "hello world" Rack application:
-------------------------------------------
$ cd /webapps/rack_example
$ some_awesome_editor config.ru
...type in some source code...
$ cat config.ru
app = proc do |env|
[200, { "Content-Type" => "text/html" }, ["hello <b>world</b>"]]
end
run app
-------------------------------------------
Finally, we deploy it by adding the following configuration options to
the Apache configuration file:
-------------------------------------------
<VirtualHost *:80>
ServerName www.rackexample.com
DocumentRoot /webapps/rack_example/public
<Directory /webapps/rack_example/public>
Allow from all
Options -MultiViews
</Directory>
</VirtualHost>
-------------------------------------------
And we're done! After an Apache restart, the above Rack application will be available
under the URL 'http://www.rackexample.com/'.
=== Deploying to a virtual host's root ===
Add a virtual host entry to your Apache configuration file. Make sure that the
following conditions are met:
- The virtual host's document root must point to your Rack application's
'public' folder.
- The Apache per-directory permissions must allow access to this folder.
- MultiViews must be disabled for this folder.
For example:
-------------------------------------------
<VirtualHost *:80>
ServerName www.rackapp.com
DocumentRoot /webapps/rackapp/public
<Directory /webapps/rackapp/public>
Allow from all
Options -MultiViews
</Directory>
</VirtualHost>
-------------------------------------------
You may also need to tweak your file/folder permissions. Make sure that the
following folders are readable and executable by Apache:
* this 'public' folder.
* the application's 'config' folder.
* all parent folders. That is, /webapps/rackapp and /webapps must also be readable and executable by Apache.
Then restart Apache. The application has now been deployed.
[[deploying_rack_to_sub_uri]]
=== Deploying to a sub URI ===
Suppose that you already have a virtual host:
-------------------------------------------
<VirtualHost *:80>
ServerName www.phusion.nl
DocumentRoot /websites/phusion
<Directory /websites/phusion>
Allow from all
</Directory>
</VirtualHost>
-------------------------------------------
And you want your Rack application to be accessible from the URL
'http://www.phusion.nl/rack'.
To do this, make a symlink in the virtual host's document root, and have it
point to your Rack application's 'public' folder. For example:
-------------------------------------------
ln -s /webapps/rackapp/public /websites/phusion/rack
-------------------------------------------
Next, add a <<RackBaseURI,RackBaseURI>> option to the virtual host configuration,
and also make sure that:
- The Apache per-directory permissions allow access to this folder.
- MultiViews is disabled for this folder.
For example:
-------------------------------------------
<VirtualHost *:80>
ServerName www.phusion.nl
DocumentRoot /websites/phusion
<Directory /websites/phusion>
Allow from all
</Directory>
RackBaseURI /rack # <-- These lines have
<Directory /websites/phusion/rack> # <-- been added.
Options -MultiViews # <--
</Directory> # <--
</VirtualHost>
-------------------------------------------
Then restart Apache. The application has now been deployed.
[TIP]
======================================
You can deploy multiple Rack applications under a virtual host, by specifying
<<RackBaseURI,RackBaseURI>> multiple times. For example:
---------------------------------
<VirtualHost *:80>
....
RackBaseURI /app1
RackBaseURI /app2
RackBaseURI /app3
</VirtualHost>
---------------------------------
======================================
=== Redeploying (restarting the Rack application) ===
Deploying a new version of a Rack application is as simple as
re-uploading the application files, and restarting the application.
There are two ways to restart the application:
1. By restarting Apache.
2. By creating or modifying the file 'tmp/restart.txt' in the Rack
application's <<application_root,root folder>>. Phusion Passenger will
automatically restart the application.
For example, to restart our example application, we type this in the
command line:
-------------------------------------------
touch /webapps/rackapp/tmp/restart.txt
-------------------------------------------
=== Rackup specifications for various web frameworks ===
include::users_guide_snippets/rackup_specifications.txt[]
== Deploying a WSGI (Python) application
Phusion Passenger supports all WSGI-compliant Python web applications. Suppose that you have a WSGI application in '/webapps/wsgiapp'. Then that folder must contain at least three entries:
- 'passenger_wsgi.py', which Phusion Passenger will use as the main entry point for your application. This file must export a WSGI object called `application`.
- 'public/', a folder containing public static web assets, like images and stylesheets.
- 'tmp/', used for 'restart.txt' (our application restart mechanism). This will be explained in a following subsection.
So '/webapps/wsgiapp' must, at minimum, look like this:
----------------------
/webapps/wsgiapp
|
+-- config.ru
|
+-- public/
|
+-- tmp/
----------------------
=== Tutorial/example: writing and deploying a Hello World WSGI application ===
First we create a Phusion Passenger-compliant WSGI directory structure:
-------------------------------------------
$ mkdir /webapps/wsgi_example
$ mkdir /webapps/wsgi_example/public
$ mkdir /webapps/wsgi_example/tmp
-------------------------------------------
Next, we write a minimal "hello world" WSGI application:
-------------------------------------------
$ cd /webapps/wsgi_example
$ some_awesome_editor passenger_wsgi.py
...type in some source code...
$ cat passenger_wsgi.py
def application(environ, start_response):
start_response('200 OK', [('Content-Type', 'text/plain')])
return [b"hello world!\n"]
-------------------------------------------
Finally, we deploy it by adding the following configuration options to
the Apache configuration file:
-------------------------------------------
<VirtualHost *:80>
ServerName www.wsgiexample.com
DocumentRoot /webapps/wsgi_example/public
<Directory /webapps/wsgi_example/public>
Allow from all
Options -MultiViews
</Directory>
</VirtualHost>
-------------------------------------------
And we're done! After an Apache restart, the above WSGI application will be available
under the URL 'http://www.wsgiexample.com/'.
=== Deploying to a virtual host's root ===
Add a virtual host entry to your Apache configuration file. Make sure that the
following conditions are met:
- The virtual host's document root must point to your WSGI application's
'public' folder.
- The WSGI per-directory permissions must allow access to this folder.
- MultiViews must be disabled for this folder.
For example:
-------------------------------------------
<VirtualHost *:80>
ServerName www.wsgiapp.com
DocumentRoot /webapps/wsgiapp/public
<Directory /webapps/wsgiapp/public>
Allow from all
Options -MultiViews
</Directory>
</VirtualHost>
-------------------------------------------
You may also need to tweak your file/folder permissions. Make sure that the
following folders are readable and executable by Apache:
* this 'public' folder.
* the application's 'config' folder.
* all parent folders. That is, /webapps/wsgiapp and /webapps must also be readable and executable by Apache.
Then restart Apache. The application has now been deployed.
=== Redeploying (restarting the WSGI application) ===
Deploying a new version of a WSGI application is as simple as
re-uploading the application files, and restarting the application.
There are two ways to restart the application:
1. By restarting Apache.
2. By creating or modifying the file 'tmp/restart.txt' in the WSGI
application's <<application_root,root folder>>. Phusion Passenger will
automatically restart the application.
For example, to restart our example application, we type this in the
command line:
-------------------------------------------
touch /webapps/wsgiapp/tmp/restart.txt
-------------------------------------------
== Configuring Phusion Passenger ==
After installation, Phusion Passenger does not need any further configurations.
Nevertheless, the system administrator may be interested in changing
Phusion Passenger's behavior. Phusion Passenger's Apache module supports the
following configuration options:
=== PassengerRoot <directory> ===
The location to the Phusion Passenger root directory. This configuration option
is essential to Phusion Passenger, and allows Phusion Passenger to locate its own
data files. The correct value is given by the installer.
If you've moved Phusion Passenger to a different directory then you need to update
this option as well. Please read
<<moving_phusion_passenger,Moving Phusion Passenger to a different directory>> for more information.
This required option may only occur once, in the global server configuration.
[[PassengerDefaultRuby]]
=== PassengerDefaultRuby <filename> ===
:version: 4.0.0
include::users_guide_snippets/since_version.txt[]
This option specifies the default Ruby interpreter to use for web apps as well as for all sorts of internal Phusion Passenger helper scripts, e.g. the one used by <<PassengerPreStart,PassengerPreStart>>. Please see <<PassengerRuby,PassengerRuby>> for more information, as well as how it relates to <<PassengerRuby,PassengerRuby>>.
This option may occur in the global server configuration. The default value is 'ruby', meaning that the Ruby interpreter will be looked up according to the `PATH` environment variable.
[[PassengerRuby]]
=== PassengerRuby <filename> ===
The `PassengerDefaultRuby` and `PassengerRuby` directives specify the Ruby interpreter to use. Similarly, the `PassengerPython` directive is for specifying the Python interpreter.
The relationship between `PassengerDefaultRuby` and `PassengerRuby` is as follows:
* `PassengerDefaultRuby` may only occur in the global server configuration.
* `PassengerRuby` may occur everywhere: in the global server configuration, in `<VirtualHost>`, in `<Directory>`, in `<Location>`, and in '.htaccess' if `AllowOverride Options` is on.
* You don't *have* to specify `PassengerRuby`. In this case `PassengerDefaultRuby` is used as the Ruby interpreter. But if you do specify `PassengerRuby` then it will override `PassengerDefaultRuby` in that context. This allows you to use `PassengerRuby` to specify a different Ruby interpreter on a per-application basis.
Phusion Passenger not only uses Ruby to run web apps, but also for running certain helper tools that are written in Ruby, e.g. the internal helper script used by <<PassengerPreStart,PassengerPreStart>>. These tools are always run using `PassengerDefaultRuby`, never by `PassengerRuby`. `PassengerRuby` is only used for running web apps. You can learn more about the internal helper scripts in <<relationship_with_ruby,Phusion Passenger and its relationship with Ruby>>.
It is okay if `PassengerDefaultRuby` refers to a different Ruby interpreter than the one you originally installed Phusion Passenger with. This too is explained in <<relationship_with_ruby,Phusion Passenger and its relationship with Ruby>>.
The reason why `PassengerDefaultRuby` exists at all is because limitations in the Apache API prevents us from implementing the same behavior using only the `PassengerRuby` directive.
There is no `PassengerDefaultPython` because there are no Phusion Passenger tools written in Python. As such, having `PassengerPython` is enough.
The following example illustrates how it works and how you can use these options to specify different Ruby/Python interpreters for different web apps.
------------------------------
# Use Ruby 1.8.7 by default.
PassengerDefaultRuby /usr/bin/ruby1.8
# Use Python 2.6 by default.
PassengerPython /usr/bin/python2.6
<VirtualHost *:80>
# This Rails web app will use Ruby 1.8.7
ServerName www.foo.com
DocumentRoot /webapps/foo/public
</VirtualHost>
<VirtualHost *:80>
# This Rails web app will use Ruby 1.9.3, as installed by RVM
PassengerRuby /usr/local/rvm/wrappers/ruby-1.9.3/ruby
ServerName www.bar.com
DocumentRoot /webapps/bar/public
# If you have a web app deployed in a sub-URI, customize
# PassengerRuby/PassengerPython inside a <Location> block.
# The web app under www.bar.com/blog will use JRuby 1.7.1
RackBaseURI /blog
<Location /blog>
PassengerRuby /usr/local/rvm/wrappers/jruby-1.7.1/ruby
</Location>
</VirtualHost>
<VirtualHost *:80>
# This Flask web app will use Python 3.0
PassengerPython /usr/bin/python3.0
ServerName www.baz.com
DocumentRoot /webapps/baz/public
</VirtualHost>
------------------------------
include::users_guide_snippets/rvm_helper_tool.txt[]
=== PassengerPython <filename> ===
:version: 4.0.0
include::users_guide_snippets/since_version.txt[]
This option allows one to specify the Python interpreter to use. See <<PassengerRuby,PassengerRuby>> for more information. The default value is 'python', meaning that the Python interpreter will be looked up according to the `PATH` environment variable.
[[PassengerAppRoot]]
=== PassengerAppRoot <path/to/root> ===
By default, Phusion Passenger assumes that the application's root directory
is the parent directory of the 'public' directory. This option allows one to
specify the application's root independently from the DocumentRoot, which
is useful if the 'public' directory lives in a non-standard place.
This option may occur in the following places:
* In the global server configuration.
* In a virtual host configuration block.
* In a `<Directory>` or `<Location>` block.
* In '.htaccess', if `AllowOverride Options` is on.
In each place, it may be specified at most once.
Example:
-----------------------------
<VirtualHost test.host>
DocumentRoot /var/rails/zena/sites/example.com/public
PassengerAppRoot /var/rails/zena # <-- normally Phusion Passenger would
# have assumed that the application
# root is "/var/rails/zena/sites/example.com"
</VirtualHost>
-----------------------------
[[PassengerSpawnMethod]]
=== PassengerSpawnMethod <string> ===
[TIP]
."What spawn method should I use?"
=========================================================
This subsection attempts to describe spawn methods, but it's okay if you don't (want to)
understand it, as it's mostly a technical detail. You can basically follow this rule of thumb:
************************************************
If your application works on Mongrel or Thin, but not on Phusion Passenger, then set
`PassengerSpawnMethod` to 'direct'. Otherwise, leave it at 'smart' (the default).
************************************************
However, we do recommend you to try to understand it. The 'smart' spawn
method bring many benefits.
=========================================================
include::users_guide_snippets/passenger_spawn_method.txt[]
This option may occur in the following places:
* In the global server configuration.
* In a virtual host configuration block.
In each place, it may be specified at most once. The default value is 'smart'.
[[PassengerLoadShellEnvvars]]
=== passengerLoadShellEnvvars <on|off> ===
:version: 4.0.20
include::users_guide_snippets/since_version.txt[]
Enables or disables the loading of shell environment variables before spawning the application.
If this option is turned on, and the user's shell is `bash`, then applications are loaded by running them with `bash -l -c`. Otherwise, they are loaded by running them directly from the `PassengerHelperAgent` process.
This option may occur in the following places:
* In the global server configuration.
* In a virtual host configuration block.
* In a `<Directory>` or `<Location>` block.
* In '.htaccess', if `AllowOverride Options` is on.
In each place, it may be specified at most once. The default value is 'on'.
[[PassengerEnabled]]
=== PassengerEnabled <on|off> ===
You can set this option to 'off' to completely disable Phusion Passenger for
a certain location. This is useful if, for example, you want to integrate a PHP
application into the same virtual host as a Rails application.
Suppose that you have a Rails application in '/apps/foo'. Suppose that you've
dropped Wordpress -- a blogging application written in PHP -- in
'/apps/foo/public/wordpress'. You can then configure Phusion Passenger as
follows:
------------------------------------
<VirtualHost *:80>
ServerName www.foo.com
DocumentRoot /apps/foo/public
<Directory /apps/foo/public/wordpress>
PassengerEnabled off
AllowOverride all # <-- Makes Wordpress's .htaccess file work.
</Directory>
</VirtualHost>
------------------------------------
This way, Phusion Passenger will not interfere with Wordpress.
'PassengerEnabled' may occur in the following places:
* In the global server configuration.
* In a virtual host configuration block.
* In a `<Directory>` or `<Location>` block.
* In '.htaccess'.
In each place, it may be specified at most once. The default value is 'on'.
[[PassengerTempDir]]
=== PassengerTempDir <directory> ===
Specifies the directory that Phusion Passenger should use for storing temporary
files. This includes things such as Unix socket files, buffered file uploads
(see also <<PassengerUploadBufferDir,PassengerUploadBufferDir>>), etc.
This option may be specified once, in the global server configuration. The
default temp directory that Phusion Passenger uses is '/tmp'.
This option is especially useful if Apache is not allowed to write to /tmp
(which is the case on some systems with strict SELinux policies) or if the
partition that /tmp lives on doesn't have enough disk space.
.Command line tools
Some Phusion Passenger command line administration tools, such as
`passenger-status`, must know what Phusion Passenger's temp directory is
in order to function properly. You can pass the directory through the
`PASSENGER_TMPDIR` environment variable, or the `TMPDIR` environment variable
(the former will be used if both are specified).
For example, if you set 'PassengerTempDir' to '/my_temp_dir', then invoke
`passenger-status` after you've set the `PASSENGER_TMPDIR` or `TMPDIR`
environment variable, like this:
----------------------------------------------------------
export PASSENGER_TMPDIR=/my_temp-dir
sudo -E passenger-status
# The -E option tells 'sudo' to preserve environment variables.
----------------------------------------------------------
[[PassengerUploadBufferDir]]
=== PassengerUploadBufferDir <directory> ===
Phusion Passenger buffers large file uploads to disk in order prevent slow file
uploads from blocking web applications. By default, a subdirectory in the
system's temporary files directory (or a subdirectory in the directory specified
in <<PassengerTempDir,PassengerTempDir>>, if set) is automatically created for
storing these buffered file uploads.
This configuration directive allows you to specify a different directory for storing
buffered file uploads. If you've specified such a directory (as opposed to using
Phusion Passenger's default) then you *must* ensure that this directory exists.
This configuration directive is also useful if you're using apache2-mpm-itk.
The buffered file upload directory that Phusion Passenger creates by default has
very strict permissions: it can only be accessed by the Apache worker processes.
However, Phusion Passenger assumes that all Apache worker processes are running
as the same user. apache2-mpm-itk breaks this assumption by running multiple
Apache worker processes as different users. So if you're using apace2-mpm-itk,
you should set this option to a directory that is writable by all Apache worker
processes, such as '/tmp'.
You may specify 'PassengerUploadBufferDir' in the following places:
* In the global server configuration.
* In a virtual host configuration block.
* In a `<Directory>` or `<Location>` block.
* In '.htaccess', if `AllowOverrides Options` is enabled.
In each place, it may be specified at most once.
=== PassengerRestartDir <directory> ===
As described in the deployment chapters of this document, Phusion Passenger
checks the file 'tmp/restart.txt' in the applications'
<<application_root,root directory>> for restarting applications. Sometimes it
may be desirable for Phusion Passenger to look in a different directory instead,
for example for security reasons (see below). This option allows you to
customize the directory in which 'restart.txt' is searched for.
You may specify 'PassengerRestartDir' in the following places:
* In the global server configuration.
* In a virtual host configuration block.
* In a `<Directory>` or `<Location>` block.
* In '.htaccess', if `AllowOverrides Options` is enabled.
In each place, it may be specified at most once.
You can either set it to an absolute directory, or to a directory relative to
the <<application_root,application root>>. Examples:
-----------------------------------
<VirtualHost *:80>
ServerName www.foo.com
# Phusion Passenger will check for /apps/foo/public/tmp/restart.txt
DocumentRoot /apps/foo/public
</VirtualHost>
<VirtualHost *:80>
ServerName www.bar.com
DocumentRoot /apps/bar/public
# An absolute filename is given; Phusion Passenger will
# check for /restart_files/bar/restart.txt
PassengerRestartDir /restart_files/bar
</VirtualHost>
<VirtualHost *:80>
ServerName www.baz.com
DocumentRoot /apps/baz/public
# A relative filename is given; Phusion Passenger will
# check for /apps/baz/restart_files/restart.txt
#
# Note that this directory is relative to the APPLICATION ROOT, *not*
# the value of DocumentRoot!
PassengerRestartDir restart_files
</VirtualHost>
-----------------------------------
.What are the security reasons for wanting to customize PassengerRestartDir?
Touching restart.txt will cause Phusion Passenger to restart the application.
So anybody who can touch restart.txt can effectively cause a Denial-of-Service
attack by touching restart.txt over and over. If your web server or one of your
web applications has the permission to touch restart.txt, and one of them has a
security flaw which allows an attacker to touch restart.txt, then that will
allow the attacker to cause a Denial-of-Service.
You can prevent this from happening by pointing PassengerRestartDir to a
directory that's readable by Apache, but only writable by administrators.
[[PassengerRollingRestarts]]
=== PassengerRollingRestarts <on|off> ===
:version: 3.0.0
include::users_guide_snippets/enterprise_only.txt[]
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 global server configuration.
* In a virtual host configuration block.
* In a `<Directory>` or `<Location>` block.
* In '.htaccess', if `AllowOverride Options` is on.
In each place, it may be specified at most once. The default value is 'off'.
=== PassengerResistDeploymentErrors <on|off> ===
:version: 3.0.0
include::users_guide_snippets/enterprise_only.txt[]
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 global server configuration.
* In a virtual host configuration block.
* In a `<Directory>` or `<Location>` block.
* In '.htaccess', if `AllowOverride Options` is on.
In each place, it may be specified at most once. The default value is 'off'.
=== Security options ===
[[PassengerUserSwitching]]
==== PassengerUserSwitching <on|off> ====
Whether to enable <<user_switching,user switching support>>.
This option may only occur once, in the global server configuration.
The default value is 'on'.
[[PassengerUser]]
==== PassengerUser <username> ====
If <<user_switching,user switching support>> is enabled, then Phusion Passenger will
by default run the web application as the owner of the file 'config/environment.rb'
(for Rails apps) or 'config.ru' (for Rack apps). This option allows you to override
that behavior and explicitly set a user to run the web application as, regardless
of the ownership of 'environment.rb'/'config.ru'.
This option may occur in the following places:
* In the global server configuration.
* In a virtual host configuration block.
* In a `<Directory>` or `<Location>` block.
In each place, it may be specified at most once.
[[PassengerGroup]]
==== PassengerGroup <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
allows you to override that behavior and explicitly set a group to run the web application
as, regardless of the ownership of 'environment.rb'/'config.ru'.
'<group name>' may also be set to the special value '!STARTUP_FILE!', in which case
the web application's group will be set to 'environment.rb'/'config.ru''s group.
This option may occur in the following places:
* In the global server configuration.
* In a virtual host configuration block.
* In a `<Directory>` or `<Location>` block.
In each place, it may be specified at most once.
[[PassengerDefaultUser]]
==== PassengerDefaultUser <username> ====
Phusion Passenger enables <<user_switching,user switching support>> by default.
This configuration option allows one to specify the user that applications must
run as, if user switching fails or is disabled.
This option may only occur once, in the global server configuration.
The default value is 'nobody'.
[[PassengerDefaultGroup]]
==== PassengerDefaultGroup <group name> ====
Phusion Passenger enables <<user_switching,user switching support>> by default.
This configuration option allows one to specify the group that applications must
run as, if user switching fails or is disabled.
This option may only occur once, in the global server configuration.
The default value is the primary group of the user specifified by
<<PassengerDefaultUser,PassengerDefaultUser>>.
[[PassengerFriendlyErrorPages]]
==== PassengerFriendlyErrorPages <on|off> ====
Phusion Passenger can display friendly error pages whenever an application fails
to start. This friendly error page presents the startup error message, some
suggestions for solving the problem, and a backtrace. This feature is very useful
during application development and useful for less experienced system administrators,
but the page might reveal potentially sensitive information, depending on the
application. Experienced system administrators who are using Phusion Passenger
on serious production servers should consider turning this feature off.
This option may occur in the following places:
* In the global server configuration.
* In a virtual host configuration block.
* In a `<Directory>` or `<Location>` block.
* In '.htaccess', if `AllowOverride Options` is on.
In each place, it may be specified at most once. The default value is 'on'.
=== Resource control and optimization options ===
[[PassengerMaxPoolSize]]
==== PassengerMaxPoolSize <integer> ====
The maximum number of <<application_process,application processes>> that may
simultaneously exist. A larger number results in higher memory usage,
but improves the ability to handle concurrent HTTP requests.
The optimal value depends on your system's hardware and your workload. You can learn more at the Phusion article link:http://blog.phusion.nl/2013/03/12/tuning-phusion-passengers-concurrency-settings/[Tuning Phusion Passenger's concurrency settings].
If you find that your server is running out of memory then you should lower this value.
This option may only occur once, in the global server configuration.
The default value is '6'.
[[PassengerMinInstances]]
==== PassengerMinInstances <integer> ====
This specifies the minimum number of application processes that should exist for a
given application. You should set this option to a
non-zero value if you want to avoid potentially long startup times after a website
has been <<idle_process,idle>> for an extended period.
Please note that this option does *not* pre-start application processes during Apache
startup. It just makes sure that when the application is first accessed:
1. at least the given number of processes will be spawned.
2. the given number of processes will be kept around even when processes are being
idle cleaned (see <<PassengerPoolIdleTime,PassengerPoolIdleTime>>).
If you want to pre-start application processes during Apache startup, then you should use the <<PassengerPreStart,PassengerPreStart>> directive, possibly in combination with
'PassengerMinInstances'. This behavior might seem counter-intuitive at first sight,
but <<PassengerPreStart,PassengerPreStart>> explains the rationale behind it.
For example, suppose that you have the following configuration:
---------------------------------
PassengerMaxPoolSize 15
PassengerPoolIdleTime 10
<VirtualHost *:80>
ServerName foobar.com
DocumentRoot /webapps/foobar/public
PassengerMinInstances 3
</VirtualHost>
---------------------------------
When you start Apache, there are 0 application processes for 'foobar.com'. Things will
stay that way until someone visits 'foobar.com'. Suppose that there is only 1 visitor.
1 application process will be started immediately to serve the visitor, while 2 will
be spawned in the background. After 10 seconds, when the idle timeout has
been reached, these 3 application processes will not be cleaned up.
Now suppose that there's a sudden spike of traffic, and 100 users visit 'foobar.com'
simultanously. Phusion Passenger will start 12 more application processes. After the idle
timeout of 10 seconds have passed, Phusion Passenger will clean up 12 application
processes, keeping 3 processes around.
The PassengerMinInstances option may occur in the following places:
* In the global server configuration.
* In a virtual host configuration block.
* In a `<Directory>` or `<Location>` block.
* In '.htaccess', if `AllowOverride Limits` is on.
In each place, it may be specified at most once. The default value is '1'.