Skip to content
Credimi Docs

🤖 Developer Setup

Prerequisites

Section titled “Prerequisites”

Before you begin, ensure you have the following tools installed:

Install slangroom-exec

Section titled “Install slangroom-exec”

Download the appropriate slangroom-exec binary for your OS from the releases page.

Add slangroom-exec to PATH and make it executable:

Terminal window
wget https://github.com/dyne/slangroom-exec/releases/latest/download/slangroom-exec-Linux-x86_64 -O slangroom-exec
chmod +x slangroom-exec
sudo cp slangroom-exec /usr/local/bin/

Install Pre-commit

Section titled “Install Pre-commit”

For most Linux distrubution, just do:

Terminal window
sudo apt install pre-commit

Install slangroom-exec

Section titled “Install slangroom-exec”

Setup Workspace

Section titled “Setup Workspace”

Clone the repository

Section titled “Clone the repository”
Terminal window
git clone https://github.com/ForkbombEu/credimi

Install dependencies

Section titled “Install dependencies”
Terminal window
cd credimi
mise trust
make credimi

Edit your .env file

Section titled “Edit your .env file”

Copy .env.example to .env

Terminal window
cp ./webapp/.env.example ./webapp/.env

Then edit the .env file, particularly:

  1. set the absolute path in ROOT_DIR
  2. Get a token from https://www.certification.openid.net and add it in TOKEN

Copy ./webapp/env.example to

Start Development Server

Section titled “Start Development Server”
Terminal window
make dev

[!TIP] Use make help to see all the commands available.

Temporal Visibility Search Attributes

Section titled “Temporal Visibility Search Attributes”

Pipeline listings rely on a Temporal visibility search attribute named PipelineIdentifier (type Keyword). Register it once per Temporal cluster:

Terminal window
temporal operator search-attributes create --name PipelineIdentifier --type Keyword

If the attribute is added after workflows already exist, trigger a Temporal visibility reindex to backfill historical data (see Temporal admin tooling docs for your deployment).

Mobile Runner Semaphore Ops (Internal)

Section titled “Mobile Runner Semaphore Ops (Internal)”

Defaults and knobs

Section titled “Defaults and knobs”
  • Default acquire wait timeout: 45m.
  • Override timeout: MOBILE_RUNNER_SEMAPHORE_WAIT_TIMEOUT=30m (or any valid time.ParseDuration value).
  • Disable semaphore (no-op acquire/release): MOBILE_RUNNER_SEMAPHORE_DISABLED=1.
  • Internal Temporal API auth key: CREDIMI_INTERNAL_ADMIN_KEY=<plaintext key> (required for internal workflow HTTP calls).

Internal admin API key rollout

Section titled “Internal admin API key rollout”
  1. Run DB migrations so api_keys supports key_type, superuser, revoked, expires_at.
  2. Provision an internal admin key (hash stored in DB, plaintext returned once).
  3. Set CREDIMI_INTERNAL_ADMIN_KEY in backend and worker runtime secrets.
  4. Deploy backend/workers with middleware + internal HTTP activity enabled.
  5. Smoke-check one authenticated user route and one internal Temporal route.

Emergency procedures

Section titled “Emergency procedures”
  • Semaphore workflows live in the Temporal default namespace with IDs: mobile-runner-semaphore/<runner_id>.
  • Query current state via Temporal UI (GetState) or GET /api/mobile-runner/semaphore?runner_identifier=....
  • To unstick a runner, terminate the semaphore workflow in Temporal; it will be recreated on the next acquire.