Zum Hauptinhalt springen

ITB 0.0.7

We're thrilled to announce the release of ITB 0.0.7, a comprehensive update combining enhanced WebApp capabilities with advanced API functionality.

πŸ“¦ Release Overview​

This release bundles improvements across components and infrastructure:

ComponentVersionFocus
WebApp0.0.710 UI/Model features + 1 bug fix
API0.0.7Metadata tracking & version tracking
Infrastructure0.0.7Traefik load balancer + integrated docs container

🎯 WebApp 0.0.7​

8 UI Features & 2 Model Improvements

Highlights​

  • ✨ Model Filter by Entity Type - Focus on relevant entity types
  • ✨ Add Entity to Canvas Center - Improved entity placement
  • ✨ Entity Usage Indicators - See where entities are used across viewpoints
  • ✨ Edge Highlighting - Trace relationships at a glance
  • ✨ Attribute Drawer - CTRL+4 for quick attribute access
  • ✨ Save Canvas as Image - Export documentation
  • ✨ Auto Arrange Canvas - Optimize layout automatically
  • ✨ Resizable Left Sidebar - Flexible workspace
  • 🎁 Mandatory Attribute Field - Better data modeling
  • 🐞 Fixed Edge Routing - Proper visualization on collapse

β†’ View WebApp 0.0.7 Release Details


πŸš€ API 0.0.7​

Enhanced Traceability & Version Tracking

Highlights​

  • πŸ“‹ Metadata Export File - Automatic _metadata.json with version info and statistics
  • πŸ” /pb_info Endpoint - Query PocketBase version information

What's tracked:

  • ITB frontend, API, and library versions
  • Export timestamp
  • Entity, relation, viewpoint, and node counts

β†’ View API 0.0.7 Release Details


πŸŽ“ Summary​

ITB 0.0.7 represents a significant milestone with improved usability, better model traceability, and enhanced data quality practices. The WebApp gains powerful productivity tools while the API adds comprehensive version tracking for compliance and diagnostics.


⚠️ Major Changes & Migration Guide​

πŸ”„ Environment Configuration Changes​

The .env file has been updated with new configuration options. Action Required:

  1. Backup your current .env file:

    cp .env .env.backup
  2. Update to the new .env template:

    cp .env.example .env
  3. Re-apply your custom settings from the backup file to the new .env

Key changes:

  • New Traefik load balancer configuration variables
  • Updated image tags for version 0.0.7
  • New documentation container settings

πŸ—οΈ Architecture Updates​

1. Traefik Load Balancer (NEW)​

This release introduces Traefik as a local load balancer, providing a cleaner URL structure for development:

Local Access URLs:

  • WebApp: http://itb.localhost (instead of port-based URLs)
  • API: http://api.itb.localhost (instead of port-based URLs)
  • Traefik Dashboard: http://traefik.localhost:8080 (optional monitoring)

Why this helps:

  • Simplified development URLs
  • Closer alignment with production architecture
  • No need to remember port numbers
  • Supports multiple projects running simultaneously

Setup: Your /etc/hosts file should include (already configured if using provided docker-compose):

127.0.0.1 itb.localhost
127.0.0.1 api.itb.localhost
127.0.0.1 traefik.localhost

2. Integrated Documentation Container (NEW)​

The ITB documentation is now packaged as an integrated container service running busybox with httpd webserver:

Access Documentation:

  • Access directly: http://itb.localhost/docs
  • Documentation is fully functional without external network calls

Benefits:

  • Documentation always matches your deployed version
  • Offline-friendly within your local/internal network
  • No external dependencies
  • Consistent documentation across teams

πŸ“‹ Update Instructions​

For Existing Users​

Follow these steps to upgrade to ITB 0.0.7:

  1. Backup your data:

    # Backup the current model
    save remote in the WebApp to export the Model to JSON
    Backup your Output / JSON Folder
  2. Update your environment:

    # Stop current instance
    docker compose down

    # Pull latest itb version from GitHub
    git pull

    # Backup and update .env
    cp .env .env.backup
    cp .env.example .env
    # Re-apply your custom settings
  3. Pull latest images and start:

    docker compose pull
    docker compose up -d
  4. Verify the installation:

    • WebApp: http://itb.localhost
    • API: http://api.itb.localhost
    • Docs: http://itb.localhost/docs

πŸ”§ Troubleshooting​

Issue: Containers not starting or old configuration persists​

If you encounter issues after upgrading, try the following steps to perform a clean start:

Stop and remove all containers:

# Stop all running containers
docker compose down

# Verify no ITB containers are running
docker ps | grep itb
# (should return no results)

Remove the PocketBase data volume (⚠️ This will reset your database):

# List volumes to find pb_data
docker volume ls | grep pb_data

# Remove the volume
docker volume rm itb_pb_data
# (or adjust the name based on your project folder name)

Start fresh:

docker compose up -d

Option 2: If you need to preserve your data​

Stop containers but keep volume:

docker compose down

Then restart with the existing data:

docker compose up -d

Common Issues & Solutions​

IssueSolution
Traefik routes not workingEnsure /etc/hosts has 127.0.0.1 itb.localhost api.itb.localhost entries
Port already in useRun docker ps to check conflicts and stop conflicting containers
Documentation not loadingVerify docs container is running: docker ps | grep docs
API not respondingCheck logs: docker compose logs api
Can't access PocketBase UIDefault URL is http://itb.localhost/_

Full Reset (Last Resort)​

If issues persist, perform a complete reset:

# Stop everything
docker compose down

# Remove all ITB-related containers
docker ps -a | grep itb | awk '{print $1}' | xargs docker rm -f

# Remove volume
docker volume rm itb_pb_data

# Clean up any dangling images (optional)
docker image prune -a

# Start fresh
docker compose up -d

⚠️ Warning: This will permanently delete your PocketBase data. Make sure you've exported your models first!


Thank you to all contributors and users who made this release possible!