StateLens StateLens

Get it

StateLens ships as a container image from a registry of its own, which is private: pulling takes the pull token your account holds, the Community edition's included, which costs nothing. Sign in to the registry with the token's name, give its password when asked, pull, point the image at a store and a way to sign in, and open it in a browser. 

docker login statelens.azurecr.io --username <token>
docker pull statelens.azurecr.io/statelens:1.1.0

Run it

The image listens on port 8080, writes everything it keeps under /data, and expects to run behind whatever terminates TLS. It reads a store through the connection string a manifest names, and signs operators in through your OpenID Connect provider, or with accounts it keeps itself. 

docker run -p 8080:8080 -v statelens-data:/data \
  -e ConnectionStrings__Memoria="Host=db;Port=5432;Database=memoria;Username=reader;Password=..." \
  -e Authentication__Oidc__Authority=... \
  -e Authentication__Oidc__ClientId=... \
  -e Authentication__Oidc__ClientSecret=... \
  statelens.azurecr.io/statelens:1.1.0

To keep the operators' accounts in the tool instead, pass -e Authentication__Local=true in place of the three provider settings: the first visit sets up the first Administrator, who makes every other account. The accounts live on the volume, or in a PostgreSQL, SQL Server or SQLite database you name — see Configuration.

What the host provides

Requirement Why
A container runtime The image carries its own .NET runtime and nothing else is installed.
Network to the store The only external dependency there is. Read only: the tool never appends an event, never writes a snapshot and never creates schema.
A volume at /data The uploaded archives, the header's branding, the tool's settings and the keys behind the sign-in cookie live there, and a restart without it signs everyone out and loses the uploads.
A probe on /healthz Answers OK as soon as the process is up, without asking any store.

The deployment guide covers the settings, the sign-in and where to put it; Configuration lists every setting the tool reads.

Editions

The Community edition reads one service and costs nothing, for as long as you like. Standard reads up to five, Professional up to twenty-five and Enterprise any number, under the licence. The image is the same for every edition: the Edition setting names the one you hold, and nothing is issued or unlocked. The paid editions are bought on the pricing page.

Back to top