Skip to content

Backup Recovery and Migration

AshleyThew edited this page Jul 5, 2026 · 1 revision

Backup, Recovery, and Migration

Overview

Bank does not provide a one-click backup command. Safe operations rely on storage-level backups and controlled conversion workflows. This page organizes migration work by subsystem so admins can execute changes safely.

How It Works

Migration paths:

  • Save type migration via convert.yml (Convert.Confirm, Convert.To.Savetype)
  • Legacy upgrade workflow via upgrade.yml
  • Other plugin imports via Bank.Converter.* flags in config.yml

Migration subsystems

  • Backend conversion subsystem (convert.yml)
  • Upgrade conversion subsystem (upgrade.yml)
  • External-plugin import subsystem (Bank.Converter.*)
  • Backup and rollback subsystem (storage snapshots)

Configuration

Files used:

  • convert.yml
  • upgrade.yml
  • config.yml converter section
  • mysql.yml and mongo.yml when changing backend

Operational policy:

  • Keep conversion flags disabled except during planned migration windows.
  • Never change backend and upgrade flags in the same uncontrolled restart.

Commands

  • /bank admin save
  • /bank admin reload (not a replacement for full restart during conversion)

Permissions

Migration operations should be restricted to full admins.

Data and Storage

Recommended backup targets before migration:

  • SQLite: plugins/Bank/database.db
  • MySQL: all bank_* tables used by Bank
  • MongoDB: bank database collections
  • Config files: full plugins/Bank/ tree

Examples

Safe save-type migration checklist:

  1. Stop or lock player access window.
  2. Run full backup.
  3. Validate target backend credentials in mysql.yml or mongo.yml.
  4. Set Convert.Confirm: true and target save type.
  5. Restart server (do not rely on reload).
  6. Verify conversion completion and reset flags.

Troubleshooting

  • Conversion restarts repeatedly: Convert.Confirm likely still true.
  • Upgrade conversion unexpectedly triggers: inspect upgrade.yml conversion flags.
  • Partial migration outcome: restore backup, reset flags, and rerun migration with server closed to players.

Related Pages

Clone this wiki locally