mygento/module-configsync

A module to store Magento configuration with multiple environments in the version control

Installs: 41 826

Dependents: 0

Suggesters: 0

Security: 0

Stars: 5

Watchers: 10

Forks: 2

Open Issues: 2

Type:magento2-module

2.4.0 2020-10-07 22:57 UTC

This package is auto-updated.

Last update: 2022-08-08 03:10:50 UTC


README

A module to store Magento configuration with multiple environments in the version control

Build Status Latest Stable Version Total Downloads

File Syntax

The configuration values are stored in a YAML file. The format of the file is as follows:

environment:
    scope_key:
       path: value

For example:

production:
    default:
        web/secure/base_url: https://domain.com/
        web/secure/use_in_frontend: 1
development:
    default:
        web/secure/base_url: https://domain1.com/
        admin/url/custom: %DELETE%
    websites-1:
        web/secure/use_in_frontend: 1
    stores-1:
        web/secure/use_in_frontend: 0

Valid scope keys are:

  • default
  • stores-$id
  • websites-$id

Use %DELETE% to delete config path

Usage

Sync config from file

php bin/magento setup:config:sync [options] [--] <env> <config_yaml_file>

Arguments:

  • env - environment for import.
  • config_yaml_file - the YAML file containing the configuration settings.

Options:

  • --detailed - display detailed information (1 - display, otherwise - not display).

Dump config

php bin/magento setup:config:dump [--] <env> <section> <filename>

Note: only default scope is implemented

Arguments:

  • env - environment name.
  • section - name of the section to export its config.
  • filename - name of the output file (Optional).