User Guide

This document describes the workflow of the IT Managed Launcher, formerly known as the Enterprise Launcher.

Topics Covered Include

  • Installing and configuring the IT Managed Launcher.

  • Installing, updating and uninstalling applications and connectors using the IT Managed Launcher.

Install and Configure Launcher

The IT Managed Launcher is available from NVIDIA’s licensing and software 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 IT Managed 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 IT Managed 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. Available releases are categorized by release channel. A release is classified as Alpha, Beta, Release, or Enterprise, depending on its maturity and stability. If an Alpha or Beta release is selected, a banner will appear on the main image to emphasize the relative stability and completeness of that release. Alpha or Beta releases may not be feature complete or fully stable. Versions classified as Release (also known as GA or General Availability) are feature complete and stable. Release versions that are supported for Enterprise customers appear in the Enterprise list. Select a package version in the dropdown list and click “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.

Note

Content packs cannot be pushed to Launcher using the above custom protocol. Instead, content packs should be extracted and installed on a central Nucleus server or shared drive which is accessible to the end user. See below for more information on installing content packs on air-gapped networks.

Examples how to open a custom protocol

  • Windows

DOS cmd

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

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

PowerShell

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

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

  • Linux

    xdg-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 the IT Managed 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 the IT Managed Launcher
chmod +x omniverse-launcher-linux-enterprise.AppImage

# Run the IT Managed 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

DOS cmd

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

Note

Notice the quotes around the DOS commands. This is needed in since the ‘&’ character will be interpreted as a background task. Also notice the ‘^’ character before the ‘&’ character. This is needed for DOS, otherwise it will be interpreted as new window popup

PowerShell

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

Note

Notice the quotes around the PowerShell commands. This is needed in PowerShell since the ‘&’ character will be interpreted as a background task

  • Linux

    xdg-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 IT Managed Launcher portal in the browser address bar when you select the application:

    _images/launcher_enterprise-slug.png

  • version : The application version to be deleted.

Using Content Packs

Content packs published by NVIDIA package the same content that’s accessible by default from within Omniverse into packs that can be installed from the Launcher Enterprise Portal for use on air-gapped networks or on networks on which Amazon S3 requests are blocked or restricted by a firewall. The following steps can be used by customers with air-gapped networks or firewalls to utilize content packs on a local Nucleus server.

Content Pack Instructions

  1. Download: From the Omniverse Portal - click on the Omniverse menu and then on the Content sub-section to access all downloadable content packs. Choose the pack you want to download. Select your preferred version, click Download, and choose either Windows or Linux as the target platform. This will initiate the download process. Depending on which content pack you’re downloading, this process may take several minutes to complete.

    _images/launcher_enterprise-content-pack.png

  2. Unpacking the archive: Once done, you’ll have a zip file on your local computer. Next you need to unpack the zipped archive to a location on your hard drive. Inside the archive, you’ll be presented with something similar to the following:

    Windows Archive Contents

    _images/launcher_enterprise-archive-windows.png

    Linux Archive Contents

    _images/launcher_enterprise-archive-linux.png

    You should see a number of files in the top level, and then a sub-folder that is named either windows-x86_64 (if you’re running Windows), or linux-x86_64 (if you’re running Linux).

    Within that folder is a package.zip file. This is the file that contains all of the art assets. Extract package.zip to the associated location in the list in Step 4.

  3. Nucleus Setup: Create the following directory structure at the top level of your Nucleus server:

NVIDIA_Content/
             Assets/
             Demos/
             Materials/
             Samples/

  1. Content Structure on Nucleus: For each pack you download, there is a directory that the contents will unzip to, and the contents should be uploaded to your Nucleus server. The directory structure matches the directory structure on the NVIDIA content mount to ensure all content paths embedded in the Omniverse platform are preserved. The following list includes the example name of the content packs followed by the intended target path on the Nucleus server.

    Architectural Brownstone Building Models

    copy ov-aecdemo3dpack-01-<version number>.<os build>-ent-package/<os build>/package/* → NVIDIA_Content/Demos/AEC/BrownstoneDemo/.

    Base Materials Pack

    copy ov-base-materials-<version number>.<os build>-ent-package/<os build>/package/* → NVIDIA_Content/Materials/Base/.

    Commercial 3D Models Pack

    copy ov-commercial3dpack-01-<version number>.<os build>-ent-package/<os build>/package/* → NVIDIA_Content/Assets/ArchVis/Commercial/.

    Environments Pack

    copy ov-environmentspack-01-<version number>.<os build>-ent-package/<os build>/package/* → NVIDIA_Content/Assets/Skies/.

    Industrial 3D Models Pack

    copy ov-industrial3dpack-01-<version number>.<os build>-ent-package/<os build>/package/* → NVIDIA_Content/Assets/ArchVis/Industrial/.

    Residential 3D Models Pack

    copy ov-residential3dpack-01-<version number>.<os build>-ent-package/<os build>/package/* → NVIDIA_Content/Assets/ArchVis/Residential/.

    Rigged 3D Characters Pack

    copy ov-character3dpack-10-<version number>.<os build>-ent-package/<os build>/package/* → NVIDIA_Content/Assets/Characters/.

    Samples 3D Models Pack

    copy ov-samples3dpack-01-<version number>.<os build>-ent-package/<os build>/package/* → NVIDIA_Content/Samples/.

    USD Physics Sample Pack

    copy ov-sig22-physics-01-<version number>.<os build>-ent-package/<os build>/package/* → NVIDIA_Content/Demos/WarehousePhysics/.

    Vegetation 3D Models Pack

    copy ov-vegetation3dpack-01-<version number>.<os build>-ent-package/<os build>/package/* → NVIDIA_Content/Assets/Vegetation/.

    VMaterials 2 Pack

    copy ov-vmats2pack-01-<version number>.<os build>-ent-package/<os build>/package/* → NVIDIA_Content/Materials/vMaterials_2/.

    Warehouse 3D Models Pack

    copy warehouse3dpack-01-<version number>.<os build>-ent-package/<os build>/package/* → NVIDIA_Content/Assets/DigitalTwin/.

  2. Set Content Permissions: Once you have all the content stored in the proper directories, select the NVIDIA_Content directory, and go to the Permissions tab. Add the users group to the list, and select read, then click apply.

_images/launcher_enterprise-permissions.png

  1. Set Content Root Aliases: Once you have all the content stored and permissions set, you must define the new content path root alias within the omniverse.toml file stored in ~/.nvidia-omniverse (linux) or %USERPROFILE%\.nvidia-omniverse (windows) for each user on the network. In the following section replace the <server_name> with the actual name of your server (i.e. <server_name> is replaced with localhost).

[aliases]
"http://omniverse-content-production.s3.us-west-2.amazonaws.com" = "omniverse://<server_name>/NVIDIA_Content"
"https://omniverse-content-production.s3.us-west-2.amazonaws.com" = "omniverse://<server_name>/NVIDIA_Content"
"http://omniverse-content-production.s3-us-west-2.amazonaws.com" = "omniverse://<server_name>/NVIDIA_Content"
"https://omniverse-content-production.s3-us-west-2.amazonaws.com" = "omniverse://<server_name>/NVIDIA_Content"
"https://twinbru.s3.eu-west-1.amazonaws.com/omniverse" = "omniverse://<server_name>/NVIDIA_Content"