Mercurial > hg > nginx-site
annotate xml/en/docs/njs/install.xml @ 2618:0b98a81f196b
Documented the ssl_reject_handshake directive.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 27 Oct 2020 22:07:25 +0000 |
parents | 33468af2eaf7 |
children |
rev | line source |
---|---|
2245
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
1 <?xml version="1.0"?> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
2 |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
3 <!-- |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
4 Copyright (C) Nginx, Inc. |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
5 --> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
6 |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
7 <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd"> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
8 |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
9 <article name="Download and install" |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
10 link="/en/docs/njs/install.html" |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
11 lang="en" |
2534
33468af2eaf7
Moved load_module from examples of js modules to Installation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2459
diff
changeset
|
12 rev="3"> |
2245
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
13 |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
14 <section id="install_package" name="Installing as a Linux package"> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
15 |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
16 <para> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
17 For Linux, njs modules |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
18 <link doc="../../linux_packages.xml" id="dynmodules">packages</link> can be used: |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
19 <list type="bullet"> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
20 |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
21 <listitem> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
22 <literal>nginx-module-njs</literal> — njs |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
23 <link doc="../ngx_core_module.xml" id="load_module">dynamic</link> modules |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
24 </listitem> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
25 |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
26 <listitem> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
27 <literal>nginx-module-njs-dbg</literal> — debug symbols for the |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
28 <literal>nginx-module-njs</literal> package |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
29 </listitem> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
30 |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
31 </list> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
32 </para> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
33 |
2534
33468af2eaf7
Moved load_module from examples of js modules to Installation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2459
diff
changeset
|
34 <para> |
33468af2eaf7
Moved load_module from examples of js modules to Installation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2459
diff
changeset
|
35 After package installation, njs dynamic modules need to be loaded with the |
33468af2eaf7
Moved load_module from examples of js modules to Installation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2459
diff
changeset
|
36 <link doc="../ngx_core_module.xml" id="load_module"><literal>load_module</literal></link> |
33468af2eaf7
Moved load_module from examples of js modules to Installation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2459
diff
changeset
|
37 directive: |
33468af2eaf7
Moved load_module from examples of js modules to Installation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2459
diff
changeset
|
38 <example> |
33468af2eaf7
Moved load_module from examples of js modules to Installation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2459
diff
changeset
|
39 load_module modules/ngx_http_js_module.so; |
33468af2eaf7
Moved load_module from examples of js modules to Installation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2459
diff
changeset
|
40 </example> |
33468af2eaf7
Moved load_module from examples of js modules to Installation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2459
diff
changeset
|
41 or |
33468af2eaf7
Moved load_module from examples of js modules to Installation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2459
diff
changeset
|
42 <example> |
33468af2eaf7
Moved load_module from examples of js modules to Installation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2459
diff
changeset
|
43 load_module modules/ngx_stream_js_module.so; |
33468af2eaf7
Moved load_module from examples of js modules to Installation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2459
diff
changeset
|
44 </example> |
33468af2eaf7
Moved load_module from examples of js modules to Installation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2459
diff
changeset
|
45 </para> |
33468af2eaf7
Moved load_module from examples of js modules to Installation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2459
diff
changeset
|
46 |
2245
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
47 </section> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
48 |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
49 |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
50 <section id="install_sources" name="Building from the sources"> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
51 |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
52 <para> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
53 The <link url="http://hg.nginx.org/njs">repository</link> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
54 with njs sources can be cloned with the following command: |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
55 (requires <link url="https://www.mercurial-scm.org">Mercurial</link> client): |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
56 <example> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
57 hg clone http://hg.nginx.org/njs |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
58 </example> |
2459
2aad23d07d96
Clarified procedure for building njs modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2245
diff
changeset
|
59 Then the modules should be compiled from |
2aad23d07d96
Clarified procedure for building njs modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2245
diff
changeset
|
60 <link doc="../configure.xml">nginx</link> root directory using the |
2245
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
61 <literal>--add-module</literal> configuration parameter: |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
62 <example> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
63 ./configure --add-module=<value>path-to-njs</value>/nginx |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
64 </example> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
65 The modules can also be built as |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
66 <link doc="../ngx_core_module.xml" id="load_module">dynamic</link>: |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
67 <example> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
68 ./configure --add-dynamic-module=<value>path-to-njs</value>/nginx |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
69 </example> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
70 </para> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
71 |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
72 <para> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
73 To build only njs command-line <link doc="cli.xml">utility</link>, run |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
74 <literal>./configure</literal> and <literal>make njs</literal> commands |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
75 from njs root directory. |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
76 The utility is available as <literal>./build/njs</literal>. |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
77 </para> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
78 |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
79 </section> |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
80 |
87a0e2c73a25
Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
81 </article> |