Docs menu

Operate

Operations

JoyMux is a local Unix daemon. Run it under a user service manager that restarts it on failure. Keep JOYMUX_DATA_DIR on a local filesystem with enough space; JoyMux does not enforce a disk quota.

Setting Purpose Default
JOYMUX_DATA_DIR Durable execution state and evidence .joymux (typically ~/.joymux)
JOYMUX_SOCKET Local API endpoint $JOYMUX_DATA_DIR/joymux.sock
JOYMUX_MEMORY_BYTES Recent output retained in memory per session 1 MiB
JOYMUX_ENV_ALLOW Request environment allowlist all requested names
JOYMUX_REDACT Regexes for derived views sent to models none

Backup

Back up the entire JOYMUX_DATA_DIR together while the daemon is stopped. Do not copy a live data directory and expect a consistent restore. Execution evidence can contain secrets — encrypt backups where required.

Startup refuses to run against a data directory it cannot trust (incompatible or corrupt storage, or a non-socket object at the configured socket path). JoyMux does not silently replace damaged storage.

Monitor

Watch daemon RSS, CPU, open files, session count, and data-directory growth. Durable lag can be observed by comparing a consumer checkpoint with the last event cursor. The public API does not expose internal queue depths.

At startup, sessions that were not already finished are recovered as failed. Processes left behind after a hard daemon kill are cleaned up on that recovery path. Configure automatic restart.

Confirm the service account can stop processes it started. macOS is supported; validate on your image before production use.

See daemon service and troubleshooting.