GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  NGINX (8)

NAME

nginx - HTTP and reverse proxy server, mail proxy server

CONTENTS

Synopsis
Description
Signals
Debugging Log
Environment
Files
Exit Status
Examples
See Also
History
Authors

SYNOPSIS

nginx [-?dhlmqtVv] [-c file] [-g directives] [-p prefix] [-s signal]

DESCRIPTION

nginx (pronounced "engine x") is an HTTP and reverse proxy server, as well as a mail proxy server. It is known for its high performance, stability, rich feature set, simple configuration, and low resource consumption.

Tengine (pronounced "T engine") is a fork of nginx by Taobao in 2011. It supports dynamic shared objects (DSO’s) and has other enhanced features.

The options are as follows:
-? -, -h Print help.
-c file Use an alternative configuration file.
-d Dump the contents of the configuration file, including the contents of ’included’ files.
-g directives Set global configuration directives. See EXAMPLES for details.
-l Show all supported directives then exit.
-m Show all compiled-in modules then exit. Tengine supports DSO modules since 1.4.0. The tag ’static’ means static module. The tag ’shared’ means dynamic shared module which is also attached with major and minor version of this modules.
-p prefix Set the prefix path. The default value is /usr/local/etc/tengine.
-q Suppress non-error messages during configuration testing.
-s signal Send a signal to the master process. The argument signal can be one of: stop, quit, reopen, reload. The following table shows the corresponding system signals:

stop SIGTERM
quit SIGQUIT
reopen
  SIGUSR1
reload
  SIGHUP
-t Do not run, just test the configuration file. nginx checks the configuration file syntax and then tries to open files referenced in the configuration file.
-V Print the nginx version, compiler version, and configure script parameters.
-v Print the nginx version.

SIGNALS

The master process of nginx can handle the following signals:

SIGINT, SIGTERM Shut down quickly.
SIGHUP Reload configuration, start the new worker process with a new configuration, and gracefully shut down old worker processes.
SIGQUIT Shut down gracefully.
SIGUSR1 Reopen log files.
SIGWINCH Shut down worker processes gracefully.

While there is no need to explicitly control worker processes normally, they support some signals too:

SIGTERM Shut down quickly.
SIGQUIT Shut down gracefully.
SIGUSR1 Reopen log files.

DEBUGGING LOG

To enable a debugging log, reconfigure nginx to build with debugging:

    ./configure --with-debug ...

and then set the debug level of the error_log:

    error_log /path/to/log debug;

It is also possible to enable the debugging for a particular IP address:

events {
        debug_connection 127.0.0.1;
}

ENVIRONMENT

The NGINX environment variable is used internally by nginx and should not be set directly by the user.

FILES

/var/run/nginx.pid
  Contains the process ID of nginx. The contents of this file are not sensitive, so it can be world-readable.
/usr/local/etc/tengine/nginx.conf
  The main configuration file.
/var/log/nginx-error.log
  Error log file.

EXIT STATUS

Exit status is 0 on success, or 1 if the command fails.

EXAMPLES

Test configuration file ~/mynginx.conf with global directives for PID and quantity of worker processes:
nginx -t -c ~/mynginx.conf \
        -g "pid /var/run/mynginx.pid; worker_processes 2;"

SEE ALSO

Documentation at http://nginx.org/en/docs/ and http://tengine.taobao.org/documentation.html.

For questions and technical support, please refer to http://nginx.org/en/support.html and http://tengine.taobao.org/.

HISTORY

Development of nginx started in 2002, with the first public release on October 4, 2004.

Tengine was open sourced in 2011.

AUTHORS


.An -nosplit
.An Igor Sysoev Aq igor@sysoev.ru .

This manual page was originally written by
.An Sergey A. Osokin Aq osa@FreeBSD.org.ru as a result of compiling many nginx documents from all over the world. Tengine specific portions added by
.An Jim Ohlstein Aq jim@ohlste.in

Search for    or go to Top of page |  Section 8 |  Main Index


Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.