wowza/wowza-streaming-engine repository overview

⁠What is Wowza Streaming Engine?

Wowza Streaming Engine™ is a robust and powerful media server designed for developers who need full control over live and on-demand video delivery. It's extensible through custom Java modules and easily integrated via REST and Java APIs, supporting both single-bitrate and adaptive bitrate streaming using industry-standard protocols such as HLS, MPEG-DASH, RTMP, RTSP, and WebRTC. Since it's designed for flexibility, the server can can be deployed on-premises or in hybrid environments. Whether you're building solutions for live events, internal broadcasts, or custom video platforms, Wowza provides the tools to manage, customize, and scale your streaming infrastructure with confidence.

⁠What's in this image

This image consists of the physical appliance (server) running the Wowza Streaming Engine software. Often, this is one or more servers dedicated to processing and streaming media. Images in this repository are provided by Wowza Media Systems, LLC, for version 4.9.3 of the software and later.

⁠How to use this image

To work with this image, make sure to update the following required environment variables:

• WSE_LICENSE_KEY: Add a valid trial or paid license key to enable usage.
• ADMIN_USER: Create an admin user to log in and access your Wowza Streaming Engine instance.
• ADMIN_PASSWORD: Create an admin password to log in and access your Wowza Streaming Engine instance. The value is hashed (PBKDF2 by default) before it is stored. It can also be an existing password hash instead of a cleartext password, in which case set ADMIN_PASSWORD_ENCRYPTED to true.
• LOG_LEVEL: Use to set the log verbosity. Possible values are DEBUG, INFO, WARN, and ERROR. We recommend using the WARN value to limit logging from Wowza Streaming Engine. This setting also helps to highlight any Wowza Streaming Engine service messages and errors.
• IPWHITELIST: Update VHost.xml to allow what ip address can access the REST API
• REST_API_DOCUMENTATION: Enable REST API documenation server (since 4.9.7)
• ADMIN_PASSWORD_ENCRYPTED: Set to true when ADMIN_PASSWORD is already a password hash rather than a cleartext password. Defaults to false (since 4.12)
  • Note: password hashes contain $ characters (for example $pbkdf2-sha512$210000$... or $2a$10$...). Docker Compose treats $ as the start of a variable substitution, so in a compose.yaml or .env file every $ in the hash must be escaped as $$, otherwise the hash is silently mangled and login fails. Example:

    environment:
      ADMIN_PASSWORD_ENCRYPTED: "true"
      ADMIN_PASSWORD: "$$pbkdf2-sha512$$210000$$<salt>$$<hash>"
    

    Copy
    With docker run -e, single-quote the value instead so the shell does not expand it: -e ADMIN_PASSWORD='$pbkdf2-sha512$210000$<salt>$<hash>'.
• ADMIN_PASSWORD_ENCODING: Password encoding to store the admin user with. Possible values are pbkdf2, md5, sha256, cleartext, and (for existing hashes only) bcrypt. Note: md5 & sha256 require digest be set in Server.xml/<AuthenticationMethod> and <PasswordEncodingScheme> to match ADMIN_PASSWORD_ENCODING. (since 4.12).

⁠Special Volume Mounts

A .addon directory will instruct the start-up script of WSE to copy the contents of that folder into the corresponding folder of the docker container. This is usefully when needing to add jar files or configurations to the already existing files of the docker container. Example to copy your custom jars into the lib folder of WSE:

  volumes:
    - ./mylibs:/usr/local/WowzaStreamingEngine/lib.addon

This will, at start up, copy the files from the local mylibs directory to the docker containers folder /usr/local/WowzaStreamingEngine/lib. For the lib directory, the script will remove older version of the same jar when the filename uses semantic versioning such as myjar-1.0.3.jar

For more, see Update the Wowza Streaming Engine container⁠.

⁠Image variants

The wowza-streaming-engine images come in different variants, each designed for a specific use case. Usage requires a valid trial or paid license. To get started, sign up⁠ for a free trial.

⁠Latest: wowza-streaming-engine:latest-<variant>

Always points to the latest version of WSE.

⁠Slim variant: wowza-streaming-engine:<version>-slim

Wowza Streaming Engine with only what it needs to run: no documentation, no pre-configured sample applications and no sample video files. At about half the size of the Base image, it is the recommended starting point for production deployments and for building your own image on top of Engine.

⁠Base variant: wowza-streaming-engine:<version>

This is image comes from a basic installation of WSE. It includes documentation, pre-configured live and vod application and some sample video files. .

⁠Trial variant: wowza-streaming-engine:latest-trial

This image is built on top of the base version of Wowza Streaming Engine. However, it provides several pre-configured sample applications to get up and running with Wowza Streaming Engine as quickly as possible. The trial version includes an up-to-date SSL certificate for wse-trial.wowza.com which resolves to 127.0.0.1.

⁠Video Intelligence Framework (VIF) variant: wowza-streaming-engine:<version>-vif-<vif_version>

This image is based on the slim variant and is pre-configured to run the Wowza Video Intelligence Framework.

See Get started with Wowza Streaming Engine⁠ for links on how to publish and play back using the sample pre-configured applications. For more detailed documentation and troubleshooting information, see Trial Wowza Streaming using a Docker Compose deployment⁠.

Usage of the trial image requires a valid trial or paid license. To get started, sign up⁠ for a free trial.

⁠License

View license information⁠ for the Wowza Streaming Engine software.