faimulus/server repository overview

⁠Faimulus Server

The official container image for the Faimulus HTTP and WebSocket server. It runs durable, explicit workflows and exposes the Faimulus control-plane API.

The image is the server runtime, not a complete application. Mount an application workspace containing your workflows, configuration, and optional drivers at /app/workspace.

GitHub repository⁠ · Documentation⁠ · Sample app⁠ · npm package⁠

⁠Run

docker run --rm -p 3000:3000 \
  -e APPLICATION_API_KEY=replace-with-a-long-random-key \
  -v ./workspace:/app/workspace:ro \
  -v faimulus-data:/app/data \
  faimulus/server:latest

The server listens on port 3000. Persist /app/data; it contains run, authorization, schedule, event, channel, and driver-cache data.

Use GET /health for process liveness and GET /ready for workspace readiness. Protect the management API with an ingress or trusted reverse proxy rather than exposing it directly to the internet.

⁠Tags

• latest - newest release
• <major> - newest release in a major series
• <major>.<minor> - newest patch in a minor series
• <major>.<minor>.<patch> - exact release