Skip to main content

Updating XBuilder

Keep XBuilder up to date to get the latest features, improvements, and security fixes. This guide explains how to safely update the extension.

Before Updating​

Backup First​

Always create a backup before updating:

  1. Database Backup

    • Use Joomla's backup tool or Akeeba Backup
    • Your popups are stored in the database

  2. File Backup

    • Backup /administrator/components/com_xbuilder
    • Backup /modules/mod_xbuilder_popup
    • Backup /media/com_xbuilder

Check Compatibility​

Before updating:

  1. Read the release notes for the new version
  2. Verify compatibility with your Joomla version
  3. Check for any breaking changes

Note Your Customizations​

If you've made customizations:

  • Custom CSS in popups (preserved in database)
  • Template overrides (rare, check /templates/[your-template]/html/)
  • Custom integrations

Update Methods​

If XBuilder supports Joomla's update system:

  1. Go to System → Update → Extensions
  2. Click Find Updates button
  3. If XBuilder update is available, it appears in the list
  4. Check the box next to XBuilder
  5. Click Update

Method 2: Manual Update via Upload​

  1. Download the latest version from your account
  2. Extract to get pkg_xbuilder.zip
  3. Go to System → Install → Extensions
  4. Upload pkg_xbuilder.zip
  5. Click Upload & Install

The installer automatically handles the update process.

Method 3: Install from URL​

If you have a direct download URL:

  1. Go to System → Install → Extensions
  2. Click Install from URL tab
  3. Enter the download URL
  4. Click Install

Update Process​

What Happens During Update​

  1. Files Updated

    • Component files are replaced
    • Module files are replaced
    • Media assets are updated

  2. Database Updated

    • Schema migrations run if needed
    • New tables/columns added if required
    • Existing data is preserved

  3. Cache Cleared

    • Component cache is invalidated
    • Browser may need cache refresh

What's Preserved​

ItemPreserved
Your popups✅ Yes
Popup configurations✅ Yes
Images you uploaded✅ Yes
Module configurations✅ Yes
Menu assignments✅ Yes

What May Change​

ItemNotes
Builder interfaceNew features may be added
Template libraryNew templates added
CSS classesCheck custom CSS compatibility
API methodsCheck release notes

After Updating​

Verify Update Success​

  1. Check Extensions → Manage → Manage
  2. Search for "xbuilder"
  3. Verify version number is updated

Clear Caches​

  1. Joomla Cache

    • Go to System → Clear Cache
    • Clear all cache

  2. Browser Cache

    • Hard refresh (Ctrl+Shift+R / Cmd+Shift+R)
    • Or clear browser cache

  3. Third-Party Cache

    • Clear any CDN cache
    • Clear server-level cache (Varnish, etc.)

Test Your Popups​

  1. Access the builder and verify it loads
  2. Open existing popups and check they display correctly
  3. Test popups on frontend
  4. Check any custom CSS still works

Review New Features​

  1. Check the release notes for new features
  2. Explore any new builder options
  3. Update documentation or training materials

Troubleshooting Updates​

Update Fails Mid-Process​

If the update fails:

  1. Don't panic - restore from backup if needed
  2. Check Joomla error logs
  3. Verify file permissions
  4. Try manual update method

Builder Not Loading After Update​

  1. Clear all caches (Joomla and browser)
  2. Check browser console for errors
  3. Verify JavaScript files are new versions
  4. Hard refresh the page (Ctrl+Shift+R)

Popups Not Displaying​

  1. Verify module is still published
  2. Clear Joomla cache
  3. Check browser console for JavaScript errors
  4. Re-save affected popups

Visual Glitches​

  1. Clear browser cache
  2. Check for CSS conflicts
  3. Review any custom CSS for compatibility
  4. Update custom CSS if needed

Version History​

Track your update history:

  1. Note version numbers when updating
  2. Keep release notes for reference
  3. Document any issues for future updates

Downgrading (If Needed)​

If you need to revert to a previous version:

  1. Restore from backup (recommended)

    • Restore database
    • Restore files

  2. Manual downgrade

    • Uninstall current version
    • Install previous version package
    • Note: Database changes may not revert
warning

Downgrading may cause data loss if the database schema changed. Always restore from a backup when possible.

Update Best Practices​

Regular Updates​

  • Check for updates monthly
  • Subscribe to update notifications
  • Update promptly for security fixes

Staging Environment​

For production sites:

  1. Test updates on staging first
  2. Verify all popups work correctly
  3. Check for visual regressions
  4. Then update production

Update Schedule​

Recommended update workflow:

  1. Backup production site
  2. Test update on staging
  3. Update production during low-traffic time
  4. Verify all functionality
  5. Monitor for issues

Getting Update Notifications​

Stay informed about updates:

  1. Check your account dashboard regularly
  2. Subscribe to newsletter for update announcements
  3. Follow official channels for release news

Support During Updates​

If you encounter issues:

  1. Check documentation for known issues
  2. Search support forums
  3. Contact support with:
    • Current version
    • Version updating to
    • Error messages
    • Screenshots if applicable

Next Steps​