Mercurial > hg > nginx-site

comparison xml/en/docs/njs/install.xml @ 2245:87a0e2c73a25

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Refactored njs documentation.
author Yaroslav Zhuravlev <yar@nginx.com>
date Mon, 24 Sep 2018 19:10:29 +0300
parents
children 2aad23d07d96
comparison
equal deleted inserted replaced
2244:467aef18bf12 2245:87a0e2c73a25
1 <?xml version="1.0"?>
2
3 <!--
4 Copyright (C) Nginx, Inc.
5 -->
6
7 <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd">
8
9 <article name="Download and install"
10 link="/en/docs/njs/install.html"
11 lang="en"
12 rev="1">
13
14 <section id="install_package" name="Installing as a Linux package">
15
16 <para>
17 For Linux, njs modules
18 <link doc="../../linux_packages.xml" id="dynmodules">packages</link> can be used:
19 <list type="bullet">
20
21 <listitem>
22 <literal>nginx-module-njs</literal> — njs
23 <link doc="../ngx_core_module.xml" id="load_module">dynamic</link> modules
24 </listitem>
25
26 <listitem>
27 <literal>nginx-module-njs-dbg</literal> — debug symbols for the
28 <literal>nginx-module-njs</literal> package
29 </listitem>
30
31 </list>
32 </para>
33
34 </section>
35
36
37 <section id="install_sources" name="Building from the sources">
38
39 <para>
40 The <link url="http://hg.nginx.org/njs">repository</link>
41 with njs sources can be cloned with the following command:
42 (requires <link url="https://www.mercurial-scm.org">Mercurial</link> client):
43 <example>
44 hg clone http://hg.nginx.org/njs
45 </example>
46 Then the modules should be compiled using the
47 <literal>--add-module</literal> configuration parameter:
48 <example>
49 ./configure --add-module=<value>path-to-njs</value>/nginx
50 </example>
51 The modules can also be built as
52 <link doc="../ngx_core_module.xml" id="load_module">dynamic</link>:
53 <example>
54 ./configure --add-dynamic-module=<value>path-to-njs</value>/nginx
55 </example>
56 </para>
57
58 <para>
59 To build only njs command-line <link doc="cli.xml">utility</link>, run
60 <literal>./configure</literal> and <literal>make njs</literal> commands
61 from njs root directory.
62 The utility is available as <literal>./build/njs</literal>.
63 </para>
64
65 </section>
66
67 </article>