Drupal and Upsun
Overview
Drupal CMS, born of DrupalCon 2024 initiative “Starshot”, has been released today. This now default download of Drupal, built on Drupal core, packages common recipes and features into a simpler experience and installation process to launch Drupal sites fast.
Alternative approach
This tutorial will take you through each step of setting up Drupal on Upsun - from building the project skeleton to defining infrastructure in YAML, with the goal of demonstrating how all the pieces fit together.
This may not be for everyone, though. Thankfully, the Upsun Activation team has released a complementary article in our Support Forum describing an internal scaffold plugin which will automatically create the required files described here.
While the user’s experience is meant to be quite different when logged into the Admin dashboard, deploying Drupal CMS is for the most part identical to deploying Drupal. Seeing as we haven’t yet brought Drupal into the Dev Center yet, I’ll do my best to present both side by side – noting differences where they exist.
Steps
Quickstart
Set up the new project according to the download instructions:
composer create-project drupal/cms:^1 upsun_drupal
composer create-project drupal/recommended-project upsun_drupal
In the project root (cd upsun_drupal
), add the following to a new .gitignore
file:
# Ignore directories generated by Composer
/drush/contrib/
/vendor/
/web/core/
/web/modules/contrib/
/web/themes/contrib/
/web/profiles/contrib/
/web/libraries/
console/
# Ignore sensitive information
/web/sites/*/settings.local.php
# Ignore Drupal's file directory
/web/sites/*/files/
# Ignore SimpleTest multi-site environment.
/web/sites/simpletest
# Ignore files generated by PhpStorm
/.idea/
# Ignore .env files as they are personal
/.env
# Ignore mounts
web/sites/default/files
tmp
private
.drush
drush-backups
.console
/.editorconfig
/.gitattributes
Setup locally with DDEV
Next, use the provided launch-drupal-cms.sh
file to set up some additional scaffolding with the help of DDEV (version 1.24.0 or later):
./launch-drupal-cms.sh
If you’ve used all the defaults up to this point, you’ll now be able to view the Drupal CMS project locally with DDEV at http://upsun-drupal.ddev.site.
To begin with, I’m going to select all the available content type options and name it My Drupal CMS site
.
After creating my admin user, I’ll be able to view my content dashboard and the final site,
And the site, complete with some initial content:
Follow the steps outlined in the DDEV CMS Quickstart docs to configure Drupal:
ddev config --project-type=drupal11 --docroot=web
Install Drush:
composer require drush/drush
Start the service:
ddev start
After this, you’ll now be able to view the Drupal 11 project locally with DDEV at http://upsun-drupal.ddev.site.
To begin with, I’m going to install the Umami starter theme:
With the basic site together locally, let’s commit what we’ve done so far:
git init
git add .
git commit -m "Initial project."
Upsun first steps
Now, use the Upsun CLI to create a new project.
upsun project:create
Then you can use the command project:init
to setup some base configuration for a PHP
application using MariaDB
and Redis
through the prompts.
upsun project:init
Configure
Open the .upsun/config.yaml
file that’s been generated and replace with the following:
applications:
drupal:
type: "php:8.3"
relationships:
mariadb: 'db:mysql'
redis: 'cache:redis'
mounts:
# The default Drupal files directory.
'/web/sites/default/files':
source: storage
source_path: 'files'
# Drupal gets its own dedicated tmp directory. The settings.platformsh.php
# file will automatically configure Drupal to use this directory.
'/tmp':
source: storage
source_path: 'tmp'
# Private file uploads are stored outside the web root. The settings.platformsh.php
# file will automatically configure Drupal to use this directory.
'/private':
source: storage
source_path: 'private'
# Drush needs a scratch space for its own caches.
'/.drush':
source: storage
source_path: 'drush'
# Drush will try to save backups to this directory, so it must be
# writeable even though you will almost never need to use it.
'/drush-backups':
source: storage
source_path: 'drush-backups'
build:
flavor: composer
web:
locations:
'/':
root: 'web'
expires: 5m
passthru: '/index.php'
allow: false
rules:
'\.(avif|webp|jpe?g|png|gif|svgz?|css|js|map|ico|bmp|eot|woff2?|otf|ttf)$':
allow: true
'^/robots\.txt$':
allow: true
'^/sitemap\.xml$':
allow: true
'^/sites/sites\.php$':
scripts: false
'^/sites/[^/]+/settings.*?\.php$':
scripts: false
'/sites/default/files':
allow: true
expires: 5m
passthru: '/index.php'
root: 'web/sites/default/files'
scripts: false
rules:
'^/sites/default/files/(css|js)':
expires: 2w
dependencies:
php:
composer/composer: "^2.7"
hooks:
build: |
set -e
# fast.
deploy: |
set -e
php ./drush/upsun_generate_drush_yml.php
cd web
bash $PLATFORM_APP_DIR/drush/upsun_deploy_drupal.sh
crons:
# Run Drupal's cron tasks every 19 minutes.
drupal:
spec: '*/19 * * * *'
commands:
start: 'cd web ; drush core-cron'
runtime:
# Enable the redis extension so Drupal can communicate with the Redis cache.
extensions:
- redis
- sodium
- apcu
- blackfire
source:
root: /
services:
db:
type: mariadb:10.6
cache:
type: redis:7.2
routes:
"https://{default}/":
type: upstream
upstream: "drupal:http"
cache:
enabled: true
# Base the cache on the session cookie and custom Drupal cookies. Ignore all other cookies.
cookies: ['/^SS?ESS/', '/^Drupal.visitor/']
"https://www.{default}/":
type: redirect
to: "https://{default}/"
This configuration is identical to what we’ve recommended for deploying Drupal on Platform.sh, just updating for the few differences seen in Upsun’s configuration.
Variables
Next, the project:init
command created a .environment
file for us, containing environment variables for our two services (MariaDB and Redis). Append the highlighted Drush configuration to the bottom of that file:
|
|
settings.php
Open web/sites/default/settings.php
and append the following highlighted portion to the bottom of that file, just below the DDEV configuration.
|
|
Upsun-specific settings
Then create a new Upsun-specific settings file web/sites/default/settings.upsun.php
that leverages the variables defined in .environemnt
that contains the following:
<?php
/**
* @file
* Platform.sh settings.
*/
use Drupal\Core\Installer\InstallerKernel;
// Set up a config sync directory.
//
// This is defined inside the read-only "config" directory, deployed via Git.
$settings['config_sync_directory'] = '../config/sync';
// Configure the database.
$databases['default']['default'] = [
'driver' => getenv('DB_SCHEME'),
'database' => getenv('DB_PATH'),
'username' => getenv('DB_USERNAME'),
'password' => getenv('DB_PASSWORD'),
'host' => getenv('DB_HOST'),
'port' => getenv('DB_PORT'),
'init_commands' => [
'isolation_level' => 'SET SESSION TRANSACTION ISOLATION LEVEL READ COMMITTED',
],
];
// Enable verbose error messages on development/staging branches, but not on the production branch.
// You may add more debug-centric settings here if desired to have them automatically enable
// on development but not production.
if (getenv('PLATFORM_ENVIRONMENT_TYPE') == 'production') {
// Production environment type.
$config['system.logging']['error_level'] = 'hide';
} else {
// Non-production environment types.
$config['system.logging']['error_level'] = 'verbose';
}
// Enable Redis caching.
if (!InstallerKernel::installationAttempted() && extension_loaded('redis') && class_exists('Drupal\redis\ClientFactory')) {
// Set Redis as the default backend for any cache bin not otherwise specified.
$settings['cache']['default'] = 'cache.backend.redis';
$settings['redis.connection']['host'] = getenv('CACHE_HOST');
$settings['redis.connection']['port'] = getenv('CACHE_PORT');
// Apply changes to the container configuration to better leverage Redis.
// This includes using Redis for the lock and flood control systems, as well
// as the cache tag checksum. Alternatively, copy the contents of that file
// to your project-specific services.yml file, modify as appropriate, and
// remove this line.
$settings['container_yamls'][] = 'modules/contrib/redis/example.services.yml';
// Allow the services to work before the Redis module itself is enabled.
$settings['container_yamls'][] = 'modules/contrib/redis/redis.services.yml';
// Manually add the classloader path, this is required for the container cache bin definition below
// and allows to use it without the redis module being enabled.
$class_loader->addPsr4('Drupal\\redis\\', 'modules/contrib/redis/src');
// Use redis for container cache.
// The container cache is used to load the container definition itself, and
// thus any configuration stored in the container itself is not available
// yet. These lines force the container cache to use Redis rather than the
// default SQL cache.
$settings['bootstrap_container_definition'] = [
'parameters' => [],
'services' => [
'redis.factory' => [
'class' => 'Drupal\redis\ClientFactory',
],
'cache.backend.redis' => [
'class' => 'Drupal\redis\Cache\CacheBackendFactory',
'arguments' => ['@redis.factory', '@cache_tags_provider.container', '@serialization.phpserialize'],
],
'cache.container' => [
'class' => '\Drupal\redis\Cache\PhpRedis',
'factory' => ['@cache.backend.redis', 'get'],
'arguments' => ['container'],
],
'cache_tags_provider.container' => [
'class' => 'Drupal\redis\Cache\RedisCacheTagsChecksum',
'arguments' => ['@redis.factory'],
],
'serialization.phpserialize' => [
'class' => 'Drupal\Component\Serialization\PhpSerialize',
],
],
];
}
if (getenv('PLATFORM_BRANCH')) {
// Configure private and temporary file paths.
if (!isset($settings['file_private_path'])) {
$settings['file_private_path'] = getenv('PLATFORM_APP_DIR') . '/private';
}
if (!isset($settings['file_temp_path'])) {
$settings['file_temp_path'] = getenv('PLATFORM_APP_DIR') . '/tmp';
}
// Configure the default PhpStorage and Twig template cache directories.
if (!isset($settings['php_storage']['default'])) {
$settings['php_storage']['default']['directory'] = $settings['file_private_path'];
}
if (!isset($settings['php_storage']['twig'])) {
$settings['php_storage']['twig']['directory'] = $settings['file_private_path'];
}
// Set the project-specific entropy value, used for generating one-time
// keys and such.
$settings['hash_salt'] = empty($settings['hash_salt']) ? getenv('PLATFORM_PROJECT_ENTROPY') : $settings['hash_salt'];
// Set the deployment identifier, which is used by some Drupal cache systems.
$settings['deployment_identifier'] = $settings['deployment_identifier'] ?? getenv('PLATFORM_TREE_ID');;
}
// The 'trusted_hosts_pattern' setting allows an admin to restrict the Host header values
// that are considered trusted. If an attacker sends a request with a custom-crafted Host
// header then it can be an injection vector, depending on how the Host header is used.
// However, Platform.sh already replaces the Host header with the route that was used to reach
// Platform.sh, so it is guaranteed to be safe. The following line explicitly allows all
// Host headers, as the only possible Host header is already guaranteed safe.
$settings['trusted_host_patterns'] = ['.*'];
config/sync
Create the config/sync
empty directory referenced in this settings file:
mkdir -p config/sync && touch config/sync/.gitkeep
Configuration reader
Install the helpful Config Reader library, which is required, and will help us to pull routing details for each environment into our settings (highlighted in the snippet in the next step).
composer require platformsh/config-reader
Drush
Lastly, we need to create some files referenced in .upsun/config.yaml
to configure Drush so it can be used within the Upsun container.
mkdir drush && touch drush/upsun_deploy_drupal.sh && touch drush/upsun_generate_drush_yml.php
Fill out the drush/upsun_deploy_drupal.sh
with the following:
#!/usr/bin/env bash
#
# We don't want to run drush commands if drupal isn't installed.
# Similarly, we don't want to attempt to run config-import if there aren't any config files to import
if [ -n "$(drush status --field=bootstrap)" ]; then
drush -y cache-rebuild
drush -y updatedb
if [ -n "$(ls $(drush php:eval "echo realpath(Drupal\Core\Site\Settings::get('config_sync_directory'));")/*.yml 2>/dev/null)" ]; then
drush -y config-import
else
echo "No config to import. Skipping."
fi
else
echo "Drupal not installed. Skipping standard Drupal deploy steps"
fi
This file runs Drush commands (cache-rebuild
and updatedb
) only when Drupal is installed. It also will only run config-import
if configuration YAMLs are present in the config_sync_directory
– config/sync
.
Change it’s permissions to run at deploy time:
chmod +x drush/upsun_deploy_drupal.sh
Then finally, fill out the Drush generator PHP file:
|
|
Deploy
Commit these new files, and push to the Upsun production environment:
git add . && git commit -m "Upsunify Drupal CMS" && upsun push -y
git add . && git commit -m "Upsunify Drupal 11" && upsun push -y
And success! At this point the Drupal site will be deployed on Upsun, ready for us to upload the settings/installation we have locally.
Syncing data
Click the dropdown showing your name in the upper right hand corner of the Upsun management console, and select the API Tokens option. Create and copy a new token. Then, using the DDEV CLI, update your global DDEV configuration (if you haven’t done so already) to connect with Upsun.
ddev config global --web-environment-add="UPSUN_CLI_TOKEN=XXXXXXXXXXXXXXXXXXXXX"
Then update the project’s DDEV configuration to match the Upsun project and environment:
|
|
Restart DDEV:
ddev restart
And push our local installation to the production environment:
ddev push upsun
Success!
Through these steps you will have successfully migrated either Drupal CMS or a skeleton Drupal 11 project, from scratch, to Upsun. Hopefully these steps provide you with enough context such that you can perform a custom migration with your own Drupal applications.
Be seeing you!