User Guide

This document describes the workflow of Enterprise Launcher

Topics Covered Include

  • Installing and configuring Enterprise Launcher.

  • Installing, updating and uninstalling applications and connectors using Enterprise Launcher.

Install and Configure Launcher

The Enterprise launcher is available from NVIDIA’s licensing and software portal. Launcher Enterprise Portal .

Before running the installer, system administrators need to configure Launcher paths by putting omniverse.toml file into user’s .nvidia-omniverse/config folder. omniverse.toml file must contain these values:

# All paths in this section should be with double backslash for Windows
[paths]
library_root = "D:\\Omniverse\\library"  # Path where to install all applications
data_root = "D:\\Omniverse\\data"        # Folder where Launcher and Omniverse apps store their data files
cache_root = "D:\\Omniverse\\cache"      # Folder where Omniverse apps store their cache and temporary files
logs_root = "C:\\Users\\MyUser\\.nvidia-omniverse\\logs"   # Folder where Launcher and Omniverse apps store their logs
confirmed = true   # Confirmation that all paths are set correctly, must be set to `true`

The system administrator should mark the omniverse.toml file to read-only to stop users from modifying the paths.

The Enterprise Launcher is installed on each user’s workstation by running the installer - see the Deployment Samples below for examples of the command options.

Note

The /S argument can be used to install Launcher silently on Windows:

omniverse-launcher-win-enterprise.exe /S

On Linux, instead of running the installer, you need to set the AppImage as an executable program and launch it – this will register the app as the default handler for omniverse-launcher:// custom URLs described below.

Install Applications

To install an application in Enterprise Launcher, system administrators must download an enterprise package with the app from Launcher Enterprise Portal :

  1. Log in on Launcher Enterprise Portal:

../_images/launcher_enterprise-login.png

  1. Select a package that you want to download:

../_images/launcher_exchange_overview.png

  1. Select a package version in the dropdown list and click on Download:

../_images/launcher_enterprise-selectversion.png

The downloaded zip file must be transferred to user’s machine or hosted on the local network. After that, the package can be pushed to Launcher by opening a custom protocol URL on user’s machine:

omniverse-launcher://install?path=<package.zip> where <package.zip> is the path where the downloaded zip file is located.

Examples how to open a custom protocol

  • Windows

    start omniverse-launcher://install?path=D:/packages/Create.zip start omniverse-launcher://install?path=//Mainframe/packages/Create.zip

  • Linux

    open omniverse-launcher://install?path=/var/packages/Create.zip

Such command will start the installation of the package and users will see the screen like this in their Launcher:

../_images/launcher_enterprise-packageinstallation.png

When the application will be installed, it will appear in user’s library and user will receive a notification:

../_images/launcher_enterprise-package-installation-finished.png

The same steps can be used further if the application needs to be updated.

Deployment Samples

This section contains example scripts to install Enterprise Launcher and then install the package downloaded from Launcher Enterprise Portal (using create.zip as the package in these examples):

Windows

:: Copy omniverse.toml to user's configuration.
:: Read "Install and configure Launcher" section to figure out the values that must be included to that file.
xcopy omniverse.toml %USERPROFILE%\.nvidia-omniverse\config\omniverse.toml

:: Set the readonly flag to prevent users from changing the configured paths
attrib +r %USERPROFILE%\.nvidia-omniverse\config\omniverse.toml

:: Run the installer and wait until Launcher is installed
start omniverse-launcher-win-enterprise.exe

:: Push the downloaded application to Launcher
start omniverse-launcher://install?path=C:\packages\create.zip

Linux

# Copy omniverse.toml to user's configuration.
# Read "Install and configure Launcher" section to figure out the values that must be included to that file.
cp omniverse.toml ~/.nvidia-omniverse/config/omniverse.toml

# Mark file as readonly to prevent other users from changing the configured paths
chmod 622 ~/.nvidia-omniverse/config/omniverse.toml

# Grant executable permissions for Enterprise Launcher
chmod +x omniverse-launcher-linux-enterprise.AppImage

# Run the Enterprise Launcher
./omniverse-launcher-linux-enterprise.AppImage

# Push the downloaded application to Launcher
open omniverse-launcher://install?path=/var/packages/create.zip

Uninstall Applications

To uninstall applications from Launcher, system administrators can use the uninstall custom protocol command on user’s machine:

Windows

start omniverse-launcher://uninstall?slug=<slug>&version=<version>

Linux

open omniverse-launcher://uninstall?slug=<slug>&version=<version>

The uninstall command accepts two arguments:

  • slug - The unique application codename.

    This name can be found on the Enterprise Launcher portal in the browser address bar when you select the application:

    ../_images/launcher_enterprise-slug.png

  • version : The application version to be deleted.