Kftray Logo
Kftray Logo
  • Documentation
  • Downloads
  • Blog
Star
Release v0.18.1A new version of kftray has been released.Check it out →
    • Introduction
    • Installation
    • Quick Start
    • Feature Comparison
    • Port Forwarding
    • Proxy Workloads
    • GitHub Sync
    • HTTP Logging
    • Auto Import
      • KFtray Overview
      • KFtray Installation
      • KFtray Usage
      • KFtui Overview
      • KFtui Installation
      • KFtui Usage
    • Configuration Guide
    • Troubleshooting
    • Best Practices
    • Version Migration Guide

Version Migration Guide

Learn how to upgrade to new versions of KFtray and KFtui.

Version Upgrades

Upgrading KFtray

  1. Backup Current State
    # Backup database
    cp ~/.kftray/kftray.db backup/
    
  2. Stop Running Processes
    # Close KFtray
    # Note: KFtui can continue running
    
  3. Install New Version
    # macOS
    brew upgrade --cask kftray
    
    # Linux
    brew upgrade kftray-linux
    
  4. Verify Installation
    kftray --version
    

Upgrading KFtui

  1. Stop Running Processes
    # Close KFtui
    # Note: KFtray can continue running
    
  2. Install New Version
    # Using installer script
    bash <(curl -s https://raw.githubusercontent.com/hcavarsan/kftray/main/hacks/kftui_installer.sh)
    
  3. Verify Installation
    kftui --version
    

Process Management

Important notes about upgrading:
  • Port forwards must be stopped before upgrading the interface that started them
  • Other interface can continue running during upgrade
  • Database is compatible between interfaces
  • Configuration remains consistent across upgrades

Version Compatibility

Supported Versions

  • KFtray: v0.10.0 and later
  • KFtui: v0.15.2 and later
  • Database: SQLite 3.x

Feature Support

FeatureMinimum Version
HTTP Loggingv0.11.7
GitHub Syncv0.10.0
Multi-configv0.9.0
UDP Supportv0.8.0

Best Practices

Before Upgrade

  • Backup database
  • Stop relevant processes
  • Document running forwards
  • Plan upgrade timing

During Upgrade

  • Follow version-specific notes
  • Verify each step
  • Keep backup accessible
  • Monitor processes

After Upgrade

  • Verify version number
  • Check running forwards
  • Test new features
  • Update documentation

Troubleshooting

Common Issues

  1. Version Mismatch
    • Verify all components upgraded
    • Check compatibility
    • Review release notes
  2. Process Issues
    • Stop affected processes
    • Verify process ownership
    • Restart if necessary

Recovery Steps

  1. Process Recovery
    • Identify stuck processes
    • Stop from correct interface
    • Restart application
  2. Database Recovery
    • Stop all interfaces
    • Restore backup
    • Restart applications

Feature Updates

Keep track of new features and changes in the release notes.

Remember: Both interfaces share the same database but manage processes independently. Always stop port forwards from the interface that started them before upgrading.
Edit this page on GitHub
GuidesBest Practices
Table of Contents
  • Version Upgrades
    • Upgrading KFtray
    • Upgrading KFtui
  • Process Management
  • Version Compatibility
    • Supported Versions
    • Feature Support
  • Best Practices
    • Before Upgrade
    • During Upgrade
    • After Upgrade
  • Troubleshooting
    • Common Issues
    • Recovery Steps
  • Feature Updates

Powered by Docus