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
• Custom Auth Proxy
• Sync Gateway 1.2 Changes
• Sync Gateway 1.3 Vendoring Options

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:

• Filing Bugs
• A guide to the source files
• Running the Tests
• Viewing/Running Jenkins builds
• Profiling to identify performance problems
• Sign the Contributor License Agreement

Design Notes

There are also pages for design and implementation questions -- caveat emptor, these may be obsolete or may never even have been implemented.

• 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