Skip to main content

Configuring Frame App

Frame App behavior can be configured on startup of the application (Command Line Arguments) and through configuration files/Windows registry keys. If you are installing Frame App on Windows endpoints and would like to configure the silent installation process, you can find additional documentation here.

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.

Command Line ArgumentsDescription and Syntax Example
displays-auto-arrangeFrame App will launch with virtual displays configured to match your local environment.

Example:
./Frame --displays-auto-arrange
kioskInstructs Frame App to launch in full screen, also known as “Kiosk mode.”

Example:
./Frame --kiosk
urlDesignates the startup URL, as you would on the “Preferences” page of Frame App.

Example:
./Frame --url=console.nutanix.com
x11-windowSwitch from GTK (default) to X11 Windows. This argument should be used with HP ThinPro OS clients.

Example:
./Frame --x11-window
Frame App 7 Early Access

Launch Frame App with arguments following the pattern: .\Frame -- --arg1=value1 --arg2=value2

Command Line ArgumentsDescription and Syntax Example
startup-urlDesignates the startup URL, as you would on the “Preferences” page of Frame App.

Example:
--startup-url="https://console.nutanix.com/"
check-for-updates-on-startupFrame App will check for updates on startup when this argument is set to ON.

Example:
--check-for-updates-on-startup=on
clear-cache-on-startupFrame App will automatically clear the local cache on startup when argument is set to ON.

Example:
--clear-cache-on-startup=on
enable-cameraFrame App will launch with camera functionality enabled when this argument is set to ON.

Example:
--enable-camera=on
enable-microphoneFrame App will launch with microphone functionality enabled when this argument is set to ON.

Example:
--enable-microphone=on
full-screenInstructs Frame App to launch in full screen when this argument is set to ON.

Example:
--full-screen=on
start-session-in-full-screenInstructs Frame App to start a session in full screen when this argument is set to ON.

Example:
--start-session-in-full-screen=on
Important

Administrators using command line arguments with Frame App 7 must provide a value for each argument entered.


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.

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 NameDescriptionValue(s)
ADVANCED_USBFrame App will enable Advanced USB support when this argument is set to ON.

Default Value: ON
ON or OFF
CHECK_FOR_UPDATES_ON_STARTUPFrame 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_STARTUPFrame App will clear the local cache on startup when this argument is set to ON.

Default Value: OFF
ON or OFF
SEND_ERROR_REPORTSFrame App will not send error reports to Nutanix when this argument is set to OFF.

Default Value: ON
ON or OFF
STARTUP_URLDesignates 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
Frame App 7Early Access
Key NameDescriptionValue(s)
STARTUP_URLDesignates the startup Uniform Resource Location (URL).

Default Value: https://console.nutanix.com/
URL
CHECK_FOR_UPDATES_ON_STARTUPFrame 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_STARTUPFrame App will automatically clear local cache on startup when this argument is set to ON.

Default Value: ON
ON or OFF
ENABLE_CAMERAFrame App will launch with camera functionality enabled when this argument is set to ON.

Default Value: ON
ON or OFF
ENABLE_MICROPHONEFrame App will launch with microphone functionality enabled when this argument is set to ON.

Default Value: ON
ON or OFF
FULL_SCREENInstructs Frame App to launch in full screen when this argument is set to ON.

Default Value: OFF
ON or OFF
START_SESSION_IN_FULL_SCREENInstructs Frame App to start a session in full screen when this argument is set to ON.

Default Value: OFF
ON or OFF
Frame App 7 Considerations
  1. Settings configured via registry keys, preferences.plist, and preferences.conf take precedence over command line arguments.
  2. Users will be unable to change settings from the Frame App GUI if they are configured via registry keys, preferences.plist, and preferences.conf or command line arguments.

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.

Frame App 7.X

/home/$USER/.config/Frame/cache

Frame App 6.X

/home/$USER/.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).

Log Location

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

Frame App 7.X

/home/$USER/.config/Frame/Logs

Frame App 6.X

/home/$USER/.Nutanix/Frame/