Skip over navigation
You are currently viewing documentation for a previously released version of OroCRM. See the latest long-term support version.

Upgrading to the Newer Version

To retrieve source code of a new version and upgrade your OroCRM instance, please execute the following steps:

  1. cd to the OroCRM root folder and switch the application to the maintenance mode.
cd /path/to/application
sudo -uwww-data bin/console lexik:maintenance:lock --env=prod
  1. Stop the cron tasks.

    crontab -e -uwww-data


    The www-data may be replaced with the user under which your web server runs.

    Comment this line.

    */1 * * * * /usr/bin/php /path/to/application/bin/console --env=prod oro:cron >> /dev/null
  2. Stop all running consumers.

  3. Create backups of your database and source code.

  4. Pull the changes from the necessary branch (3.1) or tag (3.1.1) in the application repository (e.g. or download the latest OroCRM version from the download section on the oroinc.local/orocrm , unpack archive and overwrite existing system files.


    If you have any customization or third party extensions installed, make sure that:
    • your changes to “src/AppKernel.php” file are merged to the new file.
    • your changes to “src/” folder are merged and it contains the custom files.
    • your changes to “composer.json” file are merged to the new file.
    • your changes to configuration files in “config/” folder are merged to the new files.
    sudo -uwww-data git pull
    sudo -uwww-data git checkout <branch or tag with version to upgrade to>
  5. Upgrade the composer dependency and set up the right owner to the retrieved files.

    sudo -u www-data php composer.phar install --prefer-dist --no-dev
  6. Remove old caches.

    sudo rm -rf var/cache/*
    sudo rm -rf public/js/*
    sudo rm -rf public/css/*
  7. Upgrade the platform.

    sudo -u www-data php bin/console oro:platform:update --env=prod --force
  8. Remove the caches.

    sudo -u www-data bin/console cache:clear --env=prod

    or, as alternative:

    sudo rm -rf var/cache/*
    sudo -u www-data bin/console cache:warmup --env=prod
  9. Enable cron.

    crontab -e -uwww-data

    Uncomment this line.

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

    sudo -uwww-data bin/console lexik:maintenance:unlock --env=prod
  11. Run the consumer(s).

    sudo -u www-data bin/console oro:message-queue:consume --env=prod


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

Browse maintained versions:
Back to top