You are here

Home » API reference » Config Ignore 8.3

README.txt in Config Ignore 8.3

Same filename and directory in other branches
  1. 8 README.txt
  2. 8.2 README.txt
Config Ignore
=============

INTRODUCTION
------------
Ever experienced that your site's configuration was overridden,
by the configuration on the file system, when running a `drush cim`?

Not anymore!

This modules is a tool to let you keep the configuration you want, in place.

Let's say that you do would like the `system.site` configuration
(which contains that sites name, slogan, email, etc.) to remain untouched,
on your live site, no matter what the configuration in the config folder is.

Or maybe you are getting tired of having the `devel.settings`
changed every time you import configuration?

Then this module is what you are looking for.

REQUIREMENTS
------------
You will need Drupal 8.8 or higher for this module to work. If you want to
import and export config with Drush, you need Drush 10+.

INSTALLATION
------------
Consult https://www.drupal.org/docs/8/extending-drupal-8/installing-contributed-modules-find-import-enable-configure-drupal-8
to see how to install and manage modules in Drupal 8.

CONFIGURATION
-------------
If you go to `admin/config/development/configuration/ignore`
you will see a fairly simple interface.

Add the name of the configuration that you want to ignore upon import.
(e.g. `system.site` to ignore site name, slogan and email site email address.)
Click the "Save configuration" button and you are good to go.

Do not ignore the `core.extension` configuration as it will prevent you
from enabling new modules with a config import. Use the `config_split` module
for environment specific modules.

If you need to bypass Config Ignore you can update/create a single configuration
by using the "Single import" feature found at
`admin/config/development/configuration/single/import`.

To deactivate `config_ignore`, include
`$settings['config_ignore_deactivate'] = TRUE;` in your settings.php file.

MAINTAINERS
-----------
Current maintainers:

 * Tommy Lynge Jørgensen (TLyngeJ) - https://www.drupal.org/u/tlyngej
 * Fabian Bircher (bircher) - https://www.drupal.org/u/bircher
 * Jordan Thompson (nord102) - https://www.drupal.org/u/nord102

File

README.txt
View source 
  1. Config Ignore

  2. =============

  3. 

  4. INTRODUCTION

  5. ------------

  6. Ever experienced that your site's configuration was overridden,

  7. by the configuration on the file system, when running a `drush cim`?

  8. 

  9. Not anymore!

  10. 

  11. This modules is a tool to let you keep the configuration you want, in place.

  12. 

  13. Let's say that you do would like the `system.site` configuration

  14. (which contains that sites name, slogan, email, etc.) to remain untouched,

  15. on your live site, no matter what the configuration in the config folder is.

  16. 

  17. Or maybe you are getting tired of having the `devel.settings`

  18. changed every time you import configuration?

  19. 

  20. Then this module is what you are looking for.

  21. 

  22. REQUIREMENTS

  23. ------------

  24. You will need Drupal 8.8 or higher for this module to work. If you want to

  25. import and export config with Drush, you need Drush 10+.

  26. 

  27. INSTALLATION

  28. ------------

  29. Consult https://www.drupal.org/docs/8/extending-drupal-8/installing-contributed-modules-find-import-enable-configure-drupal-8

  30. to see how to install and manage modules in Drupal 8.

  31. 

  32. CONFIGURATION

  33. -------------

  34. If you go to `admin/config/development/configuration/ignore`

  35. you will see a fairly simple interface.

  36. 

  37. Add the name of the configuration that you want to ignore upon import.

  38. (e.g. `system.site` to ignore site name, slogan and email site email address.)

  39. Click the "Save configuration" button and you are good to go.

  40. 

  41. Do not ignore the `core.extension` configuration as it will prevent you

  42. from enabling new modules with a config import. Use the `config_split` module

  43. for environment specific modules.

  44. 

  45. If you need to bypass Config Ignore you can update/create a single configuration

  46. by using the "Single import" feature found at

  47. `admin/config/development/configuration/single/import`.

  48. 

  49. To deactivate `config_ignore`, include

  50. `$settings['config_ignore_deactivate'] = TRUE;` in your settings.php file.

  51. 

  52. MAINTAINERS

  53. -----------

  54. Current maintainers:

  55. 

  56.  * Tommy Lynge Jørgensen (TLyngeJ) - https://www.drupal.org/u/tlyngej

  57.  * Fabian Bircher (bircher) - https://www.drupal.org/u/bircher

  58.  * Jordan Thompson (nord102) - https://www.drupal.org/u/nord102