11<p align =" center " >
22<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
3- <a href =" #contributors- " ><img src =" https://img.shields.io/badge/all_contributors-151 -orange.svg " alt =" All Contributors " ></a >
3+ <a href =" #contributors- " ><img src =" https://img.shields.io/badge/all_contributors-152 -orange.svg " alt =" All Contributors " ></a >
44<!-- ALL-CONTRIBUTORS-BADGE:END -->
55<a href =" https://packagist.org/packages/openmage/magento-lts " ><img src =" https://poser.pugx.org/openmage/magento-lts/d/total.svg " alt =" Total Downloads " ></a >
66<a href =" https://packagist.org/packages/openmage/magento-lts " ><img src =" https://poser.pugx.org/openmage/magento-lts/license.svg " alt =" License " ></a >
@@ -21,8 +21,8 @@ level of backwards compatibility to the official releases.
2121## Table of contents
2222
2323- [ Requirements] ( #requirements )
24- - [ Optional] ( #optional )
2524- [ Installation] ( #installation )
25+ - [ Manual Install] ( #manual-install )
2626 - [ Composer] ( #composer )
2727 - [ Git] ( #git )
2828- [ Secure your installation] ( #secure-your-installation )
@@ -36,7 +36,7 @@ level of backwards compatibility to the official releases.
3636 - [ New Events] ( #new-events )
3737 - [ Changes to SOAP/WSDL] ( #changes-to-soapwsdl )
3838- [ Development Environment with ddev] ( #development-environment-with-ddev )
39- - [ Development with PHP 8.1] ( #development-with-php-81 )
39+ - [ Development with PHP 8.1+ ] ( #development-with-php-81 )
4040- [ PhpStorm Factory Helper] ( #phpstorm-factory-helper )
4141- [ Versioning] ( #versioning )
4242- [ Public Communication] ( #public-communication )
@@ -46,36 +46,74 @@ level of backwards compatibility to the official releases.
4646
4747## Requirements
4848
49- - PHP 7.3+ (PHP 8.0 is supported, PHP 8.1 is work in progress )
49+ - PHP 7.3+ (PHP 8.0 is supported, PHP 8.1 supported but some warnings may be shown/logged, PHP 8.2 is usable but still being tested )
5050- MySQL 5.6+ (8.0+ recommended) or MariaDB
51+ - optional: Redis 5.x, 6.x and 7.0.x are supported
5152
5253
5354- PHP extension ` intl ` <small >since 1.9.4.19 & 20.0.17</small >
5455- Command ` patch ` 2.7+ (or ` gpatch ` on MacOS/HomeBrew) <small >since 1.9.5.0 & 20.1.0</small >
5556
56- __ Please be aware that although OpenMage is compatible that one or more extensions may not be.__
57-
58- ### Optional
57+ ## Installation
5958
60- - Redis 5+ (6.x recommended, latest verified compatible 6.0.7 with 20.x)
59+ ### Manual Install
6160
62- ## Installation
61+ Download the latest [ release archive ] ( https://github.com/OpenMage/magento-lts/releases ) and extract it over your existing install. ** Important: ** you must download the ZIP file from a tagged version on the releases page, otherwise there will be missing dependencies.
6362
6463### Composer
6564
66- Download the latest archive and extract it, clone the repo, or add a composer dependency to your existing project like so :
65+ Step 1: Create a new composer project:
6766
6867``` bash
69- composer require " openmage/magento-lts" :" ^19.5.0"
68+ composer init
69+ ```
70+
71+ Step 2: Configure composer. ** The below options are required.** You can see all options [ here] ( https://github.com/AydinHassan/magento-core-composer-installer#configuration ) .
72+
73+ ``` bash
74+ # Allow composer to apply patches to dependencies of magento-lts
75+ composer config --json extra.enable-patching true
76+
77+ # Configure Magento core composer installer to use magento-lts as the Magento source package
78+ composer config extra.magento-core-package-type magento-source
79+
80+ # Configure the root directory that magento-lts will be installed to, such as "pub", "htdocs", or "www"
81+ composer config extra.magento-root-dir pub
82+ ```
83+
84+ Step 3: Require ` magento-core-composer-installer ` :
85+
86+ ``` bash
87+ # PHP 7
88+ composer require " aydin-hassan/magento-core-composer-installer" :" ~2.0.0"
89+
90+ # PHP 8
91+ composer require " aydin-hassan/magento-core-composer-installer" :" ^2.1.0"
7092```
7193
72- To get the latest changes use:
94+ <small >Note: be sure to select ` y ` if composer asks you to trust ` aydin-hassan/magento-core-composer-installer ` .</small >
95+
96+ Step 4: Require ` magento-lts ` :
7397
7498``` bash
75- composer require " openmage/magento-lts" :" dev-main"
99+ # OpenMage v19
100+ composer require " openmage/magento-lts" :" ^19.4.0"
101+
102+ # OpenMage v20
103+ composer require " openmage/magento-lts" :" ^20.0.0"
76104```
77105
78- <small >Note: ` dev-main ` is just an alias for current ` 1.9.4.x ` branch and may change</small >
106+ <small >Note: be sure to select ` y ` if composer asks you to trust ` magento-hackathon/magento-composer-installer ` or ` cweagans/composer-patches ` .</small >
107+
108+ To install the latest development version (may be unstable):
109+
110+ ``` bash
111+ # OpenMage v19
112+ composer require " openmage/magento-lts" :" 1.9.4.x-dev"
113+
114+ # OpenMage v20
115+ composer require " openmage/magento-lts" :" 20.0.x-dev"
116+ ```
79117
80118### Git
81119
@@ -129,7 +167,7 @@ Most important changes will be listed here, all other changes since `19.4.0` can
129167
130168### Between Magento 1.9.4.5 and OpenMage 19.x
131169
132- - bug fixes and PHP 7.x, 8.0 and 8.1 compatibility
170+ - bug fixes and PHP 7.x, 8.0, 8.1 and 8.2 compatibility
133171- added config cache for system.xml ([ #1916 ] ( https://github.com/OpenMage/magento-lts/pull/1916 ) )
134172- search for "NULL" in backend grids ([ #1203 ] ( https://github.com/OpenMage/magento-lts/pull/1203 ) )
135173- removed ` lib/flex ` containing unused ActionScript "file uploader" files ([ #2271 ] ( https://github.com/OpenMage/magento-lts/pull/2271 ) )
@@ -145,6 +183,7 @@ Most important changes will be listed here, all other changes since `19.4.0` can
145183_ If you rely on those modules you can reinstall them with composer:_
146184- ` Mage_Backup ` : ` composer require openmage/module-mage-backup `
147185- ` Mage_PageCache ` : ` composer require openmage/module-mage-pagecache `
186+ - ` Legacy frontend themes ` : ` composer require openmage/legacy-frontend-themes `
148187
149188### Between OpenMage 19.4.18 / 20.0.16 and 19.4.19 / 20.0.17
150189
@@ -161,7 +200,8 @@ Do not use 20.x.x if you need IE support.
161200- reduce needless saves by avoiding setting ` _hasDataChanges ` flag ([ #2066 ] ( https://github.com/OpenMage/magento-lts/pull/2066 ) )
162201- removed support for ` global/sales/old_fields_map ` defined in XML ([ #921 ] ( https://github.com/OpenMage/magento-lts/pull/921 ) )
163202- enabled website level config cache ([ #2355 ] ( https://github.com/OpenMage/magento-lts/pull/2355 ) )
164- - make overrides of Mage_Core_Model_Resource_Db_Abstract::delete respect parent api ([ #1257 ] ( https://github.com/OpenMage/magento-lts/pull/1257 ) )
203+ - made overrides of Mage_Core_Model_Resource_Db_Abstract::delete respect parent api ([ #1257 ] ( https://github.com/OpenMage/magento-lts/pull/1257 ) )
204+ - rewrote Mage_Eav_Model_Config as cache for all eav entity and attribute reads ([ #2993 ] ( https://github.com/OpenMage/magento-lts/pull/2993 ) )
165205
166206For full list of changes, you can [ compare tags] ( https://github.com/OpenMage/magento-lts/compare/1.9.4.x...20.0 ) .
167207
@@ -178,14 +218,18 @@ If your project uses OpenMage through composer then all dependencies will be man
178218If you just extracted the release zip/tarball in your project's main folder then be sure to:
179219- remove the old copy of aforementioned libraries from your project, you can do that with this command:
180220 ``` bash
181- rm -rf lib/Cm lib/Credis lib/mcryptcompat lib/Pelago lib/phpseclib lib/Zend
221+ rm -rf app/code/core/Zend lib/Cm lib/Credis lib/mcryptcompat lib/Pelago lib/phpseclib lib/Zend
182222 ```
183223
184-
185224- download the new release zip file that is named ` openmage-VERSIONNUMBER.zip ` , this one is built to contain the ` vendor `
186225 folder generated by composer, with all the dependencies in it
187226- extract the zip file in your project's repository as you always did
188227
228+ We also decided to remove our Zend_DB patches (that were stored in ` app/code/core/Zend ` ) because they were very old and
229+ not compatible with the new implementations made by ZF1-Future, which is much more advanced and feature rich.
230+ This may generate a problem with `Zend_Db_Select' statements that do not use 'Zend_Db_Expr' to quote expressions.
231+ If you see SQL errors after upgrading please remember to check for this specific issue in your code.
232+
189233### New Config Options
190234
191235- ` admin/design/use_legacy_theme `
@@ -253,11 +297,11 @@ grep -rn 'urn:Magento' --include \*.xml
253297 ddev launch
254298 ```
255299
256- ## Development with PHP 8.1
300+ ## Development with PHP 8.1+
257301
258302Deprecation errors are supressed by default.
259303
260- If you want to work on PHP 8.1 support, set environment variable ` DEV_PHP_STRICT ` to ` 1 ` , to show all errors.
304+ If you want to work on PHP 8.1+ support, set environment variable ` DEV_PHP_STRICT ` to ` 1 ` , to show all errors.
261305
262306## PhpStorm Factory Helper
263307
@@ -501,6 +545,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
501545 <td align="center" valign="top" width="14.28%"><a href="https://github.com/discountscott"><img src="https://avatars.githubusercontent.com/u/5454596?v=4" loading="lazy" width="100" alt=""/><br /><sub><b>Scott Moore</b></sub></a></td>
502546 <td align="center" valign="top" width="14.28%"><a href="https://github.com/rfeese"><img src="https://avatars.githubusercontent.com/u/7074181?v=4" loading="lazy" width="100" alt=""/><br /><sub><b>Roger Feese</b></sub></a></td>
503547 <td align="center" valign="top" width="14.28%"><a href="https://github.com/AGelzer"><img src="https://avatars.githubusercontent.com/u/34437931?v=4" loading="lazy" width="100" alt=""/><br /><sub><b>Alexander Gelzer</b></sub></a></td>
548+ <td align="center" valign="top" width="14.28%"><a href="https://gitlab.com/davidhiendl"><img src="https://avatars.githubusercontent.com/u/11006964?v=4" loading="lazy" width="100" alt=""/><br /><sub><b>David Hiendl</b></sub></a></td>
504549 </tr>
505550 </tbody >
506551</table >
0 commit comments