Optional properties - Optional properties - Alfresco - Alfresco Sync Service - Alfresco/Alfresco-Sync-Service/5.2/Alfresco-Sync-Service/Configure/Overview/Optional-properties - 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

You can modify the installation, depending on your requirements, using the following optional properties in the <installLocation>/service-sync/config.yml file:

Property Description
messaging.events.repo.node.maxConsumers Specifies the maximum size of the event consumer thread pool. Increase this to provide more threads for event consumption.
messaging.events.repo.node.numConsumers Specifies the initial size of the event consumer thread pool. Depending on the load it will increase up to maxConsumers.
sync.health.events.eventLagTolerance Specifies the event lag the synchronization service events health check will tolerate before displaying a warning (default is 5000ms).
sync.authentication.basicAuthUrl Specifies the standard repository authentication URL that the synchronization service uses to authenticate sync requests.
sync.authentication.cache.expiryMs Specifies the expiry time (in ms) of the synchronization service authentication cache. Setting this higher than the default client polling time (5 minutes) should ensure that sync requests do not need to re-authenticate with the repository very often, at the cost of more memory use.
sync.cleanup.keepPeriod Specifies the length of time events are retained before being deleted (default is 28 days).
sync.cleanup.events.schedulerExpression Specifies a cron expression used by Quartz to trigger the jobs that delete old node events, namely events that are older than a configured number of days/hours/minutes (see property sync.cleanup.events.keepPeriod). The default value is 0 0 * ? * * (every hour). For more information about the cron expression, see the CronTrigger tutorial available at https://www.quartz-scheduler.org.
sync.cleanup.events.numThreads Specifies the maximum number of threads to use for event cleanup.
sync.cleanup.events.batchSize Specifies the batch size for event cleanup.
sync.cleanup.events.maxItems Specifies the maximum number of events that will be deleted once the cleaning job is triggered.
sync.cleanup.authEvents.schedulerExpression Specifies a cron expression used by Quartz to trigger the jobs that delete old authority events. These are events that don’t apply to a specific node, such as events generated when a group is deleted. The default value is 0 0 */4 ? * *(every 4 hours).
sync.cleanup.txns.schedulerExpression Specifies a cron expression used by Quartz to trigger the jobs that delete old transaction entries. The default value is 0 0 0-7 ? * * (every hour between 00:00 and 7:00).
logging.level Specifies the synchronization service logging level.
messaging.events.repo.node.redelivery.numRetries Specifies the maximum number of redelivery attempts allowed to be performed by Apache Camel before the message is exhausted and is moved to the dead letter queue. 0 disables redelivery, and -1 attempts redelivery forever until it succeeds.
Note: This is an Apache Camel redelivery attempt, not ActiveMQ. ActiveMQ will try to redeliver the message based on the jms.redeliveryPolicy.maximumRedeliveries property which is appended to the messaging.broker.url. For example, if the Sync Service is terminated in the middle of a repository transaction, the Apache Camel redelivery configuration will have no effect. Also, Apache Camel will not redeliver the message if an exception of type DoNotRetryException occurs.
messaging.broker.url Specifies the ActiveMQ connector URL. Set the value to specify your ActiveMQ location, and connection protocol. Optionally, you can override the default ActiveMQ options, such as maximumRedeliveries (default value is 6).
sync.metrics.reporter.graphite.address IP/hostname of the Graphite server where the Sync Service metrics will be sent. For more information on the Graphite server, see the docker-graphite-statsd GitHub page: https://github.com/hopsoft.
sync.metrics.reporter.graphite.enabled Sets whether sending metrics to Graphite is enabled or not.
sync.metrics.reporter.graphite.pollingInterval The amount of time between polls (in seconds). After every <pollingInterval> Graphite will receive a new batch of metrics from the Sync Service.
sync.metrics.reporter.graphite.prefix Prefix used to prepend Sync Service metrics with.
sync.metrics.reporter.graphite.port Port of the Carbon receiver. Carbon is one of the components of Graphite, and is responsible for receiving metrics over the network and writing them to disk using a storage backend.