This guide provides step-by-step instructions for upgrading your Wowza™ media server software FROM Wowza Media Server™ 3 TO Wowza Streaming Engine™ 4. Wowza Streaming Engine is the latest version of the Wowza media server software formerly known as Wowza Media Server.
Note: For step-by-step instructions for updating your Wowza Streaming Engine software installation to a newer version of the software, see How to update your Wowza Streaming Engine installation.
Best Practices for Upgrading Wowza Media Server to Wowza Streaming Engine (Video Tutorial)
Step-by-Step Upgrade Instructions
Important requirements for upgrading from Wowza Media Server 3 to Wowza Streaming Engine 4
To ensure a successful upgrade of your Media Server 3 software to Wowza Streaming Engine 4 software, be sure to follow all of the steps in the Upgrade Instructions.
Wowza Streaming Engine was formerly known as Wowza Media Server. We changed the name to reflect the server software's transformation from its early days as a single platform media server to its new role as a robust, customizable, and scalable server software that powers reliable streaming of high-quality audio and video to any device.
MediaCache AddOn, Push Publishing AddOn, and Media Security features that were incorporated into Wowza Media Server software as separate modules are "built-in" features of the Wowza Streaming Engine software. If you configured these modules for Wowza Media Server software, you must reconfigure your Wowza Streaming Engine software installation after you upgrade. See the Upgrade Instructions below for details.
After you install the Wowza Streaming Engine software, be sure to see our Wowza Documentation for the most up-to-date information, tutorials, and tips that will help you use the new software. Other online resources that are useful include:
- Wowza Streaming Engine Quick Start Guides
- Wowza Streaming Engine User's Guide
- Wowza Streaming Engine Release Notes
Existing usersLicense keys for Wowza Media Server software won't work with Wowza Streaming Engine software. New license keys are required. Determine your license type and then go to our Upgrade webpage to review our upgrade policies and to request an upgrade.
- To purchase licenses for Wowza Streaming Engine software, go to our Wowza Streaming Engine Pricing webpage.
- You can try a free trial version of the Wowza Streaming Engine software. Go to our Wowza Streaming Engine Trial webpage to complete a form and get a Trial license for Wowza Streaming Engine.
- For long-term developer use, we offer a FREE Developer license for access to the Streaming Engine software and Wowza Transcoder, Wowza nDVR, and Wowza DRM technologies. A Developer license allows three (3) input connections and ten (10) total concurrent connections with the Wowza Streaming Engine software.
Wowza Developer Resources | Request a Wowza Streaming Engine Developer License
Best Practices for Upgrading Wowza Media Server to Wowza Streaming Engine (Video Tutorial)
Step-by-Step Upgrade Instructions
1. Backup server configuration, content, and custom files
Note: We recommend that you use Wowza Streaming Engine Manager to re-create your existing Wowza Media Server software configuration on your new Wowza Streaming Engine software deployment. Wowza Media Server configuration files aren't guaranteed to work if you try to use them in a Wowza Streaming Engine installation. If you still want to use your existing application configuration (Application.xml) files with Wowza Streaming Engine, follow the instructions in this section to backup the files and then see Restore Wowza Media Server software configuration files for more information.
Backup the following folders from your existing software installation to a safe place on your hard drive outside of the Wowza Media Server installation directory:
Wowza Media Server configuration files and license keys
IMPORTANT: Remove the following configuration file from the backup: [install-dir]/conf/jmxremote.access
On-demand video files
Wowza Media Server log files (if needed for your own billing purposes for clients)
Transcoder AddOn templates
2. Uninstall Wowza Media Server software
Perpetual, Developer, and Evaluation licenses
Uninstall your Wowza Media Server software before installing Wowza Streaming Engine software. This is required by the Wowza Streaming Engine upgrade agreement.
See the "Server Installation" chapter in the Wowza Media Server User's Guide for more information about how to uninstall the Wowza Media Server software. Instructions about how to uninstall the software are included for all supported operating systems.
If you want to have both Wowza Media Server software and Wowza Streaming Engine software installed at the same time, both installations must be properly licensed. You can use a Wowza Streaming Engine Trial or Developer license to evaluate the current release while your current Wowza Media Server license is still in use in your production environment.
Until you stop your running Wowza Media Server instance, you'll continue to be billed for any instances. A 1-hour grace period is routinely provided to allow for maintenance, such as upgrades and switching to new hardware. You can use this grace period to deploy a new Wowza Streaming Engine instance and then stop an existing Wowza Media Server instance without being billed for two running instances. If the two instances are running for more than 1 hour, you'll be billed for two instances.
Note: You can continue to run your existing Wowza Media Server instance(s) and new Wowza Streaming Engine instance(s) concurrently. This means that you can provision a new Wowza Streaming Engine server instance(s) without stopping your current Wowza Media Server instance(s). It's important to note that, for example, if your Wowza Media Server Subscription license is still running, and you start a Wowza Streaming Engine Subscription license, you'll be billed for two (2) running instances.
3. Wowza Streaming Engine license keys
A license key is required to install and run the Wowza Streaming Engine software. The license key you enter when you run Wowza Streaming Engine Setup is stored in the [install-dir]/conf/Server.license file in the Wowza Streaming Engine installation:
OS X - /Library/WowzaStreamingEngine-[version]/conf/Server.license
Linux/Unix - /usr/local/WowzaStreamingEngine-[version]/conf/Server.license
If you purchase a Subscription license for the server software, you can install and run an unlimited number of Streaming Engine instances under the single license key. You can also purchase a Perpetual license for a single Streaming Engine instance. The license keys for the server software enable you to use the integrated Transcoder, nDVR, and DRM technologies for the licensed server instance.
- You can use your license key to deploy Wowza Streaming Engine software in the cloud and stream your content from high-performance virtual machines hosted remotely by third-party providers. Wowza Streaming Engine software works with virtually all cloud-hosting services, including Amazon Elastic Compute Cloud (Amazon EC2), Google Compute Engine (GCE), Microsoft Azure, and Rackspace. For more information, see Cloud Technologies.
- If you have questions about the available Wowza Streaming Engine licenses or pricing, contact email@example.com.
- If you've forgotten your license key, contact firstname.lastname@example.org.
4. Install Wowza Streaming Engine
Upgrading or patching from Wowza Media Server software builds to Wowza Streaming Engine isn't supported. You must do a full installation to upgrade to Wowza Streaming Engine. For installation requirements and instructions, see the "Server Installation" chapter in the Wowza Streaming Engine User's Guide.
Note: When configuring your newly installed media server software, we recommend that you don't copy your Wowza Media Server configuration files to your new Wowza Streaming Engine installation. Updated features may not work properly with Application.xml files from your Wowza Media Server installation and new features can't be configured. The Wowza Streaming Engine Manager user interface may not display Wowza Media Server configuration settings and/or unexpected behavior may occur. The Wowza Streaming Engine installer includes updated Application.xml files that you can configure in Streaming Engine Manager, using your older configuration files as a reference.
5. Tune Wowza Streaming Engine
Wowza Streaming Engine is automatically tuned to take best advantage of available hardware resources when the server starts. The server calculates an appropriate Java heap size, garbage collection (GC) settings, and other Java command-line options based on available hardware, the computer and Java Virtual Machine (JVM) bitness, and other factors.
By default, the server sets the Java heap size to a value that's suitable for application development environments. Before you deploy the server in production environments, where it may use memory extensively when heavily loaded, you can select an option in Wowza Streaming Engine Manager that automatically sets the heap size to a predefined value that's appropriate for production use. You can use Streaming Engine Manager to adjust many performance settings from the default values that are calculated by the server to fine-tune the server's performance. For more information, see How to do performance tuning.
6. Restore Wowza Media Server software configuration files
Important: We recommend that you only use your backed-up Wowza Media Server configuration files as a reference to help you re-create your streaming applications in Wowza Streaming Engine Manager. Updated features may not work properly using Application.xml files from your Wowza Media Server installation and new features can't be configured. The Wowza Streaming Engine Manager user interface may not display Wowza Media Server configuration settings and/or unexpected behavior may occur. Only proceed with the instructions in this section if you're sure that you want to continue.
If you add or replace Application.xml files in the Wowza Streaming Engine [install-dir]/conf directory with Application.xml files that you backed up from your Wowza Media Server software installation, most properties should be recognized and updated properly in Wowza Streaming Engine Manager when you start it and your applications should still work. However, some properties won't be recognized and reflected in the manager user interface. For this reason, we recommend that you recreate your application configuration using the settings in Streaming Engine Manager, especially if your previous application configuration is highly customized.
To import Wowza Media Server Application.xml configuration files to your Wowza Streaming Engine installation, do the following:
- Make sure that you're signed out of Wowza Streaming Engine Manager and that the Streaming Engine software and Manager is stopped (See How to start and stop Wowza Streaming Engine software.)
- Open the backed-up Application.xml file in a text editor, and add the <Name> and <AppType> properties to the <Root>/<Application> section of the file:
<Root> <Application> <Name>[application-name]</Name> <AppType>[application-type]</AppType>[application-name] must be a unique application name in your Wowza Streaming Engine deployment.
[application-type] must be one of the following values: Live, LiveEdge, LiveHTTPOrigin, VOD, VODEdge, VODHTTPOrigin, SHOUTcast, VideoChat
- Copy the updated Application.xml to your Wowza Streaming Engine installation configuration directory ([install-dir]/conf/[application-name]).
- If necessary, create the the application folder [install-dir]/applications/[application-name].
- Start Wowza Streaming Engine and sign-in to Wowza Streaming Engine Manager with the Administrator account that you created when you installed the Wowza Streaming Engine software:
- Click the Applications tab in Streaming Engine Manager. The imported application configuration should be displayed in the contents panel.
- Click the application name in the contents panel and use the Streaming Engine Manager user interface to update settings as needed. Be sure to refer to our Documentation Library for guidance.
7. Live Stream Record users
LiveStreamRecord, formerly a free AddOn for Wowza Media Server 3.1.2 (and earlier) and built-in with Wowza Media Server software (version 3.5 or later) is incorporated into Wowza Streaming Engine software as the Incoming Streams feature. It enables you to record live streams to on-demand files using the Streaming Engine Manager user interface, HTTP URL queries, or programmatically. You can split in-process live stream recording archives into multiple on-demand MP4 (QuickTime container) or FLV (Flash Video container) files automatically, with the split points based on video duration, clock time, or file size.
If you configured the LiveStreamRecord HTTP provider in Wowza Media Server 3.1.2 (or earlier), update the BaseClass and AuthenticationMethod properties in the [install-dir]/conf/VHost.xml configuration as shown in the following code sample before upgrading to Wowza Streaming Engine:
<HTTPProvider> <BaseClass>com.wowza.wms.livestreamrecord.http.HTTPLiveStreamRecord</BaseClass> <RequestFilters>livestreamrecord*</RequestFilters> <AuthenticationMethod>admin-digest</AuthenticationMethod> </HTTPProvider>
For more information about how to use the Incoming Streams feature in Wowza Streaming Engine, see How to record live streams.
8. Media security users
Security features such as SecureToken, RTMP authentication, and RTSP authentication that were provided in the MediaSecurity AddOn, the Wowza Module Collection, and built-in with Wowza Media Server software (version 3.5 or later), are merged into a ModuleCoreSecurity module in Wowza Streaming Engine. If you import Application.xml files from a Wowza Media Server software installation to Wowza Streaming Engine, you must remove security modules from the Application.xml file and configure their corresponding settings in Wowza Streaming Engine Manager instead. For a list of the security modules that were merged into the new ModuleCoreSecurity module and their corresponding settings in Streaming Engine Manager, see "Updating from Wowza Media Server software" in How to configure security using Wowza Streaming Engine Manager. This article also provides instructions for configuring each security setting in the manager.
9. MediaCache AddOn users
Media Cache technology (formerly a free AddOn for Wowza Media Server 2.0 and later) is built-in as a feature with the Wowza Streaming Engine software and can be configured in Wowza Streaming Engine Manager. The Media Cache system is a read-through caching mechanism that helps to increase the scalability of on-demand streaming. To retain your MediaCache settings from your Wowza Media Server software installation, do the following:
For details about how to configure the Media Cache feature in Wowza Streaming Engine Manager, see How to scale on-demand streaming with Media Cache.
- Open the conf/MediaCache.xml file from your Wowza Streaming Engine installation in a text editor and change the full class path to the MediaCacheSource implementation that's used to deliver the content. Change the MediaCacheSource implementations as shown below so that they will work with the Wowza Streaming Engine software:
Wowza Media Server:
<BaseClass>com.wowza.wms.plugin.mediacache.impl.MediaCacheItemHTTPImpl</BaseClass> <BaseClass>com.wowza.wms.plugin.mediacache.impl.MediaCacheItemFileImpl</BaseClass>Wowza Streaming Engine:
- Replace the conf/MediaCache.xml file in the Wowza Streaming Engine installation with the updated MediaCache.xml file.
10. Push Publishing AddOn users
Push publishing technology, formerly provided by a free AddOn for Wowza Media Server 3.1.2 (and later) is built-in with the Wowza Streaming Engine software. Push publishing technology allows you to send live streams to destinations such as content delivery networks (CDNs) and services over a variety of protocols. The destinations distribute your live stream, enabling you to scale your Streaming Engine implementation, computing resources, and delivery options for a variety of scenarios. The Stream Targets graphical user interface in Wowza Streaming Engine Manager lets you configure push publishing on the media server without manually editing an XML map file. If you manually created stream targets by editing the push publishing map file in Wowza Media Server software, the map entries will appear in your live application's Stream Targets page in Wowza Streaming Engine Manager after you upgrade.
For details about how to configure the Stream Targets feature in Wowza Streaming Engine Manager, see How to use CDNs and services to distribute live streams (push publishing).
11. Closed-captioning users
If you used Wowza Media Server 3.5.0 (and later) to serve sidecar caption files to players, you'll need to re-enable the CaptionFile HTTP provider in Wowza Streaming Engine. For more information, see How to serve sidecar caption files for on-demand streaming.
If you need help to complete your software upgrade, contact Wowza Technical Support. In your Wowza Streaming Engine support ticket, be sure to specify the license type that you have. To learn about the variety of support resources that we offer to our user community, see our Support Resources webpage.
Note: Maintenance and support is included with Wowza Streaming Engine subscription licenses, or may be purchased as one-year or three-year contracts for Wowza Streaming Engine perpetual licenses. A valid Maintenance and Support contract is required to get help from our technical support engineers. To learn about the benefits that a Maintenance and Support contract provides, see our Wowza Streaming Engine Maintenance and Support webpage.
License holders with a Wowza account can sign in to their Account Management page to find available updaters for their media server software on the My Downloads tab. You must have an active Maintenance and Support contract to get updaters.
Detailed information about our officially released media server software builds and build updates is available on our Software Updates page.
For details about how to update your Wowza Streaming Engine software, see How to update your Wowza Streaming Engine installation.