Skip to content

sync-server.md

Latest commit

 

History

History
36 lines (24 loc) · 1.57 KB

sync-server.md

File metadata and controls

36 lines (24 loc) · 1.57 KB

Sync Server: using the ObjectBox Docker image

ObjectBox Sync Server is distributed as a Docker image and we assume you Docker is installed on your machine. Depending on your personal preferences, you can use Docker Engine for the command-line interface (CLI). Docker Desktop additionally comes with graphical UI.

Note: docker run pulls images automatically; docker pull is not required unless you want to check for the latest version of the image if you already have an existing version locally.

First, let's pull the trial from Docker Hub:

docker pull objectboxio/sync-server-trial

Now let's confirm that the Sync Server container starts up. We will skip any configuration for now and just display the version:

docker run --rm -it objectboxio/sync-server-trial --version

You should see something like the following output:

001-13:45:21.7756 [INFO ] [SvSyAp] Starting ObjectBox Sync Server version 5 (protocol version: 6, core: 4.3.0-2025-05-27 (SyncServer, http, graphql, admin, tree, dlog, backup, lmdb, SyncMongoDb, Auth, Trial))
Exiting immediately (version flag given)

Congratulations 🎉

You have the ObjectBox Sync Server Docker image in place on your local machine. Now, let's proceed to the examples, e.g. the Tasks example.

Addition reading