Skip to main content
Version: v13.x - Umbraco 13

uSync.Publisher Config

for uSync 9 and 10 the majority of the uSync publisher config now lives in the Database, and can be synced between your servers via the dashboard.

AppId/AppKey​

For your servers to communicate securely they will need to have a shared AppId and AppKey, these values have to be placed in the appsettings.json file on each server.

tip

When you first open up the uSync.Publisher dashboard, uSync will prompt you to create an AppId and AppKey. you can cut and paste the JSON from that dialog box directly into your appsettings.json file.

{
  "uSync": {
    "Publisher": {
      "Settings": {
        "IncomingEnabled": true,
        "AppId": "****************",
        "AppKey": "****************"
      }
    }
  }
}

appsettings.json config File​

While most settings are now stored in the DB, there are a few settings you can control per server via the appsettings.json file:

{
  "uSync": {
    "Publisher": {
      "Settings": {
        "IncomingEnabled": true,
        "OutgoingEnabled": true, 
        "AppId": "****************",
        "AppKey": "****************",
        "Publisher": "Realtime",
        "CleanReports": true,
        "PageSize": 50,
        "MediaPageSize": 5,
        "AdditionalFolders": "",
        "SystemFolders" : "",
        "SystemExclusions" : "",
        "FileReplacements" : "",
        "IncludeHost" : true,
        "ForstHostOption" : false,
        "UserAgentString" : "",
        "RequestHeaders" : "",
      }
    }
  }
}

incomingEnabled​

Turns this server on/off for incoming requests. With this setting off the server cannot be published to or pulled from.

outgoingEnabled​

Enables this server sending publish requests. With this setting off, you will not see the publish/pull options in Umbraco.

AppId​

Application ID used alongside AppKey to sign and check any communication between instances.

AppKey​

Key used to sign communications.

Publisher​

The type of Publisher to use when pushing and pulling content.

CleanReports​

Turns on/off the trimming of folders after the report stage (this makes imports quicker as less is rechecked).

PageSize​

How many items are in a 'page' of data sent between servers.

MediaPageSize​

How many media items are in a 'page' of data sent between servers, as media is compressed and sent in pages between servers changing this value will change the size of those compressed files.

EnableRollback​

A rollback folder will be created for each sync, ensuring a backup if it all goes wrong.

AdditionalFolders​

List of folders to include.

SystemFolders​

What folders are considered system folders (e.g bin).

SystemExclusions​

Things to exclude from system.

FileReplacements​

Things that might be replaced inside a file.

RenameUsingAssembly​

Do we rename any instances of your site name in the viewimports file. This setting is on by default.

MaxRequestBodySize​

Maximum request size. The default is 500mb, if you set it to zero there is no limit.

RequestTimeout​

Timeout for http requests in seconds.

IncludeHost​

If the host name is included as part of the signature when signing requests between sites. Turning this value off may make it possible to replay requests on another server.

ForceHostOption​

If true Usync will require a host name as part of the sync.

UserAgentString​

Set the user agent string.

SeedServerUrl​

This setting is the equivalent of clicking the 'sync' button on a site, but as a pull. All server settings will be pulled from the other site.

RequestHeaders​

Add your own custom header key pairs that will get added to every request.

AllowDeletingOfOrphanedItemsForAllTypes​

warning

Use of this setting could badly break your site. We do not advise turning it on unless you are 100% sure you know what you're doing.

Enabling this setting allows you to remove 'missing' datatypes and doctypes. However, this could have a knock-on effect of removing all associated content and media from your site. We strongly advise you do not enable it.

This setting is set to false by default.