Get started

Quick start

This walkthrough gets you from an empty machine to a running integration. You need Docker Engine 24+ with Compose v2.

1. Install the stack

From the Sirius repository:

./install/install.sh            # Linux / macOS
.\install\install.ps1           # Windows PowerShell

The installer asks for ports and the first admin user, then prints the Console and API URLs. Defaults are the console on http://localhost:8088 and the API on http://localhost:8080.

Sign in with the admin credentials you chose (or admin / password if you accepted the defaults).

2. Create a source

Open Connect and add an inbound connector — HTTP is the fastest way to see a message move. Save it. Sirius can probe the endpoint before you wire it into a flow.

3. Write a transform

Open Studio, create a workspace, and keep the JavaScript pack. A first mapping that stamps a field and returns a result:

const body = sirius.json.decode(msg.raw);
body.processed_at = sirius.datetime.format(sirius.now(), "%Y-%m-%dT%H:%M:%S");
result = { message: body };

Paste a sample payload in the Run panel and execute. Outbound calls stay simulated until you turn on Live I/O.

4. Add a destination and save

Add an outbound connector (HTTP, file, queue — whatever you are delivering to). In Build, place source → transform → destination on the canvas and click Save. Save makes the integration runnable. Start it from the runtime panel.

5. Watch it

Monitor shows throughput, the message ledger, and the dead-letter queue. If a delivery fails, retry or replay — replay writes new history instead of rewriting the original.

Next: core concepts, build a flow, or the REST API.