druidfi / omen
Installs: 121 798
Dependents: 1
Suggesters: 0
Security: 0
Stars: 5
Watchers: 3
Forks: 0
Open Issues: 1
Requires
- php: ^8.0
- ext-json: *
- drupal/core-recommended: ^10.0 || ^11.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.17 || ^3.15
- phpunit/phpunit: ^9.6 <10
README
Drupal ENV detector. Detects env related configuration and sets them for you. Helps with moving sites from environment to another. Aims also to generalize your env configuration.
Also sets configuration per environment type. e.g. for development or production. Everything can still be overridden in your project.
You should just focus on your project specific configuration.
How to use
Require omen in your composer.json:
composer require druidfi/omen
And then use this as your sites/default/settings.php
:
<?php // Use druidfi/omen extract(Druidfi\Omen\Reader::get(get_defined_vars()));
Or print out all configuration (aka debug):
<?php // Print out detected configuration by druidfi/omen Druidfi\Omen\Reader::show(get_defined_vars());
See the whole example here.
Known environments
- Amazee.io Lagoon
- DDEV Local
- Lando
- Pantheon - Work in Progress
- Tugboat
- Wodby
What is detected?
- Loading of setting files and service configurations
- Database connection
- Trusted host pattern(s)
- File paths (public, private, temp)
- Hash salt
- Contrib module settings (which are affected by env)
APP_ENV
With APP_ENV
you can force a running configuration. E.g. you can run with test
configuration on dev
environment.
This means that e.g. the database credentials do not change but caching settings do change.
Values: dev
, test
or prod
(default: prod
)
Drupal configuration mapping
Drupal configuration can be overridden using ENV variables.
✖️ Detected or required
Defaults for environment types
See src/Defaults.php for values.
See current default values by environment:
Same for all environments:
$settings['config_exclude_modules']
=['devel','stage_file_proxy','upgrade_status']
$settings['config_sync_directory']
='conf/cmi'
TODO
Add support for:
- Detect e.g. Solr, Redis and Varnish configuration where available
- Other dev tools and hosting environments
- Default values for some contrib modules
Where the name "Omen" comes from?
Druids interpreted the waves of the ocean or read clouds for mundane or important omens. So reading clouds
is
basically what druidfi/omen
is doing. Your local clouds too.
Other information
This project can be found from the Packagist: https://packagist.org/packages/druidfi/omen