Introduction

To enable Local Viewing on your container you must make a number of changes to your compose file to:

expose your container's RTSP port
set a local viewer password (optional)

You have multiple options for configuring your container using a config file - including 'burning in these settings using environment variables, or using a seed config file to provide initial settings for your users.

Required change to your compose file

You should add the following entry to the ports: section of your compose file:

- "9554:9554"

So if your file looks like this:

...  
  container_name: edgevis-encoder
  ports:
     - "8443:443"
  device_cgroup_rules: 
...

it should now look like this:

...  
  container_name: edgevis-encoder
  ports:
     - "8443:443"
     - "9554:9554"
  device_cgroup_rules: 
...

You must also add the relevant EV_RTSP_PORT setting below into your environment settings.

Available Settings

To connect your encoder to a server, using a specific encoder account, you should add all of the following settings to your config file:

Setting	Description
EV_RTSP_PORT (Required)	The recommended setting is 9554. This should only be set as an environment variable in your compose file/environment file.
EV_LOCAL_VIEWER_ENABLED	Set to `true` or `false` (Default). Turns on/off the local viewing feature.
EV_LOCAL_VIEWER_PASSWORD	Set a password for granting local viewer access. By default the password is 'password'.

Change in behaviour (since v9.1)

In v9.0 these were combined into one setting. Setting EV_LOCAL_VIEWER_PASSWORD would also enable local viewing.

If you set this setting in v9.0 you should now set EV_LOCAL_VIEWER_ENABLED as well.

Examples

The minimum setting you need is the RTSP setting:

EV_RTSP_PORT=9554

However, if you want to change the default and enable local viewing, you should also set a local viewing password:

EV_RTSP_PORT=9554
EV_LOCAL_VIEWER_ENABLED=true
EV_LOCAL_VIEWER_PASSWORD=Password123!

Connecting Local Viewer to your container

This requires EdgeVis Local Viewer 9.1 or above to work!

As a container uses a different port for its web interface (compared to a hardware encoder), there is an additional step required to connect Local Viewer to your container.

When you manually enter the address of your encoder within Local Viewer to connect to it, you must also add the web port number to the ip address - you must enter <ip address>:8443

For example, if your container is running on 10.0.0.20, you should enter:

10.0.0.20:8443

In order to successully connect to the container.