Frame App Configuration

Now that you understand the basics of how to install and use Frame App, you are likely ready to make some configuration changes. This guide is intended to help administrators configure Frame App preferences, use command line arguments, and test out Early Access Features to ultimately provide an outstanding experience for their users. Use the links below to jump to specific sections of the guide, if needed:

Preferences

This section will help direct you on how to modify your Frame App preferences from within the app. To access the “Preferences” page, select it from the “Help” menu in Frame App.

Startup URL

Administrators can modify the startup URL for Frame App from this page. By default, the startup URL is set to https://frame.nutanix.com:

../../_images/frapp_gsg5.png

Startup URL Destination

The startup URL can be modified to point to a specific destination. For example, if you had a particular Launchpad in mind, it may look like the following:

../../_images/frapp_gsg6.png

As shown in the graphic above, the URL defines the customer entity, organization entity, account name, and lastly, the Launchpad name. The user will be prompted to log in with their credentials before being directed to the specified Launchpad.

Startup URL Authentication

Many organizations choose to integrate Frame with a third-party SAML2 auth provider. In this case, there is a very simple way administrators can ensure their users validate through the desired auth provider before moving on to their startup destination.

  1. Under the “Startup URL” field, define the URL where the SAML2 auth provider has been configured. In this example, our SAML2 integration is at the organization level, so we will start there:

../../_images/frapp_gsg7.png
  1. Next, append ?idp= to the URL, followed by auth provider integration name. In this example, the URL is pointing to our Azure AD integration (tutorial-azureAD). Click “Save” to apply your changes.

../../_images/frapp_gsg8.png
  1. To test, close Frame App and re-launch it. You will automatically be prompted to log in with your SAML2 provider credentials before going to the startup destination.

../../_images/frapp_gsg9.png

Now that we have specified our Azure AD integration as the IdP, we’re automatically prompted for our Microsoft credentials.

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.

Using Command Line Arguments

Windows

To launch Frame App with certain command line arguments, start by opening command prompt or PowerShell on your local machine. Specify the file path for Frame App using quotes (include the executable). Append your command line argument to the end of the file path, as shown below:

../../_images/frapp_windows1.png

Hit enter to launch Frame app with the specified parameters. Use the table below to understand command line argument options and their syntax.

Windows Command Line Arguments

Command Line Argument

Description

Syntax

url

Designates the startup URL, as you would on the “Preferences” page of Frame App.

"C:\Program Files (x86)\Frame\Frame.exe" -url=console.nutanix.com

kiosk

Instructs Frame App to launch in full screen, a.k.a. “Kiosk mode.”

"C:\Program Files (x86)\Frame\Frame.exe" -kiosk

displays-auto-arrange

Frame App will launch with virtual displays configured to match your local environment.

"C:\Program Files (x86)\Frame\Frame.exe" -displays-auto-arrange

Mac

To launch Frame App with certain command line arguments, start by launching your Terminal. You can do so by opening Finder, selecting “Utilities” from the “Go” menu, and clicking the “Terminal” icon. You can also use Spotlight (CMD + Space) and type in “Terminal.” Start the command line argument with open, the file path (/Applications/Frame.app), and the command line argument. See the example below:

../../_images/frapp_mac1.png

Hit enter to launch Frame app with the specified parameters. Use the table below to understand command line argument options and their syntax.

Mac OS Command Line Arguments

Command Line Argument

Description

Syntax

url

Designates the startup URL, as you would on the “Preferences” page of Frame App.

open /Applications/Frame.app --args --url=console.nutanix.com

kiosk

Instructs Frame App to launch in full screen, a.k.a. “Kiosk mode.”

open /Applications/Frame.app --args --kiosk

displays-auto-arrange

Frame App will launch with virtual displays configured to match your local environment.

open /Applications/Frame.app --args --kiosk

Additional features and configuration options will becoming to Frame App soon. Stay tuned for more updates!