Local installation of SysON for single-user testing purposes

This section provides instructions for installing a local version of the application, intended for testing purposes. This setup is configured for use by the local user only and does not include any 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. Deploy SysON with Docker Compose

The easiest and most straightforward method to deploy SysON using Docker Compose, which automatically deploy prerequisites.

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

Docker installed.

SysON is distributed as a docker container. To deploy SysON, just download the docker-compose file and run the following docker command in the same folder as the one where is the docker-compose.yml file:

docker compose up

This method deploys SysON (matching the version tagged in this documentation) along with a PostgreSQL database, all within a Docker container.

To deploy a specific version vYYYY.MM.0, edit the docker-compose.yml file and replace the tagged version with your desired version. For example, update the following line in the docker-compose.yml: app: image: "${IMAGE_TAG:-eclipsesyson/syson:*vYYYY.MM.0*}"

All accessible versions of SysON as Docker containers are listed in the SysON Docker registry.

Once your Docker up, please go directly to the Open your web browser section!

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 and SysON Docker container and using the command docker compose down. 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.