Library / SDK
winshining/nginx-http-flv-module avatar
winshining/nginx-http-flv-module

The upstream module's source is vendored in, and two NGINX version floors

A media streaming server based on nginx-rtmp-module. In addtion to the features nginx-rtmp-module provides, HTTP-FLV, GOP cache, VHosts (one IP for multi domain names) and JSON style statistics are supported now.

2,927 stars592 forksCBSD-2-Clause

At a glance

What is it?
nginx-http-flv-module adds HTTP-FLV playback, a GOP cache and virtual hosts to an nginx media server, and it carries its own copy of the nginx-rtmp-module sources rather than sitting beside them. The compatibility statement uses the word should and calls everything below it unknown.
Who is it for?
nginx-http-flv-module is a good fit if you need HTTP-FLV delivery specifically, want one GOP cache in front of several streams, or need several domain names on one address, and you already run nginx with the RTMP module. Four things to know before you commit.
Can I use it commercially?
Yes. BSD-2-Clause is a permissive licence: you can use, modify and sell software built on it, as long as you keep its copyright and licence notices.
Is it still maintained?
Yes. The repository last received commits 14 days ago.
What is it written in?
Mainly C, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • winshining/nginx-http-flv-module2,927 ★ · -6
Star history
Repository2026-09-242026-11-15
winshining/nginx-http-flv-module2.9k2.9k

-6 Stars in the last 52 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

Two version floors, and the compatibility statement is advisory

The compatibility note is one sentence and it hedges twice. It says the NGINX version should be equal to or greater than 1.2.6, and then that compatibility with other versions is unknown. Should is the word for a recommendation rather than a requirement, and the second clause admits that nothing is known about the rest of the range.

There is a second, harder statement further down, and it applies only to one build mode. If the module is compiled as a dynamic module, the version must be equal to or greater than 1.9.11. So there are two floors: a soft one at 1.2.6 for a static build and a hard one at 1.9.11 for a dynamic one, which is the practical constraint. A modern nginx is far past both, and the absence of an upper bound is the part worth reading as absence of evidence rather than as a guarantee.

The upstream module's sources are copied in, which is why you must not build both

The build note is emphatic: do not compile this module along with nginx-rtmp-module, because it already has all the features that module provides. The repository explains why. Alongside the module's own two files, which are named for HTTP-FLV live streaming, the root holds around fifty source files named for the upstream RTMP module, covering AMF parsing, bandwidth calculation, the codec, command, control, core, exec, handshake, limit, live, log, mp4, netcall, notify, parse, play, proxy protocol, receive, record, relay, send, shared, stat and variables modules.

That is not a patch set and not a thin wrapper. It is a source-level superset, which turns the upstream module from a dependency into vendored code inside this repository. The practical consequences are all mechanical: you cannot install both, an upstream fix has to be merged by hand rather than picked up by updating a submodule, and the two modules will drift as the upstream project changes.

Three rows of the feature table defer to remarks instead of answering

The comparison table has two columns of tick marks and a column of remarks, and the prose is where the tradeoffs live. Omitting the listen directive is supported here, with the condition that there must be at least one listen directive somewhere. Audio-only support for both RTMP and HTTP-FLV is supported, with the warning that it will not work if wait_video or wait_key is switched on. And independence from endianness is listed as partially supported in a branch rather than in the main line.

Those three are the rows to read before configuring anything, because each is a case where a capability is conditional on another setting rather than simply present or absent. The other rows are unconditional: HTTP-FLV for playback with HTTPS-FLV and chunked responses, the GOP cache, virtual hosts so one address can serve several domain names, single-track HLS, reuseport support, a timer for the access log, JSON style statistics, and statistics for recordings.

Publishing copies the stream rather than transcoding it

The publish command is deliberately minimal.

code
ffmpeg -re -i MEDIA_FILE_NAME -c copy -f flv rtmp://example.com[:port]/appname/streamname

The copy flag is the whole point, and the documentation says so: transcoding is not used for simplicity. What you publish is what the module serves, which removes a CPU cost and also removes the chance to fix a codec on the way in. The URL has three required parts. The application name has to match an application block inside the rtmp block. The stream name can be anything but cannot be left out. And the default RTMP port is 1935, with any other port written into the address after a colon.

There is a compatibility note for older FFmpeg builds, which do not understand the copy flag and need the two codec flags spelled out separately instead. Same behaviour, longer line.

Browser playback inherits whatever codec you published

The play URL for HTTP-FLV is a plain http address with a directory segment and a query string naming the application and the stream, with an optional port parameter.

code
http://example.com[:port]/dir?[port=xxx&]app=appname&stream=streamname

Two constraints come with the players. The browser player supports only H.264 video and AAC or MP3 audio, and since nothing transcodes on the way in, an incompatible source stream simply will not play there. That browser player also only runs where Media Source Extensions are available.

