Usage

General Notes

Server Sharing

By default, users and applications on separate computers cannot access the Nucleus Server. To grant access, click ‘Enable Sharing’ in the System Monitor at http://localhost:3080

../../_images/nucleus_system-monitor_server-sharing.png

Important

The server will not be accessible to clients outside of the hosted network.

Caution

Before sharing your server, ensure all your personal accounts with ‘Admin’ user rights have strong passwords. The default ‘Admin’ account has password “admin” and should be changed to a unique password.

See Reset Password

System Monitor

System Monitor is the primary utility for monitoring the services in Nucleus Workstation:

  • Click the menu next to ‘Local Nucleus Collaboration Service’ and click ‘Settings’ to bring up System Monitor in a browser. Verify that all services are listed as ‘Running’.

  • Open http://localhost:3080 in a web browser.

Useful features include:

  • Starting and stopping individual services

  • Managing cache

  • Managing server connections

  • Managing logs for individual services

Detailed usage info is covered on the System Monitor page.

Port Configuration

Nucleus Core API and Discovery Service API use ports 3009 and 3333 respectively. These must not be changed. In addition, ports 3080 and 3085 are reserved by System Monitor.

Cache ports can be configured from System Monitor. Click on ‘Configure Ports’:

../../_images/nucleus_system-monitor_configure-ports-1.png

which will open the “Ports” page:

../../_images/nucleus_system-monitor_configure-ports-2.png

Change port numbers to suit your configuration and click ‘Apply’.

Important

You may need to restart other applications using cache for the changes to be applied.

These are the default ports used by Omniverse:

Utility

Port

Nucleus Core API

3009 (Do not change!)

Discovery Service API

3333 (Do not change!)

System Monitor

3080, 3085 (reserved)

Nucleus Metrics (Prometheus)

3010

Nucleus Navigator

34080

Authentication Service API

3100

Authentication Form

3180

Cache Service

8891

Cache API

8892

Web

34080

Search

3400

Ports for the other services can be changed in their respective configuration files for each service (usually .toml or .json) which can be found in the same directory as the service executable. The directories for each service executable are displayed in the System Monitor ‘Apps’ tab.

Data Management

The user data directory is selected during installation of Nucleus Workstation via Launcher. Once set, all data will be stored there as database entries.

To back up your data, simply create a copy of the data directory. From there, you are free to choose any method that works best for you.

To restore the data, you will have to ensure that data path points to the same path as your backup directory. There are two ways to do this:

  1. Change DATA PATH in Launcher to point to the backup directory:

    • During installation: set ‘DATA PATH’ to your backup location

    • After installation: click on Profile > Settings, set ‘DATA PATH’ to your backup location and save

  2. Open the config file named: .nvidia-omniverse/config/omniverse.toml

    • Manually set the data_root parameter to your backup location. For example:

data_root = "c:\\ProgramData\\NVIDIA Corporation\\Omniverse"

Authentication

User authentication is detailed on the Authentication and User Management page.

Omniverse Nucleus Navigator

Omniverse Nucleus Navigator is a client application for managing files, users, and Access Controlled Lists (ACLs). There are two ways to access it:

  1. Click on the folder icon next to ‘Local Nucleus Collaboration Service’ to bring up Navigator UI. Log in using the Administrator account

  2. Open http://localhost:3080 in a web browser; log in using the Administrator account.

More details are available on the Omniverse Nucleus Navigator page.