Mercurial > hg > nginx-site

comparison xml/en/docs/install.xml @ 271:4c6d2c614d2c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Cleaned up XML tag mess: - all of <parameter> and <code>, and some of <dirname>, <value>, and <command> were replaced by <literal>; - the rest of <dirname> were replaced by links; - <argument> were replaced by <value>; - <value> is now rendered in HTML in italic; - <literal> and <path> can now contain <value>. Cleaned up terminology mess: - directives take "parameters".
author Ruslan Ermilov <ru@nginx.com>
date Fri, 23 Dec 2011 17:29:59 +0000
parents 06b4c1f3149d
children 64107bc400c4
comparison
equal deleted inserted replaced
270:945d7299c26c 271:4c6d2c614d2c
8 8
9 <para> 9 <para>
10 The build is configured using the <command>configure</command> command. 10 The build is configured using the <command>configure</command> command.
11 It defines various aspects of the system, including the methods nginx 11 It defines various aspects of the system, including the methods nginx
12 is allowed to use for connection processing. 12 is allowed to use for connection processing.
13 At the end it creates a <command>Makefile</command>. 13 At the end it creates a <path>Makefile</path>.
14 The <command>configure</command> command supports the following parameters: 14 The <command>configure</command> command supports the following parameters:
15 <list> 15 <list>
16 16
17 <listitem> 17 <listitem>
18 <para> 18 <para>
19 <command>--prefix=&lt;<value>path</value>&gt;</command>&mdash;defines 19 <literal>--prefix=<value>path</value></literal>&mdash;defines
20 a directory that will keep server files. 20 a directory that will keep server files.
21 This same directory will also be used for all relative paths set by 21 This same directory will also be used for all relative paths set by
22 <command>./configure</command> (except for paths to libraries sources) 22 <command>configure</command> (except for paths to libraries sources)
23 and in the <command>nginx.conf</command> configuration file. 23 and in the <path>nginx.conf</path> configuration file.
24 It is set to the <command>/usr/local/nginx</command> directory by default. 24 It is set to the <path>/usr/local/nginx</path> directory by default.
25 </para> 25 </para>
26 </listitem> 26 </listitem>
27 27
28 <listitem> 28 <listitem>
29 <para> 29 <para>
30 <command>--sbin-path=&lt;<value>path</value>&gt;</command>&mdash;sets 30 <literal>--sbin-path=<value>path</value></literal>&mdash;sets
31 the name of an nginx executable file. 31 the name of an nginx executable file.
32 This name is used only during installation. 32 This name is used only during installation.
33 By default the file is named 33 By default the file is named
34 <command>&lt;<value>prefix</value>&gt;/sbin/nginx</command>. 34 <path><value>prefix</value>/sbin/nginx</path>.
35 </para> 35 </para>
36 </listitem> 36 </listitem>
37 37
38 <listitem> 38 <listitem>
39 <para> 39 <para>
40 <command>--conf-path=&lt;<value>path</value>&gt;</command>&mdash;sets 40 <literal>--conf-path=<value>path</value></literal>&mdash;sets
41 the name of an <command>nginx.conf</command> configuration file. 41 the name of an <path>nginx.conf</path> configuration file.
42 If needs be, nginx can always be started with a different configuration file, 42 If needs be, nginx can always be started with a different configuration file,
43 by specifying it in the command-line parameter 43 by specifying it in the command-line parameter
44 <nobr><command>-c &lt;<value>file</value>&gt;</command></nobr>. 44 <nobr><literal>-c <value>file</value></literal></nobr>.
45 By default the file is named 45 By default the file is named
46 <command>&lt;<value>prefix</value>&gt;/conf/nginx.conf</command>. 46 <path><value>prefix</value>/conf/nginx.conf</path>.
47 </para> 47 </para>
48 </listitem> 48 </listitem>
49 49
50 <listitem> 50 <listitem>
51 <para> 51 <para>
52 <command>--pid-path=&lt;<value>path</value>&gt;</command>&mdash;sets 52 <literal>--pid-path=<value>path</value></literal>&mdash;sets
53 the name of an nginx.pid file that will store the process ID 53 the name of an nginx.pid file that will store the process ID
54 of the main process. 54 of the main process.
55 After installation, the file name can always be changed in the 55 After installation, the file name can always be changed in the
56 <command>nginx.conf</command> configuration file using the 56 <path>nginx.conf</path> configuration file using the
57 <link doc="ngx_core_module.xml" id="pid"/> directive. 57 <link doc="ngx_core_module.xml" id="pid"/> directive.
58 By default the file is named 58 By default the file is named
59 <command>&lt;<value>prefix</value>&gt;/logs/nginx.pid</command>. 59 <path><value>prefix</value>/logs/nginx.pid</path>.
60 </para> 60 </para>
61 </listitem> 61 </listitem>
62 62
63 <listitem> 63 <listitem>
64 <para> 64 <para>
65 <command>--error-log-path=&lt;<value>path</value>&gt;</command>&mdash;sets 65 <literal>--error-log-path=<value>path</value></literal>&mdash;sets
66 the name of the primary error, warnings, and diagnostic file. 66 the name of the primary error, warnings, and diagnostic file.
67 After installation, the file name can always be changed in the 67 After installation, the file name can always be changed in the
68 <command>nginx.conf</command> configuration file using the 68 <path>nginx.conf</path> configuration file using the
69 <link doc="ngx_core_module.xml" id="error_log"/> directive. 69 <link doc="ngx_core_module.xml" id="error_log"/> directive.
70 By default the file is named 70 By default the file is named
71 <command>&lt;<value>prefix</value>&gt;/logs/error.log</command>. 71 <path><value>prefix</value>/logs/error.log</path>.
72 </para> 72 </para>
73 </listitem> 73 </listitem>
74 74
75 <listitem> 75 <listitem>
76 <para> 76 <para>
77 <command>--http-log-path=&lt;<value>path</value>&gt;</command>&mdash;sets 77 <literal>--http-log-path=<value>path</value></literal>&mdash;sets
78 the name of the primary request log file of the HTTP server. 78 the name of the primary request log file of the HTTP server.
79 After installation, the file name can always be changed in the 79 After installation, the file name can always be changed in the
80 <command>nginx.conf</command> configuration file using the 80 <path>nginx.conf</path> configuration file using the
81 <link doc="http/ngx_http_log_module.xml" id="access_log"/> directive. 81 <link doc="http/ngx_http_log_module.xml" id="access_log"/> directive.
82 By default the file is named 82 By default the file is named
83 <command>&lt;<value>prefix</value>&gt;/logs/access.log</command>. 83 <path><value>prefix</value>/logs/access.log</path>.
84 </para> 84 </para>
85 </listitem> 85 </listitem>
86 86
87 <listitem> 87 <listitem>
88 <para> 88 <para>
89 <command>--user=&lt;<value>name</value>&gt;</command>&mdash;sets 89 <literal>--user=<value>name</value></literal>&mdash;sets
90 the name of an unprivileged user whose credentials will be used 90 the name of an unprivileged user whose credentials will be used
91 by worker processes. 91 by worker processes.
92 After installation, the name can always be changed in the 92 After installation, the name can always be changed in the
93 <command>nginx.conf</command> configuration file using the 93 <path>nginx.conf</path> configuration file using the
94 <link doc="ngx_core_module.xml" id="user"/> directive. 94 <link doc="ngx_core_module.xml" id="user"/> directive.
95 The default user name is nobody. 95 The default user name is nobody.
96 </para> 96 </para>
97 </listitem> 97 </listitem>
98 98
99 <listitem> 99 <listitem>
100 <para> 100 <para>
101 <command>--group=&lt;<value>name</value>&gt;</command>&mdash;sets 101 <literal>--group=<value>name</value></literal>&mdash;sets
102 the name of a group whose credentials will be used 102 the name of a group whose credentials will be used
103 by worker processes. 103 by worker processes.
104 After installation, the name can always be changed in the 104 After installation, the name can always be changed in the
105 <command>nginx.conf</command> configuration file using the 105 <path>nginx.conf</path> configuration file using the
106 <link doc="ngx_core_module.xml" id="user"/> directive. 106 <link doc="ngx_core_module.xml" id="user"/> directive.
107 By default, a group name is set to the name of an unprivileged user. 107 By default, a group name is set to the name of an unprivileged user.
108 </para> 108 </para>
109 </listitem> 109 </listitem>
110 110
111 <listitem> 111 <listitem>
112 <para> 112 <para>
113 <command>--with-select_module</command><br/> 113 <literal>--with-select_module</literal><br/>
114 <command>--without-select_module</command>&mdash;enables or disables 114 <literal>--without-select_module</literal>&mdash;enables or disables
115 building a module that allows the server to work with the 115 building a module that allows the server to work with the
116 <c-func>select</c-func> method. 116 <c-func>select</c-func> method.
117 This module is built automatically if the platform does not appear 117 This module is built automatically if the platform does not appear
118 to support more appropriate methods such as kqueue, epoll, rtsig, or /dev/poll. 118 to support more appropriate methods such as kqueue, epoll, rtsig, or /dev/poll.
119 </para> 119 </para>
120 </listitem> 120 </listitem>
121 121
122 <listitem> 122 <listitem>
123 <para> 123 <para>
124 <command>--with-poll_module</command><br/> 124 <literal>--with-poll_module</literal><br/>
125 <command>--without-poll_module</command>&mdash;enables or disables 125 <literal>--without-poll_module</literal>&mdash;enables or disables
126 building a module that allows the server to work with the 126 building a module that allows the server to work with the
127 <c-func>poll</c-func> method. 127 <c-func>poll</c-func> method.
128 This module is built automatically if the platform does not appear 128 This module is built automatically if the platform does not appear
129 to support more appropriate methods such as kqueue, epoll, rtsig, or /dev/poll. 129 to support more appropriate methods such as kqueue, epoll, rtsig, or /dev/poll.
130 </para> 130 </para>
131 </listitem> 131 </listitem>
132 132
133 <listitem> 133 <listitem>
134 <para> 134 <para>
135 <command>--without-http_gzip_module</command>&mdash;disables building a module 135 <literal>--without-http_gzip_module</literal>&mdash;disables building a module
136 that <link doc="http/ngx_http_gzip_module.xml">compresses responses</link> 136 that <link doc="http/ngx_http_gzip_module.xml">compresses responses</link>
137 of an HTTP server. 137 of an HTTP server.
138 The zlib library is required to build and run this module. 138 The zlib library is required to build and run this module.
139 </para> 139 </para>
140 </listitem> 140 </listitem>
141 141
142 <listitem> 142 <listitem>
143 <para> 143 <para>
144 <command>--without-http_rewrite_module</command>&mdash;disables building a 144 <literal>--without-http_rewrite_module</literal>&mdash;disables building a
145 module that allows an HTTP server to 145 module that allows an HTTP server to
146 <link doc="http/ngx_http_rewrite_module.xml">redirect requests and change URI 146 <link doc="http/ngx_http_rewrite_module.xml">redirect requests and change URI
147 of requests</link>. 147 of requests</link>.
148 The PCRE library is required to build and run this module. 148 The PCRE library is required to build and run this module.
149 The module is experimental&mdash;its directives may change in the future. 149 The module is experimental&mdash;its directives may change in the future.
150 </para> 150 </para>
151 </listitem> 151 </listitem>
152 152
153 <listitem> 153 <listitem>
154 <para> 154 <para>
155 <command>--without-http_proxy_module</command>&mdash;disables building an 155 <literal>--without-http_proxy_module</literal>&mdash;disables building an
156 HTTP server <link doc="http/ngx_http_proxy_module.xml">proxying module</link>. 156 HTTP server <link doc="http/ngx_http_proxy_module.xml">proxying module</link>.
157 <!-- 157 <!--
158 The MD5 library is required to build and run this module. 158 The MD5 library is required to build and run this module.
159 --> 159 -->
160 </para> 160 </para>
161 </listitem> 161 </listitem>
162 162
163 <listitem> 163 <listitem>
164 <para> 164 <para>
165 <command>--with-http_ssl_module</command>&mdash;enables building a module 165 <literal>--with-http_ssl_module</literal>&mdash;enables building a module
166 that adds the <link doc="http/ngx_http_ssl_module.xml">HTTPS protocol 166 that adds the <link doc="http/ngx_http_ssl_module.xml">HTTPS protocol
167 support</link> to an HTTP server. 167 support</link> to an HTTP server.
168 This module is not built by default. 168 This module is not built by default.
169 The OpenSSL library is required to build and run this module. 169 The OpenSSL library is required to build and run this module.
170 </para> 170 </para>
171 </listitem> 171 </listitem>
172 172
173 <listitem> 173 <listitem>
174 <para> 174 <para>
175 <command>--with-pcre=&lt;<value>path</value>&gt;</command>&mdash;sets 175 <literal>--with-pcre=<value>path</value></literal>&mdash;sets
176 the path to the sources of the PCRE library. 176 the path to the sources of the PCRE library.
177 The library distribution (version 177 The library distribution (version
178 4.4&mdash;6.1) needs to be downloaded from the 178 4.4&mdash;6.1) needs to be downloaded from the
179 <link url="http://www.pcre.org">PCRE</link> site and extracted. 179 <link url="http://www.pcre.org">PCRE</link> site and extracted.
180 The rest is done by nginx's ./configure and make. 180 The rest is done by nginx's ./configure and make.
186 </para> 186 </para>
187 </listitem> 187 </listitem>
188 188
189 <listitem> 189 <listitem>
190 <para> 190 <para>
191 <command>--with-zlib=&lt;<value>path</value>&gt;</command>&mdash;sets 191 <literal>--with-zlib=<value>path</value></literal>&mdash;sets
192 the path to the sources of the zlib library. 192 the path to the sources of the zlib library.
193 The library distribution (version 193 The library distribution (version
194 1.1.3&mdash;1.2.2) needs to be downloaded from the 194 1.1.3&mdash;1.2.2) needs to be downloaded from the
195 <link url="http://www.gzip.org/zlib/">zlib</link> site and extracted. 195 <link url="http://www.gzip.org/zlib/">zlib</link> site and extracted.
196 The rest is done by nginx's ./configure and make. 196 The rest is done by nginx's ./configure and make.
199 </para> 199 </para>
200 </listitem> 200 </listitem>
201 201
202 <listitem> 202 <listitem>
203 <para> 203 <para>
204 <command>--with-cc-opt=&lt;<value>parameters</value>&gt;</command>&mdash;sets 204 <literal>--with-cc-opt=<value>parameters</value></literal>&mdash;sets
205 additional parameters that will be added to the CFLAGS variable. 205 additional parameters that will be added to the CFLAGS variable.
206 When using the system PCRE library under FreeBSD, 206 When using the system PCRE library under FreeBSD,
207 <command>--with-cc-opt="-I /usr/local/include"</command> 207 <literal>--with-cc-opt="-I /usr/local/include"</literal>
208 should be specified. 208 should be specified.
209 If the number of files supported by <c-func>select</c-func> needs to be 209 If the number of files supported by <c-func>select</c-func> needs to be
210 increased it can also be specified here such as this: 210 increased it can also be specified here such as this:
211 <command>--with-cc-opt="-D FD_SETSIZE=2048"</command>. 211 <literal>--with-cc-opt="-D FD_SETSIZE=2048"</literal>.
212 </para> 212 </para>
213 </listitem> 213 </listitem>
214 214
215 <listitem> 215 <listitem>
216 <para> 216 <para>
217 <command>--with-ld-opt=&lt;<value>parameters</value>&gt;</command>&mdash;sets 217 <literal>--with-ld-opt=<value>parameters</value></literal>&mdash;sets
218 additional parameters that will be used during linking. 218 additional parameters that will be used during linking.
219 When using the system PCRE library under FreeBSD, 219 When using the system PCRE library under FreeBSD,
220 <command>--with-ld-opt="-L /usr/local/lib"</command> 220 <literal>--with-ld-opt="-L /usr/local/lib"</literal>
221 should be specified. 221 should be specified.
222 </para> 222 </para>
223 </listitem> 223 </listitem>
224 224
225 </list> 225 </list>