Quickstart

Run the emulator with Docker Compose and check that the services are ready.

Start Sqrzl

Run these commands in a terminal:

git clone https://github.com/sqrzl/sqrzl-emulator.git
cd sqrzl-emulator
docker compose up --build

The first build can take a few minutes. Leave Compose running while you use the emulator.

Open a service

ServiceAddress
Storage APIshttp://localhost:9000
Admin UIhttp://localhost:9001
SMTP capturelocalhost:2525
API healthhttp://localhost:9000/healthz

The checked-in Compose file enables authentication. Sign in to the admin UI with:

Username or access key
admin
Password or secret key
sqrzl-secret

Check readiness

curl --fail http://localhost:9000/healthz
docker compose ps

A healthy API returns 200 OK. To inspect startup or request logs, run:

docker compose logs --follow sqrzl

Stop Sqrzl

docker compose down

This stops the container and keeps the named storage volume. See Data and reset before deleting stored data.