How to install SysON ecosystem only ?

This section provides a step-by-step guide on setting up the necessary ecosystem to develop the product locally. By following these instructions, you’ll configure your local environment with all required dependencies, tools, and services, enabling you to develop, test, and troubleshoot the product effectively on your own machine.

1. Start the database instance

SysON uses PostgreSQL as its database.

For development or local testing, the simplest approach is to initiate a PostgreSQL instance using Docker.

docker run -p 5433:5432 --name syson-postgres \
                            -e POSTGRES_USER=dbuser \
                            -e POSTGRES_PASSWORD=dbpwd \
                            -e POSTGRES_DB=syson-db \
                            -d postgres

For Windows users, here is the same command on one line:

docker run -p 5433:5432 --name syson-postgres -e POSTGRES_USER=dbuser -e POSTGRES_PASSWORD=dbpwd -e POSTGRES_DB=syson-db -d postgres

Docker images are build to run on x86_64 architecture. If you need to run SysON docker image on a Mac Silicon architecture, please execute the following command in your terminal before executing the docker image:

export DOCKER_DEFAULT_PLATFORM=linux/amd64

This may take a while the first time you run this as Docker will first pull the PostgreSQL image.

If you don’t have Docker or prefer to use an existing PostgreSQL installation, modify the following command-line parameters and ensure the POSTGRES_USER possesses administrative rights on the database. These rights are necessary for the automatic creation of the database schema.

2. Start the application

Before you run the application, please ensure you have following the prerequisites and downloaded the JAR (org.eclipse.syson.syson-application-YYYY.M.X.jar) from the download section.

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://localhost:5433/syson-db \
          --spring.datasource.username=dbuser \
          --spring.datasource.password=dbpwd

3. Open your web browser

Navigate to http://localhost:8080 to experience SysON.

To end your local testing session, ensure you stop the running PostgreSQL Docker container using the command docker kill syson-postgres. Please note that this will erase all the data you have generated during testing.

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

4. Other resources

Configuring HTTPS for local server deployment of SysON for testing purposes