ndSync Registry Settings

Follow

Table of Contents

ndSync for Windows

Note: By default, ndSync will use the auto update settings from ndOffice (if ndOffice is installed) if there are no other auto-update registry settings for ndSync.

Welcome to ndSync message registry

Values

Registry Location: HKEY_CURRENT_USER\Software\NetDocuments\ndSync\WasLaunched

If set to True, you will not see the popup when ndSync is first launched.

  • True
  • False

Welcome Tour registry

 

Registry Location:

HKEY_CURRENT_USER\Software\NetDocuments\ndSync\WasLaunched

Set the appropriate value to see the ndSync tour dialog on the first launch of ndSync. If its value is set to True, you will not see the tour.

  • True
  • False

Host registry

Values

Specify the host to be used.

  • US (vault.netvoyage.com)
  • US-GOV (gov.netdocuments.us)
  • UK (eu.netdocuments.com)
  • AU (au.netdocuments.com)
  • DE (de.netdocuments.com)

ProxyOptionSetting registry

 Values

Specify the proxy to be used.

  • Manual – Must use if populating the ProxyHost key.
  • NoProxy – Will not use a proxy server.
  • Automatic – Will use default proxy server from the browser settings.

ProxyHost registry

 Values

Specify the IP address or name of the proxy followed by a colon and a port number. (ex. 10.252.52.33:8888). If a proxy is not specified then the system-defined proxy is used.

Any valid host

ProxyPort registry

Values

The port to be used by the proxy.

Any valid port

ShowLoginOnStartup registry

Values

The ShowLoginOnStartup registry, with the True or False values, can be added to control whether or not the ndSync login page appears when the user’s computer or virtual desktop starts up if the user has not logged in already. (By default, the login page will appear.)

This will help in virtual environments so that the ndSync login page does not repeatedly appear to every user until they login.

  • True - shows login
  • False - turns off login prompt until login

LoginRepoID registry

 Values

The LoginRepoID registry specifies the repository GUID that ndSync uses in the login process as a query parameter to the login URL.

This has the effect of redirecting the user to the IDP login page when ndSync prompts for a login.

The value for this is the repository GUID, for example, CA-12ABC780.

AutoUpdateEnabled registry

Values

Controls whether the feature is enabled/disabled.

If the AutoUpdateEnabled registry is set to True, then ndOffice will check for updates automatically.

If the AutoUpdateEnabled registry is set to False, ndOffice will not check for updates automatically.

  • True (this value is default).
  • False

PromptForAutomaticUpdates registry

Values

The PromptForAutomaticUpdates registry value in the registry is set to True, ndOffice will prompt when there are updates ready to be installed. 

The PromptForAutomaticUpdates registry value in the registry is set to False, ndOffice will not prompt when there are updates ready to be installed. Set to False if AutoUpdateEnabled is set to False.

  • True (this value is default).
  • False

AlternativeUpdateURLEnabled registry

Values

Users can choose whether to redirect the update check to their own specified appversions.xml file.

  • True – ndOffice will check for updates automatically.
  • False ndOffice will not check for updates automatically

AlternativeUpdateURL registry

Values

The URL for the appversions.xml for the user’s environment.

For example, https://somelocation.com/AppVersions.xml

CircuitBreakerEnabled registry

Values

You can automatically enable and configure the Circuit Breaker for all of its users.

Note: If these values are set in HKEY_CURRENT_USER, they will simply be treated as defaults, but the user can override them.  If these values are set in HKEY_LOCAL_MACHINE, then the user cannot override the settings.

  • True (this value is default).
  • False

CircuitBreakerActivities registry

Values

This registry determines the number of activities that must be tracked in a certain period of time to trigger the Circuit Breaker. 

Note: If these values are set in HKEY_CURRENT_USER, they will simply be treated as defaults, but the user can override them.  If these values are set in HKEY_LOCAL_MACHINE, then the user cannot override the settings.

  • 2 (minimum)
  • 25 (maximum)

The default is 5 activities.

CircuitBreakerMinutes registry

Values

This registry determines the rolling period of time, in minutes, during which the amount of activity being tracked can trigger the Circuit Breaker. 

Note: If these values are set in HKEY_CURRENT_USER, they will simply be treated as defaults, but the user can override them.  If these values are set in HKEY_LOCAL_MACHINE, then the user cannot override the settings.

  • 1 (minimum)
  • 10 (maximum)

The default is 2 minutes.

StoreRefreshToken registry

Values

This registry determines whether refresh token will be or will not be stored in the database.

  • True (this value is default)
  • False

ShowUnsyncedLocalContentEnabled registry

Values

Add the Unsynced Local Content button in Settings which allows creating a document with a list of unsynced content.

  • True (this value is default)
  • False

 

LogFolderName registry

Values

Registry location:

HKEY_CURRENT_USER\Software\NetDocuments\ndSync\LogFolderName

HKEY_LOCAL_MACHINE\Software\NetDocuments\ndSync\LogFolderName

The entered value will be taken as the name of the folder where ndSync logs are stored.

ndSync for Mac

For the Mac, settings similar to the ndSync for Windows registry settings. You can find them in a file that is called com.netdocuments.ndSync.plist saved to the Library/Preferences folder. ndSync will take its default settings from this file, but you can override many of these settings from the Settings dialog in ndSync or edit the values in this file.

ProxySettings registry

Proxy information.

You can change this setting either via registry or from the graphical user interface (Settings dialog > Proxy Settings tab).

ActiveHost registry

Host settings.

You can change this setting either via registry or from the graphical user interface (Settings dialog > Advanced tab > Host text box).

FirstLaunchPerformed registry

Does not have UI. The first launch of ndSync indicator. We use it to set up ndSync auto-launch and show the tutorial screen on the first startup.

ShowLoginOnStartup registry

Do not show login automatically on the startup screen.

ShowFreeSpaceLimitWarning registry

Does not have UI. Used to suppress free space limit warning message.

SuppressWorkspaceWarning registry

Suppress showing warning message when a user adds workspace to synchronization.

Back to All Registry Settings