Skip to main content

Workflow Editor

Repository: maize-workflow-management-editor.

Choose the deployment​

The Maize MVP includes a UI-only Compose file. The editor's Compose files start only wme-ui. The preview Workflow Assistant uses the assistant-runtime service, which is deployed with the backend; see Model Repository → assistant-runtime.

Build and start the editor​

git clone --branch dev/ai-feature https://github.com/datacrop/maize-workflow-management-editor.git
cd maize-workflow-management-editor
cp .env.example .env

Edit .env for your backend and Keycloak before starting Compose. The default docker-compose.yaml builds a local wme-ui:latest image:

docker compose up -d --build

To use published GHCR images instead, select the registry Compose file explicitly:

docker compose -f docker-compose.registry.yaml pull
docker compose -f docker-compose.registry.yaml up -d

The wme-ui container serves the app with nginx on host port UI_PORT (default 5173; set 80 to serve it at http://HOST). Keycloak and the backend must allow the editor's origin for that port; see Keycloak → Serving the editor. Settings are written into /env-config.js when the container starts. After editing .env, recreate the UI container with docker compose up -d --force-recreate wme-ui (include -f docker-compose.registry.yaml if using registry images); changing these values does not require rebuilding the image.

VariableMeaning
VITE_API_URLBackend URL, e.g. http://HOST:9090
VITE_BACKEND_IPBackend host (used for "default WME instance" addresses)
VITE_AIRFLOW_IPAirflow host (Airflow iframes)
VITE_KIBANA_URLKibana URL for embedded views (default http://VITE_AIRFLOW_IP:5601)
VITE_AKHQ_URLAKHQ URL for Kafka links (default http://VITE_BACKEND_IP:8081)
VITE_ASSISTANT_URL (Preview)assistant-runtime URL as seen by browsers (default http://VITE_BACKEND_IP:8200)
VITE_KEYCLOAK_URLKeycloak base URL, e.g. http://HOST:8180/
VITE_KEYCLOAK_REALM, VITE_KEYCLOAK_CLIENT_IDdatacrop-Platform, datacrop-front
VITE_PROJECT_NAMEName shown in the header
VITE_DEFAULT_PRIMARY_COLORDefault theme colour (users can change it in Settings)

Open http://HOST:5173 (or http://HOST with UI_PORT=80), log in, and run Settings → Initialize Resources (once per user).

Workflow Assistant (Preview)​

The editor contains only the chat UI. The browser calls the assistant-runtime service directly at VITE_ASSISTANT_URL, the same way it calls the backend at VITE_API_URL; nginx does not proxy it. The runtime runs in the backend stack and needs no assistant settings or secrets in the editor's .env.

To enable the assistant:

  1. Deploy the backend with the runtime, from the dev/ai-feature branch of maize-model-repository. See Model Repository → assistant-runtime.
  2. Leave VITE_ASSISTANT_URL blank if the runtime is on the backend host at port 8200. Otherwise, set it to the runtime's public URL.
  3. Make sure the editor's origin (for example http://HOST on port 80 or http://HOST:5173) is in the backend's CORS_ALLOWED_ORIGINS, which the runtime also uses.

The assistant uses the AI provider configured in the backend or in each user's settings and needs a model with tool calling. See AI providers and Assistant runtime.