# Red5 open source media server

===========

[![Maven Central](https://img.shields.io/maven-central/v/org.red5/red5-server.svg)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.red5%22)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)


* Red5 open source media server is one of the [free live streaming solutions](https://www.red5.net/open-source-live-streaming/) provided by Red5. It is written in Java and is designed to be flexible with a simple plugin architecture that allows for customization of virtually any video-on-demand (VOD) and live streaming scenario. Read more about its key features and capabilities [here](https://www.red5.net/red5-media-server/) Installed over 1,000,000 times worldwide, Red5 open source media server has powered applications for organizations like Amazon, the US Department of Defense, Akamai, Harvard University, and many others. Red5 open source media server is server core for [Red5pro](https://www.red5.net/red5-pro/low-latency-streaming-software/) and [Red5Cloud](https://www.red5.net/red5-cloud-low-latency-live-streaming-platform/).Red5 open source media server is ideal for developers, hobbyists, and students who want to experiment with live video streaming technology, build a media server and learn how it works. 

Automatic builds (Courtesy of Apache [OpenMeetings](http://openmeetings.apache.org/)):

 * [Red5](https://ci-builds.apache.org/job/OpenMeetings/job/Red5-server/)
 * [Windows Installer](https://ci-builds.apache.org/job/OpenMeetings/job/red5-installer/)

## Developer Community Support

If you have questions regarding the development, there are a couple of places you get help help from fellow developers:[Join Red5 Slack community](https://red5pro.slack.com/)
Ask your question on [Red5 official subreddit](https://www.reddit.com/r/red5/) or [Stack](https://stackoverflow.com/questions/tagged/red5?sort=newest)

## Maven

Releases are available at [Sonatype - Releases](https://mvnrepository.com/search?q=red5)

Snapshots are available at [Sonatype - Snapshots](https://mvnrepository.com/search?q=red5)

Include the red5-parent in your __pom.xml__  in the __dependencyManagement__ section

```xml
<dependencyManagement>
    <dependencies>
      <dependency>
          <groupId>org.red5</groupId>
          <artifactId>red5-parent</artifactId>
          <version>${red5.version}</version>
          <type>pom</type>
      </dependency>
    </dependencies>
</dependencyManagement>  
```

in addition to any other Red5 projects in the __dependencies__ section

```xml
  <dependency>
      <groupId>org.red5</groupId>
      <artifactId>red5-server</artifactId>
      <version>${red5.version}</version>
      <type>jar</type>
  </dependency>
```

## Build from Source

As of release 1.2.2 the target JDK is now JDK 11 and the Maven poms use the [toolchain plugin](https://maven.apache.org/guides/mini/guide-using-toolchains.html).

To build the red5 jars, execute the following on the command line:
```sh
mvn -Dmaven.test.skip=true install
```
This will create the jars in the "target" directory of the workspace; this will also skip the unit tests.

To package everything up in an assembly (tarball/zip):
```sh
mvn -Dmaven.test.skip=true clean package -P assemble
```

## Docker RTMP Integration Test

This repo includes an integration test that:
- starts a Red5 server container
- launches 5 concurrent RTMP publishers via `ffmpeg`
- validates subscriptions with `ffprobe`
- collects logs and checks for handshake / rejection issues

Prerequisites:
- `docker`
- `ffmpeg`
- `ffprobe`
- Java 21 and Maven

Run against the published image (`mondain/red5:latest`):
```sh
mvn -pl tests -Pdocker-integration -Dred5.it.image=mondain/red5:latest -Dred5.it.autoPull=on -DskipTests=false verify
```

Run against your current checkout (build + dockerize local version first):
```sh
bash tests/src/test/resources/scripts/build_local_red5_docker_image.sh red5-local:dev
mvn -pl tests -Pdocker-integration -Dred5.it.image=red5-local:dev -Dred5.it.autoPull=off -DskipTests=false verify
```

Artifacts are written to:
```text
tests/target/rtmp-docker-it/<timestamp>/
```

Key outputs:
- `red5-container.log`: server logs from the container
- `publisher-stream*.log`: per-publisher `ffmpeg` logs
- `ffprobe-stream*.json`: per-stream probe validation
- `handshake-findings.log`: handshake-related findings
- `connection-rejections.log`: connection rejection findings

To build a milestone tarball:
```sh
mvn -Dmilestone.version=1.0.7-M1 clean package -Pmilestone
```

## Older Releases
Visit this page to review release notes from all previous versions [Releases·Red5/red5-server](https://github.com/Red5/red5-server/releases)

## Supporters

[![YourKit](https://www.yourkit.com/images/yklogo.png)](https://www.yourkit.com/java/profiler/)

YourKit supports open source projects with innovative and intelligent tools
for monitoring and profiling Java and .NET applications.

[![Red5](Red5-logo.png)](https://red5pro.com/)

Red5 is a trusted [live streaming solution provider](https://www.red5.net/products/) for developers, startups and enterprises, delivering video, audio, and data with under 250 ms of latency.