There is a shell trap in the same paragraph: playing from a command line player requires the URL to be quoted, because an unquoted ampersand is read by the shell as a job control character and the arguments after it are discarded.

Windows support is x86 in practice, whatever the label says

The supported systems line reads Linux as recommended, then FreeBSD, then MacOS, and then Windows with the word limited attached. The build section explains what limited means. On Windows the module is built with Microsoft's compiler following the nginx guide for the Win32 platform, and the add-module option has to be passed at the configure script step.

The qualification comes next, and it is specific. If a compiler that does not handle 64-bit properly is used, Visual Studio 2010 being the example given, the build must keep the default settings with the target machine type set to x86. So with such a compiler the build is limited to the default x86 target, which is a real constraint for anyone planning to serve video from Windows.

The rest of the prerequisite list is shared across platforms: make and a compiler on Unix-like systems, a debugger, FFmpeg or OBS to publish, VLC or the browser player to play, and PCRE, OpenSSL and zlib for nginx itself when regular expressions, encrypted access or compression are needed.

The tree has a dash directory the feature table never mentions

The repository root contains directories named doc, dash and hls beyond the sources (plus .github). Two of them are predictable from the documentation: doc is for documentation, and hls matches the table row claiming single-track HLS support.

The dash directory is not. There is no MPEG-DASH row anywhere in the feature comparison, and no mention of DASH in the visible documentation, yet the directory sits at the top level of the tree. Either the feature is unlisted or the directory holds a shared implementation that the listed features also use, and there is nothing here that settles which.

The samples directory settles a different question. The only example files listed are two images, samples/flv.js.png and samples/jwplayer_vlc.png, rather than code you can copy, which is worth knowing before you spend time looking for a reference implementation to adapt.

The Flash route has a published end date and a stated replacement path

The player section names four options: VLC and OBS over both RTMP and HTTP-FLV, a commercial web player over RTMP, and the browser player over HTTP-FLV. Underneath them sits a note about the Flash player, stating that Adobe stopped supporting it officially after December 31, 2020, and that plugins depending on it will stop working once major browsers remove it.

The README also notes that flv.js can only run in browsers that support Media Source Extensions.

The release history is patch-level and unhurried: 1.2.13 in February 2026, 1.2.14 in July 2026, and 1.2.15 on 2026-11-01, with the last push to master on 2026-11-01. The repository is not archived, has no declared homepage, and is BSD-2-Clause licensed with an AUTHORS file alongside the licence.

Editorial conclusion

nginx-http-flv-module is a good fit if you need HTTP-FLV delivery specifically, want one GOP cache in front of several streams, or need several domain names on one address, and you already run nginx with the RTMP module. Four things to know before you commit. It is a source superset rather than an add-on, so it cannot be compiled next to the upstream RTMP module and swapping it means recompiling nginx. The version statement is advisory: treat 1.2.6 as the static floor and 1.9.11 as the dynamic one, and verify anything newer yourself. Publishing copies rather than transcodes, so the codec you hand it is the codec your players must support, which in practice means H.264 with AAC or MP3 for the browser path. And the Flash player route has a published end date, so plan on flv.js with Media Source Extensions or on HLS.

Frequently asked questions

What is nginx-http-flv-module?

A C module for nginx that provides media streaming, based on nginx-rtmp-module, and adding HTTP-FLV for playback, a GOP cache, virtual hosts, single-track HLS, reuseport support, a timer for the access log and JSON style statistics. It is BSD-2-Clause licensed and is compiled into nginx.

Which NGINX versions does nginx-http-flv-module support?

The documentation says the NGINX version should be equal to or greater than 1.2.6 and calls compatibility with other versions unknown. For a build as a dynamic module it is stricter: the version must be equal to or greater than 1.9.11.

Can I build nginx-http-flv-module together with nginx-rtmp-module?

No, and the documentation says not to, because it already provides everything nginx-rtmp-module provides. The repository contains its own copies of the upstream ngx_rtmp source files, which is the reason the two cannot be compiled into the same nginx.

Which players work with nginx-http-flv-module?

VLC and OBS over RTMP and HTTP-FLV, a commercial web player over RTMP, and flv.js over HTTP-FLV. flv.js needs a browser with Media Source Extensions and plays only H.264 video with AAC or MP3 audio, which matters because publishing uses a stream copy rather than a transcode.

Official sources

  1. Issues
  2. License: BSD-2-Clause
  3. README
  4. Releases
  5. winshining/nginx-http-flv-module on GitHub
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/winshining-nginx-http-flv-module.svg)](https://hysenlabs.com/projects/winshining-nginx-http-flv-module)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/winshining-nginx-http-flv-module.svg)](https://hysenlabs.com/projects/winshining-nginx-http-flv-module)

Was this useful?