The Wowza Streaming Engine™ (WSE) server configuration settings are stored in the Server.xml configuration file located in the [install-dir]/conf directory. The settings in Server.xml apply to the entire WSE server, not individual streaming applications.
Note: The properties described below apply to the latest WSE version. Some properties may not apply to earlier versions.
XML reference
Name
The name of the media server.
Description
A text description of the media server.
RESTInterface
Settings to control access to the WSE REST API. The <RESTInterface> element contains the following sub-elements:
Enable: (Boolean) Enables or disables WSE REST API. (Default: true)
IPAddress: The network interface IP address that the REST interface binds to. If IPAddress is set to the wildcard (*) character, the REST interface binds to all available network interfaces.
Port: The port used to access the REST API. (Default: 8087)
AuthenticationMethod: Sets the REST API authentication method. (Changing the value to basic on WSE 4.8.5.05 and earlier prevents the use of WSE Manager.) Available values:
basic(default)none(prevents the use of WSE Manager)digest(default prior to WSE 4.8.5.05)digestfileremotehttp
Example URLs for accessing the REST API:
- http://localhost:8087
- http://username:password@localhost:8087
PasswordEncodingScheme: The default user password encoding method. Supported values:
bcrypt(default)digestcleartext
DiagnosticURLEnable: (Boolean) Set to false to disable diagnostic URLs. Set to true to enable the diagnostic URLs listed below. (Default: true)
- http://localhost:8087/
- http://localhost:8087/diag
SSLConfig: Secure Sockets Layer (SSL) configuration settings. The <SSLConfig> element may contain the following sub-elements:
- Enable: Set to
trueto require that all REST API request be made over HTTPS. (Default:false) - KeyStorePath: The full path to the keystore file.
- KeyStorePassword: The keystore password.
- KeyStoreType: The keystore type. (Default:
JKS) - SSLProtocol: The cryptographic protocol. (Default:
TLS) - Algorithym: The encryption algorithm. (Default:
SunX509) - CipherSuites: A comma-separated list of cipher suites.
- Protocols: A comma-separated list of SSL protocol names.
IPWhitelist: A comma-separated list of IP addresses authorized to use the WSE REST API. Wildcard (*) characters are supported (for example, 192.168.*.*). The default value is the localhost loopback address (127.0.0.1).
IPBlacklist: A comma-separated list of IP addresses prohibited from using the WSE REST API. Wildcard (*) characters are supported.
EnableXMLFile: (Boolean) Enables or disables the /v2/servers/{server}/xml/{filename}endpoint. (For example, http://127.0.0.1:8087/v2/servers/_defaultServer_/xml/conf/Server). For security, we recommend leaving this value set to false. (Default:false).
DocumentationServerEnable: (Boolean) Set to true to view the WSE REST API docs locally. (Default: false)
DocumentationServerPort: The port used to view the WSE REST API docs locally. (Default: 8089).
DocumentationServerAuthenticationMethod: The HTTP authentication method used to access the REST API documentation. Available values are none, basic, or digest. (Default: digest)
Example URLs for accessing REST API documentation:
- http://localhost:8089
- http://username:password@localhost:8089
Properties: Custom, user-defined properties with a name, value, and type. The <Properties> element may contain one or more individual <Property> elements, as described below.
- Property: The container element the custom property.
- Name: The custom property's name.
- Value: The custom property's value.
- Type: The custom property's type. (May be a
Boolean,Integer, or aString.)
CommandInterface
The WSE command interface is only used to allow remote shutdown of the server. It should be completely disabled in production environments.
HostPort: A container element for configuring a command interface host port.
- ProcessorCount: The number of threads allocated to the command interface. (Default:
${com.wowza.wms.TuningAuto}) - IpAddress: The IP or domain name of the address the command interface will listen to for incoming requests. If set to the wildcard (
*) character, it will listen for connections on all available network interfaces. (Default:*) - Port: The command interface port used to shut down the server during testing. (Default:
8083)
AdminInterface
A Java Management Extensions (JMX) interface, used for monitoring WSE.
ObjectList: A list of objects made available through the JMX interface.
Stats
Configuration settings for the server statistics page. (Available to WSE Manager or HTTPProviders on port 8086.) These statistics reference the HTTP provider's serverinfo, connectioncounts, and connectioninfo.
Enable: (Boolean) Specifies whether statistics are compiled and sent.
Properties: Custom, user-defined server statistic properties with a name, value, and type. The <Properties> element may contain one or more individual <Property> elements, as described below.
- Property: The container element the custom property.
- Name: The custom property's name.
- Value: The custom property's value.
- Type: The custom property's type. (May be a
Boolean,Integer, or aString.)
JMXRemoteConfiguration
Used to configure the Java Management Extensions (JMX) interface.
UserAgents
Values in HTTP requests that are interpreted as RTMPT requests. Any HTTP request header that includes a UserAgents value is considered to be an RTMPT request.
Streams
A container element for configuring the streaming protocol default type.
DefaultStreamPrefix: The default streaming protocol type. This value is overridden by IServerNotify2, the server listener in onServerConfigLoaded. This value is set with IServer.setDefaultStreamNamePrefix(String streamNamePrefix) and String IServer.getDefaultStreamNamePrefix() or with the ServerListeners container. (Default: mp4)
ServerListeners
Server and vhost-level event listeners that allow developers to invoke server-side Java.
VHostListeners
Vhost-level event listeners to extend server functionality.
HandlerThreadPool
Handler thread pool configuration settings. Used to process incoming messages. (Server-level thread pools are only used if a vhost's HandlerThreadPool is set to 0.)
PoolSize: The maximum number of server-level threads in the handler thread pool.
TransportThreadPool
Transport thread pool configuration settings. Used to read and write data from the transport sockets. (Server-level thread pools are only used if a vhost's TransportThreadPool is set to 0.) This value is also used to process the shutdown command and must always be greater than or equal to 10.
PoolSize: The maximum number of server-level threads in the transport thread pool.
RTP
Port configuration settings for RTP, native RTP, RTSP, and MPEG-TS streaming.
DatagramStartingPort: The starting port value for incoming UDP streams. (Port assignment starts with this value and increments by 1.) A common value for RTSP/RTP-based servers is 6790. If you plan to support RTP, native RTP, RTSP, or MPEG-TS streams, you should open UDP ports 6970-9999.
DatagramPortSharing: (Boolean) Specifies whether to allow port sharing.
true: UDP ports can be used by multiple SDP sessions or different application instances. This allows a single RTP video stream to be referenced by multiple SDP files. (For example, a video stream with multiple language options.)false: UDP ports can't be shared. Attempting to reuse a UDP port will return an error.
Manager
A container element for WSE Manager properties.
Properties: Custom properties with name, value, and type that can be added by the user.
- Property: The custom property's container element
- Name: The custom property's name.
- Value: The custom property's value.
- Type: The custom property's type. (May be a
Boolean,Integer, or aString.)
Transcoder
A container element for configuring a relative path to an SDK library for hardware-accelerated encoding. For more information, see:
Properties
Custom, user-defined properties used to extend the server. Properties are available in the WSE Java API through the IServer.getProperties() interface. Custom properties are added to the collection returned by IServer.getProperties().
Property: The container element for the custom property.
- Name: The custom property's name.
- Value: The custom property's value.
- Type: The custom property's type. (May be a
Boolean,Integer, or aString.)
