Install Obeo Enterprise for SysON for production

Follow these instructions to install 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 Obeo Enterprise for 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 Development cycle.

2. Prepare ecosystem

Pay attention to deploying enterprise-grade version of the prerequisites, including the database service. Before manually deploying the database, it’s recommend to use a managed database instance, either provided by the organization’s IT service or through cloud services.

Before you proceed with the installation, confirm you have following the prerequisites

It’s recommended to provide a dedicated host, such as a server or virtual machine, to serve the Obeo Enterprise for SysON application, and no other services.

This step provides the following configuration elements :

  • database hostname

  • database port

  • database name

  • database username

  • database password

3. Installing Obeo Enterprise for SysON Manually

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

You should have received from Obeo the oe4syson-application-YYYY.M.X.jar application. Contact Obeo support if you have not received the application.

4. Configure the server license

To request a server license, start Obeo Enterprise for SysON on the machine that will host the application without configuring ocp.license.

The application will report an Invalid license message and will stop the application. During shutdown, it will print instructions followed by the fingerprint of the host in the console.

Send this fingerprint to your Obeo contact to request a server license. The server license allows the application to run on the same machine where the fingerprint was generated.

When Obeo provides the server license, configure it through the ocp.license configuration property, either as the OCP_LICENSE environment variable, a Java system property, or a command-line argument. The command in the next section uses a command-line argument.

5. Secure the application

As explain on this guide, the Obeo Enterprise for 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 organization, such as Namecheap.

The certification authority requires producing a PKCS12 keystore.

This step provides the following configuration elements:

  • keystore path

  • keystore password

  • private key password

  • certificate alias name

6. Start the application

To run the application, you’ll need to use the Java Runtime Environment (JRE) to run the oe4syson-application-YYYY.M.X.jar.

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

java -jar path/to/your/oe4syson-application-YEAR.MONTH.0.jar \
  \
  --ocp.license=serverLicenseProvidedByOBEO \
  \
  --spring.datasource.url=jdbc:postgresql://localhost:5433/oe4syson-db \
  --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

Do not forget to replace the placeholders above with your actual values.

6.1. First start

If you start Obeo Enterprise for SysON for the first time, the console will display the password for the server admin account. You must use this password to log in.

Here is an example of the password displayed in the console:

The "admin" account has been created with the password %GNw28*F9NMcQpaCu6Ob0oxnc+JOVP5romwBQr

This password is only displayed once, so make sure to copy it and store it in a safe place.

Then you can log in to the application using the admin account and the password displayed in the console.

As an alternative (before the first start), you can set a password for the server admin account using the obeocloudplatform.admin.password configuration property, either as the OBEOCLOUDPLATFORM_ADMIN_PASSWORD environment variable, a Java system property, or a command-line argument.

7. Open your web browser

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

If you meet any issues during the installation process, see the troubleshooting guide for detailed solutions.