Realm Sync Documentation

Welcome to the Realm Sync Documentation Space!

This space contains all of the ins and outs of working with synced realms. This space of our documentation is relevant for both cloud and self-hosting users. You'll find basic code snippets and all of the details regarding working with your instance of the Realm Object Server. You will often find that this section of our documentation points back to the client SDK docs. You will need to use the two domains in conjunction.

Navigating Our Documentation

The Realm Platform is comprised of both mobile SDKs and server components. As a result, different users will have different informational needs. In this section, we'll try to highlight the areas that you'll find most helpful.

Syncing Data

Audience: Developers syncing Realms via the Realm Platform

Our sync documentation contains all of the ins and outs of working with synced realms. This space of our documentation is relevant for both cloud and self-hosting users. You'll find basic code snippets and all of the details regarding working with your instance of the Realm Object Server. You will often find that this section of our documentation points back to the client SDK docs. You will need to use the two domains in conjunction.

Realm Database

Audience: Developers working with either local or synced Realms

General Documentation for our Client SDKs can be found here. From this landing page, you'll want to select your language of choice (i.e. Swift, Java, etc). In each Client SDK, you'll be able to learn syntax, find code snippets, and learn about best practices.

Realm Object Server

Audience: Operators who are hosting their own Realm Object Server instance or Realm Cloud users who want to know how things work behind the scenes

This section of the documentation focuses mostly on tasks associated with hosting your own instance of the Realm Object Server. You'll find information on installation, configuration, and server management. Realm Cloud users can also learn more about the underlying service provided to them.

Where do I start?

The best way to get started is to try Realm Platform out for yourself! Head over to our Getting Started documentation for a comprehensive walkthrough. You'll start by getting an instance of the Realm Object Server and then learn the basics of syncing mobile data through a variety of mobile and server exercises.

Getting Help

Having an issue with Realm Platform that you don't feel you can solve from the documentation? There are a number of avenues for you: