Deployment Options#

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

Deploy From Production Ready Web Assets Artifact#

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

$ ngc registry resource download-version "nvidia/ace/tokkio-iframe:2.0.0"

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

You may also configure the Iframe 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 Iframe configuration settings:

$ python3 init.py

The resulting config_override.js file can be copied into the build/ folder to enable the configuration. Upload the build directory into your chosen CSP or production server to start the Iframe.

Deploy From the Iframe Docker Container#

Tokkio Iframe 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.

INGRESS_ENDPOINT="https://1.2.3.4:30888/ws"
VST_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-iframe nvcr.io/nvidia/ace/tokkio-iframe:2.0.0

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

On this page