<?xml version="1.0"?>

<!DOCTYPE module SYSTEM "../../../dtd/module.dtd">

<module name="Core functionality"
        link="/en/docs/ngx_core_module.html"
        lang="en">

<section id="example" name="Example Configuration">

<para>
<example>
user www www;
worker_processes 2;

error_log /var/log/nginx-error.log info;

events {
    use kqueue;
    worker_connections 2048;
}

...
</example>
</para>

</section>


<section id="directives" name="Directives">

<directive name="daemon">
<syntax><literal>on</literal> | <literal>off</literal></syntax>
<default>on</default>
<context>main</context>

<para>
Determines whether nginx should become a daemon.
Mainly used during development.
</para>

</directive>


<directive name="error_log">
<syntax>
<value>file</value> | <literal>stderr</literal>
[<literal>debug</literal> |
<literal>info</literal> |
<literal>notice</literal> |
<literal>warn</literal> |
<literal>error</literal> |
<literal>crit</literal> |
<literal>alert</literal> |
<literal>emerg</literal>]</syntax>
<default>logs/error.log error</default>
<context>main</context>
<context>http</context>
<context>server</context>
<context>location</context>

<para>
Configures logging.
</para>

<para>
The first parameter defines a file that will store the log.
<!--
If filename is not absolute, it is prefixed with the prefix path.
-->
The special value <literal>stderr</literal> selects the standard error file.
</para>

<para>
The second parameter determines the level of logging.
Log levels above are listed in the order of increasing severity.
Setting a certain log level will cause all messages of
the specified and more severe log levels to be logged.
For example, the default level <literal>error</literal> will
cause <literal>error</literal>, <literal>crit</literal>,
<literal>alert</literal>, and <literal>emerg</literal> messages
to be logged.
If this parameter is omitted then <literal>error</literal> is used.
<note>
For <literal>debug</literal> logging to work, nginx needs to
be built with <literal>--with-debug</literal>.
</note>
</para>

</directive>


<directive name="env">
<syntax><value>variable</value>[=<value>value</value>]</syntax>
<default>TZ</default>
<context>main</context>

<para>
Allows to limit a set of environment variables, change their values,
or create new environment variables, for the following cases:
<list type="bullet">

<listitem>
variable inheritance during a
<link doc="control.xml" id="upgrade">live upgrade</link>
of an executable file;
</listitem>

<listitem>
use of variables by the module
<link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link>;
</listitem>

<listitem>
use of variables by worker processes.
Please bear in mind that controlling system libraries in this way
is not always possible as it is not uncommon for libraries to check
variables only during initialization, well before they can be set
using this directive.
An exception from this is an above mentioned
<link doc="control.xml" id="upgrade">live upgrade</link>
of an executable file.
</listitem>

</list>
</para>

<para>
The TZ variable is always inherited and made available to the module
<link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link>,
unless configured explicitly.
</para>

<para>
Usage example:
<example>
env MALLOC_OPTIONS;
env PERL5LIB=/data/site/modules;
env OPENSSL_ALLOW_PROXY_CERTS=1;
</example>
</para>

<para>
<note>
The NGINX environment variable is used internally by nginx
and should not be set directly by the user.
</note>
</para>

</directive>


<directive name="include">
<syntax><value>file</value> | <value>mask</value></syntax>
<default/>
<context/>

<para>
Includes another <value>file</value>, or files matching the
specified <value>mask</value>, into configuration.
Included files should consist of
syntactically correct directives and blocks.
</para>

