upgrade.yml Reference

Overview

This page documents upgrade.yml, which controls guarded upgrade and conversion flags.

How It Works

Upgrade flags are checked during startup. Certain flags trigger conversion/cleanup routines and should be used carefully with backups.

Configuration

Key paths:

• Upgrade.Confirm
• Upgrade.Version
• Upgrade.Conversion.Old
• Upgrade.Conversion.Mysql
• Upgrade.Database.Cleanup

Commands

No dedicated command toggles this file directly.

Permissions

Upgrade operations are file-admin only workflows.

Data and Storage

Incorrect upgrade flags can trigger migration/cleanup behavior affecting persisted account data.

Examples

• Keep all upgrade toggles false during normal operation.

Troubleshooting

• Unexpected conversion at startup: inspect Upgrade.Conversion.* and Upgrade.Database.Cleanup values.

Related Pages

• Backup, Recovery, and Migration
• Version Compatibility and Known Limitations
• config-convert.yml Reference

Generated Default Configuration

Source: plugins/Bank/upgrade.yml

Upgrade:
  # No upgrade needed at this time
  Confirm: false
  # DO NOT TOUCH, THIS WILL TRIGGER AN UPGRADE
  Version: 506
  Conversion:
    # SET THIS ONLY TO TRUE IF UPGRADING FROM BEFORE 4.1.0
    # THIS WILL TRIGGER A CONVERSION, WHICH MAY TAKE SOME TIME
    # MAKE SURE TO BACKUP OLD BANK DATA
    Old: false
    # IF USING MYSQL ON THE OLD PLUGIN AND WISH TO KEEP USING MYSQL SET THIS TO TRUE
    Mysql: false
  Database:
    # ONLY ENABLE THIS IF YOU NEED TO CLEANUP THE DATA IN YOUR DATABASE(to cleanup)
    Cleanup: false