nginx-site: xml/en/docs/windows.xml annotate

annotate xml/en/docs/windows.xml @ 3090:27532d42102b default tip

Documented the "rate" parameter of the "error_log" directive.

author	Maxim Dounin <mdounin@mdounin.ru>
date	Sun, 16 Jun 2024 06:55:30 +0300
parents	be1ef1d56e96
children

rev	line source
580 be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 553 diff changeset	1 <!--
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 553 diff changeset	2 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 553 diff changeset	3 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 553 diff changeset	4 -->
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 553 diff changeset	5
50 9d544687d02c Fixed DOCTYPE declaration. Ruslan Ermilov <ru@nginx.com> parents: 0 diff changeset	6 <!DOCTYPE article SYSTEM "../../../dtd/article.dtd">
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	7
3076 be1ef1d56e96 Updated Windows archive names. Maxim Dounin <mdounin@mdounin.ru> parents: 2342 diff changeset	8 <article name="freenginx for Windows"
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	9 link="/en/docs/windows.html"
589 764fbac1b8b4 Added document revision. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	10 lang="en"
3076 be1ef1d56e96 Updated Windows archive names. Maxim Dounin <mdounin@mdounin.ru> parents: 2342 diff changeset	11 rev="6">
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	12
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	13 <section>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	14
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	15 <para>
3076 be1ef1d56e96 Updated Windows archive names. Maxim Dounin <mdounin@mdounin.ru> parents: 2342 diff changeset	16 Version of freenginx for Windows uses the native Win32 API
be1ef1d56e96 Updated Windows archive names. Maxim Dounin <mdounin@mdounin.ru> parents: 2342 diff changeset	17 (not the Cygwin emulation layer).
2342 4795c2ae5066 Added the "poll" method for Windows. Yaroslav Zhuravlev <yar@nginx.com> parents: 1878 diff changeset	18 Only the <c-func>select</c-func> and <c-func>poll</c-func> (1.15.9)
4795c2ae5066 Added the "poll" method for Windows. Yaroslav Zhuravlev <yar@nginx.com> parents: 1878 diff changeset	19 connection processing methods are currently used,
265 4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	20 so high performance and scalability should not be expected.
3076 be1ef1d56e96 Updated Windows archive names. Maxim Dounin <mdounin@mdounin.ru> parents: 2342 diff changeset	21 Due to this and some other known issues version of freenginx for Windows
265 4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	22 is considered to be a <i>beta</i> version.
4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	23 At this time, it provides almost the same functionality as a UNIX version
4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	24 of nginx except for
4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	25 XSLT filter, image filter, GeoIP module, and embedded Perl language.
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	26 </para>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	27
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	28 <para>
3076 be1ef1d56e96 Updated Windows archive names. Maxim Dounin <mdounin@mdounin.ru> parents: 2342 diff changeset	29 To install freenginx/Windows, <link doc="../download.xml">download</link>
922 9ad2770d3f28 Finished renaming development to mainline. Ruslan Ermilov <ru@nginx.com> parents: 589 diff changeset	30 the latest mainline version distribution (<mainline_version/>),
9ad2770d3f28 Finished renaming development to mainline. Ruslan Ermilov <ru@nginx.com> parents: 589 diff changeset	31 since the mainline branch of nginx contains all known fixes.
265 4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	32 Then unpack the distribution, go to the
3076 be1ef1d56e96 Updated Windows archive names. Maxim Dounin <mdounin@mdounin.ru> parents: 2342 diff changeset	33 freenginx-<mainline_version/>
265 4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	34 directory, and run <command>nginx</command>.
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	35 Here is an example for the drive C: root directory:
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	36
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	37 <programlisting>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	38 cd c:\
3076 be1ef1d56e96 Updated Windows archive names. Maxim Dounin <mdounin@mdounin.ru> parents: 2342 diff changeset	39 unzip freenginx-<mainline_version/>.zip
be1ef1d56e96 Updated Windows archive names. Maxim Dounin <mdounin@mdounin.ru> parents: 2342 diff changeset	40 cd freenginx-<mainline_version/>
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	41 start nginx
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	42 </programlisting>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43
265 4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	44 Run the <command>tasklist</command> command-line utility
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45 to see nginx processes:
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	46
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	47 <programlisting>
922 9ad2770d3f28 Finished renaming development to mainline. Ruslan Ermilov <ru@nginx.com> parents: 589 diff changeset	48 C:\nginx-<mainline_version/>>tasklist /fi "imagename eq nginx.exe"
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	49
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	50 Image Name PID Session Name Session# Mem Usage
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	51 =============== ======== ============== ========== ============
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	52 nginx.exe 652 Console 0 2 780 K
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	53 nginx.exe 1332 Console 0 3 112 K
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	54 </programlisting>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	55
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	56 One of the processes is the master process and another is the worker process.
265 4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	57 If nginx does not start, look for the reason in
4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	58 the error log file <path>logs\error.log</path>.
4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	59 If the log file has not been created, the reason for this should be reported
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	60 in the Windows Event Log.
265 4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	61 If an error page is displayed instead of the expected page, also look
4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	62 for the reason in the <path>logs\error.log</path> file.
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	63 </para>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	64
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	65 <para>
3076 be1ef1d56e96 Updated Windows archive names. Maxim Dounin <mdounin@mdounin.ru> parents: 2342 diff changeset	66 freenginx/Windows uses the directory where it has been run as the prefix
265 4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	67 for relative paths in the configuration.
4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	68 In the example above, the prefix is
3076 be1ef1d56e96 Updated Windows archive names. Maxim Dounin <mdounin@mdounin.ru> parents: 2342 diff changeset	69 <path>C:\freenginx-<mainline_version/>\</path>.
265 4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	70 Paths in a configuration file must be specified in UNIX-style using
4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	71 forward slashes:
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	72
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	73 <programlisting>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	74 access_log logs/site.log;
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	75 root C:/web/html;
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	76 </programlisting>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	77 </para>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	78
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	79 <para>
3076 be1ef1d56e96 Updated Windows archive names. Maxim Dounin <mdounin@mdounin.ru> parents: 2342 diff changeset	80 freenginx/Windows runs as a standard console application (not a service),
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	81 and it can be managed using the following commands:
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	82
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	83 <table note="yes">
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	84
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	85 <tr>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	86 <td width="20%">nginx -s stop</td>
265 4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	87 <td>fast shutdown</td>
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	88 </tr>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	89
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	90 <tr>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	91 <td>nginx -s quit</td>
265 4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	92 <td>graceful shutdown</td>
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	93 </tr>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	94
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	95 <tr>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	96 <td>nginx -s reload</td>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	97 <td>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	98 changing configuration,
265 4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	99 starting new worker processes with a new configuration,
4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	100 graceful shutdown of old worker processes
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	101 </td>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	102 </tr>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	103
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	104 <tr>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	105 <td>nginx -s reopen</td>
265 4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	106 <td>re-opening log files</td>
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107 </tr>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	108
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	109 </table>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	110 </para>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	111
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	112 </section>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	113
121 49443032011c Unified <section> syntax for "article" and "module" documents. Ruslan Ermilov <ru@nginx.com> parents: 50 diff changeset	114 <section id="known_issues"
49443032011c Unified <section> syntax for "article" and "module" documents. Ruslan Ermilov <ru@nginx.com> parents: 50 diff changeset	115 name="Known issues">
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	116
461 6135f3c95bf6 Unified markup for lists. Ruslan Ermilov <ru@nginx.com> parents: 265 diff changeset	117 <list type="bullet">
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	118
461 6135f3c95bf6 Unified markup for lists. Ruslan Ermilov <ru@nginx.com> parents: 265 diff changeset	119 <listitem>
265 4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	120 Although several workers can be started, only one of them
4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	121 actually does any work.
461 6135f3c95bf6 Unified markup for lists. Ruslan Ermilov <ru@nginx.com> parents: 265 diff changeset	122 </listitem>
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	123
461 6135f3c95bf6 Unified markup for lists. Ruslan Ermilov <ru@nginx.com> parents: 265 diff changeset	124 <listitem>
1662 48615cf80e20 Documented the UDP proxy functionality. Yaroslav Zhuravlev <yar@nginx.com> parents: 922 diff changeset	125 The UDP proxy functionality is not supported.
48615cf80e20 Documented the UDP proxy functionality. Yaroslav Zhuravlev <yar@nginx.com> parents: 922 diff changeset	126 </listitem>
48615cf80e20 Documented the UDP proxy functionality. Yaroslav Zhuravlev <yar@nginx.com> parents: 922 diff changeset	127
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	128 </list>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	129
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	130 </section>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	131
121 49443032011c Unified <section> syntax for "article" and "module" documents. Ruslan Ermilov <ru@nginx.com> parents: 50 diff changeset	132 <section id="possible_future_enhancements"
49443032011c Unified <section> syntax for "article" and "module" documents. Ruslan Ermilov <ru@nginx.com> parents: 50 diff changeset	133 name="Possible future enhancements">
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	134
461 6135f3c95bf6 Unified markup for lists. Ruslan Ermilov <ru@nginx.com> parents: 265 diff changeset	135 <list type="bullet">
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	136
461 6135f3c95bf6 Unified markup for lists. Ruslan Ermilov <ru@nginx.com> parents: 265 diff changeset	137 <listitem>
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	138 Running as a service.
461 6135f3c95bf6 Unified markup for lists. Ruslan Ermilov <ru@nginx.com> parents: 265 diff changeset	139 </listitem>
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	140
461 6135f3c95bf6 Unified markup for lists. Ruslan Ermilov <ru@nginx.com> parents: 265 diff changeset	141 <listitem>
553 6330ca27a485 Translated "events" into English. Ruslan Ermilov <ru@nginx.com> parents: 461 diff changeset	142 Using the I/O completion ports as a connection processing method.
461 6135f3c95bf6 Unified markup for lists. Ruslan Ermilov <ru@nginx.com> parents: 265 diff changeset	143 </listitem>
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	144
461 6135f3c95bf6 Unified markup for lists. Ruslan Ermilov <ru@nginx.com> parents: 265 diff changeset	145 <listitem>
265 4d047c05b7ad Revised the "nginx for Windows" article. Ruslan Ermilov <ru@nginx.com> parents: 148 diff changeset	146 Using multiple worker threads inside a single worker process.
461 6135f3c95bf6 Unified markup for lists. Ruslan Ermilov <ru@nginx.com> parents: 265 diff changeset	147 </listitem>
0 61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	148
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	149 </list>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	150
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	151 </section>
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	152
61e04fc01027 Initial import of the nginx.org website. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	153 </article>

Mercurial > hg > nginx-site

annotate xml/en/docs/windows.xml @ 3090:27532d42102b default tip