<para>
Usage example:
<example>
include mime.types;
include vhosts/*.conf;
</example>
</para>

</directive>


<directive name="master_process">
<syntax><literal>on</literal> | <literal>off</literal></syntax>
<default>on</default>
<context>main</context>

<para>
Determines whether worker processes are started.
This directive is intended for nginx developers.
</para>

</directive>


<directive name="pcre_jit">
<syntax><literal>on</literal> | <literal>off</literal></syntax>
<default>off</default>
<context>main</context>
<appeared-in>1.1.12</appeared-in>

<para>
Enables or disables the use of “just-in-time compilation” (PCRE JIT)
for regular expressions known at configuration parse time.
</para>

<para>
PCRE JIT can speed up processing of regular expressions significantly.
<note>
The JIT is available in PCRE libraries starting from version 8.20
built with the <literal>--enable-jit</literal> configuration parameter.
When building the PCRE library with nginx (<literal>--with-pcre=</literal>),
the JIT support should be enabled with the
<literal>--with-pcre-jit</literal> configuration parameter.
</note>
</para>

</directive>


<directive name="pid">
<syntax><value>file</value></syntax>
<default>nginx.pid</default>
<context>main</context>

<para>
Defines a <value>file</value> that will store the process ID of the main process.
</para>

</directive>


<directive name="ssl_engine">
<syntax><value>device</value></syntax>
<default/>
<context>main</context>

<para>
Defines the name of the hardware SSL accelerator.
</para>

</directive>


<directive name="timer_resolution">
<syntax><value>interval</value></syntax>
<default/>
<context>main</context>

<para>
Reduces timer resolution in worker processes, thus reducing the
number of <c-func>gettimeofday</c-func> system calls made.
By default, <c-func>gettimeofday</c-func> is called each time
on receiving a kernel event.
With reduced resolution, <c-func>gettimeofday</c-func> is only
called once per specified <value>interval</value>.
</para>

<para>
Example:
<example>
timer_resolution 100ms;
</example>
</para>

<para>
An internal implementation of interval depends on the method used:
<list type="bullet">

<listitem>
an <c-def>EVFILT_TIMER</c-def> filter if <literal>kqueue</literal> is used;
</listitem>

<listitem>
<c-func>timer_create</c-func> if <literal>eventport</literal> is used;
</listitem>

<listitem>
<c-func>setitimer</c-func> otherwise.
</listitem>

</list>
</para>

</directive>


<directive name="user">
<syntax><value>user</value> [<value>group</value>]</syntax>
<default>nobody nobody</default>
<context>main</context>

<para>
Defines <value>user</value> and <value>group</value>
credentials used by worker processes.
If <value>group</value> is omitted, a group whose name equals
that of <value>user</value> is used.
</para>

</directive>


<directive name="worker_priority">
<syntax><value>number</value></syntax>
<default>0</default>
<context>main</context>

<para>
Defines a scheduling priority for worker processes like is
done by the <command>nice</command> command: a negative
<value>number</value>
means higher priority.
Allowed range normally varies from -20 to 20.
</para>

<para>
Example:
<example>
worker_priority -10;
</example>
</para>

</directive>


<directive name="worker_processes">
<syntax><value>number</value></syntax>
<default>1</default>
<context>main</context>

<para>
Defines the number of worker processes.
</para>

<para>
The optimal value depends on many factors including (but not
limited to) the number of CPU cores, the number of hard disk
drives that store data, and load pattern.
When in doubt, setting it to the number of available CPU cores
would be a good start.
</para>

</directive>


<directive name="worker_rlimit_core">
<syntax><value>size</value></syntax>
<default/>
<context>main</context>

<para>
Changes the limit on the largest size of a core file
(<c-def>RLIMIT_CORE</c-def>) for worker processes.
Used to increase the limit without restarting the main process.
</para>

</directive>


<directive name="worker_rlimit_nofile">
<syntax><value>number</value></syntax>
<default/>
<context>main</context>

<para>
Changes the limit on the maximum number of open files
(<c-def>RLIMIT_NOFILE</c-def>) for worker processes.
Used to increase the limit without restarting the main process.
</para>

</directive>


<directive name="working_directory">
<syntax><value>directory</value></syntax>
<default/>
<context>main</context>

<para>
Defines a current working directory for a worker process.
It is primarily used when writing a core-file, in which case
a worker process should have write permission for the
specified directory.
</para>

</directive>

</section>

</module>