Workstation

General Notes

Server Sharing

By default, users and applications from a different computer cannot access the Nucleus Server. To give them access, click this button in the System Monitor:

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

IMPORTANT Before sharing your server you should make sure all your personal accounts with admin access level have strong passwords. The default “admin” account has password “admin” and this should be set to something unique. See Reset Password.

System Monitor

System Monitor is the primary utility for monitoring the services in Nucleus Workstation. Ways to access it:

  • Click the burger 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 in the System Monitor Documentation.

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-11.png

You will land on this page:

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

Change port numbers however you wish and click ‘Apply’. It’s important to note that after applying changes here, you may need to restart other applications using cache for the change to take effect.

These are the default ports used by Omniverse:

Utility

Port

Nucleus Core API

3009

Nucleus Metrics (Prometheus)

3010

Omniverse Navigator

8080

System Monitor

3080, 3085

Discovery Service API

3333

Authentication Service API

3100

Authentication Form

3180

Cache Service API

8891

Cache Service Control

8892

Web

8080

Search

3400

Snapshots

3120

Ports for the other services can be changed in their respective configuration files. Configuration files for each service (usually a TOML or JSON) 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 live 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. Two ways to do this:

  • Change DATA PATH in Launcher to point to the backup directory. This can be changed in 2 locations:
    • Click on Profile button > Settings, set ‘DATA PATH’ to the location of your backup, and then save

    • During installation of Workstation, set ‘DATA PATH’ to the location of your backup

  • Open .nvidia-omniverse/config/omniverse.toml. Manually set data_root to be the location of your backup. i.e. data_root = “c:\ProgramData\NVIDIA Corporation\Omniverse”

Authentication

Covered in Authentication and User Registration document.

Omniverse Navigator

Omniverse Navigator (formerly Omniverse Web) is a web application for managing files, users, and ACLs. There are two ways to access it:

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

  • Open http://localhost:8080/ in a web browser. Log in using the Administrator account

Please refer to the Omniverse Navigator document for more detailed information.