Configuring Frame App

Frame App behavior can be configured on startup of the application (Command Line Arguments) and through configuration files/Windows registry keys.

Command Line Arguments

Command line arguments or “launch arguments” are parameters that are automatically passed to a program (via command line) to modify its behavior. Some organizations may choose to use these modifiers to better fit their use case. We will start by providing a list of the available command line arguments and then explain how to configure them based on your operating system.

To launch Frame App with certain command line arguments, start by opening command prompt/terminal on your local machine. Specify the file path for Frame App (include the executable). Append your command line argument(s) after file path.

You may launch Frame App with the specified parameters. Use the table below to understand command line argument options and their syntax.

Linux
macOS
Windows

Command Line Arguments	Description and Syntax Example
`disable-mouse-lock`	By default, Frame App will ignore mouse forward/back button events. If this argument is used, Frame App will respond to mouse forward/back button events. When a user is in session, these mouse events can cause the user to exit their session accidentally. Example: `./Frame --disable-mouse-lock`
`displays-auto-arrange`	Frame App will launch with virtual displays configured to match your local environment. Example: `./Frame --displays-auto-arrange`
`kiosk`	Instructs Frame App to launch in full screen, also known as “Kiosk mode.” Example: `./Frame --kiosk`
`url`	Designates the startup URL, as you would on the “Preferences” page of Frame App. Example: `./Frame --url=console.nutanix.com`
`x11-window`	Switch from GTK (default) to X11 Windows. This argument should be used with HP ThinPro OS clients. Example: `./Frame --x11-window`

Command Line Arguments	Description and Syntax Example
`disable-mouse-lock`	By default, Frame App will ignore mouse forward/back button events. If this argument is used, Frame App will respond to mouse forward/back button events. When a user is in session, these mouse events can cause the user to exit their session accidentally. Example: `open /Applications/Frame.app --args --disable-mouse-lock`
`displays-auto-arrange`	Frame App will launch with virtual displays configured to match your local environment. . Example: `open /Applications/Frame.app --args --displays-auto-arrange`
`kiosk`	Instructs Frame App to launch in full screen, also known as “Kiosk mode.” . Example: `open /Applications/Frame.app --args --kiosk`
`url`	Designates the startup URL, as you would on the “Preferences” page of Frame App. . Example: `open /Applications/Frame.app --args --url=console.nutanix.com`

Starting Frame App in the macOS Terminal

Command Line Arguments	Description and Syntax Example
`disable-mouse-lock`	By default, Frame App will ignore mouse forward/back button events. If this argument is used, Frame App will respond to mouse forward/back button events. When a user is in session, these mouse events can cause the user to exit their session accidentally. Example: `"C:\Program Files\Frame\Frame.exe" -disable-mouse-lock`
`displays-auto-arrange`	Frame App will launch with virtual displays configured to match your local environment. . Example: `"C:\Program Files\Frame\Frame.exe" -displays-auto-arrange`
`kiosk`	Instructs Frame App to launch in full screen, also known as “Kiosk mode.” . Example: `"C:\Program Files\Frame\Frame.exe" -kiosk`
`url`	Designates the startup URL, as you would on the “Preferences” page of Frame App. . Example: `"C:\Program Files\Frame\Frame.exe" -url=console.nutanix.com`

Starting Frame App on the Windows command line

User Preference Policies

Frame Administrators can enforce user preference policies across all installations of Frame App for Linux, Frame App for macOS, and/or Frame App for Windows through a preferences.conf file (Linux), plist (macOS), and group policy objects (Windows), respectively.

Linux
macOS
Windows

For Frame App for Linux 6.10 and greater, Frame administrators can control user preferences by creating and saving a configuration file at the location /etc/nutanix-frame/preferences.conf.

The conf file contains name-value pairs in the format KEY = VALUE. Spaces will be ignored. The list of supported keys and associated values are described in the following table.

Key Name	Description	Value(s)
`ADVANCED_USB`	Frame App will enable Advanced USB support when this argument is set to ON. Default Value: `ON`	`ON` or `OFF`
`CHECK_FOR_UPDATES_ON_STARTUP`	Frame App will check for updates on startup when this argument is set to ON. If there is an update available, Frame App will ask the user if they wish to download and install the update. Default Value: `ON`	`ON` or `OFF`
`CLEAR_CACHE_ON_STARTUP`	Frame App will clear the local cache on startup when this argument is set to ON. Default Value: `OFF`	`ON` or `OFF`
`SEND_ERROR_REPORTS`	Frame App will not send error reports to Nutanix when this argument is set to OFF. Default Value: `ON`	`ON` or `OFF`
`STARTUP_URL`	Designates the startup Uniform Resource Location (URL). Default Value: `https://console.nutanix.com/`	URL

