/** @type {import('@scandipwa/magento-scripts').CMAConfiguration} */
module.exports = {
magento: { ... },
configuration: {
composer: {
// lets change composer version to 2.8.8
version: '2.8.8'
}
}
};
// Define composer version from a channel
/** @type {import('@scandipwa/magento-scripts').CMAConfiguration} */
module.exports = {
magento: { ... },
configuration: {
composer: {
// lets change composer version to latest-2.2.x (LTS)
version: 'latest-2.2.x'
}
}
};
PHP Image Infrastructure
Install extension
Set Debug Trigger value to PHPSTORM
docker run \
-d \
--name newrelic-infra \
--network=host \
--cap-add=SYS_PTRACE \
--privileged \
--pid=host \
-v "/:/host:ro" \
-v "/var/run/docker.sock:/var/run/docker.sock" \
-e NRIA_LICENSE_KEY=<LICENSE_KEY> \
newrelic/infrastructure:latest
You also need to apply changes by running the [start](/getting-started/available-commands/start) command **without** [**-s option**](/getting-started/available-commands/start#s-skip-setup). # Using custom domain {% hint style="danger" %} ## For Multi-Store configuration use [the following guide](/usage-guide/configuring-multi-store) {% endhint %} {% hint style="warning" %} This page is relevant for `magento-scripts` versions before 2.2.x. Version 2.2.x is using Multi Store configuration. {% endhint %} ## 1. Add domain to the /etc/hosts file In order for this config to work you need to add your host domain to the `/etc/hosts` file, for example: ```bash # /etc/hosts file 127.0.0.1 localhost 127.0.0.1 scandipwa.local # some other domain ``` ## 2. Setup CMA Add to your `cma.js` file field `host` with your domain: ```javascript module.export = { magento: { ... }, host: 'scandipwa.local' } ``` That is it! Just now we have setup a domain in our application!\ Now to apply changes we need to run the [start](/getting-started/available-commands/start) command **without** [**-s option**](/getting-started/available-commands/start#s-skip-setup). # Using Enterprise Edition ## 1. Create new CMA app ```bash npx create-magento-app@latest magento-enterprise ``` ## 2. Set magento.edition to "enterprise" in the config file {% code title="cma.js" %} ```javascript module.exports = { magento: { first_name: 'Scandiweb', last_name: 'Developer', email: 'developer@scandipwa.com', user: 'admin', password: 'scandipwa123', adminuri: 'admin', mode: 'developer', edition: 'enterprise' // <- edit this }, configuration: {} }; ``` {% endcode %} ## 3. Run the application Start the application with the [start](/getting-started/available-commands/start) command. {% hint style="warning" %} You need access keys with access to Magento Enterprise on them to be able to install the **enterprise edition**. {% endhint %} ```bash npm run start ``` # Using OpenSearch {% hint style="info" %} Available since `magento-scripts` 2.3.1 {% endhint %} {% hint style="info" %} From Magento 2.4.8 CMA will use OpenSearch as the default search engine. {% endhint %} ## 1. Create new CMA app ```bash npx create-magento-app@latest magento-with-opensearch ``` ## 2. Set searchengine to "opensearch" in the configuration section of the config file {% code title="cma.js" %} ```javascript module.exports = { // ...other configurations configuration: { searchengine: 'opensearch' // <- set this } }; ``` {% endcode %} ### 2.1 Configure OpenSearch (optional) ```javascript module.exports = { // ...other configurations configuration: { searchengine: 'opensearch', opensearch: { // change opensearch image here image: 'opensearchproject/opensearch:2.13.0', env: { // additional environment variables for container OPENSEARCH_JAVA_OPTS: '-Xms2048m -Xmx4096m' } } } }; ``` ## 3. Run the application You need to apply changes by running the [start](/getting-started/available-commands/start) command **without** [**-s option**](/getting-started/available-commands/start#s-skip-setup). # Importing database To import the database use the [import-db](/getting-started/available-commands/import-db) command. {% hint style="warning" %} ### **Heads up!** If you are running a version older than **magento-scripts\@1.6.0**, you will need to start project manually using [start command](/getting-started/available-commands/start)! {% endhint %} {% tabs %} {% tab title="Yarn" %} ```bash yarn import-db
| Area | You manage in a vanilla setup | CMA manages for you |
|---|---|---|
| Services | Install and configure nginx, PHP-FPM, a database, Redis, a search engine, a mail catcher, SSL, optionally Varnish | One start runs the full stack as containers: nginx, two PHP-FPM (one with Xdebug), MariaDB, Redis, ElasticSearch or OpenSearch, MailDev, an SSL-terminating proxy, optional Varnish |
| Service versions | Track Adobe's requirements matrix; upgrade each component when Magento bumps it | Every service version is pinned to your Magento version β a Magento upgrade swaps the whole stack for you |
| PHP | Install the right PHP and ~28 extensions per project; switch versions between projects | A prebuilt container image matching your Magento version; your host PHP is irrelevant |
| Ports | Hardcode host ports, resolve clashes between projects | Assigned automatically, cached per project, bound to 127.0.0.1; several CMA projects run side by side |
| Wiring | Hand-edit env.php hosts and base URLs after every change | env.php and the base URLs are rewritten to point at the containers on every start |
| Daily commands | docker exec, docker logs, mysql client incantations | npm run cli (a shell with magento, composer, mariadb aliases), exec, logs, status |
| Debugging | Toggle Xdebug ini and restart PHP-FPM | A second PHP-FPM container with Xdebug is always ready; enabled per request via browser cookie, or debugphp for CLI |
| IDE setup | Hand-written launch.json and PhpStorm config | .vscode/ and .idea/ are generated and kept in sync with the assigned ports |
| Path | Purpose | Commit it? |
|---|---|---|
cma.js | project configuration | yes |
package.json | CMA scripts and dependency | yes |
README.md | project readme with the CMA commands | yes |
AGENTS.md, CLAUDE.md, .claude/, .agents/ | AI agent instructions for the CMA commands | yes |
node_modules/.create-magento-app-cache/ | generated nginx / PHP / Varnish / MariaDB configs | no |
.vscode/launch.json | XDebug launch configuration | your call |
.idea/ | PhpStorm PHP, XDebug and database settings | your call |
.git/hooks/post-checkout | warns on composer.json / composer.lock changes after a branch switch | n/a |
// cma.js
const {
ioncube,
memcached,
pdo_sqlsrv,
sqlsrv,
imagick
} = require('@scandipwa/magento-scripts-php-extensions');
/** @type {import('@scandipwa/magento-scripts').CMAConfiguration} */
module.exports = {
// ... other configurations
configuration: {
php: {
extensions: { // <- set extensions here
ioncube,
memcached,
pdo_sqlsrv,
sqlsrv,
imagick
}
}
}
};
You also need to apply changes by running the [start](/v1/getting-started/available-commands/start) command **without** [**-s option**](/v1/getting-started/available-commands/start#s-skip-setup). # Importing database To import the database use the [import-db](/v1/getting-started/available-commands/import-db) command. {% hint style="warning" %} ### **Heads up!** If you are running a version older than **magento-scripts\@1.6.0**, you will need to start project manually using [start command](/v1/getting-started/available-commands/start)! {% endhint %} {% tabs %} {% tab title="Yarn" %} ```bash yarn import-db