Local installation of SysON for single-user testing purposes

Follow these instructions to install a local version of the application, intended for testing purposes. This setup is configured for use by the local user only and doesn’t 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, confirm you have the following Hardware prerequisites:

  • Docker installed and running.

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’s the docker-compose.yml file:

docker compose up

To run Docker Compose confirm your Docker is running.

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

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

export DOCKER_DEFAULT_PLATFORM=linux/amd64

To deploy a specific version vYYYY.MM.0, edit the docker-compose.yml file and replace the tagged version with your required version. For example, update the following line in the docker-compose.yml:

app:
  image: "${IMAGE_TAG:-eclipsesyson/syson:*vYYYY.MM.0*}"

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

Once your Docker up, go directly to the Open your web browser[Open your web browser] section.

3. Open your web browser

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

To end your local testing session, confirm you stop the running PostgreSQL and SysON Docker container and by using the command docker compose down. Note that this erases all the data you have generated during testing.

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