preferences.conf Example
STARTUP_URL=https://console.nutanix.com/
CLEAR_CACHE_ON_STARTUP=ON

For Frame App for macOS 6.10 and greater, Frame administrators can control user preferences by creating and saving a plist file at the location /Users/Shared/nutanix-frame/preferences.plist.

The plist file contains name value pairs in the format:

<key>VALID_KEY</key>
<string>VALID_VALUE</string>

The list of supported keys and associated values are described in the prior table. An example plist file would be:

preferences.plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>STARTUP_URL</key>
    <string>https://console.nutanix.com/</string>
    <key>CLEAR_CACHE_ON_STARTUP</key>
    <string>ON</string>
  </dict>
</plist>

Frame App for Windows 6.3 (and greater) enables Windows administrators to set user preferences via group policy objects (GPOs). This allows Windows administrators to use Windows GPOs to change those preferences for all users or specific users.

Administrators can update Frame App user preferences either in HKEY_LOCAL_MACHINE or HKEY_CURRENT_USER. If user preference registry keys are set in HKEY_LOCAL_MACHINE, those user preferences will take precedence as they will apply to all users. The relative path to the registry keys is \SOFTWARE\Nutanix\Frame\Preferences.

Key Name	Description	Type	Value(s)
`ADVANCED_USB`	Frame App will enable Advanced USB support when this argument is set to ON. Default Value: `ON`	REG_SZ	`ON` or `OFF`
`CHECK_FOR_UPDATES_ON_STARTUP`	Frame App will check for updates on startup when this argument is set to ON. If there is an update available, Frame App will ask the user if they wish to download and install the update. Default Value: `ON`	REG_SZ	`ON` or `OFF`
`CLEAR_CACHE_ON_STARTUP`	Frame App will clear the local cache on startup when this argument is set to ON. Default Value: `OFF`	REG_SZ	`ON` or `OFF`
`SEND_ERROR_REPORTS`	Frame App will not send error reports to Nutanix when this argument is set to OFF. Default Value: `ON`	REG_SZ	`ON` or `OFF`
`STARTUP_URL`	Designates the startup Uniform Resource Location (URL). Default Value: `https://console.nutanix.com/`	REG_SZ	URL

preferences.conf Example
STARTUP_URL=https://console.nutanix.com/
CLEAR_CACHE_ON_STARTUP=ON

Local Cache

Frame App functions similarly to web browsers. Frame App contains a local cache that saves cookies, session tokens, and specific user preferences (e.g., automatically use all local displays). The cache can be deleted manually when required.

Follow the steps below based on the operating system on which Frame App is installed. Replace $USER with the name of your user.

Linux
macOS
Windows

/home/$USER/.Nutanix/Frame/cache

/Users/$USER/Library/Application Support/com.nutanix.frame/cache

C:\Users\$USER\AppData\Nutanix\Frame\cache

note

The removal of the local cache will not remove the Startup URL value as this is stored either in the Preferences database or in the registry (for Windows).

Preferences Database

Frame App maintains its preferences in a SQLite database file in the following locations:

Linux
macOS
Windows

/home/$USER/.Nutanix/Frame/preferences.sqlite

/Users/$USER/Library/Application Support/com.nutanix.frame/preferences.sqlite

If Frame App was installed for a single user:

C:\Users\$USER\AppData\Nutanix\Frame\preferences.sqlite

If Frame App was installed for all users:

C:\ProgramData\Nutanix\Frame\

Log Location

Frame App writes its logs to the following locations. Replace username with the name of your user.

Linux
macOS
Windows

/home/$USER/.Nutanix/Frame/

/Users/$USER/Library/Application Support/com.nutanix.frame/

C:\Users\$USER\AppData\Nutanix\Frame\logs

Command Line Arguments​

User Preference Policies​

Local Cache​

Preferences Database​

Log Location​

Command Line Arguments

User Preference Policies

Local Cache

Preferences Database

Log Location