Mercurial > hg > nginx-site

annotate xml/en/docs/install.xml @ 486:1bf933a9df8b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
- Mentioned that --with-pcre-jit has appeared in 1.1.12, and added a link to the "pcre_jit" directive. - Brought the range of supported PCRE library versions up to date.
author Ruslan Ermilov <ru@nginx.com>
date Wed, 11 Apr 2012 03:26:09 +0000
parents 6135f3c95bf6
children be54c443235a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <!DOCTYPE article SYSTEM "../../../dtd/article.dtd">
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
3 <article name="Installing nginx"
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
4 link="/en/docs/install.html"
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
5 lang="en">
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
6
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
7 <section>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9 <para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10 The build is configured using the <command>configure</command> command.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 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
12 is allowed to use for connection processing.
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
13 At the end it creates a <path>Makefile</path>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14 The <command>configure</command> command supports the following parameters:
461
6135f3c95bf6 Unified markup for lists.
Ruslan Ermilov <ru@nginx.com>
parents: 289
diff changeset
15 <list type="bullet">
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
17 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
19 <literal>--prefix=<value>path</value></literal>&mdash;defines
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 a directory that will keep server files.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21 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
22 <command>configure</command> (except for paths to libraries sources)
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
23 and in the <path>nginx.conf</path> configuration file.
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
24 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
25 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
30 <literal>--sbin-path=<value>path</value></literal>&mdash;sets
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31 the name of an nginx executable file.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32 This name is used only during installation.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 By default the file is named
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
34 <path><value>prefix</value>/sbin/nginx</path>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
37
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
40 <literal>--conf-path=<value>path</value></literal>&mdash;sets
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
41 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
42 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
43 by specifying it in the command-line parameter
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
44 <nobr><literal>-c <value>file</value></literal></nobr>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45 By default the file is named
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
46 <path><value>prefix</value>/conf/nginx.conf</path>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
52 <literal>--pid-path=<value>path</value></literal>&mdash;sets
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 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
54 of the main process.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55 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
56 <path>nginx.conf</path> configuration file using the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57 <link doc="ngx_core_module.xml" id="pid"/> directive.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58 By default the file is named
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
59 <path><value>prefix</value>/logs/nginx.pid</path>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
65 <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
66 the name of the primary error, warnings, and diagnostic file.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
67 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
68 <path>nginx.conf</path> configuration file using the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69 <link doc="ngx_core_module.xml" id="error_log"/> directive.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70 By default the file is named
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
71 <path><value>prefix</value>/logs/error.log</path>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
77 <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
78 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
79 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
80 <path>nginx.conf</path> configuration file using the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81 <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
82 By default the file is named
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
83 <path><value>prefix</value>/logs/access.log</path>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
85 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
86
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
89 <literal>--user=<value>name</value></literal>&mdash;sets
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 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
91 by worker processes.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 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
93 <path>nginx.conf</path> configuration file using the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 <link doc="ngx_core_module.xml" id="user"/> directive.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95 The default user name is nobody.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
98
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
100 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
101 <literal>--group=<value>name</value></literal>&mdash;sets
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
102 the name of a group whose credentials will be used
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
103 by worker processes.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
104 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
105 <path>nginx.conf</path> configuration file using the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
106 <link doc="ngx_core_module.xml" id="user"/> directive.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
107 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
108 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
109 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
110
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
113 <literal>--with-select_module</literal><br/>
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
114 <literal>--without-select_module</literal>&mdash;enables or disables
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
115 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
116 <c-func>select</c-func> method.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 This module is built automatically if the platform does not appear
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
118 to support more appropriate methods such as kqueue, epoll, rtsig, or /dev/poll.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
119 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121
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 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
124 <literal>--with-poll_module</literal><br/>
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
125 <literal>--without-poll_module</literal>&mdash;enables or disables
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
126 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
127 <c-func>poll</c-func> method.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
128 This module is built automatically if the platform does not appear
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
129 to support more appropriate methods such as kqueue, epoll, rtsig, or /dev/poll.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
130 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
131 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
132
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 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
135 <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
136 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
137 of an HTTP server.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
138 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
139 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
140 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
141
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
142 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
143 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
144 <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
145 module that allows an HTTP server to
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
146 <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
147 of requests</link>.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
148 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
149 The module is experimental&mdash;its directives may change in the future.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
150 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
151 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
152
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 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
155 <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
156 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
157 <!--
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
158 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
159 -->
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
160 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
161 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
162
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 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
165 <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
166 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
167 support</link> to an HTTP server.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
168 This module is not built by default.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
169 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
170 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
171 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
172
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 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
175 <literal>--with-pcre=<value>path</value></literal>&mdash;sets
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
176 the path to the sources of the PCRE library.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
177 The library distribution (version
486
1bf933a9df8b - Mentioned that --with-pcre-jit has appeared in 1.1.12, and added
Ruslan Ermilov <ru@nginx.com>
parents: 461
diff changeset
178 4.4&mdash;8.30) needs to be downloaded from the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
179 <link url="http://www.pcre.org">PCRE</link> site and extracted.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
180 The rest is done by nginx's ./configure and make.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181 The library is required for regular expressions support in the
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
182 <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
183 and for the
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
184 <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
185 module.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
186 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
187 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
188
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
189 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
190 <para>
289
df261b1ce71f Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents: 282
diff changeset
191 <literal>--with-pcre-jit</literal>&mdash;builds the PCRE library with
486
1bf933a9df8b - Mentioned that --with-pcre-jit has appeared in 1.1.12, and added
Ruslan Ermilov <ru@nginx.com>
parents: 461
diff changeset
192 “just-in-time compilation” support (1.1.12, see
1bf933a9df8b - Mentioned that --with-pcre-jit has appeared in 1.1.12, and added
Ruslan Ermilov <ru@nginx.com>
parents: 461
diff changeset
193 <link doc="ngx_core_module.xml" id="pcre_jit"/>).
289
df261b1ce71f Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents: 282
diff changeset
194 </para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents: 282
diff changeset
195 </listitem>
df261b1ce71f Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents: 282
diff changeset
196
df261b1ce71f Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents: 282
diff changeset
197 <listitem>
df261b1ce71f Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents: 282
diff changeset
198 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
199 <literal>--with-zlib=<value>path</value></literal>&mdash;sets
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
200 the path to the sources of the zlib library.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
201 The library distribution (version
282
64107bc400c4 Bumped versions of supported PCRE and zlib libraries.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
202 1.1.3&mdash;1.2.5) needs to be downloaded from the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
203 <link url="http://www.gzip.org/zlib/">zlib</link> site and extracted.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
204 The rest is done by nginx's ./configure and make.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
205 The library is required for the
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
206 <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
207 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
208 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
209
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
210 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
211 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
212 <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
213 additional parameters that will be added to the CFLAGS variable.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
214 When using the system PCRE library under FreeBSD,
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
215 <literal>--with-cc-opt="-I /usr/local/include"</literal>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
216 should be specified.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
217 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
218 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
219 <literal>--with-cc-opt="-D FD_SETSIZE=2048"</literal>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
220 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
221 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
222
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
223 <listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
224 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
225 <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
226 additional parameters that will be used during linking.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
227 When using the system PCRE library under FreeBSD,
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
228 <literal>--with-ld-opt="-L /usr/local/lib"</literal>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
229 should be specified.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
230 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
231 </listitem>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
232
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
233 </list>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
234
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
235 </para>
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 <para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
238 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
239 <programlisting>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
240 ./configure
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
241 --sbin-path=/usr/local/nginx/nginx
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
242 --conf-path=/usr/local/nginx/nginx.conf
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
243 --pid-path=/usr/local/nginx/nginx.pid
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
244 --with-http_ssl_module
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
245 --with-pcre=../pcre-4.4
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
246 --with-zlib=../zlib-1.1.3
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
247 </programlisting>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
248 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
249
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
250 </section>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
251
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
252 </article>