Requirements

Ubuntu

CentOS/RedHat

Debian

Windows

macOS

12, 14

5, 6, 7

8

Windows 8, Windows 10, Windows Server 2012

Yosemite, El Capitan

Network configuration

Sync Gateway uses specific ports for communication with the outside world, mostly Couchbase Lite databases replicating to and from Sync Gateway. The following table lists the ports used for different types of Sync Gateway network communication:

Port

Description

4984

Public port. External HTTP port used for replication with Couchbase Lite databases and other applications accessing the REST API on the Internet.

4985

Admin port. Internal HTTP port for unrestricted access to the database and to run administrative tasks.

Once you have downloaded Sync Gateway on the distribution of your choice you are ready to install and start it as a service.

Ubuntu

Install sync_gateway with the dpkg package manager e.g:

dpkg -i couchbase-sync-gateway-community_1.3.1-16_x86_64.deb

When the installation is complete sync_gateway will be running as a service.

service sync_gateway start
service sync_gateway stop

The config file and logs are located in /home/sync_gateway.

Note: You can also run the sync_gateway binary directly from the command line. The binary is installed at /opt/couchbase-sync-gateway/bin/sync_gateway.

Red Hat/CentOS

Install sync_gateway with the rpm package manager e.g:

rpm -i couchbase-sync-gateway-community_1.3.1-16_x86_64.rpm

When the installation is complete sync_gateway will be running as a service.

On CentOS 5:

service sync_gateway start
service sync_gateway stop

On CentOS 6:

initctl start sync_gateway
initctl stop sync_gateway

On CentOS 7:

systemctl start sync_gateway
systemctl stop sync_gateway

The config file and logs are located in /home/sync_gateway.

Debian

Install sync_gateway with the dpkg package manager e.g:

dpkg -i couchbase-sync-gateway-community_1.3.1-16_x86_64.deb

When the installation is complete sync_gateway will be running as a service.

systemctl start sync_gateway
systemctl stop sync_gateway

The config file and logs are located in /home/sync_gateway.

Windows

Install sync_gateway on Windows by running the .exe file from the desktop.

couchbase-sync-gateway-community_1.3.1-16_x86_64.exe

When the installation is complete sync_gateway will be installed as a service but not running.

Use the Control Panel --> Admin Tools --> Services to stop/start the service.

Walrus mode

By default, Sync Gateway uses a built-in, in-memory server called "Walrus" that can withstand most prototyping use cases, extending support to at most one or two users. In a staging or production environment, you must connect each Sync Gateway instance to a Couchbase Server cluster.

Note: Do not add, modify or remove data in the bucket using Couchbase Server SDKs or the Admin Console, or you will confuse Sync Gateway. To modify documents, we recommend you use the Sync Gateway's REST API.

Couchbase Server network configuration

In a typical mobile deployment on premise or in the cloud (AWS, RedHat etc), the following ports must be opened on the host for Couchbase Server to operate correctly: 8091, 8092, 8093, 8094, 11207, 11210, 11211, 18091, 18092, 18093. You must verify that any firewall configuration allows communication on the specified ports. If this is not done, the Couchbase Server node can experience difficulty joining a cluster. You can refer to the Couchbase Server Network Configuration guide to see the full list of available ports and their associated services.

Getting Started

Before installing Sync Gateway, you should have completed the Getting Started instructions for Couchbase Lite on the platform of your choice (iOS, Android, .NET, Xamarin, Java or PhoneGap). To begin synchronizing between Couchbase Lite and Sync Gateway follow the steps below: