annotate xml/en/docs/configure.xml @ 2083:fb5eef3637a4

Avoid double negative in if_not_empty. Use of "not" and "until" in the same sentence makes it confusing. Moreover, use of "until" with something that doesn't describe an event or point in time is wrong.
author Sergey Kandaurov <pluknet@nginx.com>
date Mon, 11 Dec 2017 19:15:31 +0300
parents 7d9c836d14bf
children ebc9fb8139e4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
580
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 486
diff changeset
1 <!--
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 486
diff changeset
2 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 486
diff changeset
3 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 486
diff changeset
4 -->
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 486
diff changeset
5
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
6 <!DOCTYPE article SYSTEM "../../../dtd/article.dtd">
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
7
924
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
8 <article name="Building nginx from Sources"
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
9 link="/en/docs/configure.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
10 lang="en"
2043
7d9c836d14bf Updated PCRE version in "Building nginx".
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2018
diff changeset
11 rev="11">
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
12
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
13 <section>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15 <para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16 The build is configured using the <command>configure</command> command.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
17 It defines various aspects of the system, including the methods nginx
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 is allowed to use for connection processing.
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
19 At the end it creates a <path>Makefile</path>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 The <command>configure</command> command supports the following parameters:
461
6135f3c95bf6 Unified markup for lists.
Ruslan Ermilov <ru@nginx.com>
parents: 289
diff changeset
21 <list type="bullet">
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
25 <literal>--prefix=<value>path</value></literal>&mdash;defines
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 a directory that will keep server files.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27 This same directory will also be used for all relative paths set by
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
28 <command>configure</command> (except for paths to libraries sources)
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
29 and in the <path>nginx.conf</path> configuration file.
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
30 It is set to the <path>/usr/local/nginx</path> directory by default.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
36 <literal>--sbin-path=<value>path</value></literal>&mdash;sets
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
37 the name of an nginx executable file.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38 This name is used only during installation.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39 By default the file is named
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
40 <path><value>prefix</value>/sbin/nginx</path>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
46 <literal>--conf-path=<value>path</value></literal>&mdash;sets
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
47 the name of an <path>nginx.conf</path> configuration file.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48 If needs be, nginx can always be started with a different configuration file,
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49 by specifying it in the command-line parameter
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
50 <nobr><literal>-c <value>file</value></literal></nobr>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51 By default the file is named
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
52 <path><value>prefix</value>/conf/nginx.conf</path>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
58 <literal>--pid-path=<value>path</value></literal>&mdash;sets
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59 the name of an nginx.pid file that will store the process ID
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60 of the main process.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61 After installation, the file name can always be changed in the
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
62 <path>nginx.conf</path> configuration file using the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63 <link doc="ngx_core_module.xml" id="pid"/> directive.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 By default the file is named
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
65 <path><value>prefix</value>/logs/nginx.pid</path>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
66 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
67 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
71 <literal>--error-log-path=<value>path</value></literal>&mdash;sets
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72 the name of the primary error, warnings, and diagnostic file.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73 After installation, the file name can always be changed in the
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
74 <path>nginx.conf</path> configuration file using the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75 <link doc="ngx_core_module.xml" id="error_log"/> directive.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76 By default the file is named
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
77 <path><value>prefix</value>/logs/error.log</path>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
78 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
82 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
83 <literal>--http-log-path=<value>path</value></literal>&mdash;sets
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84 the name of the primary request log file of the HTTP server.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
85 After installation, the file name can always be changed in the
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
86 <path>nginx.conf</path> configuration file using the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87 <link doc="http/ngx_http_log_module.xml" id="access_log"/> directive.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88 By default the file is named
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
89 <path><value>prefix</value>/logs/access.log</path>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
91 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92
1952
3be7279397c8 Documented the "build" parameter of the "configure" command.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1894
diff changeset
93 <listitem id="build">
3be7279397c8 Documented the "build" parameter of the "configure" command.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1894
diff changeset
94 <para>
3be7279397c8 Documented the "build" parameter of the "configure" command.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1894
diff changeset
95 <literal>--build=<value>name</value></literal>&mdash;sets
3be7279397c8 Documented the "build" parameter of the "configure" command.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1894
diff changeset
96 an optional nginx build name.
3be7279397c8 Documented the "build" parameter of the "configure" command.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1894
diff changeset
97 </para>
3be7279397c8 Documented the "build" parameter of the "configure" command.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1894
diff changeset
98 </listitem>
3be7279397c8 Documented the "build" parameter of the "configure" command.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1894
diff changeset
99
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
100 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
101 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
102 <literal>--user=<value>name</value></literal>&mdash;sets
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
103 the name of an unprivileged user whose credentials will be used
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
104 by worker processes.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
105 After installation, the name can always be changed in the
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
106 <path>nginx.conf</path> configuration file using the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
107 <link doc="ngx_core_module.xml" id="user"/> directive.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
108 The default user name is nobody.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
109 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
110 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
113 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
114 <literal>--group=<value>name</value></literal>&mdash;sets
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
115 the name of a group whose credentials will be used
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116 by worker processes.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 After installation, the name can always be changed in the
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
118 <path>nginx.conf</path> configuration file using the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
119 <link doc="ngx_core_module.xml" id="user"/> directive.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 By default, a group name is set to the name of an unprivileged user.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
122 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
126 <literal>--with-select_module</literal><br/>
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
127 <literal>--without-select_module</literal>&mdash;enables or disables
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
128 building a module that allows the server to work with the
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
129 <c-func>select</c-func> method.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
130 This module is built automatically if the platform does not appear
1465
eea7541e7c6a Removed "rtsig" and "worker_rlimit_sigpending".
Ruslan Ermilov <ru@nginx.com>
parents: 924
diff changeset
131 to support more appropriate methods such as kqueue, epoll, or /dev/poll.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
132 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
133 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
134
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
135 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
136 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
137 <literal>--with-poll_module</literal><br/>
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
138 <literal>--without-poll_module</literal>&mdash;enables or disables
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
139 building a module that allows the server to work with the
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
140 <c-func>poll</c-func> method.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
141 This module is built automatically if the platform does not appear
1465
eea7541e7c6a Removed "rtsig" and "worker_rlimit_sigpending".
Ruslan Ermilov <ru@nginx.com>
parents: 924
diff changeset
142 to support more appropriate methods such as kqueue, epoll, or /dev/poll.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
143 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
144 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
145
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
146 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
147 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
148 <literal>--without-http_gzip_module</literal>&mdash;disables building a module
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
149 that <link doc="http/ngx_http_gzip_module.xml">compresses responses</link>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
150 of an HTTP server.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
151 The zlib library is required to build and run this module.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
152 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
153 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
154
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
155 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
156 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
157 <literal>--without-http_rewrite_module</literal>&mdash;disables building a
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
158 module that allows an HTTP server to
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
159 <link doc="http/ngx_http_rewrite_module.xml">redirect requests and change URI
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
160 of requests</link>.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
161 The PCRE library is required to build and run this module.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
162 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
163 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
164
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
165 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
166 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
167 <literal>--without-http_proxy_module</literal>&mdash;disables building an
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
168 HTTP server <link doc="http/ngx_http_proxy_module.xml">proxying module</link>.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
169 <!--
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
170 The MD5 library is required to build and run this module.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
171 -->
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
172 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
173 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
175 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
176 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
177 <literal>--with-http_ssl_module</literal>&mdash;enables building a module
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
178 that adds the <link doc="http/ngx_http_ssl_module.xml">HTTPS protocol
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
179 support</link> to an HTTP server.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
180 This module is not built by default.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181 The OpenSSL library is required to build and run this module.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
182 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
183 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
184
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
185 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
186 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
187 <literal>--with-pcre=<value>path</value></literal>&mdash;sets
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
188 the path to the sources of the PCRE library.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
189 The library distribution (version
2043
7d9c836d14bf Updated PCRE version in "Building nginx".
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2018
diff changeset
190 4.4&mdash;8.41) needs to be downloaded from the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
191 <link url="http://www.pcre.org">PCRE</link> site and extracted.
924
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
192 The rest is done by nginx’s <command>./configure</command> and
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
193 <command>make</command>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
194 The library is required for regular expressions support in the
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
195 <link doc="http/ngx_http_core_module.xml" id="location"/> directive
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
196 and for the
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
197 <link doc="http/ngx_http_rewrite_module.xml">ngx_http_rewrite_module</link>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
198 module.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
199 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
200 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
201
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
202 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
203 <para>
289
df261b1ce71f Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents: 282
diff changeset
204 <literal>--with-pcre-jit</literal>&mdash;builds the PCRE library with
659
77a3314c74a7 Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents: 625
diff changeset
205 “just-in-time compilation” support (1.1.12, the
77a3314c74a7 Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents: 625
diff changeset
206 <link doc="ngx_core_module.xml" id="pcre_jit"/> directive).
289
df261b1ce71f Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents: 282
diff changeset
207 </para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents: 282
diff changeset
208 </listitem>
df261b1ce71f Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents: 282
diff changeset
209
df261b1ce71f Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents: 282
diff changeset
210 <listitem>
df261b1ce71f Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents: 282
diff changeset
211 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
212 <literal>--with-zlib=<value>path</value></literal>&mdash;sets
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
213 the path to the sources of the zlib library.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
214 The library distribution (version
1894
d011ffde3760 Updated zlib and PCRE versions.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1749
diff changeset
215 1.1.3&mdash;1.2.11) needs to be downloaded from the
858
65e75e59a714 Updated versions of external libraries and link to zlib site.
Valentin Bartenev <vbart@nginx.com>
parents: 732
diff changeset
216 <link url="http://zlib.net">zlib</link> site and extracted.
924
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
217 The rest is done by nginx’s <command>./configure</command> and
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
218 <command>make</command>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
219 The library is required for the
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
220 <link doc="http/ngx_http_gzip_module.xml">ngx_http_gzip_module</link> module.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
221 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
222 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
223
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
224 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
225 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
226 <literal>--with-cc-opt=<value>parameters</value></literal>&mdash;sets
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
227 additional parameters that will be added to the CFLAGS variable.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
228 When using the system PCRE library under FreeBSD,
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
229 <literal>--with-cc-opt="-I /usr/local/include"</literal>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
230 should be specified.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
231 If the number of files supported by <c-func>select</c-func> needs to be
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
232 increased it can also be specified here such as this:
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
233 <literal>--with-cc-opt="-D FD_SETSIZE=2048"</literal>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
234 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
235 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
236
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
237 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
238 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
239 <literal>--with-ld-opt=<value>parameters</value></literal>&mdash;sets
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
240 additional parameters that will be used during linking.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
241 When using the system PCRE library under FreeBSD,
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
242 <literal>--with-ld-opt="-L /usr/local/lib"</literal>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
243 should be specified.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
244 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
245 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
246
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
247 </list>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
248
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
249 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
250
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
251 <para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
252 Example of parameters usage (all of this needs to be typed in one line):
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
253 <programlisting>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
254 ./configure
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
255 --sbin-path=/usr/local/nginx/nginx
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
256 --conf-path=/usr/local/nginx/nginx.conf
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
257 --pid-path=/usr/local/nginx/nginx.pid
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
258 --with-http_ssl_module
2018
7ee425a5ae29 Updated PCRE version.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1952
diff changeset
259 --with-pcre=../pcre-8.41
1894
d011ffde3760 Updated zlib and PCRE versions.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1749
diff changeset
260 --with-zlib=../zlib-1.2.11
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
261 </programlisting>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
262 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
263
924
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
264 <para>
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
265 After configuration,
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
266 nginx is compiled and installed using <command>make</command>.
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
267 </para>
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
268
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
269 </section>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
270
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
271 </article>