The Convergence Server is the main server side component of the Convergence Realtime Collaboration Framework. Convergence enables developers to rapidly integrate realtime collaboration directly into their applications.
The core Convergence capability is composed of multiple individual projects that are released together. To simplify things, there is a central project that is used for issues, project planning, and road mapping. To report an issue please use the convergence-project repository.
Languages and Frameworks
- Scala: The Convergence Server is developed primarily in Scala.
- SBT: SBT is the build tool used by the Convergence Server.
- Akka: Akka is the main development framework used by the Convergence Server. Akka provides the primary ability for multiple Convergence Servers to cluster together, providing horizontal scalability, and high availability.
- OrientDB: Orient DB is used as the backing database.
- Google Protocol Buffers: Protocol Buffers are used as the communications protocol for realtime collaboration over Web Sockets.
The following development tools are required to build the Convergence Server:
The standard SBT tasks can be used to compile and test the server.
The main entry point of the Convergence Server is the
com.convergencelabs.server.ConvergenceServer class. This is a good place to start if you are new to the code base.
The Convergence Server uses the SBT Native Packager to build its binary distribution. To stage the build run:
The resultant build will be located in
Refer to the SBT Native Packager Documentation for additional build targets.
Convergence Dev Server
The Convergence Dev Server runs an all-in-one instance of Convergence along with an embedded OrientDB Database. The Convergence Dev Server will start up and OrientDB database and initialize it. It will also start a backend node, a rest API, and a realtime API. In order to better reflect a typical deployment, th Convergence Dev Server actually starts up three instances of the Convergence Server (cluster see, backend, and api server). These three instances are tied together using Akka clustering. By default ports 2551, 2552, and 2553 are used by the akka remoting subsystem (each port being used by one of the three ConvergenceServer instances).
By default, when the Convergence Dev Server successfully starts, it will provide two endpoints:
Running the Convergence Dev Server
The Convergence Dev Server can be run from your IDE of choice by executing the following main class:
By default, the Convergence Dev Server will delete the OrientDB database(s) when it starts up. IF you would like to retain data between runs set the following java property:
-Dconvergence.dev-server.persistent = true
Embedded Orient DB
In order to use the OrientDB web interface, the OrientDB Studio plugin must be loaded. The plugin is a dependency of the Convergence Server project but must be copied into the "target/orientdb/plugins" directory. As a convenience, there is an SBT task available to do this. To initialize the Orient DB plugins run the following SBT Command:
The embedded OrientDB can be accessed at: http://localhost:2480/
password can be used to access the databases.
Building and Running the Binary Distribution
This project uses the SBT Native Packager to build a binary distribution. The distribution can be built by running to following command:
The distribution will be located in
distribution/target/universal/stage. You can run the server by opening a terminal in this directory and executing:
You will need a running OrientDB Server. The easiest way to accomplish that is using the following docker command:
docker run --rm \ --name orientdb \ -p 2424:2424 \ -p 2480:2480 \ -e ORIENTDB_ROOT_PASSWORD=password \ orientdb:3.0.37
Convergence Labs provides several channels for support:
- Please use the Convergence Community Forum for general and technical questions, so the whole community can benefit.
- For paid dedicated support or custom development services, contact us directly.
- Chat with us on the Convergence Public Slack.
- Email email@example.com for all other inquiries.
The Convergence Server is also available under a Commercial License. If you are interested in a non-open source license please contact us at Convergence Labs.