Install with zip - Install with zip - Alfresco - Alfresco Sync Service - Alfresco/Alfresco-Sync-Service/5.2/Alfresco-Sync-Service/Install/Install-options/Install-with-zip - 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

Use these instructions to install the Sync Service repository modules and services on Alfresco Content Services.

You can download the release files from Hyland Community by navigating to Support > Software Downloads > Alfresco Downloads.

The Sync Service distribution ZIP file, AlfrescoSyncServer-x.x.x.zip (where x.x.x is the exact version provided), includes all the files required to provide the Sync Service. This file contains the following artifacts:

  • amps-repository directory containing the Sync Service repository AMP: alfresco-device-sync-repo-x.x.x.amp
  • licenses directory containing the 3rd-party licenses
  • service-sync directory with:
    • service-sync-x.x.x.jar Sync Service JAR
    • config.yml property file
    • syncservice start/stop script
    • sync.jks SSL keys

    where x.x.x is the exact version provided in the distribution ZIP file.

Note: The keystore sync.jks contains a self-signed certificate that should be used for testing purposes only. You’ll need to provide your own SSL keys for a production environment.
Note: Make sure you’re running the correct versions of operating system and software before you install the AMP file. For more information, see Prerequisites.
  1. Download the distribution ZIP.
  2. Extract the ZIP file into a system directory; for example, <installLocation>/.

    We’ll refer to this new directory (<installLocation>/sync), as the Alfresco Sync Service installation directory. In this directory you’ll see these folders:

    1. amps-repository
    2. licenses
    3. service-sync
  3. Stop the Alfresco repository.
  4. Use the Module Management Tool (MMT) to install the AMP into the repository WAR.

    For more information, see instructions in the Install Alfresco Module Package section in the Alfresco Content Services documentation.

    For example, to apply the alfresco-device-sync-repo-x.x.x.amp, use the following command:

     java -jar <alfrescoInstallLocation>\bin\alfresco-mmt.jar install <installLocation>\amps-repository\alfresco-device-sync-repo-x.x.x.amp <installLocation>\tomcat\webapps\alfresco.war
    

    where x.x.x is the exact version provided in the distribution ZIP.

  5. Add the following properties to the alfresco-global.properties file:
     dsync.service.uris=https://<hostname>:9090/alfresco
     messaging.broker.url=failover:(tcp://localhost:61616)?timeout=3000
    

    where:

    1. dsync.service.uris specifies the hostname of the Sync Service (or the load balancer hiding the Sync Service cluster) that Desktop Sync clients can see. For example, https://<hostname>:9090/alfresco.
    2. The dsync.service.uris value needs to be set to an IP address or hostname of the Sync Service machine that can be accessed by the Desktop Sync clients outside the firewall. In addition, the port 9090 needs to be opened up in the firewall so that clients can access the Sync Service.
    3. messaging.broker.url specifies the location of ActiveMQ.
  6. Configure the Sync Service properties in the <installLocation>/service-sync/config.yml file.

    For more information on configuring Sync Service, see Overview.

    For example, edit the following properties:

    1. repo:
        hostname: localhost
      

      where repo.hostname is the IP address of the repository host.

    2. messaging:
        broker:
            host: localhost
      

      where messaging.broker.host is the IP address of the ActiveMQ host.

    3. sql:
        db:
            url: jdbc:postgresql:alfresco
      

      where sql.db.url is the URL of the Postgres database.

  7. Start and configure PostgreSQL.

    For more information, see Postgres.

  8. Start ActiveMQ.

    If ActiveMQ is down, the repository transactions will fail and rollback. In production environments, it’s advisable that you run an ActiveMQ cluster in failover mode to avoid this situation. See the MasterSlave article in the ActiveMQ documentation available at https://activemq.apache.org.

    For more information, see the ActiveMQ section in the Alfresco Content Services documentation.

  9. Start the repository.
    Note: Wait for the repository to fully start before proceeding to the next step.
  10. Start the Sync Service. Remember to replace x.x.x with the exact version provided in the distribution ZIP.

    For Linux:

    cd <installLocation>/service-sync
    
    java -Xmx2G -Djava.io.tmpdir=/var/tmp/dsync -classpath <classpath to database.jar file>:service-sync-x.x.x.jar org.alfresco.service.sync.dropwizard.SyncService server config.yml
    

    See Run via a script.

    For Windows:

    cd <installLocation>/service-sync
    
    java -Xmx2G -Djava.io.tmpdir=/users/<username>sync/tmp -classpath <classpath to database.jar file>;service-sync-x.x.x.jar org.alfresco.service.sync.dropwizard.SyncService server config.yml
    
    Note: For production systems, you need to configure JMX authentication as password authentication over the Secure Sockets Layer (SSL) is enabled by default. However, in a test environment, you can disable all security, namely both password authentication and SSL, when you start the Java VM. For configuration options, see Connect through JMX. For more information, see the Monitoring and Management Using JMX Technology article in the Oracle documentation available at https://docs.oracle.com.
    Note: The PostgreSQL JDBC driver must be provided and included in the startup command line as shown above.

    For more information, see Postgres.

  11. Access Alfresco Share by browsing to: http://<hostname>:8080/share .
  12. Check the repository and Sync Service log file (<installLocation>/service-sync/logs/sync-service.log by default) to see if the Sync Service started properly. The location of the log file can be configured using the logging properties in the config.yml file.
    To validate that the Sync Service is configured correctly, see Sync Service health check.