Skip to content

Upgrade Guide โ€‹

Upgrading Ridy (and other BetterSuite products) is a safe and streamlined process when following the correct steps. This guide covers both Docker-based deployments and customized Flutter client upgrades, including precautions, version compatibility, and post-upgrade tasks.


๐Ÿ“Œ Before You Begin โ€‹

โœ… Backup First โ€” Always

Before upgrading your system:

  • Backup the database (e.g., using mysqldump):

    bash
    mysqldump -u root -p your_database_name > backup.sql
  • Optionally, back up the .env file and uploaded assets

  • Backup any modified Flutter app code in version control (e.g., Git)


๐Ÿณ Docker-Based Upgrade โ€‹

This is the recommended approach for most production users.

1. Pull the Latest Images

Ensure Docker and docker-compose are available. Then run:

bash
docker compose pull

2. Review .env File (if needed)

  • The .env file is not overwritten, so your custom values remain
  • However, new environment variables may be introduced in newer versions
    โ†’ Compare with the latest .env.example and copy over any missing keys

3. Rebuild and Restart Services

bash
docker compose up -d --build

This will:

  • Rebuild containers with the latest version
  • Apply any automatic database migrations via the admin-api service

๐Ÿง‘โ€๐Ÿ’ป Flutter Client App Upgrade โ€‹

For those who have customized or white-labeled the apps:

1. Get the Latest Zip

  • Download the latest version of the app (e.g., rider-frontend) ZIP package
  • Extract it into a clean branch or folder

2. Create a Rebase Flow (Git Recommended)

bash
git checkout your-custom-branch
git rebase upstream/main  # assuming upstream is the clean version

Or use diff tools to manually apply changes from the official source.

3. Regenerate Assets

If your custom app uses branding:

bash
dart run flutter_native_splash:create
dart run flutter_launcher_icons
flutter gen-l10n

4. Rebuild the App

bash
flutter build apk   # for Android
flutter build ios   # for iOS

๐Ÿงช Post-Upgrade Checklist โ€‹

TaskApplies ToNotes
Test trip/order creationServer + ClientValidate dispatch, tracking, and completion flows
Check admin panel accessServerEnsure all modules load and dashboard is responsive
Review .env for missing keysServerCompare with .env.example
Run Flutter app and test flowsClientTest login, booking, notifications, payments
Validate Firebase pushClientEnsure Firebase config is still valid
Check wallet and payment gatewaysServer + ClientMake sure gateways work with updated APIs
View logs for any errorsServer (Docker logs)Use docker logs or admin logs page

๐Ÿ”„ Compatibility Notes โ€‹

ScenarioSupported?Notes
Server upgraded, old client usedโœ… YesIf within same major version
New client used with older serverโŒ NoMay fail if API fields are missing/incompatible
Flutter app not updated after serverโš ๏ธ RiskyMay lose compatibility if backend fields changed

๐Ÿง‘โ€๐Ÿ”ง Pro Plus Users โ€‹

If you are a Pro Plus customer, Lume Agency manages upgrade flows for you.
Your custom changes will be rebased and merged with upstream by our engineering team, and deployments are handled internally.