Back up and restore Sync Service - Back up and restore Sync Service - Alfresco - Alfresco Sync Service - Alfresco/Alfresco-Sync-Service/5.2/Alfresco-Sync-Service/Administer/Administration-overview/Back-up-and-restore-Sync-Service - 5.2 - 5.2

Alfresco Sync Service
Platform
Alfresco
Product
Alfresco Sync Service
Release
5.2
License
ft:lastPublication
2026-05-28T22:10:46.888000
ft:locale
en-US

The approach to backup and restore is to ensure that the repository is backed up before the Sync Service, so that a subsequent restore can simply remove any tracked repository changes that occurred after the repository backup.

  1. To perform a backup of your Sync Service database, follow these steps:
    1. Backup your repository database. See Back up and restore section in Alfresco Content Services.
    2. After you have successfully backed up the repository, wait for a couple of minutes to ensure that the synchronization server has correctly tracked the repository after the repository backup.
    3. Alternatively, ensure that all undelivered events in the event queue, Consumer.<guid>.alfresco.repo.event2 have been delivered such that Messages Dequeued == Number Of Pending Messages. Here, guid is the synchronization server id, which can be determined from the syncServiceIdCheck in the health check response, https://localhost:9090/alfresco/healthcheck.
    4. Backup your synchronization service database using your database vendor’s backup/restore tools.
  2. To perform a restore, follow these steps:
    1. Use the ActiveMQ console to check that all the events in the event queue, Consumer.<guid>.alfresco.repo.event2 have been consumed. Using the ActiveMQ console, you can either:
      • Remove any undelivered events in the Virtual Topic, alfresco.repo.event2 and associated queue, Consumer.<guid>.alfresco.repo.event2.
      • Delete the Virtual Topic, alfresco.repo.event2 and associated queue, Consumer.<guid>.alfresco.repo.event2.

      Here, guid is the synchronization server id, which can be determined from the syncServiceIdCheck in the health check response, https://localhost:9090/alfresco/healthcheck.

      Note: The Virtual Topic and associated queue will be recreated automatically.
    2. Restore the repository database. See Back up and restore section in Alfresco Content Services.
    3. Restore the Sync Service database using your database vendor’s backup/restore tools.
    4. Restart the Sync Service with the following additional command line parameter: 
       -Drecover=<repo admin username>:<repo admin password>

      The Sync Service will ensure that it and the repository are in sync during bootstrap, before becoming available for requests.