Local installation of Sirius Web for single-user testing purposes

Use this guide to spin up a local Sirius Web instance for evaluation or workshops. It relies on Docker to provide the PostgreSQL database and mirrors the steps commonly used in trainings.

Stable versions

Only YEAR.MONTH.0 releases are supported outside of test environments. Intermediate versions are meant for experimentation and can change without notice, so always pick the .0 tag for evaluation or demos you share with others. See Sirius Web development cycle for the release cycle details.

1. Prerequisites

Make sure your workstation satisfies the hardware prerequisites and that the following tools are installed:

  • Java 21 (JDK). Verify with:

    java -version

  • Docker Desktop or Engine, so you can run a PostgreSQL container.

  • Network access to download the sample application and container images.

If you already have PostgreSQL 15 or newer installed locally, you can reuse it instead of Docker. Adjust the connection parameters accordingly.

2. Start PostgreSQL with Docker

docker run -p 5432:5432 --name sirius-web-postgres \
  -e POSTGRES_USER=dbuser \
  -e POSTGRES_PASSWORD=dbpwd \
  -e POSTGRES_DB=sirius-web-db \
  -d postgres:15

This command:

  • Maps container port 5432 to the port 5432 of your machine.

  • Creates a dbuser/dbpwd account and a sirius-web-db database.

  • Runs PostgreSQL 15 in the background.

Add --rm if you want Docker to remove the container automatically when it stops.

Stop the container when you are done testing:

docker stop sirius-web-postgres

3. Launch the sample application

Download the sample sirius-web-YYYY.M.X.jar from the packages page, then run:

java -jar sirius-web-YYY.M.X.jar \
  --spring.datasource.url=jdbc:postgresql://localhost:5432/sirius-web-db \
  --spring.datasource.username=dbuser \
  --spring.datasource.password=dbpwd

The application starts on http://localhost:8080 by default. Keep the terminal open so you can stop the server with Ctrl+C when you finish testing.

4. Next steps

  • Open your browser and navigate to http://localhost:8080 to reach the Homepage.

  • Create a blank project or import one of the templates to explore the studio features.

  • When you are ready for multi-user or production deployments, move on to Install Sirius Web for production for SSL, scaling, and hardening guidance.

Remember to stop both the Java process (Ctrl+C) and the PostgreSQL container (or your native database service) when you finish a session. If you used Docker volumes only, removing the container also deletes all data created during testing.