Usage

General Notes

Nucleus Service Sharing

By default, users and applications on separate computers cannot access the Nucleus service but Nucleus Workstation does support sharing for multiple users.

  1. To grant access, click Enable Sharing in the System Monitor at http://localhost:3080 (Windows may present a dialog window to adjust your firewall settings.)

../_images/nucleus_system-monitor_server-sharing.png
  1. Obtain the IP Address of your computer that is running the Nucleus service (i.e., 192.168.0.4 and it’s recommended for this computer to have a static IP).

  2. Using your IP Address, add this to your Nucleus list, as this will be the address you share with other users.

  3. Add your user accounts to this Nucleus service, and generate share links with the invite button for other users on your network to log in with.

../_images/nucleus_navigator_user_invite.png

Important

The service will not be accessible to clients outside of the hosted network and cannot be hosted within a Cloud Service Provider and be connected to remotely.

Caution

Before sharing the Nucleus service, 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 for additional information.

System Monitor

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

  • Click the menu next to Local Nucleus Collaboration Service and click Settings to load 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 service connections

  • Managing logs for individual services

Detailed usage info is covered in the System Monitor documentation.

Port Configuration

A comprehensive list of TCP/IP Ports that Nucleus uses is here.

See Networking and TCP/IP Ports for a comprehensive list of the ports used by Omniverse.

Data Management

The data directory is selected during installation of Nucleus Workstation via Launcher. Once set, all data will be stored in that location.

To back up your data, simply create a copy of the data directory. From there, you are free to choose any backup method you prefer.

To restore the data, ensure that the 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 Profile > Settings, set ‘DATA PATH’ to your backup location

  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 within the Authentication and User Management documentation.

Nucleus Navigator

Nucleus Navigator is a client application for managing files, users, and permissions via Access Control Lists (ACLs).

Further details are available within the Nucleus Navigator documentation.