How to Use Environment Variables for your Drupal Settings with Docksal
Warning: This post is over a year old. I don't always update old posts with new information, so some of this information may be out of date.
Within the Docksal documentation for Drupal settings, the example database
settings include hard-coded credentials to connect to the Drupal database. For
example, within a
settings.php file, you could add this:
$databases['default']['default'] = [ 'driver' => 'mysql', 'host' => 'db', 'database' => 'myproject_db', 'username' => 'myproject_user', 'password' => 'myproject_pass', ];
Whilst this is fine, it does mean that there is duplication in the codebase as
the database credentials can also be added as environment variations within
.docksal/docksal.env - this is definitely the case if you want to use a custom
database name, for example.
Also if one of these values were to change, then Drupal wouldn't be aware of that and would no longer be able to connect to the database.
It also means that the file can’t simply be re-used on another project as it contains project-specific credentials.
We can improve this by using the environment variables within the settings file.
The relevant environment variables are
MYSQL_DATABASE for the database name,
MYSQL_PASSWORD for the MySQL username and password. These
can be set in
.docksal/docksal.env, and will need to be present for this to
DOCKSAL_STACK=default MYSQL_DATABASE=myproject_db MYSQL_USER=myproject_user MYSQL_PASSWORD=myproject_pass
With these in place, they can be referenced within the settings file using the
$databases['default']['default'] = [ 'driver' => 'mysql', 'host' => 'db', 'database' => getenv('MYSQL_DATABASE'), 'username' => getenv('MYSQL_USER'), 'password' => getenv('MYSQL_PASSWORD'), ];
Now the credentials are no longer duplicated, and the latest values from the environment variables will always be used.
However, you may see a message like this when you try and load the site:
Drupal\Core\Database\DatabaseAccessDeniedException: SQLSTATE[HY000] Access denied for user ''@'172.19.0.4' (using password: NO) in /var/www/core/lib/Drupal/Core/Database/Driver/mysql/Connection.php on line 156
If you see this, the environment variables aren’t being passed into Docksal’s
cli container, so the values are not being populated. To enable them, edit
.docksal/docksal.yml and add
MYSQL_USER to the
environment section of the
version: '2.1' services: cli: environment: - MYSQL_DATABASE - MYSQL_PASSWORD - MYSQL_USER
After changing this file, run
fin start to rebuild the project containers and
try to load the site again.