Home

Welcome to the Sync Gateway wiki!

This is the place to discuss development and contribution to Couchbase Sync Gateway. You'll find pages about coding style and running the tests. There are also pages about experimental features (either things that are still in the design phase, or things that are checked in on a branch.) As the features become adopted into the product, their content will move to official documentation. So think of this wiki as the cutting edge for contributors.

Documentation

• README
• Official Docs
• Example Configs
• Installing on Linux without package manager access
• SSL Support
• Bucket Shadowing
• Sync Gateway 1.2 Changes
• Sync Gateway 1.3 Vendoring Options
• Issue 2857 Repair Tool

Profiling and Monitoring

• expvars
• monitoring script
• Performance Metrics

Contributing

Before you create a pull request, you should join the mailing list as well as check these pages out:

• Development workflow
• Building a fork via repo
• Filing Bugs
• A guide to the source files
• Viewing/Running Jenkins builds
• Profiling to identify performance problems
• Sign the Contributor License Agreement

Deploying

• Testfest deployment steps

Developer

• How to submit Sync Gateway pull requests
• Error Wrapping Best Practices
• Multi-Channel Replication
• Schema
• Shared-Nothing Deployment
• Changes Worker Pattern
• "Bulk GET" replication protocol extension
• "POST to _changes" replication protocol extension
• Rev Tree Storage on Couchbase Server
• Distributed Index Design
• OpenID Connect Notes
• Couchbase Lite 2.0 Replication Protocol