A newer version of this documentation is available.

View Latest



      Sync Gateway is the synchronization server in a Couchbase Mobile deployment. It is designed to provide data synchronization for large-scale interactive web, mobile, and IoT applications, as shown in the following architecture diagram.

      cbm architecture
      Figure 1. Couchbase Mobile — Couchbase Server Deployment Architecture

      You can read more about the Data Synchronization process in Mobile-Server Data Synchronization. Amongst its most important and commonly used features is secure Access Control.

      Sync Gateway assures secure access control using:

      • User authentication, which ensures that only authorized users can connect to Sync Gateway. For more information see Users and Roles and the User Authentication Guide

      • Data Routing, which ensures that authorized users can only access documents in those Sync Gateway Channel(s) assigned to them and only in accordance with their assigned privileges. You can set those privileges to confer Read Access and-or Write Access as required.

        The business logic behind the validation and authorization of document access is provided by the customizable Sync Function.