firegento / magesetup2
firegento/magesetup2
MageSetup provides the necessary configuration (system config, tax, agreements, etc. for a national market.
FireGento_MageSetup
MageSetup configures a shop for a national market.
Currently supported countries are:
- Austria (at)
- Switzerland (ch)
- Germany (de)
- Spain (es)
- France (fr)
- United Kingdom (gb)
- Italy (it)
- Netherlands (nl)
- Poland (pl)
- Romania (ro)
- Russia (ru).
More countries to follow.
Missing your country? Please open a pull request with the necessary configuration for your country and help us support more countries.
Requirements
- PHP >= 7.3
- Magento >= 2.4.3
If you are using Magento < 2.4.3, you can still use version 0.4.*.
Installation
Via composer (recommended)
Please go to the Magento2 root directory and run the following commands in the shell:
composer require firegento/magesetup2
bin/magento module:enable FireGento_MageSetup
bin/magento setup:upgrade
Manually
Please create the directory app/code/FireGento/MageSetup and copy the files from this repository to the created directory. Then run the following commands in the shell:
bin/magento module:enable FireGento_MageSetup
bin/magento setup:upgrade
Usage
bin/magento magesetup:setup:run <country_code> <processors>
Parameters:
<country_code>is a required argument. Please find available country codes in country list above (e.g.defor Germany).<processors>is an optional argument. If no processor code is given, all processors will be run.
Available processors:
agreementsfor setting up the terms and conditionscmsfor setting up all required cms pages and cms blockssystemConfigfor setting up base configuration values.taxfor setting up the base tax rules / tax rates.
Example:
Run all processors for Germany:
bin/magento magesetup:setup:run de
Only run agreements and cms for Germany:
bin/magento magesetup:setup:run de agreements cms
Hyvä Themes
If you're using Hyvä as frontend in your Magento 2 instance, please install the corresponding
compatibility module. You can find all detailed installation instructions in the compatibility module repository.
Support
If you encounter any problems or bugs, please create an issue on GitHub.
Contribution
Any contribution to the development of MageSetup is highly welcome. The best possibility to provide any code is to open a pull request on GitHub.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
Developer
FireGento Team
- Website: http://firegento.com
- Twitter: @firegento
Maintainer
- @sprankhub
- @frostblogNet
- @Schrank
- @therouv
Licence
GNU General Public License, version 3 (GPLv3)
Copyright
(c) 2015-2022 FireGento Team
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
Newer Versions
See GitHub releases.
[v1.2.3] - 2025-05-24
Added
- PHP 8.4 compatibility (thanks @sprankhub)
Changed
- Update GitHub Actions (thanks @sprankhub)
- Update CH tax rates (thanks @sprankhub)
[v1.2.2] - 2024-08-08
Added
- PHP 8.3 compatibility (thanks @jg-development and @sprankhub)
Changed
- Update GitHub Actions (thanks @sprankhub)
[v1.2.1] - 2023-03-20
Added
- PHP 8.2 compatibility (thanks @aweb3r)
[v1.2.0] - 2022-09-07
Changed
- Make shouldAddPriceDetails public for customizations (thanks @Cloudy777)
- PHP 8.1 compatibility: add integration tests (thanks @frostblogNet)
[v1.1.2] - 2022-08-17
Changed
- PHP 8.1 compatibility: Prevent "trim(): Passing null to parameter 1 of type string is deprecated" error (thanks @therouv)
[v1.1.1] - 2022-08-16
Added
- dedicated usage section in README (thanks @therouv)
Changed
- fix XSD reference in
etc/magesetup.xml#208 (thanks @sprankhub)
[v1.1.0] - 2022-03-31
Added
- support for PHP 8.1 #207 (thanks @domeglic)
[v1.0.0] - 2021-08-19
Added
- support for Magento 2.4.3 #200 (thanks @sprankhub)
Changed
- fatal error on all frontend pages #199 (thanks @sprankhub)
Removed
- support for Magento < 2.4.3 #200 (thanks @sprankhub)
[v0.4.1] - 2020-11-04
Changed
- Registry key already exists error for HTTPS sites #186 (thanks @sprankhub)
- Wrong attribute group name in setup scripts #187 (thanks @norgeindian)
[v0.4.0] - 2020-10-08
Added
[v0.3.0] - 2020-06-30
Added
- Add all contributors and bot config (thanks @kkrieger85)
- Add integration test (thanks @sprankhub,@BorisovskiP)
- Add integration test to travis ci #166 (thanks @frostblogNet)
- Add unit test form blocks (thanks @frostblogNet)
- Add integration test for visible in checkout property (thanks @sprankhub)
Changed
- Fix imprint blocks in mails #149 (thanks @sprankhub)
- Hide tax details for grouped product #150 (thanks @sprankhub)
- Fix setting of tax class ID on products (thanks @sprankhub)
- Configure kg as weight unit during setup #31 (thanks @sprankhub)
- Use delivery time label from attribute config (Note you have to configure the attribute lable in the admin area) #124 (thanks @sprankhub)
- Use newer coding magento standard (thanks @sprankhub)
- Update English translation (thanks @sprankhub)
- Update German translation (thanks @sprankhub)
- Replace around with after plugin (thanks @sprankhub)
Removed
- Remove price details from tier prices #87 (thanks @sprankhub)
- Drop support for magento 2.2.x and php 7.1.x (thanks @sprankhub + @frostblogNet)
- Remove unused Dutch translation (thanks @sprankhub)
| Version | Stability | QA Status | Compatibility | Released |
|---|---|---|---|---|
| 1.3.0 | stable | Fail | Magento 2.4.7-2.4.9 Details | 2026-05-22 06:01:22 |
| 1.2.5 | stable | Not tested | Not yet tested Details | 2026-01-28 06:47:00 |
| 1.2.4 | stable | Not tested | Not yet tested Details | 2025-11-21 14:15:41 |
| 1.2.3 | stable | Not tested | Not yet tested Details | 2025-05-24 20:21:02 |
| 1.2.2 | stable | Not tested | Not yet tested Details | 2024-08-08 14:05:28 |
| 1.2.1 | stable | Not tested | Not yet tested Details | 2023-03-20 22:22:34 |
| 1.2.0 | stable | Not tested | Not yet tested Details | 2022-09-07 08:36:38 |
| 1.1.2 | stable | Not tested | Not yet tested Details | 2022-08-17 12:37:13 |
| 1.1.1 | stable | Not tested | Not yet tested Details | 2022-08-16 18:12:36 |
| 1.1.0 | stable | Not tested | Not yet tested Details | 2022-03-31 19:23:41 |
| 1.0.0 | stable | Not tested | Not yet tested Details | 2021-08-19 21:30:23 |
| 0.4.1 | stable | Not tested | Not yet tested Details | 2020-11-04 20:36:20 |
| 0.4.0 | stable | Not tested | Not yet tested Details | 2020-10-08 12:42:45 |
| 0.3.0 | stable | Not tested | Not yet tested Details | 2020-06-30 19:53:22 |
| 0.2.0 | stable | Not tested | Not yet tested Details | 2020-03-08 10:41:41 |
| 0.1.2 | stable | Not tested | Not yet tested Details | 2019-07-20 10:49:46 |
| 0.1.1 | stable | Not tested | Not yet tested Details | 2019-01-09 14:40:13 |
| 0.1.0 | stable | Not tested | Not yet tested Details | 2018-09-07 09:03:30 |
Requires 4
| Package | Constraint |
|---|---|
| php | ~7.3.0||~7.4.0||~8.1.0||~8.2.0||~8.3.0||~8.4.0||~8.5.0 |
| magento/module-store | * |
| magento/module-backend | * |
| magento/framework | >=103.0.3 |
Compatibility
Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.
Code Quality
Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge. A phpcs finding can't make a module incompatible.
Static analysis
Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.
| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Fail | 129 | 4 errors, 125 warnings (ruleset: Magento2) — 113 auto-fixable with phpcbf |
| PHPMD | Fail | 17 | 17 rule violations (UnusedFormalParameter:6, MissingImport:3, ErrorControlOperator:3, UnusedLocalVariable:3, CyclomaticComplexity:1) |
| Cpd | Warning | 1 | 1 duplicated chunk spanning 39 total lines (min-lines=5, min-tokens=70) |
| Composer validate | Info | 4 | valid; 4 advisory notes (composer validate --strict) |
PHPStan
Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases.
Tests
Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.
Unit tests
Security
Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.
More from firegento
View vendorTurn an existing module into recurring revenue.
If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.