Deployment Options#

The are several options to deploy the Tokkio UI, as discussed in the sections below:

Deploy From Production Ready Web Assets Artifact#

To follow this section, it is required that the reader has experience required to deploy a static website. This section will only show you how to retrieve the static web pages, it will not explain how to deploy them.

The Tokkio UI is compiled into a production build with webpack. The production build can be obtained from NGC as below

$ ngc registry resource download-version "nvidia/ace/tokkio_ui:5.0.0"

After downloading the UI from NGC, unzip the tar file. The build folder will be populated with the web assets.

You may also configure the UI before publishing the web assets by setting the corresponding environment variables. A list of the available configurations are listed in the Configuration section.

After setting the environment variables, run the init.py script to inject them into the UI configuration settings:

$ python3 init.py

The resulting env-config.js file can be copied into the build/ folder to enable the configuration.

Once the above steps are completed, the web assets are ready to be deployed into any of the numerous third party options available for website hosting. Instructions for deploying the static web assets are not in the scope of this documentation.

Deploy From the UI Docker Container#

Tokkio UI web assets are packaged into a docker container and hosted through a development server. To run the docker, first create a file named .env containing the desired configuration. Please reference the Configuration section for details on the available configuration.

Here is an example .env file

UI_SERVER_ENDPOINT="https://1.2.3.4:30888"
WEBSOCKET_ENDPOINT="wss://1.2.3.4:30888/ws"
VST_WEBSOCKET_ENDPOINT="wss://1.2.3.4:30888/vms/ws"
ENABLE_CAMERA=false

Next, start the docker with the following command

docker run -d --rm -p 3000:3000 --env-file=.env --name tokkio-ui nvcr.io/nvidia/ace/tokkio-ui:5.0.0

The Tokkio UI can be accessed in your browser at https://<host IP>:3000.

Deploy Dev Server From Source Code#

This option is not recommended unless you need to update the source code.

First, pull the source code from the public NGC offering:

$ ngc registry resource download-version "nvidia/ace/tokkio_ui_source:5.0.1"

Next, unzip the source code and navigate to the source directory:

cd tokkio_ui_source_v5.0.1
tar -xvzf tokkio-ui-source.tar.gz
cd tokkio-ui

Then, install the dependencies and start the dev server:

cd vst-streaming-lib
npm install
npm run build
cd ..
npm install
HTTPS=true npm start

The Tokkio UI can be accessed in your browser at https://<host IP>:3000.

On this page