[null, {"document_url": "https://confluence.atlassian.com/conf65/configuring-synchrony-for-data-center-939702056.html", "unformatted_src": "/conf65/files/939702056/939702057/1/1509520564254/DataCenter6-0Diagram-COLOURS.png", "src": "https://confluence.atlassian.com/conf65/files/939702056/939702057/1/1509520564254/DataCenter6-0Diagram-COLOURS.png", "formatted_filename": "DataCenter Diagram COLOURS", "rendered_width": 600}, null, {"document_url": "https://confluence.atlassian.com/conf65/configuring-synchrony-for-data-center-939702056.html", "unformatted_src": "/conf65/files/939700386/939700387/1/1509520394867/Cog.png", "src": "https://confluence.atlassian.com/conf65/files/939700386/939700387/1/1509520394867/Cog.png", "formatted_filename": "Cog"}, null]


Configuring Synchrony for Data Center

Confluence Data Center Technical Overview






When you install Confluence Server, Synchrony is automatically configured to run as a seperate process on your server.

For Confluence Data Center, we give you full control by allowing you to set Synchrony up yourself. This gives you the flexibility to deploy Synchrony standalone on the same nodes as Confluence, or in its own cluster with as many nodes as you need.


Here's an example architecture, with a 2 node Synchrony cluster to support a three node Confluence cluster. To set up Synchrony in Data Center you'll need to:

See Installing Confluence Data Center for a step by step guide to setting up Synchrony for Data Center.

Required Synchrony properties (Data Center only)

Before you can run Synchrony, you need to edit the start-synchrony script to provide the following values.

Optional Synchrony system properties (Data Center only)

When you start Synchrony, we pass default values for the properties listed below. You can choose to override these values by specifying any of these properties when you start Synchrony.

Start and stop Synchrony

To start Synchrony, run start-synchrony.sh or start-synchrony.bat.  A process ID (PID) file will be created in your synchrony directory.

To stop Synchrony, run stop-synchrony.sh or stop-synchrony.bat.  This will destroy the PID file that the start script created in your Synchrony directory.  If you've customised the location for storing the PID file in the start-synchrony script, you'll need to also update this in the stop-synchrony script.

If you're unable to start Synchrony, check that there is not an existing PID file in your Synchrony directory.

You can only use these scripts to start and stop Synchrony in Confluence Data Center.

To restart Synchrony in Confluence server head to > General Configuration > Collaborative editing.

Accessing Synchrony logs

Your Synchrony logs will be stored in the Synchrony directory in each node (wherever you run the start and stop scripts from).


If your users are unlikely to be able to get a WebSocket connection to Synchrony (for example your load balancer or reverse proxy does not support WebSockets) you can enable XHR fallback by passing the synchrony.enable.xhr.fallback system property to Confluence. Note that this is a Confluence system property and must be passed to Confluence, it is not part of your start Synchrony command.

You will need to open Synchrony's port, as you can't use the built-in Synchrony proxy with Data Center. The synchrony.proxy.enabled system property mentioned in the Confluence Server documentation has no effect in Data Center.

Run Synchrony as a service

If you'd prefer to run Synchrony as a service, see Run Synchrony-standalone as a service on Linux.

It's currently not possible to run Synchrony as a service on Windows.

Provide credentials to Synchrony using environment variables (Linux)

If you prefer to store sensitive information in your environment, rather than directly in the Synchrony startup scripts you can create a synchronyenv file, and use it to provide your database credentials.

These instructions are for Linux users. We'll assume your dedicated Synchrony user is named synchrony.

Create the synchronyenv file

Modify your Synchrony startup script

Modify your shell profile

Bash as login shell will load the following profiles in order. Your environment may vary, but this is an example for Ubuntu:

Note: Bash as non-login interactive shell will load ~/.bashrc

If the info you defined in your synchronyenv file appears correctly in the output above, you should be good to start Synchrony once again. If they don't appear, you may need to define them in a different profile config, based on your operating system and shell.



