Skip to main content

Updates

How to safely update SigmaOrders to newer versions.

Update Process​

Standard Update​

  1. Backup Your Data

    # Backup the entire plugin folder
    cp -r plugins/SigmaOrders plugins/SigmaOrders.backup

  2. Stop the Server

    • Gracefully stop the server
    • Wait for all operations to complete

  3. Replace the JAR

    • Remove old SigmaOrders.jar
    • Place new SigmaOrders.jar in plugins/ folder

  4. Start the Server

    • Start server normally
    • Watch console for update messages

Automatic Config Updates​

The plugin automatically updates config.yml when new options are added:

  • Old settings are preserved
  • New settings use defaults
  • No manual migration needed

Database Migrations​

Database schema updates are automatic:

  • Tables are created/updated on startup
  • Data is preserved during updates
  • No manual SQL required

Version Compatibility​

Breaking Changes​

Major version updates may include breaking changes:

  • Review configuration changes
  • Test on a development server first
  • Check release notes for version details

Backward Compatibility​

  • Config files: Backward compatible (old keys still work)
  • Database: Automatic migrations
  • API: Deprecated methods remain until major version

Update Checklist​

Before updating:

  • Read changelog for new features/changes
  • Backup plugin folder
  • Backup database file (database.db)
  • Test on development server (if available)
  • Note current version for rollback

After updating:

  • Verify plugin loads successfully
  • Check console for errors
  • Test basic functionality (/orders)
  • Verify configuration still works
  • Check database integrity

Rollback Procedure​

If an update causes issues:

  1. Stop the Server
  2. Restore Backup 
    rm -rf plugins/SigmaOrders
    cp -r plugins/SigmaOrders.backup plugins/SigmaOrders
  3. Restore Database (if needed) 
    cp plugins/SigmaOrders.backup/database.db plugins/SigmaOrders/
  4. Start Server
  5. Report Issue (if applicable)

Update Notifications​

The plugin checks for updates on startup:

  • Update notifications appear in console
  • Check console on each server start
  • Updates are checked via manifest system

Development Builds​

If using development/snapshot builds:

  • May be unstable
  • Backup more frequently
  • Test thoroughly before production use

Next Steps​