Install on VPS (Virtual Private Server)
This article explains how to run the platform on a virtual server. Minimal configuration of the platform component is described in the following chapters.
As the platform requires databases to store its data, it is recommended to install those beforehand. In a section below are links to vendors' installation manuals.
Requirements
As the platform components are implemented in Java, all you need to start the platform is to install JVM from preferred vendor.
Dependencies
- JVM 21+ - The platform is tested on Oracle JDK, and on Eclipse Temurin
- Redis 8+ - Official Redis installation guide.
- MongoDB 8+ - Official MongoDB installation guide.
- Elasticsearch 8+ - Official Elasticsearch installation guide.
Resources
- At least 3 CPU cores and 4 GB of available memory on your machine
- A Linux server is preferred
WARNING
You can install the platform on Windows Server, but there is no official support for Redis on Windows. To run Redis on Windows, you need WSL2 or Docker to run in as a container.
Networking and ports
- Admin: 8888, 9999
- Gateway: 8800, 9900
- Search: 8600, 9600
- Application Engine Worker: 8080, 9090
- MongoDB: 27017
- Elasticsearch: 9200, 9300
- Redis: 6379
- Minio: 9000, 9001
Platform Cluster dependencies
As the platform consists of several components, there is "the right" order in which to start them so that all communication, node registration, and other processes are executed successfully. While we try to make the platform as robust as possible, we recommended following this order:
- Databases and external dependent services (e.g. object storage) are available.
- Admin
- Application Engine Worker
- Search
- Gateway