Installing Sync Gateway

This content explains how to install a Sync Gateway instance
Preparatory Steps
Before starting ensure you have read and actioned the steps in Before You Start

Install Sync Gateway on the operating system of your choice:

Enterprise Edition

  • Ubuntu

  • Red Hat/CentOS

  • Debian

  • Windows

  • macOS

Download Sync Gateway from the Couchbase downloads page or using wget.

wget http://packages.couchbase.com/releases/couchbase-sync-gateway/2.7.0/couchbase-sync-gateway-enterprise_2.7.0_x86_64.deb

Install sync_gateway with the dpkg package manager e.g:

dpkg -i couchbase-sync-gateway-enterprise_2.7.0_x86_64.deb

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

To stop/start the sync_gateway service, use the following.

sudo service sync_gateway start
sudo service sync_gateway stop

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

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.

Download Sync Gateway from the Couchbase downloads page or using the wget.

wget http://packages.couchbase.com/releases/couchbase-sync-gateway/2.7.0/couchbase-sync-gateway-enterprise_2.7.0_x86_64.rpm

Install sync_gateway with the rpm package manager e.g:

rpm -i couchbase-sync-gateway-enterprise_2.7.0_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

The initctl restart sync_gateway command does not work in CentOS 6. To restart Sync Gateway, the stop/start commands can be used instead.

On CentOS 7:

systemctl start sync_gateway
systemctl stop sync_gateway

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

Download Sync Gateway from the Couchbase downloads page or using the wget.

wget http://packages.couchbase.com/releases/couchbase-sync-gateway/2.7.0/couchbase-sync-gateway-enterprise_2.7.0_x86_64.deb

Install sync_gateway with the dpkg package manager e.g:

dpkg -i couchbase-sync-gateway-enterprise_2.7.0_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.

Download Sync Gateway from the Couchbase downloads page. Open the installer and follow the instructions. If the installation was successful you will see the following.

windows installation complete

