Documentation:TurnkeySettings

Introduction

The TurnkeySettings.xml is a settings file in the App_Data folder of the Turnkey application. This file holds a number of settings that control the behavior of your application.

Using the Portal

The TurnkeySettings.xml is recreated for your application by the portal.mdriven.net when you press SendSettingsAndRestart. The TurnkeySettings is thus a normally generated file based on the settings you have given your application in portal.mdriven.net.

Local Installation (not using the portal)

When you have a standalone or local installation that the portal cannot reach, you will need to supply this file yourself.

TurnkeySettingsExtra.xml

From July 2019, we allow for a TurnkeySettingsExtra.xml file to be created.

This file will not be touched/created by the portal. The TurnkeySettingsExtra.xml will be read prior to the TurnkeySettings.xml file being read.

The use-case for TurnkeySettingsExtra.xml is that you may have settings local to your application that the portal does not know about - like experimental or new settings not available in the portal.

One such example at the time of writing is the ORCID authentication settings that we believe very few will use and thus should neither consume portal space nor increase portal complexity for the user.

Furthermore, the TurnkeySettingsExtra allows to set the local app name - not overwritten by SendSettings:

<ApplicationNameAsMenu>false</ApplicationNameAsMenu>  -- this prevent the ApplicationName to be added as a index link after the AppLogo in the menubar

Some of the Settings Available in the TurnkeySettings.xml file

<HidePasswordLogin>
  False
</HidePasswordLogin>

<AllowUserToChooseSocialLoginEmail>
  True
</AllowUserToChooseSocialLoginEmail>

<SkipExternalAccountConfirmationScreen>
  False
</SkipExternalAccountConfirmationScreen>

<UseCSSGridByDefault>
  True
</UseCSSGridByDefault>

<HideRegistration>
  True
</HideRegistration>

<CurrentUserViewModel>
name of viewmodel to bring up when user click logged in name
</CurrentUserViewModel>