Skip to main content
Version: v16.x - Umbraco 16

appsettings.config

tip

For Umbraco v.9 and above, all configuration lives in the appsettings.json file.

The majority of these settings will have default values that do not need to be changed.

appsettings.json
{
    "uSync": {
        "Settings": {
            "AddOnPing": true,
            "BackgroundNotifications": false,
            "CacheFolderKeys": true,
            "CustomMappings": {},
            "DefaultExtension": ".config",
            "DefaultSet": "Default",
            "DisableDashboard": false,
            "EnableHistory": true,
            "ExportAtStartup": "None",
            "ExportOnSave": "All",
            "FailOnDuplicates": false,
            "FailOnMissingParent": false,
            "FirstBootGroup": "all",
            "Folders": ["uSync/root","uSync/v16"],
            "HideAddOns": false,
            "HistoryFolder": "uSync/history",
            "ImportAtStartup": "None",
            "ImportOnFirstBoot": false,
            "IsRootSite": false,
            "LockRoot": false,
            "LockRootTypes": "",
            "ReportDebug": false,
            "ShowVersionCheckWarning": true,
            "UiEnabledGroups": "All",
        },
        "Sets": {
            "Default": {
                "DisabledHandlers": [],
                "Enabled": true,
                "Handlers": {},
                "HandlerGroups": [],
                "HandlerDefaults": {
                    "Actions": [],
                    "Enabled": true,
                    "FailOnMissingParent": false,
                    "Group": "",
                    "GuidNames": false,
                    "Settings": {},
                    "UseFlatStructure": true
                }
            }
        }
    }
}

uSync:Settings​

AddOnPing​

Ping the jumoo.co.uk website to check for addons and updates.

"Settings": {
    "AddOnPing": true,
  }

BackgroundNotifications​

Run all notifications on background thread to speed up import processing, see Background Notifications

"Settings": {
    "BackgroundNotifications": false,
  }

CacheFolderKeys​

Use a cache for the names and keys of folders during import. This increases import speeds.

"Settings": {
    "CacheFolderKeys": true,
  }

CustomMappings​

Custom item mappings for 3rd party or custom property editors.

"Settings": {
    "CustomMappings": {},
  }

DefaultExtension​

Default file extension for the uSync files.

"Settings": {
    "DefaultExtension": ".config",
  }

DefaultSet​

Name of the handler set used by default.

"Settings": {
    "DefaultSet": "Default",
  }

DisableDashboard​

Disable the default dashboard (so people can't accidentally press the buttons).

"Settings": {
    "DisableDashboard": false,
  }

EnableHistory​

Enable viewing the import and export history in the uSync dashboard.

"Settings": {
    "EnableHistory": true,
  }

ExportAtStartup​

Handler groups used when exporting items at startup.

"Settings": {
    "ExportAtStartup": "None",
  }

ExportOnSave​

Handler groups whose items will be exported when changes are saved in Umbraco.

"Settings": {
    "ExportOnSave": "All",
  }

FailOnDuplicates​

Fail if a duplicate file of same type and key is detected during the import process.

"Settings": {
    "FailOnDuplicates": false,
  }

FailOnMissingParent​

Should an import fail if the parent of an item is missing.

"Settings": {
    "FailOnMissingParent": false,
  }

FirstBootGroup​

Handler group(s) to run on first boot. Default is All (i.e full import)

"Settings": {
    "FirstBootGroup": "all",
  }

Folders​

Collection of folders uSync looks in when performing imports. uSync merges these folders together, for more info look at uSync Roots.

"Settings": {
    "Folders": ["uSync/root/","uSync/v16"],
  }

HideAddOns​

List of addon (tabs) you don't want to show inside uSync dashboard.

"Settings": {
    "HideAddOns": false,
  }

HistoryFolder​

Location of the history folder.

"Settings": {
    "HistoryFolder": "uSync/history",
  }

ImportAtStartup​

Handler groups used when importing items at startup.

"Settings": {
    "ImportAtStartup": "None",
  }

ImportOnFirstBoot​

Import the uSync folder on the first boot.

"Settings": {
    "ImportOnFirstBoot": false,
  }

IsRootSite​

Sets this site to be the root site (so it will save into "uSync/root/").

"Settings": {
    "IsRootSite": false,
  }

LockRoot​

When locked, you can't make changes to anything that is in the root.

"Settings": {
    "LockRoot": false,
  }

LockRootTypes​

Lock specific types at root so they can't be changed in child sites.

Specific types such as: document, media, member, dictionary-item, macro, template, document-type, media-type, data-type, member-type, member-group, relation-type forms-form, forms-prevalue, forms-datasource, and language.

"Settings": {
    "LockRootTypes": "",
  }

ReportDebug​

Create a report while producing an export (debugging only).

"Settings": {
    "ReportDebug": false,
  }

ShowVersionCheckWarning​

Display the warning box if the current import is from an older version of uSync.

"Settings": {
    "ShowVersionCheckWarning": true,
  }

UiEnabledGroups​

Handler groups that show in the uSync dashboard.

"Settings": {
    "UiEnabledGroups": "All",
  }

Group Values​

Group values can be None, All or any Settings group that you have installed on your site. The default groups are 'Settings' and 'Content'.

Group values can be a combination of settings groups (but all or none will override any other groups set in a list)

None​

No groups, effectively off

All​

All groups, everything on

Settings​

Settings only (e.g Datatypes, doctypes)

Content​

Content only (e.g media, content)

Forms​

Umbraco Forms elements

Users​

Users and groups

Members​

Members and groups

uSync:Sets​

DisabledHandlers​

List of handlers to disable for this set.

Enabled​

Turn on the handler set.

HandlerGroups​

List of handler groups to include in this set.

uSync:Sets:HandlerDefaults​

Default settings for the handler, these values can be overridden for individual handlers.

Actions​

List of actions for which the handler is valid.

Enabled​

Enable or disable the handler.

FailOnMissingParent​

Should an import fail if the parent of an item is missing.

Group​

Override the group used for a handler.

GuidNames​

Should uSync use the guid of an item as its file name. This ensures there are no clashes in names, but makes it harder to manually read what settings are in a folder.

Settings​

Specific settings for each handler, this will override the defaults.

UseFlatStructure​

Use a flat file structure for the file produced by the handler.

Action Values​

Actions values determine which 'actions' a handler fires for. The handler action value can be a combination of any of the actions below.

Report​

Report any changes to items

Import​

Import items

Export​

Export items when started via dashboard

Save​

Export items on save

All​

All of the above actions

The default value is all actions.

For Handler Settings, see the Handler Docs.