VHosts Configuration - Storm Streaming Server

VHosts configuration directly relates to sockets and the protocols they support. A single instance of Storm Streaming Server can have multiple active sockets, each with an individually defined list of supported protocols (e.g., RTMP, HTTP). Each socket can operate in SSL mode, provided that the appropriate certificate file (jks) along with a password is supplied.

VHost configuration can also be done from the Storm Control Panel.

Sample Configuration

Below you'll find the default configuration:

config/preferences.xml - VHosts block

xml

<VHostSettings>
    <VHost host="127.0.0.1" port="1935" isSSL="false">
        <Protocols>RTMP</Protocols>
    </VHost>
    <VHost host="127.0.0.1" port="8080" isSSL="false" isControlPanel="true">
        <Protocols>WEBSOCKETS, HTTP</Protocols>
    </VHost>
</VHostSettings>

For SSL enabled socket a VHost item differs a bit:

SSL-enabled VHost

xml

<VHostSettings host="127.0.0.1" port="443" isSSL="true">
    <Protocols>WEBSOCKETS, HTTP</Protocols>
    <Certificate path="/etc/ssl/private/wildcard.acme.com.jks" password="qwerty" />
</VHostSettings>

Field Explanation

Field	Description
`VHost:host`	A host or an IP where socket should be opened. You can use "" to open a socket on all network interfaces. For Docker-based setups please always use "", because ports must be forwarded between a host and a container.
`VHost:port`	TCP/IP port where socket should be opened.
`VHost:isSSL`	Specifies whether this virtual host should run through SSL Layer. Please keep in mind that if this field is set to "true" `<Certificate>` tag is required.
`VHost:isControlPanel`	Defines whether this port can be used to access the Storm Control Panel. You may want to create an additional port restricted to your VPN for accessing the Storm Control Panel.
`Protocols`	List of protocols supported on this virtual host. Available protocols: HTTP, WEBSOCKETS, RTMP.
`Certificate:path`	A path to jks certificate file.
`Certificate:password`	A valid password for the jks file.

Available Protocols

Protocol	Description
`RTMP`	The most popular protocol for creating audio-video broadcasts is primarily used for delivering the stream to the streaming server. The default port for this protocol is 1935. Storm Streaming Server supports this protocol both in its standard version and in an "Enhanced" version, which includes support for H.265 and AV1 codecs.
`HTTP`	Another protocol is responsible for handling HLS, MPEG-DASH, the Admin Panel, and the REST-API. The default port for the HTTP version of this protocol is 80, while for the SSL version, it is 443.
`WEBSOCKETS`	There is also a protocol responsible for supporting Storm's internal protocol, which is based on the Media Source Extensions mechanism. Like HTTP, its default port is 80, and for the SSL version, it is 443.

Certificate Files

In order to enable SSL layer a proper JKS file containing a key & certificate is required. This is a standard for all Java-based applications. If you wish to learn how to create a proper JKS file, please check our tutorial, that you can see here.

Docker Configuration

If the Storm Streaming Server operates within a Docker environment, it's important to remember that all sockets are created inside the container, not on the host device (unless configured otherwise). Therefore, you should always use "*" when declaring the host and remember to forward these ports outside of the container during its creation. By default, a Docker container with the Storm Streaming Server image forwards ports 1935 and 8080. Additional ports can be added as needed.

Docker VHosts configuration

xml

<VHosts>
    <VHost host="*" port="1935" isSSL="false">
        <Protocols>RTMP</Protocols>
    </VHost>
    <VHost host="*" port="8080" isSSL="false" isControlPanel="true">
        <Protocols>WEBSOCKETS, HTTP</Protocols>
    </VHost>
</VHosts>

Verification

For verification, please check logs or console output messages. You should see something like that:

Log output

text

14:50:25 INFO  Config - vHost :: 192.168.10.3:1935 | SSL: false | RTMP
14:50:25 INFO  Config - vHost :: 192.168.10.3:8080 | SSL: false | WEBSOCKETS, HTTP

SSL Nginx Passthrough

Please keep in mind that for production workloads Java SSL Engine might not be ideal in terms of pure performance. We highly advise combining Storm Streaming Server with Nginx for SSL Encryption/Decryption. You can learn how to do this here.

Next Step

In the next step you'll learn how to configure basic Mono Application.

Support Needed?

If you have any questions or need assistance, please create a support ticket and our team will help you.