How-to guides

Connect a worker in a new language

1. Copy the SDK from sdks/<language>/ into your project (SDKs: install and connect).
2. Give the worker JOOBQ_GATEWAY_URL (the server's origin) and the SDK token the server has in JOOBQUI_SDK_TOKEN.
3. Register your jobs and workflows, then start it; it appears on the Workers page once it has registered.
4. Enqueue a job from the console's API or a producer and watch it complete on the Jobs page.

Make the first admin of a new deployment

./joobqui accounts:create admin@example.com admin   # the first account is an admin

Run it with the same environment as the server. Then invite people from the Access page or with ./joobqui invites:create [DAYS] [--role ROLE].

Give Prometheus access

Create a token with the viewer role on the Access page (or add HASH:viewer to JOOBQUI_API_TOKENS) and scrape /metrics of every instance with it as a bearer credential. See Monitoring.

Rotate the payload keys

1. Put the new key first in JOOBQUI_PAYLOAD_KEYS (new:...,old:...) on every process that seals or opens jobs, and restart them: new jobs are sealed with it, old ones still open.
2. When no job sealed with the old key can still exist (queued, delayed, retrying or dead), remove it.

Rotate the SDK token

JOOBQUI_SDK_TOKEN is one shared value: set the new one on the server and restart it, then restart the workers with the new value. Workers with the old token get 401 sdk_token_required until they are restarted.

Recover a lost second factor

./joobqui accounts:mfa:reset EMAIL removes the account's second factor, ends its sessions and revokes its tokens; a role that must have one enrols again at the next sign-in.

Re-drive dead letters after a fix

Deploy the fix, then select the dead letters on the console's dead-letter page and re-drive them, or call POST /api/v1/dlq/redrive {jids} (operator).