Control Panel Configuration - Storm Streaming Server

Sample Configuration

To connect to the panel, appropriate server configuration through the config/preferences.xml file is necessary. The first step is to ensure that we have at least one VHost that supports the HTTP protocol. It is also necessary to add the isControlPanel parameter set to true. The standard configuration is shown in the example below and ensures an open socket on port 8080.

config/preferences.xml - VHost configuration

xml

Copy

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

If you want to learn more about the correct configuration of VHosts, we recommend consulting our VHost Guide.

User Accounts & Authorization

The Control Panel uses a role-based access control system. Each user account is defined within the <Authorization> block of the <ControlPanelSettings> element and can be assigned granular permissions per component.

config/preferences.xml - Control Panel settings

xml

Copy

<ControlPanelSettings enabled="true">
    <IPWhiteList>192.168.1.1, 10.0.0.2</IPWhiteList>
    <Authorization>
        <User username="admin" password="secret123" algorithm="plain">
            <AccessRights>
                <Component name="Server" access="read-write" />
                <Component name="Application" access="read-write" />
                <Component name="Stream" access="read-only" />
                <Component name="Viewer" access="read-only" />
            </AccessRights>
        </User>
    </Authorization>
</ControlPanelSettings>

General Settings

The <ControlPanelSettings> element accepts the following parameters:

User Configuration

Each <User> element defines a single account with the following attributes:

Access Rights

Each user must have an <AccessRights> block containing one or more <Component> entries. This allows fine-grained control over what parts of the system a given user can view or modify.

Available components:

Access levels:

Example: Multi-User Setup

The following example demonstrates a setup with an administrator and a read-only monitoring account:

config/preferences.xml - Multi-user configuration

xml

Copy

<ControlPanelSettings enabled="true">
    <IPWhiteList>192.168.1.0/24</IPWhiteList>
    <Authorization>
        <User username="admin" password="strongPassword1" algorithm="plain">
            <AccessRights>
                <Component name="Server" access="read-write" />
                <Component name="Application" access="read-write" />
                <Component name="Stream" access="read-write" />
                <Component name="Viewer" access="read-write" />
            </AccessRights>
        </User>
        <User username="monitor" password="strongPassword2" algorithm="plain">
            <AccessRights>
                <Component name="Server" access="read-only" />
                <Component name="Application" access="read-only" />
                <Component name="Stream" access="read-only" />
                <Component name="Viewer" access="read-only" />
            </AccessRights>
        </User>
    </Authorization>
</ControlPanelSettings>

First Connection

Using any internet browser such as Chrome, Safari, Edge, or Firefox, we open the control panel subpage. The address of our panel will look like this:

Control Panel URL

text

Copy

http://127.0.0.1:8080/cpanel

If we are not using an SSL certificate in the configuration, we use http; otherwise, we replace this part with https. The address 127.0.0.1 is the host name or IP provided in the VHost configuration. In the case of using Docker, it might also be a domain like localhost or CONTAINER_NAME.docker. Port 8080 is the port on which the socket is open. In the case of Docker, this port may be different due to port forwarding between the host and the container.