Sync Gateway
![Sync Gateway Documentation][SG_DOCS]
Sync Gateway is a horizontally scalable web server that securely manages the access control and synchronization of data between [Couchbase Lite][CB_LITE] and [Couchbase Server][CB_SERVER].
Couchbase Capella DBaaS
Couchbase's cloud database platform is the easiest and fastest way to begin with Couchbase and eliminate ongoing database management efforts. Try for free at [Couchbase Capella][CB_CAPELLA].
Self-Managed and On-Prem
Download Sync Gateway and other Couchbase packages for Linux, Windows and macOS at [Couchbase Downloads][CB_DOWNLOAD].
Build from source
Pre-requisites
- Building the Enterprise Edition requires access to private code, and cannot be built by third-parties.
Build Instructions
$ go buildContributing
Pre-commit hooks
Pre-commit is optional — it's a convenience to catch issues locally before CI does. Run once per checkout to enable it:
uvx pre-commit installAfter that, the hooks run automatically whenever you git commit. uvx ships with uv.
Running hooks manually
If you need to run the hooks outside of a commit:
uvx pre-commit run # staged files only
uvx pre-commit run --all-files # entire repoResources
- [Sync Gateway Documentation][SG_DOCS]
- [Couchbase Forums][CB_FORUM]
- Couchbase Products:
- [Couchbase Downloads][CB_DOWNLOAD]
- [Sync Gateway Issue Tracker][SG_ISSUES]
License
[CB_MOBILE]: https://www.couchbase.com/products/mobile [CB_GATEWAY]: https://www.couchbase.com/products/sync-gateway [CB_LITE]: https://www.couchbase.com/products/lite [CB_SERVER]: https://www.couchbase.com/products/server [CB_SDK]: https://www.couchbase.com/products/developer-sdk [CB_DOWNLOAD]: https://www.couchbase.com/downloads [CB_FORUM]: http://forums.couchbase.com [SG_DOCS]: https://docs.couchbase.com/sync-gateway/current/introduction.html [SG_ISSUES]: https://github.com/couchbase/sync_gateway/issues?q=is%3Aissue+is%3Aopen [CB_CAPELLA]: https://cloud.couchbase.com/sign-up?ref=github-sgw