annotate xml/en/docs/install.xml @ 580:be54c443235a

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