Skip to Content
Getting startedInstallation

Installation

SES Modeler Community Edition is an on-premise application. The release package runs the web application, API, collaboration service, and PostgreSQL persistence on infrastructure you control.

Check the download page for package availability, then follow the guide for your chosen installer.

This documentation describes the current deployment design. Exact package names, versions, checksums, and included files are release-specific. Always use the instructions and release notes shipped with the version you are installing.

Choose a deployment path

PathUse this whenRuntime model
Native Windows installerDocker is not allowed or you want Windows service managementAPI, web, and Yjs run as Windows services. PostgreSQL is local or external.
Docker deploymentDocker Desktop is approved on the Windows hostPostgreSQL, API, web, and Yjs run as a local Compose stack.

Both paths host a web application that you open in a browser. Docker currently binds its services to the local host. The native installer defaults to local access and offers an optional LAN Trial for shared use on a trusted private network. The current Community Edition uses guest authentication and shared model access; it does not separate users from each other or verify their identities.

Before you begin

Host requirements

The native package targets 64-bit Windows. Check the release’s operating-system prerequisites for its bundled dependencies, and run the installer with administrator permissions.

The Docker path requires a Windows workstation supported by Docker Desktop’s Windows requirements , with Linux containers enabled. Docker Desktop is not supported on Windows Server; the native installer and Docker Desktop do not have interchangeable host requirements.

The current native dependency lock targets Node.js 24.18.1 and PostgreSQL 17.10-2. A later release may update these versions.

Native installer requirements

  • Recommended installation can install the locked Node.js version when it is not already present.
  • Advanced installation requires Node.js 24 or newer to already be installed.
  • The native API is self-contained; installing the .NET runtime separately is not required.
  • Advanced installation requires an existing, reachable PostgreSQL database and an application user with the permissions needed to apply migrations. The bundled native database and Docker stack use PostgreSQL 17; check the release prerequisites before using another major version.

Docker requirements

  • Docker Desktop must be installed and running.
  • docker compose version 2 must be available on PATH.
  • The release package must contain all four image archives: api.tar, web.tar, yjs.tar, and postgres.tar. Setup loads these images without building from source or pulling from a registry.

Back up existing installations

Before reinstalling or updating an existing deployment, back up the PostgreSQL database and any model attachments. Also keep a copy of the release configuration. Database migrations run when the API starts, and a complete automatic rollback is not provided.

Default local endpoints

Setup uses these defaults when they are available:

ServiceEndpoint
Web applicationhttp://localhost:3000
APIhttp://localhost:5150
API readinesshttp://localhost:5150/health/ready
Yjs collaboration servicews://localhost:1234

If a default port is already in use, Setup suggests another available port. You can accept the suggestion or enter another port between 1024 and 65535. Web, API, and Yjs must use different ports. Shortcuts and browser URLs follow the selected web port.

The Docker Compose deployment keeps PostgreSQL on the internal Compose network. It does not publish a PostgreSQL host port by default.

Security boundary

The current Community deployment uses CommunityGuest authentication and OpenShared model access. Visitors choose a display name, and authenticated guests can view and edit all user models. This is deliberate shared-workspace behavior for local or trusted use, not a hostile-client security boundary.

Do not expose the current Community deployment directly to the public internet or treat LAN Trial as a production server profile. A shared organizational deployment requires HTTPS/WSS, identity, and explicit collaboration authorization that are not provided by the current Community deployment.

Continue

Once your installation is running, follow Build your first model. The walkthrough starts in the Model Repository and creates the model content it uses.