Realm Object Server is a Node application that is distributed via npm. This section will cover the basics of getting an instance of the Realm Object Server. If you're just getting started, you will likely want to head over to the Install for Development section while experienced users who are getting ready to deploy their app in the production will want to install the Realm Object Server as a distributed cluster.

Supported Operating Systems

We currently support the following operating systems:

  • macOS 10+

  • Ubuntu 16.04+

  • RHEL 6+

  • CentOS 7+

We plan to add native support for Windows. In the meantime, you can use Docker during your development period.

Port Requirements

The Realm Object Server utilizes websocket connections over TCP to synchronize data. This means that you will need to make sure your firewall allows TCP communication over whichever ports your ROS is configured to use. By default, this is port 9080 for HTTP traffic. We recommend securing your server by enabling HTTPs communication which is done over port 9443.

Connecting to the Server

Connections to the server are made via websockets which communicate (by default) over port 9080, so you'll need to be sure to open this port. The port number can be reconfigured within your server's index file. The simplest way to test connectivity is by using Realm Studio.

Version Compatibility Table

Realm Object Server 3.x is backwards compatible with all SDK's that supports ROS 3.0 or later. So when a new ROS version is available, always update the server first and then the client SDKs.

While ROS supports older SDK's than the ones listed below, the versions listed are required to support the new ROS 3.0 features like Query-based Synchronization


Realm JS

Realm Swift + Objective-C

Realm Java

Realm .Net


Data Adapter

Realm Postgres

Data Adapter

Realm Studio

3.0 - 3.10

>= 2.3

>= 3.2

>= 5.0

>= 3.0

>= 1.1

>= 1.1

>= 1.0

3.11 -

>= 2.17

>= 3.10

>= 5.7

>= 3.4

>= 2.0

>= 1.6

>= 3.0

Not what you were looking for? Leave Feedback‚Äč