Prerequisites

To offer a smooth and successful installation, your system must meet the required hardware and software requirements specified below. It outlines the recommended hardware specifications, operating systems, and other essential prerequisites for running Sirius Web.

Before installing Sirius Web, make sure you have the right software and infrastructure to run it. These system prerequisites lay the foundation for optimal performance and capability, guaranteeing that Sirius Web operates efficiently on your environment. Take a moment to review and align your system with the recommended specifications outlined after to offer a smooth installation and a robust user experience.

If a platform and version isn’t listed on this page, it implies that this platform and version isn’t tested, bugs fixed, or provided help for.

1. Installation Architecture

Before diving into the installation process, it’s crucial to understand the underlying architecture of Sirius Web. This section provides a detailed overview of the system’s components, their interactions, and the overall design principles.

Sirius Web is a web application, meaning it runs centrally on a server, and users interact with it through web browsers from any computer on the same network.

There is one primary method for installing Sirius Web, following the classical client-server model:

  • The server computer runs the Sirius Web Server,

  • N client computers run the Sirius Web Clients.

Sirius Web Installation Architecture

1.1. Web application runtime

Sirius Web ships as a regular Spring Boot executable jar. Starting this jar launches both the backend services and the static frontend resources so a single process provides the complete experience. Out of the box the platform exposes HTTP and WebSocket endpoints to manipulate representations and serves the React based UI assets over HTTP. Because it relies on Spring Boot, you can reuse the usual tooling available for any Spring application (monitoring, logging, devtools, etc.).

1.1.1. Core dependencies

The server requires a PostgreSQL database. It can be collocated on the same machine, hosted in a Docker container, or run on another server entirely. No other external services are mandatory which makes on-prem, air-gapped, or cloud deployments straightforward. Once the jar and the database are configured the application does not need internet access and can run on a private network.

1.1.2. Deployment scenarios

The default packaging makes it easy to deploy Sirius Web as a self-contained service in a virtual machine, container, or managed cloud instance. Specifiers who need to add corporate branding or bundle additional representations can still rely on the same foundation while keeping control over the rest of their stack. End users simply point their browsers to the deployed endpoint, download the frontend once, and then interact with the backend over HTTP/WebSocket while they manipulate their diagrams, tables, and other representations.

1.1.3. Where to go next

Need to understand how to extend or embed the platform instead of using the stock jar? See Customization and extensions for the supported strategies (custom entry points, additional Spring Boot jars, or embedding Sirius Components inside another host application). For a deeper look at how the backend itself is structured, refer to Backend architecture.

2. Server-side installation requirements

To set up the Sirius Web Server, it’s crucial to meet the specific prerequisites that lay the groundwork for a stable and reliable server environment.

Hardware

  • For a small number of projects, less or equal to 10, and about 10-30 users, 100k semantic elements and 1000 representations in total: a recent server featuring a multi-core CPU clocked at 2 GHz and equipped with 4 GB of available RAM, along with a reasonably fast hard drive, 7200 Revolutions Per Minute - RPM or faster, should cater for your needs.

    • Required RAM: 4 GB

    • Recommended RAM 8 GB or more

    • Required CPU: Dual-core processor

    • Recommended CPU: Quad-core processor

    • Disk space: 10 GB for installation

    • Supplementary disk space for application data

  • To enhance performance further, it’s advisable to follow Sirius Web memory usage and assign more memory as needed. In scenarios where your system anticipates a large volume of concurrent requests, deploying Sirius Web applications on a multi-core CPU machine becomes helpful. This strategy increases the concurrency of processing requests, leading to improved response times for your users. Adjusting memory allocation and leveraging multi-core capabilities contribute to optimizing the all system responsiveness. For more information, you can also see Scaling Sirius Web.

Operating system

Sirius Web operates purely on Java and should function on any supported operating system, given that it meets the JDK / JRE requirements.

  • Linux 64-bit, preferable distributions include Ubuntu, CentOS, or Red Hat Enterprise Linux.

  • Windows Server 64-bit, recommended versions include Windows Server 2016 or later : Read antivirus in Sirius Web applications.

Database

To connect your Sirius Web instance to an enterprise database, you must install and configure one of the following supported databases:

  • PostgreSQL 15

Verify that the server has a dedicated PostgreSQL database with administrator rights.

Java Runtime Environment - JRE

You need to install and configure a separate JRE to run Sirius Web, you have to install a supported version of the Java runtime:

  • Use Java 21 to run the Sirius Web Server.

It’s recommended to use the Java runtime provided by the Eclipse Temurin project.

Network Connectivity

Stable internet connection for updates and communication with Sirius Web Clients.

3. Client-side installation requirements

Sirius Web is browser-based software, which means you can run Sirius Web on all full desktop operating systems : MacOS, Windows, Linux, or Chrome OS.

3.1. Supported browsers

Users can interact with the central server through following web browsers:

Desktop browsers:

  • Chrome latest stable version

  • Mozilla Firefox latest stable version

Mobile browsers:

Note that Sirius Web isn’t supported on mobile devices.
Sirius Web doesn’t support Internet Explorer.

Sirius Web supports a minimal screen resolution of 1024 * 768 with maximized browsers.

3.2. Supported operating system

The minimal operating system - OS requirements are:

  • Windows 10 or later

  • Apple macOS 13.x Ventura and later

  • Any Linux operating system that supports the browsers mentioned earlier

  • Any Chrome operating system that supports the browsers mentioned earlier

You can find out what browser and operating system version you have on What’s my Browser.

A plugin, add-on, or extension that you have installed in your browser could cause speed, upload, download, or various interface problem with Sirius Web. To see if this is the case you can try disabling all plugins, add-ons, or extensions within your browser.

4. Deployment recommendations

4.1. Latency

You should aim to offer a network with the lowest possible latency between the client and the server.

4.2. Server and database latency

To get optimal performance, it’s strongly recommend hosting both the server and database on the same physical server to reduce latency between the two components.

4.3. Network stability

Virtual Private Network - VPN aren’t recommended. It’s a common latency factor such as other network elements that could drop connections that are more or less inactive. As such wireless connection are also not recommended as any loss of connectivity might lead to instability in the product and loss of data. If a network element of this kind is mandatory, use an SSH tunnel as a workaround to avoid client/server disconnections.

4.4. Server isolation

Sirius Web should be the unique way to edit the information stored in the database.

5. Disclaimer

Sirius Web isn’t warranted to run without any error or interruption. We don’t make any warranty about the statements that are under the section Deployment recommendations, it’s for information purposes.

You acknowledge and accept the risks involved by using these products that could include without limitation, downtime, loss of connectivity or data, system crashes, bad performances or performance degradation.