acsf-init Drush command (provided as part of the Site Factory Connector module) prepares a custom Drupal
distribution for development and deployment on Site Factory. The command
appends information to your website’s
while also creating any necessary directories, identifying database
credentials, creating a
sites.php file, and copying files required by
acsf-init will make changes to your website’s
sites/default/settings.php file, move your customizations in your
settings.php file to another file or into a
Failing to move your customizations could cause you to lose them when
settings.php is overwritten.
You must execute the
acsf-init command whenever you update Drupal core or
the Site Factory Connector module to a newer version.
For more information about the different
settings.php files in
your Site Factory platform, see Understanding settings.php
To add the Site Factory Connector module to your codebase, use the command appropriate for your installed version of Drupal:
Drupal 7: Download the module by using the
drush dl acsf command.
Drupal 9 or later (using BLT 9 or later): Add the module to
your codebase by using the
blt recipes:acsf:init:all command.
Drupal 9 or later (without BLT): Add the module to your
composer.json by using the
composer require drupal/acsf command.
Do not install the module in more than one location in your code repository
(such as both
docroot/modules/contrib). Multiple instances of the module can prevent
Site Factory from discovering and using the module.
To determine if your code repository contains more than one version of the
module, run the following Git command in the
git ls-files "*acsf.info*"
acsf-initafter module or Drupal core updates¶
Whenever you update the Site Factory Connector module to a newer version, complete the following steps to update the module in your Drupal distribution:
Download and extract the updated Site Factory Connector module from
Drupal.org into your distribution with the command appropriate to your
version of Drupal and BLT, replacing
[path/to/acsf/acsf_init] with the path to your
composer update drupal/acsf --with-dependencies /local/site/vendor/bin/drush acsf-init --include="[path/to/acsf/acsf_init]/acsf/acsf_init" --root="/local/site/docroot" -y
Drupal 9 or later and BLT 9 (or later):
Drupal 9 or later and BLT 8:
The Drush command creates several directories and then copies files that Site Factory requires for its tasks, including locating the correct database credentials.
Run the following Drush command from the docroot directory to ensure everything is in order before you commit the custom distribution to the repository:
drush --include=/path/to/acsf/acsf_init acsf-init-verify
acsf-init-verify command should display the following
acsf-init required files ok
You must repeat this process every time you update the Site Factory Connector module.
BLT versions 9.2 or later can test
part of the
blt validate command. To enable this feature, add the
following lines to your project’s
validate: acsf: true
Commit and push your custom distribution’s files to Site Factory. For the specific procedure to guide you through this process, see Preparing for the code deployment.
Update your Prod environment with the custom distribution’s files you pushed. For the specific procedure to guide you through this process, see Performing a production deployment.
If you fail to execute the
acsf-init command, or Site Factory
cannot determine the Site Factory Connector module version, your deployment
settings.phpfor local development¶
The Site Factory Connector module ensures the
file includes only the required settings for Site Factory. When
developing a custom Drupal distribution locally for use on
Site Factory, you may need to modify
settings.php in ways
conflicting with the requirements enforced by the Site Factory
You can avoid conflicts by executing the
acsf-init command with the
--skip-default-settings parameter to skip the
when running a Drupal website that includes the Site Factory
Connector module, but is not on
Site Factory, as in the following example:
drush --include=/path/to/acsf/acsf_init acsf-init --skip-default-settings
This parameter enables you to locally deploy and test a version of
settings.php with settings needed for local development, while still
ensuring your production websites use the version of
by Site Factory.
You must execute
before you commit and push your custom distribution’s files to
acsf-init command writes your
sites/default/settings.php file when
you prepare a custom Drupal distribution for development and deployment on
Site Factory. If you cannot create new websites using your custom
Drupal distribution, examine the
.gitignore file in your code repository.
.gitignore file may be set to exclude the
settings.php file, so
settings.php never gets pushed to the Site Factory. If your
.gitignore file contains a line similar to the following example, delete
# Ignore configuration files that may contain sensitive information. sites/*/settings.php
After deleting the line, commit your changes, and push your code again, as described in Performing a production deployment.
If you do not execute the
acsf-init command after an Site Factory platform
release, or execute the command incorrectly, you may encounter one or more of
the following error messages:
If a hotfix fails, ensure your user has permission to overwrite the