Software Updates

The platform can check GitHub Releases for new versions, notify administrators in the UI, and optionally apply updates automatically with health verification and rollback on failure.

Features

Settings UI

Open Settings → Software Updates (requires manage_users and manage_api permissions).

Out of the box (Docker)

docker compose up -d --build on a local PC or VPS enables in-app updates automatically:

• Docker socket and project directory are mounted into the backend
• Settings → Software Updates shows Auto-update: Ready
• Update now applies the latest GitHub release with progress and rollback on failure

Works with git clone (preferred) or a downloaded release archive — without .git, the updater downloads the release tarball from GitHub.

To disable: set UPDATE_EXECUTOR_ENABLED=false in .env.

Check-only mode

If the executor is disabled, the platform still:

• Checks GitHub for new releases
• Shows notifications and release links

Manual upgrade follows normal Deployment steps.

How auto-update works (Docker)

Auto-update runs a detached updater container on the host Docker socket so it survives backend restarts.

Default docker-compose.yml backend service (already configured):

environment:
  UPDATE_EXECUTOR_ENABLED: "true"
  UPDATE_DEPLOY_MODE: docker
  UPDATE_COMPOSE_FILE: /deploy/docker-compose.yml
  UPDATE_PROJECT_ROOT: /deploy
  UPDATE_HOST_PROJECT_ROOT: ${PWD}
  UPDATE_DATA_VOLUME: dap_update_data
  UPDATE_DOCKER_NETWORK: dap_default
  UPDATE_HEALTH_URL: http://backend:3001/api/health
volumes:
  - update_data:/app/data/updates
  - /var/run/docker.sock:/var/run/docker.sock
  - ${PWD}:/deploy

Replica stack: use docker-compose.replica.yml (UPDATE_DEPLOY_MODE=docker-replica, network dap-replica-network).

Verify

In Settings → Software Updates, Auto-update executor should show Ready.

Use Check now to query GitHub, then Update to vX.Y.Z to test.

Environment variables

UPDATE_HEALTH_URL from the updater container should reach the backend after restart. On Docker Desktop use http://host.docker.internal:3001/api/health.

Update flow

sequenceDiagram
  participant UI
  participant API
  participant Scheduler
  participant Updater
  participant Docker

  Scheduler->>API: check GitHub releases
  UI->>API: POST /api/updates/apply
  API->>Updater: docker run (detached)
  Updater->>Updater: snapshot git + images
  Updater->>Updater: git checkout tag
  Updater->>Docker: compose pull && up -d
  Updater->>API: health check
  alt health OK
    Updater->>API: write update-result.json (completed)
  else health fail
    Updater->>Updater: rollback script
    Updater->>API: write update-result.json (rolled_back)
  end
  API->>UI: poll status / progress

API endpoints

All routes require authentication and manage_users + manage_api.

Kubernetes

In-cluster auto-update is not enabled by default. Use your GitOps / CI pipeline (see Kubernetes) to roll out new images. The check-and-notify UI still works if the backend can reach api.github.com.

Troubleshooting

Logs: {UPDATE_DATA_DIR}/update-{jobId}.log