mirror of
https://github.com/nginx/nginx.git
synced 2025-02-25 18:55:26 -06:00
The reference documentation is moving elsewhere.
This commit is contained in:
Ruslan Ermilov
File diff suppressed because it is too large
Load Diff
@@ -1,90 +0,0 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>HTTP MP4 Module</title></head><body><center><h3>HTTP MP4 Module</h3></center><center><h4>Summary</h4></center><p>
|
||||
The module <code>ngx_http_mp4_module</code> provides pseudo-streaming
|
||||
server-side support for H.264/AAC files typically having filename extensions
|
||||
<code>.mp4</code>, <code>.m4v</code>,
|
||||
and <code>.m4a</code>.
|
||||
</p><p>
|
||||
Pseudo-streaming works in alliance with conformant Flash players.
|
||||
A player sends an HTTP request to the server with a start time
|
||||
argument in the request URI’s query string (named simply
|
||||
<code>start</code>
|
||||
and specified in seconds), and the server responds with a stream
|
||||
so that its start position corresponds to the requested time,
|
||||
for example:
|
||||
<blockquote><pre>
|
||||
http://example.com/elephants_dream.mp4?start=238.88
|
||||
</pre></blockquote>
|
||||
This allows for a random seeking at any time, or starting playback
|
||||
in the middle of a timeline.
|
||||
</p><p>
|
||||
To support seeking, H.264-based formats store the metadata
|
||||
in the so-called “moov atom.”
|
||||
It is a part of the file that holds the index information for the
|
||||
whole file.
|
||||
</p><p>
|
||||
To start playback, a player first needs to read metadata.
|
||||
This is done by sending a special request with the
|
||||
<code>start=0</code>
|
||||
argument. Many encoding software will insert the metadata at
|
||||
the end of the file. This is bad for pseudo-streaming:
|
||||
the metadata needs to be located at the beginning of the file,
|
||||
or else the entire file will have to be downloaded before it
|
||||
starts playing. If a file is well-formed (with metadata at the
|
||||
beginning of a file), nginx just sends back the contents of a file.
|
||||
Otherwise, it has to read the file and prepare a new stream so that
|
||||
metadata comes before media data.
|
||||
This involves some CPU, memory, and disk I/O overhead,
|
||||
so it is a good idea to
|
||||
<a href="http://flowplayer.org/plugins/streaming/pseudostreaming.html#prepare">
|
||||
prepare an original file for pseudo-streaming</a>,
|
||||
rather than having nginx do this on every such request.
|
||||
</p><p>
|
||||
For a matching request with a non-zero
|
||||
<code>start</code>
|
||||
argument, nginx will read metadata from the file, prepare the
|
||||
stream starting from the requested offset, and send it to a client.
|
||||
This has the same overhead as described above.
|
||||
</p><p>
|
||||
If a matching request does not include the
|
||||
<code>start</code>
|
||||
argument, there is no overhead, and the file is just sent as a static resource.
|
||||
Some players also support byte-range requests, and thus do not require
|
||||
this module at all.
|
||||
</p><p>
|
||||
This module is not built by default, it should be enabled with the
|
||||
<code>--with-http_mp4_module</code>
|
||||
configuration parameter.
|
||||
|
||||
If you were using the third-party mp4 module, be sure to disable it.
|
||||
</p><p>
|
||||
A similar pseudo-streaming support for FLV files is provided by the module
|
||||
<a href="ngx_http_flv_module.html">ngx_http_flv_module</a>.
|
||||
</p><a name="example"></a><center><h4>Example Configuration</h4></center><p><blockquote><pre>
|
||||
location /video/ {
|
||||
mp4;
|
||||
mp4_buffer_size 1m;
|
||||
mp4_max_buffer_size 5m;
|
||||
}
|
||||
</pre></blockquote></p><a name="directives"></a><center><h4>Directives</h4></center><hr><a name="mp4"></a><strong>syntax</strong>:
|
||||
<code>mp4</code><br><strong>default</strong>:
|
||||
<strong>none</strong><br><strong>context</strong>:
|
||||
<code>location</code><br><p>
|
||||
Turns on module processing in a surrounding location.
|
||||
</p><hr><a name="mp4_buffer_size"></a><strong>syntax</strong>:
|
||||
<code>mp4_buffer_size <code><i>size</i></code></code><br><strong>default</strong>:
|
||||
<code>mp4_buffer_size 512K</code><br><strong>context</strong>:
|
||||
<code>http</code>, <code>server</code>, <code>location</code><br><p>
|
||||
Sets the initial size of a memory buffer used to process MP4 files.
|
||||
</p><hr><a name="mp4_max_buffer_size"></a><strong>syntax</strong>:
|
||||
<code>mp4_max_buffer_size <code><i>size</i></code></code><br><strong>default</strong>:
|
||||
<code>mp4_max_buffer_size 10M</code><br><strong>context</strong>:
|
||||
<code>http</code>, <code>server</code>, <code>location</code><br><p>
|
||||
During metadata processing, a larger buffer may become necessary.
|
||||
Its size cannot exceed the specified <code><i>size</i></code>,
|
||||
or else nginx will return the server error
|
||||
500 (Internal Server Error),
|
||||
and log the following:
|
||||
<blockquote><pre>
|
||||
"/some/movie/file.mp4" mp4 moov atom is too large:
|
||||
12583268, you may want to increase mp4_max_buffer_size
|
||||
</pre></blockquote></p></body></html>
|
||||
@@ -1,148 +0,0 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>Core Module</title></head><body><center><h3>Core Module</h3></center><a name="example"></a><center><h4>Example Configuration</h4></center><p><blockquote><pre>
|
||||
user www www;
|
||||
worker_processes 2;
|
||||
|
||||
error_log /var/log/nginx-error.log info;
|
||||
|
||||
events {
|
||||
use kqueue;
|
||||
worker_connections 2048;
|
||||
}
|
||||
|
||||
...
|
||||
</pre></blockquote></p><a name="directives"></a><center><h4>Directives</h4></center><hr><a name="daemon"></a><strong>syntax</strong>:
|
||||
<code>daemon <code>on</code> | <code>off</code></code><br><strong>default</strong>:
|
||||
<code>daemon on</code><br><strong>context</strong>:
|
||||
<code>main</code><br><p>
|
||||
Determines whether nginx should become a daemon.
|
||||
Mainly used during development.
|
||||
</p><hr><a name="env"></a><strong>syntax</strong>:
|
||||
<code>env <code><i>VAR</i></code>[=<code><i>VALUE</i></code>]</code><br><strong>default</strong>:
|
||||
<code>env TZ</code><br><strong>context</strong>:
|
||||
<code>main</code><br><p>
|
||||
Allows to limit a set of environment variables, change their values,
|
||||
or create new environment variables, for the following cases:
|
||||
<ul><li>
|
||||
variable inheritance during a
|
||||
<a href="control.html#upgrade">live upgrade</a>
|
||||
of an executable file;
|
||||
</li><li>
|
||||
use of variables by the module
|
||||
<a href="http/ngx_http_perl_module.html">ngx_http_perl_module</a>;
|
||||
</li><li>
|
||||
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
|
||||
<a href="control.html#upgrade">live upgrade</a>
|
||||
of an executable file.
|
||||
</li></ul></p><p>
|
||||
The TZ variable is always inherited and made available to the module
|
||||
<a href="http/ngx_http_perl_module.html">ngx_http_perl_module</a>,
|
||||
unless configured explicitly.
|
||||
</p><p>
|
||||
Usage example:
|
||||
<blockquote><pre>
|
||||
env MALLOC_OPTIONS;
|
||||
env PERL5LIB=/data/site/modules;
|
||||
env OPENSSL_ALLOW_PROXY_CERTS=1;
|
||||
</pre></blockquote></p><hr><a name="include"></a><strong>syntax</strong>:
|
||||
<code>include <code><i>file</i></code> | <code><i>mask</i></code></code><br><strong>default</strong>:
|
||||
<strong>none</strong><br><strong>context</strong>:
|
||||
<strong>any</strong><br><p>
|
||||
Includes another <code><i>file</i></code>, or files matching the
|
||||
specified <code><i>mask</i></code>, into configuration.
|
||||
Included files should consist of
|
||||
syntactically correct directives and blocks.
|
||||
</p><p>
|
||||
Usage example:
|
||||
<blockquote><pre>
|
||||
include mime.types;
|
||||
include vhosts/*.conf;
|
||||
</pre></blockquote></p><hr><a name="master_process"></a><strong>syntax</strong>:
|
||||
<code>master_process <code>on</code> | <code>off</code></code><br><strong>default</strong>:
|
||||
<code>master_process on</code><br><strong>context</strong>:
|
||||
<code>main</code><br><p>
|
||||
Determines whether worker processes are started.
|
||||
This directive is intended for nginx developers.
|
||||
</p><hr><a name="pid"></a><strong>syntax</strong>:
|
||||
<code>pid <code><i>file</i></code></code><br><strong>default</strong>:
|
||||
<code>pid nginx.pid</code><br><strong>context</strong>:
|
||||
<code>main</code><br><p>
|
||||
Defines a <code><i>file</i></code> which will store the process ID of the main process.
|
||||
</p><hr><a name="ssl_engine"></a><strong>syntax</strong>:
|
||||
<code>ssl_engine <code><i>device</i></code></code><br><strong>default</strong>:
|
||||
<strong>none</strong><br><strong>context</strong>:
|
||||
<code>main</code><br><p>
|
||||
Defines the name of the hardware SSL accelerator.
|
||||
</p><hr><a name="user"></a><strong>syntax</strong>:
|
||||
<code>user <code><i>user</i></code> [<code><i>group</i></code>]</code><br><strong>default</strong>:
|
||||
<code>user nobody nobody</code><br><strong>context</strong>:
|
||||
<code>main</code><br><p>
|
||||
Defines <code><i>user</i></code> and <code><i>group</i></code>
|
||||
credentials used by worker processes.
|
||||
If <code><i>group</i></code> is omitted, a group whose name equals
|
||||
that of <code><i>user</i></code> is used.
|
||||
</p><hr><a name="timer_resolution"></a><strong>syntax</strong>:
|
||||
<code>timer_resolution <code><i>interval</i></code></code><br><strong>default</strong>:
|
||||
<strong>none</strong><br><strong>context</strong>:
|
||||
<code>main</code><br><p>
|
||||
Reduces timer resolution in worker processes, thus reducing the
|
||||
number of <code>gettimeofday()</code> system calls made.
|
||||
By default, <code>gettimeofday()</code> is called each time
|
||||
on receiving a kernel event.
|
||||
With reduced resolution, <code>gettimeofday()</code> is only
|
||||
called once per specified <code><i>interval</i></code>.
|
||||
</p><p>
|
||||
Example:
|
||||
<blockquote><pre>
|
||||
timer_resolution 100ms;
|
||||
</pre></blockquote></p><p>
|
||||
An internal implementation of interval depends on the method used:
|
||||
<ul><li>
|
||||
an <code>EVFILT_TIMER</code> filter if <code>kqueue</code> is used;
|
||||
</li><li><code>timer_create()</code> if <code>eventport</code> is used;
|
||||
</li><li><code>setitimer()</code> otherwise.
|
||||
</li></ul></p><hr><a name="worker_rlimit_core"></a><strong>syntax</strong>:
|
||||
<code>worker_rlimit_core <code><i>size</i></code></code><br><strong>default</strong>:
|
||||
<strong>none</strong><br><strong>context</strong>:
|
||||
<code>main</code><br><p>
|
||||
Changes the limit on the largest size of a core file
|
||||
(<code>RLIMIT_CORE</code>) for worker processes.
|
||||
Used to increase the limit without restarting the main process.
|
||||
</p><hr><a name="worker_rlimit_nofile"></a><strong>syntax</strong>:
|
||||
<code>worker_rlimit_nofile <code><i>number</i></code></code><br><strong>default</strong>:
|
||||
<strong>none</strong><br><strong>context</strong>:
|
||||
<code>main</code><br><p>
|
||||
Changes the limit on the maximum number of open files
|
||||
(<code>RLIMIT_NOFILE</code>) for worker processes.
|
||||
Used to increase the limit without restarting the main process.
|
||||
</p><hr><a name="worker_priority"></a><strong>syntax</strong>:
|
||||
<code>worker_priority <code><i>number</i></code></code><br><strong>default</strong>:
|
||||
<code>worker_priority 0</code><br><strong>context</strong>:
|
||||
<code>main</code><br><p>
|
||||
Defines a scheduling priority for worker processes like is
|
||||
done by the <code>nice</code>: a negative
|
||||
<code><i>number</i></code>
|
||||
means higher priority.
|
||||
Allowed range normally varies from -20 to 20.
|
||||
</p><p>
|
||||
Example:
|
||||
<blockquote><pre>
|
||||
worker_priority -10;
|
||||
</pre></blockquote></p><hr><a name="worker_processes"></a><strong>syntax</strong>:
|
||||
<code>worker_processes <code><i>number</i></code></code><br><strong>default</strong>:
|
||||
<code>worker_processes 1</code><br><strong>context</strong>:
|
||||
<code>main</code><br><p>
|
||||
Defines the number of worker processes.
|
||||
</p><hr><a name="working_directory"></a><strong>syntax</strong>:
|
||||
<code>working_directory <code><i>directory</i></code></code><br><strong>default</strong>:
|
||||
<strong>none</strong><br><strong>context</strong>:
|
||||
<code>main</code><br><p>
|
||||
Defines a current working directory for a worker process.
|
||||
It is primarily used when writing a core-file, in which case
|
||||
a working process should have write permission for the
|
||||
specified directory.
|
||||
</p></body></html>
|
||||
Reference in New Issue
Block a user