Skip to Content

qb update - QuickBox Updates

Keep QuickBox Current

Check for and install QuickBox updates

The qb update function offers you a convenient and flexible way to manage updates for your QuickBox installation. With this feature, you have full control over the update process, allowing you to manually check for updates and choose when to apply them.


Quick Reference

CommandDescription
qb update checkCheck for available QuickBox updates
qb update quickboxUpdate QuickBox to the latest version

Check for Updates

Check if a new version of QuickBox is available:

qb update check

What you’ll see:

  • Current installed version
  • Latest available version
  • Whether an update is available
  • Release notes for new version
  • What’s changed since your version

Output example:

Current version: v1.0.210 Latest version: v1.0.215 Status: Update available Changes: - Added new application support - Fixed database backup issue - Improved performance - Security updates

Regular Checks

Run qb update check regularly to stay informed about new releases. Updates often include important security patches and bug fixes.


Update QuickBox

Install the latest QuickBox update:

qb update quickbox

Update process:

  1. Backs up current QuickBox configuration
  2. Downloads latest QuickBox version
  3. Applies updates to core system
  4. Updates CLI tools and libraries
  5. Migrates configuration if needed
  6. Restarts affected services
  7. Verifies update was successful

What gets updated:

  • QuickBox core system
  • CLI tools (qb command)
  • Dashboard interface
  • System libraries
  • Configuration files (preserved with migration)
  • Documentation

What is NOT affected:

  • User data
  • Installed applications
  • User configurations
  • Database content

Backup Recommendation

While QuickBox automatically creates a backup before updating, it’s good practice to manually backup your database before major updates:

qb manage db -o backup

Before Updating

Pre-Update Checklist

Follow these steps for a smooth update:

  1. Check for updates and read release notes:

    qb update check qb news
  2. Backup your database:

    qb manage db -o backup
  3. Check disk space:

    df -h

    Ensure you have at least 1GB free space.

  4. Notify users (if multi-user server):

    • Inform users of planned maintenance
    • Choose low-traffic time for update
  5. Review running applications:

    qb status

Service Interruption

Some services may be briefly interrupted during the update process. Plan updates during low-usage periods to minimize impact on users.


Update Workflow

Standard Update Process

Complete update workflow:

# 1. Check what's new qb update check qb news # 2. Backup database qb manage db -o backup # 3. Perform update qb update quickbox # 4. Verify update was successful qb --version # 5. Check all services are running qb status # 6. Test dashboard access # Visit your dashboard URL in a browser

Troubleshooting Updates

If the update fails or causes issues:

# 1. Check system logs journalctl -xe # 2. Restore from backup if needed qb manage db -o restore # 3. Try fixing common issues qb fix permissions qb fix nginx qb fix login # 4. Restart services qb restart # 5. If issues persist, contact support

Update Frequency

How Often to Update

Recommended update schedule:

🟢 Security Updates

Immediately

Install security updates as soon as possible to protect your server from vulnerabilities.

🟡 Bug Fixes

Within 1 week

Bug fix updates should be installed promptly to ensure system stability.

🔵 New Features

When convenient

Feature updates can be installed at your convenience, during planned maintenance windows.


Version Information

Check Current Version

View your installed QuickBox version:

qb --version

Example output:

QuickBox Pro v1.0.215

You can also view version information in the dashboard footer.


Update Types

Understanding Update Releases

QuickBox uses semantic versioning:

  • Major Updates (v1.x.x → v2.x.x)

    • Significant new features
    • Major architectural changes
    • May require manual intervention
    • Breaking changes possible
  • Minor Updates (v1.1.x → v1.2.x)

    • New features and improvements
    • Backward compatible
    • Safe to install with minimal risk
  • Patch Updates (v1.0.1 → v1.0.2)

    • Bug fixes
    • Security patches
    • Performance improvements
    • Should be installed promptly

Common Issues

Update Check Fails

# Check internet connectivity ping -c 3 quickbox.io # Check DNS resolution nslookup quickbox.io # Try again qb update check

Update Process Hangs

# Stop the update (Ctrl+C) # Check system resources top df -h # Free up disk space if needed (admin only) qb clean system_logs -o 7 -u yourusername # Try update again qb update quickbox

Services Not Starting After Update

# Check service status systemctl status quickbox-* # Fix permissions qb fix permissions # Restart services qb restart # If still failing, restore from backup qb manage db -o restore

Best Practices

Do

  • Check for updates regularly
  • Read release notes before updating
  • Backup database before major updates
  • Update during low-traffic periods
  • Test after updating
  • Keep backups of working versions

Don't

  • Skip security updates
  • Update without checking release notes
  • Update during peak usage times
  • Ignore backup recommendations
  • Update on low disk space
  • Skip post-update verification

Rollback Updates

If an update causes issues, you can rollback:

# Restore previous database backup qb manage db -o restore # Select the backup from before the update # Restart services qb restart

Limited Rollback

QuickBox does not maintain multiple system versions. If you need to rollback, contact support via Discord for assistance. Database backups can be restored, but system files may require support intervention.



Need Help?

Having trouble with updates? Get help from our support team and community:

Join the Community

Media server operators sharing configs, getting support, and shaping the future of QuickBox Pro.

Dedicated Support
Feature Previews
Community Configs
Active Discussions
Join Discord Server