This repository is the home of an unofficial community-driven project. It's goal is to be a dependable alternative to the Magento CE official releases which integrates improvements directly from the community while maintaining a high level of backwards compatibility to the official releases.
Pull requests with bug fixes and security patches from the community are encouraged and welcome!
- Requirements
- Installation
- Secure your installation
- Changes
- Development Environment with ddev
- Development with PHP 8.1
- PhpStorm Factory Helper
- Versioning
- Public Communication
- Maintainers
- License
- Contributors
-
PHP 7.3+ (PHP 8.0 is supported, PHP 8.1 is work in progress)
-
MySQL 5.6+ (8.0+ recommended) or MariaDB
-
PHP extension
intlsince 1.9.4.19 & 20.0.17 -
Command
patch2.7+ (orgpatchon MacOS/HomeBrew) since 1.9.5.0 & 20.1.0
Please be aware that although OpenMage is compatible that one or more extensions may not be.
- Redis 5+ (6.x recommended, latest verified compatible 6.0.7 with 20.x)
Download the latest release archive 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.
Step 1: Create a new composer project:
composer initStep 2: Configure composer. The below options are required. You can see all options here.
# Allow composer to apply patches to dependencies of magento-lts
composer config --json extra.enable-patching true
# Configure Magento core composer installer to use magento-lts as the Magento source package
composer config extra.magento-core-package-type magento-source
# Configure the root directory that magento-lts will be installed to, such as "pub", "htdocs", or "www"
composer config extra.magento-root-dir pubStep 3: Require magento-core-composer-installer:
# PHP 7
composer require "aydin-hassan/magento-core-composer-installer":"~2.0.0"
# PHP 8
composer require "aydin-hassan/magento-core-composer-installer":"^2.1.0"Note: be sure to select y if composer asks you to trust aydin-hassan/magento-core-composer-installer.
Step 4: Require magento-lts:
# OpenMage v19
composer require "openmage/magento-lts":"^19.4.0"
# OpenMage v20
composer require "openmage/magento-lts":"^20.0.0"Note: be sure to select y if composer asks you to trust magento-hackathon/magento-composer-installer or cweagans/composer-patches.
To install the latest development version (may be unstable):
# OpenMage v19
composer require "openmage/magento-lts":"1.9.4.x-dev"
# OpenMage v20
composer require "openmage/magento-lts":"20.0.x-dev"If you want to contribute to the project:
git init
git remote add origin https://github.com/<YOUR GIT USERNAME>/magento-lts
git pull origin main
git remote add upstream https://github.com/OpenMage/magento-lts
git pull upstream 1.9.4.x
git add -A && git commitDon't use common paths like /admin for OpenMage Backend URL. Don't use the path in robots.txt and keep it secret. You can change it from Backend (System / Configuration / Admin / Admin Base Url) or by editing app/etc/local.xml:
<config>
<admin>
<routers>
<adminhtml>
<args>
<frontName><![CDATA[admin]]></frontName>
</args>
</adminhtml>
</routers>
</admin>
</config>Don't use common file names like api.php for OpenMage API URLs to prevent attacks. Don't use the new file name in robots.txt and keep it secret with your partners. After renaming the file you must update the webserver configuration as follows:
RewriteRule ^api/rest api.php?type=rest [QSA,L]
rewrite ^/api/(\w+).*$ /api.php?type=$1 last;`
Most important changes will be listed here, all other changes since 19.4.0 can be found in
release notes.
- bug fixes and PHP 7.x, 8.0 and 8.1 compatibility
- added config cache for system.xml (#1916)
- search for "NULL" in backend grids (#1203)
- removed
lib/flexcontaining unused ActionScript "file uploader" files (#2271) - Mage_Catalog_Model_Resource_Abstract::getAttributeRawValue() now returns
'0'instead offalseif the value stored in the database is0(#572) - removed modules:
If you rely on those modules you can reinstall them with composer:
Mage_Backup:composer require openmage/module-mage-backupMage_PageCache:composer require openmage/module-mage-pagecacheLegacy frontend themes:composer require openmage/legacy-frontend-themes
- PHP extension
intlis required
Do not use 20.x.x if you need IE support.
- removed IE conditional comments, IE styles, IE scripts and IE eot files (#1073)
- removed frontend default themes (default, modern, iphone, german, french, blank, blue) (#1600)
- fixed incorrect datetime in customer block (
$useTimezoneparameter) (#1525) - added redis as a valid option for
global/session_save(#1513) - reduce needless saves by avoiding setting
_hasDataChangesflag (#2066) - removed support for
global/sales/old_fields_mapdefined in XML (#921) - enabled website level config cache (#2355)
- make overrides of Mage_Core_Model_Resource_Db_Abstract::delete respect parent api (#1257)
For full list of changes, you can compare tags.
Most of the 3rd party libraries/modules that were bundled in our repository were removed and migrated to composer dependencies. This allows for better maintenance and upgradability.
Specifically:
phpseclib,mcrypt_compat,Cm_RedisSession,Cm_Cache_Backend_Redis,Pelago_Emogrifier(#2411)- Zend Framework 1 (#2827)
If your project uses OpenMage through composer then all dependencies will be managed automatically.
If you just extracted the release zip/tarball in your project's main folder then be sure to:
-
remove the old copy of aforementioned libraries from your project, you can do that with this command:
rm -rf app/code/core/Zend lib/Cm lib/Credis lib/mcryptcompat lib/Pelago lib/phpseclib lib/Zend
-
download the new release zip file that is named
openmage-VERSIONNUMBER.zip, this one is built to contain thevendorfolder generated by composer, with all the dependencies in it -
extract the zip file in your project's repository as you always did
We also decided to remove our Zend_DB patches (that were stored in app/code/core/Zend) because they were very old and
not compatible with the new implementations made by ZF1-Future, which is much more advanced and feature rich.
This may generate a problem with `Zend_Db_Select' statements that do not use 'Zend_Db_Expr' to quote expressions.
If you see SQL errors after upgrading please remember to check for this specific issue in your code.
admin/design/use_legacy_themeadmin/global_search/enableadmin/emails/admin_notification_email_templatecatalog/product_image/progressive_thresholdcatalog/search/search_separatordev/log/max_levelnewsletter/security/enable_form_keysitemap/category/lastmodsitemap/page/lastmodsitemap/product/lastmod
adminhtml_block_widget_form_init_form_values_afteradminhtml_block_widget_tabs_html_beforeadminhtml_sales_order_create_save_beforecheckout_cart_product_add_beforesitemap_cms_pages_generating_beforesitemap_urlset_generating_before
Since 19.4.17/20.0.15 we changed the targetNamespace of all the WSDL files (used in the API modules), from Magento to OpenMage.
If your custom modules extends OpenMage's APIs with a custom WSDL file and there are some hardcoded targetNamespace="urn:Magento" strings, your APIs may stop working.
Please replace all occurrences of
targetNamespace="urn:Magento"
with
targetNamespace="urn:OpenMage"
or alternatively
targetNamespace="urn:{{var wsdl.name}}"
to avoid any problem.
To find which files need the modification you can run this command from the root directory of your project.
grep -rn 'urn:Magento' --include \*.xml- Install ddev
- Clone the repository as described in installation (Git)
- Create a ddev config, defaults should be good for you
ddev config
- Open
.ddev/config.yamland change the php version to your needs - Download and start the containers
ddev start
- Open your site in browser
ddev launch
Deprecation errors are supressed by default.
If you want to work on PHP 8.1 support, set environment variable DEV_PHP_STRICT to 1, to show all errors.
This repo includes class maps for the core Magento files in .phpstorm.meta.php.
To add class maps for installed extensions, you have to install N98-magerun
and run command:
n98-magerun.phar dev:ide:phpstorm:metaYou can add additional meta files in this directory to cover your own project files. See PhpStorm advanced metadata for more information.
Though Magento does not follow Semantic Versioning we aim to provide a workable system for dependency definition.
- Discord (maintained by Flyingmana)
- Daniel Fahlke
- David Robinson
- Fabrizio Balliano
- Lee Saferite
- Mohamed Elidrissi
- Ng Kiat Siong
- Sven Reichel
- Tymoteusz Motylewski
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!