Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Begin writing Nginx documentation.

  • Loading branch information...
commit 85846ccdf3f89ecabba99104bd4743e2385d5fd8 1 parent 7f05cf0
@FooBarWidget FooBarWidget authored
View
4 INSTALL
@@ -1,4 +1,6 @@
Please read the file README for installation instructions.
If you're having trouble installing Phusion Passenger, please
-read the file 'doc/Users guide.html'.
+read the file 'doc/Users guide Apache.html' or 'doc/Users guide Nginx.html',
+depending on whether you want to install Phusion Passenger for Apache or for
+Nginx.
View
13 README
@@ -7,15 +7,22 @@ to http://www.modrails.com/ for general information.
=== Regular installation
-Run the following script as root:
+You can install either Phusion Passenger for Apache or for Nginx. Run either of
+the following programs as root:
./bin/passenger-install-apache2-module
+-OR-
+
+ ./bin/passenger-install-nginx-module
+
That's it. :)
-For troubleshooting, configuration and tips, please read the Users Guide:
+For troubleshooting, configuration and tips, please read the corresponding
+Users Guide:
- doc/Users guide.html
+ doc/Users guide Apache.html
+ doc/Users guide Nginx.html
This file is included in the source tarball, and may also be viewed online on
our website.
View
5 Rakefile
@@ -548,7 +548,7 @@ subdir 'doc' do
ASCIIDOC = 'asciidoc'
ASCIIDOC_FLAGS = "-a toc -a numbered -a toclevels=3 -a icons"
ASCII_DOCS = ['Security of user switching support', 'Users guide',
- 'Architectural overview']
+ 'Users guide Nginx', 'Architectural overview']
DOXYGEN = 'doxygen'
@@ -640,7 +640,8 @@ spec = Gem::Specification.new do |s|
# If you're running 'rake package' for the first time, then these
# files don't exist yet, and so won't be matched by the above glob.
# So we add these filenames manually.
- 'doc/Users guide.html',
+ 'doc/Users guide Apache.html',
+ 'doc/Users guide Nginx.html',
'doc/Security of user switching support.html',
'doc/*/*',
View
8 bin/passenger-install-apache2-module
@@ -69,6 +69,10 @@ class Installer < PhusionPassenger::AbstractInstaller
return result
end
+ def users_guide
+ return "#{DOCDIR}/Users guide Apache.html"
+ end
+
def install!
if PhusionPassenger.natively_packaged?
check_dependencies || exit(1)
@@ -177,7 +181,7 @@ private
puts
line
render_template 'apache2/deployment_example',
- :users_guide => USERS_GUIDE,
+ :users_guide => users_guide,
:phusion_website => PHUSION_WEBSITE,
:passenger_website => PASSENGER_WEBSITE
end
@@ -185,7 +189,7 @@ private
def show_possible_solutions_for_compilation_and_installation_problems
new_screen
render_template 'apache2/possible_solutions_for_compilation_and_installation_problems',
- :users_guide => USERS_GUIDE,
+ :users_guide => users_guide,
:passenger_website => PASSENGER_WEBSITE
end
end
View
8 bin/passenger-install-nginx-module
@@ -30,6 +30,10 @@ class Installer < PhusionPassenger::AbstractInstaller
]
end
+ def users_guide
+ return "#{DOCDIR}/Users guide Nginx.html"
+ end
+
def install!
Dir.chdir(PASSENGER_ROOT)
show_welcome_screen
@@ -320,7 +324,7 @@ private
line
puts
render_template 'nginx/deployment_example',
- :users_guide => USERS_GUIDE,
+ :users_guide => users_guide,
:phusion_website => PHUSION_WEBSITE,
:passenger_website => PASSENGER_WEBSITE
end
@@ -329,7 +333,7 @@ private
line
puts
render_template 'nginx/possible_solutions_for_compilation_and_installation_problems',
- :users_guide => USERS_GUIDE,
+ :users_guide => users_guide,
:passenger_website => PASSENGER_WEBSITE
end
View
0  doc/Users guide.txt → doc/Users guide Apache.html
File renamed without changes
View
59 doc/Users guide Nginx.txt
@@ -0,0 +1,59 @@
+= Phusion Passenger users guide, Nginx version =
+
+image:images/phusion_banner.png[link="http://www.phusion.nl/"]
+
+Phusion Passenger is an Nginx module, which makes deploying Ruby and Ruby on
+Rails applications on Nginx a breeze. It follows the usual Ruby on Rails
+conventions, such as "Don't-Repeat-Yourself" and ease of setup, while at the
+same time providing enough flexibility.
+
+This users guide will teach you:
+
+- How to install Nginx with Phusion Passenger support.
+- How to configure Phusion Passenger.
+- How to deploy a Ruby on Rails application.
+- How to deploy a link:http://rack.rubyforge.org/[Rack]-based Ruby application.
+- How to solve common problems.
+
+This guide assumes that the reader is somewhat familiar with Nginx and with
+using the commandline.
+
+
+== Supported operating systems ==
+
+Phusion Passenger works on any POSIX-compliant operating system. In other
+words: practically any operating system on earth, except Microsoft Windows.
+
+Phusion Passenger for Nginx has been tested on:
+
+- Ubuntu Linux 8.04 (x86)
+- Gentoo Linux (AMD64)
+- MacOS X Leopard (x86)
+
+Other operating systems have not been tested, but Phusion Passenger will probably
+work fine on them. Please
+link:http://code.google.com/p/phusion-passenger/issues/list[report a bug]
+or
+link:http://groups.google.com/group/phusion-passenger[join our discussion list]
+if it doesn't.
+
+
+== Installing Phusion Passenger ==
+
+[[install_passenger]]
+=== Overview of download and installation methods ===
+
+There are several ways to install Phusion Passenger:
+
+1. By installing the Phusion Passenger gem, as instructed on the
+ link:http://www.modrails.com/install.html[``Install'' page on the Phusion
+ Passenger website].
+2. By downloading the source tarball from the Phusion Passenger website
+ ('passenger-x.x.x.tar.gz').
+
+Phusion Passenger provides an easy-to-use installer for installing the Phusion
+Passenger Nginx module.
+
+TIP: You might have to run the installation commands in the following sections
+as 'root'. If the installer fails because of permission errors, it will tell
+you.
View
3  lib/phusion_passenger/abstract_installer.rb
@@ -32,7 +32,6 @@ module PhusionPassenger
class AbstractInstaller
PASSENGER_WEBSITE = "http://www.modrails.com/"
PHUSION_WEBSITE = "www.phusion.nl"
- USERS_GUIDE = "#{DOCDIR}/Users guide.html"
def initialize(options = {})
options.each_pair do |key, value|
@@ -172,7 +171,7 @@ def check_dependencies
color_puts "If the aforementioned instructions didn't solve your problem, then please take"
color_puts "a look at the Users Guide:"
puts
- color_puts " <yellow>#{USERS_GUIDE}</yellow>"
+ color_puts " <yellow>#{users_guide}</yellow>"
return false
end
end
Please sign in to comment.
Something went wrong with that request. Please try again.