📄️ Debugging uSync
There may come a time when uSync isn't doing what you expect it to do ☹. This is a sad time for us all, we want to stop that from happening, but first we need to work out what is wrong.
📄️ Turn Off Content Edition
Disable Content Saving to Disk
📄️ Image HMAC Settings
This feature was introduced in Umbraco version 17.3. To use the settings on this page you will need this version or a subsequent version.
📄️ Dictionary Handler
Change the DictionaryHandler's Group
📄️ Upgrading uSync
You can upgrade uSync by entering this command into the commandline:
📄️ Using Guid File Names
When uSync saves an exported item to disk, it will use the name or alias of the item as the file name by default.
📄️ uSync.Migrations
Migrations can be varied and complex, and while we have developed uSync.Migrations, we cannot support individual migrations. The code is open source, and if you have any issues we encourage you to contribute.
📄️ Flat File Structure
By default, uSync will store all of the items of the same 'type' (e.g DataTypes) in a flat folder structure.
📄️ Background Notifications
The Background Notifications setting is in appsettings.json
📄️ FirstBoot 🥇🥾
uSync FirstBoot is designed to get you up and going with an Umbraco site, easily and with minimal interaction.
📄️ uSync Roots 🌳
As of Umbraco 17, child sites put their files in usync/v17. Read our Folder Changes page for more info.
📄️ History
The History feature logs imports and exports, allowing you to keep track of every change added to your files.
📄️ uSync.Once / Stop Files
uSync.once and uSync.stop are special files that you can use on your deployments to control how uSync imports will run at startup.
📄️ Selectable Sets
Within uSync you have the option to configure multiple 'Handler Sets'. Each of these sets defines which sync handlers are used and how they behave when running report, import or export events.
📄️ Importing/Exporting Options
If you go to Settings --> uSync you can Import or Export your Settings, your Content, or Everything. This can be done by clicking the Import and Export buttons. Sometimes more specific versions of these actions are nessacery, and so you are presented with options.
📄️ Webhooks
This page is for triggering webhooks. If you want to serialize your webhooks, you will need to use the webhook handler.
📄️ uSync Performance Tuning
We work hard to make uSync's impact on your site as small as possible, but as your site gets larger some of the work uSync has to do to keep the sync folders in order will increase.
📄️ Import Caching
Normally, on import, uSync checks every page for any change that needs importing. While this is helpful to ensure no changed files are missed, this can slow down imports and reports on sites with a lot (10,000+) of content to search through.
📄️ Exclude/Include Content
Excluding and Including are both useful tools to make sure uSync only syncs the content you need it to.
📄️ v17 Folder Changes
As of Umbraco 14, the usync/v9 folder will change names with each version, e.g usync/v14 for version 14, usync/v15 for version 15, etc.