Frequently Asked Questions (FAQ)

Technical Questions

How do I handle errors in my workflow?

PROOF uses Notify Messages to communicate errors. When an error occurs, the orchestrator receives notification about the error location and reason. Check the monitoring panel and logs for error details.

Where do I place files for my workflows to access?

Place your files in the proof-environment/data/userdata/ directory. Files in this directory can be accessed by workflow blocks such as FileReader.

Data Directory Structure:

  • userdata/ - User-managed files for workflow blocks
  • attachments/ - Workflow attachments organized by attachment ID
  • executions/ - Model file logs organized by execution ID (as specified in docker-compose)

How can I export workflow executions?

  • Export: All users can export their workflow executions as ZIP files from the monitoring interface. The export includes all configurations, inputs, and attachments.

How do I track the progress of my workflow execution?

The monitoring interface displays real-time execution progress, including:

  • Current communication point (CP) of the execution
  • Visual progress bars showing completion status
  • Input values and workflow parameters
  • Status of individual blocks

Which Docker images can be used in Block Templates?

Block Templates typically use the PROOF worker images from the GitHub Container Registry:

  • Python workers: ghcr.io/kit-iai-proof/proof-worker-python:1.2.0
  • Custom workers: You can create custom Docker images based on the PROOF worker images

When creating a Block Template, specify the container image in the containerImage field. PROOF will automatically download the image if it's not already available locally (v1.1.0+).

Troubleshooting

The command 'docker' could not be found in this WSL 2 distro.

Start the Docker Desktop application.

It looks like you have tried to invoke the docker CLI from the docker-desktop WSL2 distribution. This is not supported.

Ensure to use the Ubuntu distro in WSL and not your Docker-Desktop distro.

Unable to get image 'ghcr.io/kit-iai-proof/': permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock

Enable the setting "Enable Integration with my default WSL distro" in Docker Desktop, for details see here

My workflow won't start. What should I check?

  1. Ensure all required inputs are configured
  2. Check that all blocks are properly connected
  3. Verify that the workflow is saved
  4. Check the monitoring panel for error messages
  5. Review logs for detailed error information

Blocks are not connecting. Why?

Blocks can only connect if their inputs and outputs are compatible (same data type). Compatible connections are indicated by matching colors. Check that you're connecting compatible pin types.

Where can I find logs?

Logs are available in the Monitoring panel of the PROOF UI. Select a workflow execution or blocks to view its logs and status information.

Model log files are stored in the file system at proof-environment/data/executions/[execution-id]/ for offline analysis and troubleshooting.

Accessing logs via Docker (advanced): You can also access container logs directly using Docker commands:

docker logs <container-name>

The container name is derived from the block title with spaces removed.

Note: Block titles must follow Docker naming conventions (no brackets or special characters). See Creating Workflows - Block Naming Restrictions for details.

I can't remove the "proof-files" volume. What should I do?

If you receive an error when trying to remove the proof-files Docker volume, you need to remove all containers that are using this volume first.

Steps to resolve:

  1. Stop all running PROOF containers:
    cd proof-environment/docker docker compose down
  2. Remove all stopped containers that use the volume:
    docker container prune
  3. Now you can remove the volume:
    docker volume rm proof-files

Alternatively, use docker compose down -v to remove volumes along with containers.

Getting Help

Where can I find more documentation?

Who should I contact for support?

For questions, issues, or suggestions, please contact the PROOF development team at KIT (Karlsruhe Institute of Technology) at proof@iai.kit.edu.