Skip to content
Brezel Docs
Blog

Migrate to brezel/api 2.x

brezel/api 2.0 brings a lot of underlying changes. Functionally, not much is different, but technically, a lot is new.

We now use PHP 8.4 and Laravel 11 with a bunch of new packages and an optimized and linted codebase.

Migration steps

To update your project to brezel/api 1.0, follow these steps:

  1. Install PHP 8.4 on your machine
  2. Copy over the latest project structure (esp. the content of composer.json. Keep your name and version if you want, but the rest is needed) from brezel/brezel
  3. Update your project to the latest brezel/api 2.x version.
    • For that delete the vendor folder and the composer.lock file.
    • Go into your composer.json and remove "@composer check-platform-reqs" from the pre-update-cmd hook in the scripts section if present.
    • Run composer update to install the new dependencies.
    • Re-add "@composer check-platform-reqs" to the pre-update-cmd hook in the scripts section in your composer.json file.
  4. Update your .env file to match the new .env.example file.
  5. Schedule downtime with your Customer (~2h, minimum)
  6. Install PHP 8.4 and set up everything on your production environment (see https://wiki.brezel.io/deploy/virtual_server/ for further instructions)
  7. Use the new brotcast service based on Laravel Reverb
    • Adjust your .env and the supervisor config to use the new, shipped-with-brezel, brotcast service. More info in the deployment guide linked above.
  8. Run / deploy as normal
    • Make sure to test important parts of your application to ensure that everything works as expected.