Environmental Config

Component ID

2850335

Component name

Environmental Config

Component type

module

Maintenance status

Development status

Component security advisory coverage

not-covered

Downloads

123

Component created

Component changed

Component body

Environmental_config is a module that helps you automatically importing environment
specific configuration without any hassle.

It's ideal when you need different settings for a specific module or system configuration in your development/staging or live server.

It runs with the standard Drupal Configuration Synchronisation and doesn't require many configurations.

Real life examples of usage

You have your Google Analytics module with a live API key saved in the Drupal configuration. You don't want to manually change the API key every time you deploy a new development server.

You have another third-party module that connects with your client's CRM live database.
You don't want to risk to alter or have access to sensitive data on non-live environments.

You have your development bunch of modules that have to bee manually re-enabled every time a live DB import happens.

Environmental_config can help you by managing environment-based configuration files and
auto-importing them with the standard Drupal configuration synchronisation or through
a specific Drupal console command.

It has been designed especially to work in CI environments where there are limited options to work with custom system environment variables and settings.

Requirements

  • Config (core module)
  • Drupal console (>=1.0.0-rc15)

Roadmap

Environmental_config is currently under active development and is released as beta.

Known problems

There are no known problems at the moment.

Contributing

A full test coverage is planned to be released but any help is welcome.

config_split

Config_split provides similar functionality but works with a
pre-configured profile editable from the UI, it also offers export
functionality.

Environmental_config doesn't provide a UI, it only needs a valid configuration in the settings.php file where to extract the current environment name. Once the settings are valid its work is based on the environment detected and will work without further user input (ideal for CI environments).

Installation and configuration

See the README.md file for further information.

Notes

Environmental_config only works on the Synchronisation tab (Import all) and not on the single Import tab.

Please note that environmental_config doesn't act in the export process. You will need to manually create your environmental configuration files and put in your environmental config directory.