Share +

Couchbase Sync Gateway   


A sync server that enables Couchbase Server to act as a replication endpoint for Couchbase Lite.

What is Couchbase Sync Gateway?

Couchbase Sync Gateway is an internet-facing cloud component that securely synchronizes data between Couchbase Lite on the mobile devices and the Couchbase servers on the cloud. It is an easy-to-use scalable sync solution that will effortlessly syncs local app data with Couchbase Lite to a remote Couchbase Server database.


This box installs a Couchbase Sync Gateway and start its synchonization services with the COUCHBASE_SERVER binding.


  • Maintains up-to-date copies of documents where users need them. On mobile devices for instant access and on servers in data centers for reasons such as synchronizing documents, sharing documents, and loss-protection. Mobile apps create, update, and delete files locally, Sync Gateway takes care of the rest.

  • Provides access control, ensuring that users can only access documents to which they should have access.

  • Ensures that only relevant documents are synced. Sync Gateway accomplishes this by examining document and applying business logic to decide whether to assign the documents to channels. Access control and ensuring that only relevant documents are synced are achieved through the use of channels and the sync function.


This open source software is free to use.


Deployment Variables

ADMIN_PORT: Admin port to be opened [4985 as default value]

BUCKET: Bucket name of the database to be synchronized.

CONFIG: Config.json file to be configured with the variables values.

COUCHBASE_SERVER: Binding to the Couchbase Server to synchronize with.

EDITION: Choose between enterprise or community [enterprise as default value]

SYNC_PORT: Sync port to be opened [4984 as default value]

Deployment behavior

An instance executing this box will use bash scripting to download, install and configure Couchbase Sync Gateway. Box events handle the Couchbase Sync Gateway lifecycle on the instance as follows:

Install operation:

pre_install event script: detects the linux distribution family, downloads the correct Couchbase Sync Gateway package (rpm or deb) for the select edition and installs it using rpm or dpkg package manager.

Start operation:

pre_start event script: downloads and configures config.json file and uses it to launch the sync gateway in background.

Supported Distributions

The box supports deploying to these linux distributions:

  • Amazon Linux AMI 2015.03

  • Centos 6.5, 7

  • RedHat 7

  • Ubuntu 12.04, 14.04

Use Cases


Support for your software purchased via the Marketplace is rendered by the individual Software Provider. The CenturyLink Customer Care Team is unable to provide support for your software. However, if you are experiencing issues with the infrastructure that hosts your software, please open a ticket with Below you can find the contact information for support of this software.

Visit this site for licensing and support frequently asked questions.

End User License Agreement (EULA)

You Agree to the Provider Terms of Service Associated with this Software.
Not a customer? Register now.

Other Products by CAM




Cloud Application Manager OSS , Databases , Developer Tools , Open Source

deployment models

  • Cloud Application Manager

operating systems

not specified