How to install SysON for production ?

This section provides instructions for installing a production-ready version of the application. This setup is intended for deployment in a live environment, with full multi-user access and all necessary security configurations.

1. Get SysON

Stable versions

Only YEAR.MONTH.0 versions are stable and suitable for production deployments. Other versions, such as intermediate releases, are intended solely for testing purposes. They’re not recommended for production use due to their potential for further changes and instability. Always use the stable .0 releases for any production environments to ensure reliability and support. For more details see SysON development cycle.

2. Prepare ecosystem

Pay attention to deploy enterprise grade version of the prerequisites. In particular the database service. Before do deploy manually the database, we recommend to use managed database instance (provided by the IT service of a corporation or using cloud services)

Before you proceed with the installation, please ensure you have following the prerequisites

We recommend to provide a dedicated host (server or virtual machine) to serve the SysON application and only the application.

This step provide the following configuration elements :

  • database hostname

  • database port

  • database name

  • database username

  • database password

3. Installing SysON Manually

SysON is distributed as a single executable Java Archive JAR which contains the complete SysON application along with all its dependencies. This distribution simplifies the setup process, enabling convenient exploration of SysON’s features.

To download the latest pre-built JAR for SysON, follow these steps:

  1. Before you begin the installation process, navigate to the download page for org.eclipse.syson.syson-application-YYYY.M.X.jar to access all versions.

  2. Identify the SysON latest available version for download.

    Latest version

  3. Click the latest version to open its specific page.

  4. In the Assets section, locate the JAR file named org.eclipse.syson.syson-application-YYYY.M.X.jar.

    Download JAR file

  5. Click the JAR file to start the download to your local machine.

This process ensures that you get the most recent version of the SysON application in the form of a pre-built JAR file.

4. Secure the application

As explain on this guide, the SysON application must be secured to ba available on a network. For a production grade deployment, certificates used to secure the connection must be valid and provided by a valid authority.

Documentation to generate this kind of certificate is provided by dedicated organism (here is an example).

Following the certification authority, a PKCS12 keystore must be produced.

This step provide the following configuration elements :

  • keystore path

  • keystore password

  • private key password

  • certificate alias name

5. Start the application

To run the application, you’ll need to use the Java Runtime Environment (JRE) to execute the pre-build JAR (org.eclipse.syson.syson-application-YYYY.M.X.jar) you downloaded earlier.

Go to the folder containing the org.eclipse.syson.syson-application-YYYY.M.X.jar and run the command:

java -jar path/to/your/syson-application-YEAR.MONTH.0.jar \
  \
  --spring.datasource.url=jdbc:postgresql://databaseHost:5433/databaseName \
  --spring.datasource.username=databaseUsername \
  --spring.datasource.password=databasePassword \
    \
  --server.ssl.key-store=path/to/your/keystore.p12 \
  --server.ssl.key-store-password=keyStorePassword \
  --server.ssl.key-store-type=PKCS12 \
  --server.ssl.key-alias=server \
  --server.ssl.key-password=privateKeyPassword \
    \
  --server.port=443

6. Open your web browser

Navigate to https://<serverIP>:443 to experience SysON.

If you encounter any issues during the installation process, please refer to the troubleshooting guide for detailed solutions.