Important

You are browsing upcoming documentation for version 6.0 of OroCommerce, OroCRM, and OroPlatform, scheduled for release in 2024. Read version 5.1 (the latest LTS version) of the Oro documentation to get up-to-date information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Deploy Application Changes to a New Environment (Testing or Production) 

This guide explains how to deploy changes for Oro applications.

Hint

The instructions below will help you update a self-hosted application instance. If your application is hosted on OroCloud, follow the OroCloud guide to run the automated upgrade.

Warning

Ensure that you have the recent database and source code dump to roll back changes in case of errors before processing the upgrade

An absolute path to the directory where an application is installed will be used in the guide and will be referred to as <application-root-folder> further in this topic.

Note

We highly recommend running all the commands in this guide from the same user the web server runs (e.g., nginx or www-data).

To retrieve a new version and upgrade your Oro application instance:

  1. Navigate to the Oro application root folder.

    cd <application-root-folder>
    
  2. Make sure that no changes require the database schema update.

    php bin/console oro:entity-extend:update --dry-run --env=prod
    

    The platform update is possible only when the database schema is up-to-date.

  3. Switch the application to the maintenance mode.

    php bin/console lexik:maintenance:lock --env=prod
    
  4. Stop the cron tasks.

    crontab -e
    

    Comment the line below:

    */1 * * * * /usr/bin/php <application-root-folder>/bin/console --env=prod oro:cron >> /dev/null
    
  5. Stop all running consumers. They are usually managed by Supervisord.

  6. Create backups of your database and source code.

  7. Check out the new code version from the release tag of your custom application git repository or deploy the latest version from an archive provided by the developer with the new code version.

  8. Remove old caches.

    rm -rf var/cache/prod/
    
  9. Install PHP and NodeJS dependencies, build assets and set up the right owner for the retrieved files.

    composer install --prefer-dist --no-dev
    
  10. Update the application state to correspond to the code changes.

php bin/console oro:platform:update --env=prod

Note

To speed up the update process, consider using --schedule-search-reindexation or the --skip-search-reindexation option:

  • --schedule-search-reindexation — postpone search reindexation process until the message queue consumer is started (on step 12 below).

  • --skip-search-reindexation — skip search reindexation. Later, you can start it manually using commands oro:search:reindex to update search index for the specified entities and oro:website-search:reindex to rebuild storefront search index. See Search Index: Indexation Process.

  1. Remove the caches.

    php bin/console cache:clear --env=prod
    

Alternatively, run:

rm -rf var/cache/prod/
php bin/console cache:warmup --env=prod
  1. Enable cron.

    crontab -e
    

    Uncomment the line below.

    */1 * * * * /usr/bin/php <application-root-folder>/bin/console --env=prod oro:cron >> /dev/null
    
  2. Switch your application back to the normal mode from the maintenance mode.

    php bin/console lexik:maintenance:unlock --env=prod
    
  3. Run the consumer(s) that you stopped at step 5.

    Note

    If PHP bytecode cache tools (e.g., opcache) are used, PHP-FPM (or Apache web server) should be restarted after the uprgade to flush cached bytecode from the previous installation.

See Also

Business Tip

Looking to harness the new trend of digital commerce? Check out our guide on a B2B marketplace platform.