` command.
Examples:
/** @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'
}
}
};
```javascript
// Install any composer plugin:
/** @type {import('@scandipwa/magento-scripts').CMAConfiguration} */
module.exports = {
magento: { ... },
configuration: {
composer: {
plugins: {
//
'hirak/prestissimo': {
enabled: true
}
}
}
}
};
```
### Varnish
Varnish configuration is located in the `varnish` field and contains the following fields:
* `enabled` - A **boolean** option to manually enable or disable Varnish in the setup. (Default: `false`)
* `configTemplate` - `varnish.vcl` template file location. With this option, you can define your own `varnish.vcl` file that will be used by Varnish. (Original `varnish.template.vcl` file can be found [here](https://github.com/scandipwa/create-magento-app/blob/master/build-packages/magento-scripts/lib/config/templates/varnish.template.vcl))
* `image` - Varnish image **string**.
* `healthCheck` - A **boolean** option to manually enable or disable Varnish HealthCheck in the setup. (Default: `false`)
* `platform` - Select the platform mode for the service. Working values are `linux/amd64` and `linux/arm64`, but they are limited only to supported platforms by Docker. Default value `''` , which will tell magento-scripts to select the appropriate platform automatically. Recommended to use default value unless you specifically need to change platform to support a legacy Magento installation.
{% hint style="info" %}
Varnish image is pulled from [Docker Hub](https://hub.docker.com/_/varnish).
{% endhint %}
{% hint style="warning" %}
Varnish is disabled by default since **magento-scripts\@2.4.0**.
{% endhint %}
```javascript
/** @type {import('@scandipwa/magento-scripts').CMAConfiguration} */
module.exports = {
magento: { ... },
configuration: {
varnish: {
// lets change composer version to 6.0
image: 'varnish:6.0'
}
}
};
```
### SSL Terminator (Nginx)
SSL Terminator is an Nginx instance, its configuration is located in `sslTerminator` field and contains the following fields:
* `image` - Container image **string**.
* `configTemplate` - SSL Terminator template file location **string**. With this option, you can define your own `ssl-terminator.template.conf` - File that will be copied inside the `$CMA_CACHE/ssl-terminator/conf.d/` folder which is mounted in Nginx container to `/etc/nginx/conf.d/` folder. **string** (Original `ssl-terminator.template.conf` file can be found [here](https://github.com/scandipwa/create-magento-app/blob/master/build-packages/magento-scripts/lib/config/templates/ssl-terminator.template.conf))
* `platform` - Select the platform mode for the service. Working values are `linux/amd64` and `linux/arm64`, but they are limited only to supported platforms by Docker. Default value `''` , which will tell magento-scripts to select the appropriate platform automatically. Recommended to use default value unless you specifically need to change platform to support a legacy Magento installation.
{% hint style="info" %}
Nginx image is pulled from [Docker Hub](https://hub.docker.com/_/nginx).
{% endhint %}
```javascript
/** @type {import('@scandipwa/magento-scripts').CMAConfiguration} */
module.exports = {
magento: { ... },
configuration: {
sslTerminator: {
// lets change nginx image version to 1.19
image: 'nginx:1.19.0',
// and use custom ssl-terminator nginx template
configTemplate: './ssl-terminator.conf.template'
}
}
};
```
### NewRelic
{% hint style="warning" %}
Available only on Linux. WSL/MacOS are not supported.
{% endhint %}
NewRelic is a monitoring service for applications and uses the following configurations fileds:
* `enabled` - Boolean indicating if NewRelic is used in the application or not. Default is `false`.
* `licenseKey` - License key **string**. Located in API Keys section on NewRelic.
```javascript
/** @type {import('@scandipwa/magento-scripts').CMAConfiguration} */
module.exports = {
magento: { ... },
configuration: {
newRelic: {
enabled: true,
licenseKey: ''
}
}
};
```
{% hint style="info" %}
Learn about adding NewRelic to your application [here](https://docs.create-magento-app.com/usage-guide/configuring-newrelic).
{% endhint %}
## Domain
{% hint style="info" %}
Available in `magento-scripts` \~2.0.x and \~2.1.x
{% endhint %}
The host configuration is a string located in `host` field and by default, it is set to `localhost` .\
You can put your own host domain that will be set to nginx config as `server_name` and set Magento secure and unsecure base\_url values.
```javascript
/** @type {import('@scandipwa/magento-scripts').CMAConfiguration} */
module.exports = {
magento: { ... },
host: 'scandipwa.local'
};
```
{% hint style="info" %}
Learn about adding a localhost domain to your application [here](https://docs.create-magento-app.com/usage-guide/setup-custom-domain).
{% endhint %}
## Multi-Store Domains
{% hint style="info" %}
Since `magento-scripts` 2.2.x!
{% endhint %}
`storeDomains` allows to set different domains for Magento stores.
Use `store code` as `key` and domain as a `value`.
```javascript
/** @type {import('@scandipwa/magento-scripts').CMAConfiguration} */
module.exports = {
magento: { ... },
storeDomains: {
admin: 'scandipwa.local'
}
};
```
{% hint style="info" %}
Learn about configuring Multi-Store domains in your application [here](https://docs.create-magento-app.com/usage-guide/configuring-multi-store).
{% endhint %}
## SSL
SSL configuration is located in the `ssl` field and contains the following values:
* `enabled` - Enables or disables SSL in the application. **boolean** (`false` by default)
* `external_provider` - Allows to use external SSL provider in the application. **boolean** (`false` by default)
* `ssl_certificate` - SSL certificate file location **string**. You can put there your SSL certificate file location relative to the project root folder or use absolute value.
* `ssl_certificate_key` - SSL certificate key file location **string**. You can put there your SSL certificate file location relatively to the project root folder or use absolute value.
```javascript
/** @type {import('@scandipwa/magento-scripts').CMAConfiguration} */
module.exports = {
magento: { ... },
ssl: {
enabled: true,
external_provider: false,
ssl_certificate: './path/to/my/certificate',
ssl_certificate_key: './path/to/my/certificate-key.pem'
}
};
```
{% hint style="info" %}
Learn about enabling SSL in your application [here](https://docs.create-magento-app.com/usage-guide/enabling-ssl).
{% endhint %}
## Prefix
Prefix configuration is a boolean located in the `prefix` field and by default, it is set to `true` .
But what prefixes are used for?\
Prefix is a unique identifier that will be appended to docker container and volume names to prevent possible interference between folders with similar names. (Interference between folders look like [that](https://github.com/scandipwa/create-magento-app/issues/13))\
Setting `prefix` to `false` is generally **not recommended** but might be necessary for legacy projects.
```javascript
/** @type {import('@scandipwa/magento-scripts').CMAConfiguration} */
module.exports = {
magento: { ... },
prefix: false
};
```