Skip to content

getting-started.md

Latest commit

 

History

History
39 lines (24 loc) · 1.2 KB

getting-started.md

File metadata and controls

39 lines (24 loc) · 1.2 KB
Raw

Getting Started

Install SimRun and reach the dashboard.

Prerequisites

  • mise — manages Go 1.25 and Node 22 automatically. Alternatively, install Go 1.25 and Node 22 yourself.
  • PostgreSQL — a running instance accessible from the host where SimRun will run.

Build

Clone the repository, then run:

mise run build

This builds the SvelteKit frontend and compiles the simrun binary, placing it at dist/simrun.

Run

Database migrations run automatically on startup. Set the database URL and start the server:

export SR_DATABASE_URL="postgres://user:pass@localhost:5432/simrun?sslmode=disable"
./dist/simrun

The UI and API are served on http://localhost:8080.

Authentication is optional

Without SR_GOOGLE_CLIENT_ID and SR_GOOGLE_CLIENT_SECRET set, login is disabled and the app runs unauthenticated. See deployment.md for OAuth setup.

Next steps

  • concepts.md — understand scenarios, detonators, matchers, and collectors
  • walkthrough.md — run your first detection test end to end
  • configuration.md — configure connectors, app defaults, and environment variables