Sync Gateway runs as a service (reachable on http://localhost:4985). To stop/start the service, you can use the Services application (Control Panel → Admin Tools → Services).

  • The configuration file is located under C:\Program Files\Couchbase\Sync Gateway\serviceconfig.json.

  • Logs are located under C:\Program Files\Couchbase\Sync Gateway\var\lib\couchbase\logs.

macOS is supported only for development and test environments (see Supported OS).

Download Sync Gateway from the Couchbase downloads page or using the wget.

wget http://packages.couchbase.com/releases/couchbase-sync-gateway/2.7.0/couchbase-sync-gateway-enterprise_2.7.0_x86_64.tar.gz

From here, there are two installation options.

Option 1: Start Sync Gateway from the Command Line

  1. Unpack the tar.gz installer.

    sudo tar -zxvf couchbase-sync-gateway-enterprise_2.7.0_x86_64.tar.gz

  2. Launch the sync_gateway program from the command line.

    ~/Downloads/couchbase-sync-gateway/bin/sync_gateway

Option 2: Run Sync Gateway as a service

  1. Unpack the tar.gz installer to the /opt directory.

    sudo tar -zxvf couchbase-sync-gateway-enterprise_2.7.0_x86_64.tar.gz --directory /opt

  2. Create a new macOS user.

    sudo sysadminctl -addUser sync_gateway

    If the operation is successful, you will get the following output.

    sysadminctl ----------------------------
sysadminctl No clear text password or interactive option was specified (adduser, change/reset password will not allow user to use FDE) !
sysadminctl ----------------------------
sysadminctl Creating user record…
sysadminctl Assigning UID: 505
sysadminctl Creating home directory at /Users/sync_gateway

  3. Create a new group and add the sync_gateway user to that group.

    sudo dseditgroup -o create sync_gateway
sudo dseditgroup -o edit -a sync_gateway -t user sync_gateway

  4. Run Sync Gateway as a service with the following.

    cd /opt/couchbase-sync-gateway/service
sudo ./sync_gateway_service_install.sh

    Other scripts in that directory are available to update or uninstall the service.

  5. Sync Gateway is now reachable on 0.0.0.0:4984. The configuration file and logs are located in /Users/sync_gateway.

Community Edition

  • Ubuntu

  • Red Hat/CentOS

  • Debian

  • Windows

  • macOS

Download Sync Gateway from the Couchbase downloads page or using wget.

wget http://packages.couchbase.com/releases/couchbase-sync-gateway/2.7.0/couchbase-sync-gateway-community_2.7.0_x86_64.deb

Install sync_gateway with the dpkg package manager e.g:

dpkg -i couchbase-sync-gateway-community_2.7.0_x86_64.deb

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

To stop/start the sync_gateway service, use the following.

sudo service sync_gateway start
sudo service sync_gateway stop

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

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.

Download Sync Gateway from the Couchbase downloads page or using the wget.

wget http://packages.couchbase.com/releases/couchbase-sync-gateway/2.7.0/couchbase-sync-gateway-community_2.7.0_x86_64.rpm

Install sync_gateway with the rpm package manager e.g:

rpm -i couchbase-sync-gateway-community_2.7.0_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

The initctl restart sync_gateway command does not work in CentOS 6. To restart Sync Gateway, the stop/start commands can be used instead.

On CentOS 7:

systemctl start sync_gateway
systemctl stop sync_gateway

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

Download Sync Gateway from the Couchbase downloads page or using the wget.

wget http://packages.couchbase.com/releases/couchbase-sync-gateway/2.7.0/couchbase-sync-gateway-community_2.7.0_x86_64.deb

Install sync_gateway with the dpkg package manager e.g:

dpkg -i couchbase-sync-gateway-community_2.7.0_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.

Download Sync Gateway from the Couchbase downloads page. Open the installer and follow the instructions. If the installation was successful you will see the following.

windows installation complete

Sync Gateway runs as a service (reachable on http://localhost:4985). To stop/start the service, you can use the Services application (Control Panel → Admin Tools → Services).

  • The configuration file is located under C:\Program Files\Couchbase\Sync Gateway\serviceconfig.json.

  • Logs are located under C:\Program Files\Couchbase\Sync Gateway\var\lib\couchbase\logs.

Download Sync Gateway from the Couchbase downloads page or using the wget.

wget http://packages.couchbase.com/releases/couchbase-sync-gateway/2.7.0/couchbase-sync-gateway-community_2.7.0_x86_64.tar.gz

From here, there are two installation options.

Option 1: Start Sync Gateway from the Command Line

  1. Unpack the tar.gz installer.

    sudo tar -zxvf couchbase-sync-gateway-community_2.7.0_x86_64.tar.gz

  2. Launch the sync_gateway program from the command line.

    ~/Downloads/couchbase-sync-gateway/bin/sync_gateway

Option 2: Run Sync Gateway as a service

  1. Unpack the tar.gz installer to the /opt directory.

    sudo tar -zxvf couchbase-sync-gateway-community_2.7.0_x86_64.tar.gz --directory /opt

  2. Create a new macOS user.

    sudo sysadminctl -addUser sync_gateway

    If the operation is successful, you will get the following output.

    sysadminctl ----------------------------
sysadminctl No clear text password or interactive option was specified (adduser, change/reset password will not allow user to use FDE) !
sysadminctl ----------------------------
sysadminctl Creating user record…
sysadminctl Assigning UID: 505
sysadminctl Creating home directory at /Users/sync_gateway

  3. Create a new group and add the sync_gateway user to that group.

    sudo dseditgroup -o create sync_gateway
sudo dseditgroup -o edit -a sync_gateway -t user sync_gateway

  4. Run Sync Gateway as a service with the following.

    cd /opt/couchbase-sync-gateway/service
sudo ./sync_gateway_service_install.sh

    Other scripts in that directory are available to update or uninstall the service.

  5. Sync Gateway is now reachable on 0.0.0.0:4984. The configuration file and logs are located in /Users/sync_gateway.

Next Steps
Learn more:
Do more:

  • Import Filters: To use Sync Gateway on clusters with a large amount of data you can configure an import filter (see: Configure import filter).

  • Sync Functions: For finer gained control of document access, you can Configure Sync Function.