2
.\" Copyright (C) 2010 Sergey A. Osokin
3
.\" Copyright (C) Nginx, Inc.
4
.\" All rights reserved.
6
.\" Redistribution and use in source and binary forms, with or without
7
.\" modification, are permitted provided that the following conditions
9
.\" 1. Redistributions of source code must retain the above copyright
10
.\" notice, this list of conditions and the following disclaimer.
11
.\" 2. Redistributions in binary form must reproduce the above copyright
12
.\" notice, this list of conditions and the following disclaimer in the
13
.\" documentation and/or other materials provided with the distribution.
15
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33
.Nd "HTTP and reverse proxy server, mail proxy server"
38
.Op Fl g Ar directives
45
is an HTTP and reverse proxy server, as well as a mail proxy server.
46
It is known for its high performance, stability, rich feature set, simple
47
configuration, and low resource consumption.
49
The options are as follows:
50
.Bl -tag -width ".Fl d Ar directives"
54
Use an alternative configuration
56
.It Fl g Ar directives
57
Set global configuration directives.
66
Suppress non-error messages during configuration testing.
68
Send a signal to the master process.
72
.Cm stop , quit , reopen , reload .
73
The following table shows the corresponding system signals:
75
.Bl -tag -width ".Cm reopen" -compact
86
Do not run, just test the configuration file.
88
checks the configuration file syntax and then tries to open files
89
referenced in the configuration file.
93
version, compiler version, and
102
The master process of
104
can handle the following signals:
106
.Bl -tag -width ".Dv SIGINT , SIGTERM" -compact
107
.It Dv SIGINT , SIGTERM
110
Reload configuration, start the new worker process with a new
111
configuration, and gracefully shut down old worker processes.
113
Shut down gracefully.
119
executable on the fly.
121
Shut down worker processes gracefully.
124
While there is no need to explicitly control worker processes normally,
125
they support some signals too:
127
.Bl -tag -width ".Dv SIGINT , SIGTERM" -compact
131
Shut down gracefully.
136
To enable a debugging log, reconfigure
138
to build with debugging:
140
.Dl "./configure --with-debug ..."
147
.Dl "error_log /path/to/log debug;"
149
It is also possible to enable the debugging for a particular IP address:
150
.Bd -literal -offset indent
152
debug_connection 127.0.0.1;
158
environment variable is used internally by
160
and should not be set directly by the user.
162
.Bl -tag -width indent
164
Contains the process ID of
166
The contents of this file are not sensitive, so it can be world-readable.
168
The main configuration file.
169
.It Pa %%ERROR_LOG_PATH%%
173
Exit status is 0 on success, or 1 if the command fails.
175
Test configuration file
177
with global directives for PID and quantity of worker processes:
178
.Bd -literal -offset indent
179
nginx -t -c ~/mynginx.conf \e
180
-g "pid /var/run/mynginx.pid; worker_processes 2;"
186
.Pa http://nginx.org/en/docs/ .
188
For questions and technical support, please refer to
189
.Pa http://nginx.org/en/support.html .
193
started in 2002, with the first public release on October 4, 2004.
196
.An Igor Sysoev Aq igor@sysoev.ru .
198
This manual page was originally written by
199
.An Sergey A. Osokin Aq osa@FreeBSD.org.ru
200
as a result of compiling many
202
documents from all over the world.