Routing for Drupal multisite

[lpeabody]

Use Case

My use case for this feature is supporting Drupal multisite. For example, I have a project name of my-drupal-project. I want my-drupal-project.ddev.site to go to the default Drupal site, and other-site-my-drupal-project.ddev.site to go to the other_site Drupal site.

Related info

I like to setup my DDEV projects so the name configuration value is not set directly in a YAML file. So, it is dynamically determined based on the name of the directory the DDEV project sits in. This allows me to simultaneously run the same project side by side on the same host simply by dropping the same codebase into different directories.

Possible approach

In the use case given, the project name is my-drupal-project. DDEV takes this and uses it to calculate the reverse proxy routing rules. To satisfy the use case, I would like DDEV to set the rule such that my-drupal-project.ddev.site is matched as well as other-site-my-drupal-project.ddev.site. Looking at the project's generated Traefik config file, the rule looks like the following:

rule: HostRegexp(`^my-drupal-project\.ddev\.site$`)

an alternative to this that would satisfy my requirement would be to simply remove the opening caret:

rule: HostRegexp(`my-drupal-project\.ddev\.site$`)

Maybe a boolean configuration flag could be introduced for enabling or disabling the incorporation of the caret? Something like...

enable_open_host_prefixes: true

...where a false value prefixes the regex rule with a caret, and true omits the caret. Default would be false for backwards compatibility reasons.

[rfay]

Drupal's primary routing technique is often via the hostname.

You already know that you can configure multiple hostnames, right, with additional_hostnames and additional_fqdns ?

And you already know that you can omit the hostname from a project's config.yaml and it will use the directory name?

And you already know about the classic setup for drupal multisite in https://github.com/ddev/ddev-contrib/tree/master/recipes/drupal8-multisite ?

It's not clear to me how your needs aren't already met by additional_hostnames and a possible sites.php file. Please continue the conversation!

[lpeabody]

I think the wrapper script approach is reasonable since we're basically swapping out the use of ddev start directly. With the sites.php snippet I included in a previous response, this wrapper script ddev multisite-start seems to do the trick:

#!/usr/bin/env bash

# Define the directory to search
directory="$DDEV_DOCROOT/sites"

# Find directories excluding 'settings' and 'default'
hostnames=$(find "$directory" -maxdepth 1 -mindepth 1 -type d ! -name 'settings' ! -name 'default' -exec basename {} \; | sed 's/_/-/g')

# Create the YAML file
cat > .ddev/config.multisite_hosts.yaml <<EOL
additional_hostnames:
$(for hostname in $hostnames; do echo "  - $hostname-$DDEV_SITENAME"; done)
EOL

ddev start "$@"

Not perfect, but it works. Could probably roll this into an addon to be used when wanting to have directory-based hostnames for URLs. Thanks for the inspiration @rfay!

[rfay]

Since you seem to be an expert with multisite, please consider a guest blog for ddev.com in this territory. That ddev_contrib article is so old and untended... It's super easy, just markdown. Thanks!

[lpeabody]

please consider a guest blog for ddev.com in this territory.

I will! Thank you for the invitation. I'm at DrupalCon next week so I could do this then.

I went ahead and started a simple addon, available at https://github.com/lpeabody/ddev-drupal-multisite-hostnames. It is strictly meant to generate DDEV hostnames for multisite directories and including the information in sites.php. Seems to work well enough.

[penyaskito]

My use case for this feature is supporting Drupal multisite. For example, I have a project name of my-drupal-project. I want my-drupal-project.ddev.site to go to the default Drupal site, and other-site-my-drupal-project.ddev.site to go to the other_site Drupal site.

Why not just having one project (one instance of your code)?

If you want having separate codebases, don't define additional hostnames.
If you want having a multisite define the routing in sites.php

I'm failing to understand what you trying to achieve.

[lpeabody]

I explained my use case earlier on, you can read about it further up in the conversation.