Run via a script - Run via a script - Alfresco - Alfresco Sync Service - Alfresco/Alfresco-Sync-Service/5.2/Alfresco-Sync-Service/Configure/Run-via-a-script - 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 run the Sync Service using a script.

Ensure that you’ve installed the required software before installing Sync Service.

Before you start the Sync Service, see the Prerequisites and Readme.txt file included in the distribution ZIP file, AlfrescoSyncServer-x.x.x.zip (where x.x.x is the exact version provided), for more information.

  1. Create a user that you’ll use to run the process.
    • For Linux:

      Create a user named dsync that you’ll use to run the process, with user home set to /opt/alfresco-sync-service.

      For example:

       sudo useradd -m -d /opt/alfresco-sync-service dsync

      The format of the command is: sudo useradd -m -d </PATH/TO/FOLDER> <USERNAME>

    • For Windows:

      You only need a dedicated user if JMX remote authentication is enabled. See Readme.txt file in the distribution ZIP file for details.

  2. Use one of the start up scripts from the distribution ZIP.
    • For Linux: syncservice.sh
    • For Windows: syncservice.bat

    • On Linux:

      1. Make the script file executable:

        sudo chmod +x /opt/alfresco-sync-service/syncservice.sh

      2. Start the Sync Service by issuing the following command:

        sudo /opt/alfresco-sync-service/syncservice.sh start

      3. Stop the Sync Service by issuing the following command:

        sudo /opt/alfresco-sync-service/syncservice.sh stop

    • On Windows:

      1. Run syncservice.bat to start the Sync Service.

      2. Press CTRL+C to stop the Sync Service, or via JMX. See Readme.txt for more.