nginx (8)

Leading comments

Copyright (C) 2010 Sergey A. Osokin
Copyright (C) Nginx, Inc.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the...

(The comments found at the beginning of the groff file "man8/nginx.8".)

NAME

nginx - HTTP and reverse proxy server, mail proxy server

SYNOPSIS

groff Fl m Ns Cm doc Ar [-?hqTtVv [-c file ] ] [-g directives ] [-p prefix ] [-s signal ]

DESCRIPTION

groff Fl m Ns Cm doc Ar (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.

The options are as follows:

-? , h

Print help.

-c file

Use an alternative configuration file

-g directives

Set global configuration directives. See Sx EXAMPLES for details.

-p prefix

Set the prefix path. The default value is /usr/share/nginx

-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. groff Fl m Ns Cm doc Ar checks the configuration file syntax and then tries to open files referenced in the configuration file.

-T

Same as -t but additionally dump configuration files to standard output.

-V

Print the groff Fl m Ns Cm doc Ar version, compiler version, and configure script parameters.

-v

Print the groff Fl m Ns Cm doc Ar version.

SIGNALS

The master process of groff Fl m Ns Cm doc Ar 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.

SIGUSR2

Upgrade the groff Fl m Ns Cm doc Ar executable on the fly.

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 groff Fl m Ns Cm doc Ar 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 groff Fl m Ns Cm doc Ar and should not be set directly by the user.

FILES

/run/nginx.pid

Contains the process ID of . The contents of this file are not sensitive, so it can be world-readable.

/etc/nginx/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 nginx.org/en/docs

For questions and technical support, please refer to nginx.org/en/support.html

HISTORY

Development of groff Fl m Ns Cm doc Ar started in 2002, with the first public release on October 4, 2004.

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 groff Fl m Ns Cm doc Ar documents from all over the world.