Migration guide

Warning

Always make a database and file backup before updating your installation!

Introduction

  • There is no automatic update tool, updating FoodCoopShop needs to be done manually. But it’s not too hard and this migration guide helps you.
  • Updating to v3.6 or later can only be done from v3.5.x
  • Updating from v2.x to v3.x can only be done from v2.7.x Migration guide for v2.x

v3.6.2

This is the latest stable version.

  • Release date: 2023-11-27
  • Updating to this version can only be done from v3.5.x!
  • Minimal requirement for PHP is 8.1 (PHP 8.2 is recommended)
  • PHP bzip2 lib is required (for automatic database backups). You can find out, if bzip2 is installed, if you can find “bzip2” within your phpinfo output. If not, it needs to be installed.
  • Replace app.cakeServerName with App.fullBaseUrl. Notice the uppercase A in App.fullBaseUrl: 
    'App' => [
  'fullBaseUrl' => 'https://wwww.example.com', // no slash at the end!
],
'app' => [
  //your other configs
],
  • If you created mailto-links in any editor (eg. pages, footer…), then remove the link and just save the plain email address. The software now automatically generates a spam protected mailto-link.
  • replace source code => see bottom of page
  • If you use PHP 8.1 (not recommended!), you have to manually replace “8.2” with “8.1” twice in your composer.json before executing your migrations: first, second
  • run bin/cake migrations migrate --source Migrations/prepare-for-update-from-v3.5
  • execute migrations => see bottom of page
  • clear cache => see bottom of page

v3.5.1

  • Release date: 2023-02-28
  • Minimal requirement for PHP is now 8.1
  • Minimal requirement for MySQL is now 8.0
  • add the array indizes ‘emailFormat’ and ‘transport’ to your credentials.php: 
    'Email' => [
  'debug' => [
      'emailFormat' => 'html',
      'transport' => 'debug',
  • remove Email.fallback and EmailTransport.fallback from credentials.php
  • replace source code => see bottom of page
  • execute migrations => see bottom of page
  • clear cache => see bottom of page

v3.4.2

  • Minimal requirement for PHP is now 8.0
  • Rename app.sendEmailWhenOrderDetailQuantityOrPriceChanged to app.sendEmailWhenOrderDetailQuantityChanged in custom_config.php
  • Frontend caching of product / category data is enabled by default. If you manipulate product data in the database directly, do not forget to clear the cache manually (see bottom of page).
  • It’s recommended to add cache prefixes to custom_config.php see custom_config.default.php 
    'Cache' => [
  'default' => [
      'prefix' => 'example_com_',
  ],
  '_cake_core_' => [
      'prefix' => 'example_com_',
  ],
  '_cake_model_' => [
      'prefix' => 'example_com_',
  ],
],
  • replace source code => see bottom of page
  • execute migrations => see bottom of page
  • clear cache => see bottom of page

v3.3.0

  • The old member fee system was removed. If you used it, remove app.memberFeeEnabled from custom_config.php. How to use the new member fee system.
  • The minimal requirement for npm is now v7 (if you install vendors by yourself)
  • Change the cronjob to run the worker. See cronjobs (bottom of page)
  • replace source code => see bottom of page
  • execute migrations => see bottom of page
  • clear cache => see bottom of page

v3.2.2

  • replace source code => see bottom of page
  • execute migrations => see bottom of page
  • clear cache => see bottom of page

v3.2.1

  • replace source code => see bottom of page
  • Due to a code cleaning problem where all old migrations were removed in v3.0, two migrations were lost. Installations that migrated from <= v3.0 to v3.2.x need to copy these two migrations - Migration A and Migration B - into the folder /config/Migrations/ and then go on with the next point “execute migrations”. Details
  • execute migrations => see bottom of page
  • clear cache => see bottom of page

v3.2.0

  • replace source code => see bottom of page
  • execute migrations => see bottom of page: the command changed with this version!
  • clear cache => see bottom of page
  • add a new cronjob to handle the new queue: */5 * * * * /your-app/bin/cake queue runworker -q
  • rename app.customFrontendColorTheme to app.customThemeMainColor
  • The new default logo format is png. You can change back to jpg setting app.logoFileName to logo.jpg
  • Minimal requirement for PHP is now 7.4
  • After the update, please remove app.adminEmail and app.adminPassword.

v3.1.0

  • replace source code => see bottom of page
  • execute migrations => see bottom of page
  • clear cache => see bottom of page

v3.0.x

  • FCS v3.x uses CakePHP v4 as the base framework.
  • For the new major version v3 a lot of legacy code was removed. Please ensure that your last v2.x installation at least runs two full months in production before updating to v3! The reason is, that in v2.2 / v2.3 the invoice generation was changed. If you don’t use the invoice cronjob, you can update to v3 immediately.
  • app.dateOfFirstSendInvoiceCronjobWithPickupDayUpdate can be removed
  • replace source code => see bottom of page
  • execute migrations => see bottom of page
  • clear cache => see bottom of page
  • PHP >= 7.3
  • MySQL >= 5.7.7 (to support utf8mb4)

replace source code

  • rename old installation folder (e.g. foodcoopshop-old)
  • upload source code of new version into new folder with the name of the old version before renaming
  • copy the following files and folders from your old installation directory into the new directory
    • config/custom_config.php
    • config/credentials.php
    • webroot/files
    • files_private
    • and any other adapted files (favicons, /css/custom.css, /css/mobile-frontend-custom.css…)

execute migrations

  • >= v3.2: $ bin/cake migrations migrate && bin/cake migrations migrate -p Queue
  • < v3.2: $ bin/cake migrations migrate

clear cache

bin/cake cache clear_all