Skip to content

Create seperate dnsmasq configs for every site or proxy #1536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Create seperate dnsmasq configs for every site or proxy #1536

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2305ee2
create seperate dnsmasq configs for every site or proxy
Oct 28, 2025
fab091a
move "test_unlink_removes_dnsmasq_host_config" so it can mutate the d…
Oct 28, 2025
d46e984
translate german comments to english
Oct 29, 2025
3fad06b
add tld param to link and proxy command that creates specific dnsmasq…
Oct 30, 2025
45d0617
fix failing tests after adding tld param to proxy and link command
Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 89 additions & 16 deletions cli/Valet/DnsMasq.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@

class DnsMasq
{
public $dnsmasqMasterConfigFile = BREW_PREFIX.'/etc/dnsmasq.conf';
public $dnsmasqMasterConfigFile = BREW_PREFIX . '/etc/dnsmasq.conf';

public $dnsmasqSystemConfDir = BREW_PREFIX.'/etc/dnsmasq.d';
public $dnsmasqSystemConfDir = BREW_PREFIX . '/etc/dnsmasq.d';

public $resolverPath = '/etc/resolver';

public function __construct(public Brew $brew, public CommandLine $cli, public Filesystem $files, public Configuration $configuration) {}
public function __construct(public Brew $brew, public CommandLine $cli, public Filesystem $files, public Configuration $configuration)
{
}

/**
* Install and configure DnsMasq.
Expand All @@ -30,7 +32,7 @@ public function install(string $tld = 'test'): void

$this->brew->restartService('dnsmasq');

info('Valet is configured to serve for TLD [.'.$tld.']');
info('Valet is configured to serve for TLD [.' . $tld . ']');
}

/**
Expand All @@ -40,13 +42,13 @@ public function uninstall(): void
{
$this->brew->stopService('dnsmasq');
$this->brew->uninstallFormula('dnsmasq');
$this->cli->run('rm -rf '.BREW_PREFIX.'/etc/dnsmasq.d/dnsmasq-valet.conf');
$this->cli->run('rm -rf ' . BREW_PREFIX . '/etc/dnsmasq.d/dnsmasq-valet.conf');

// As Laravel Herd uses the same DnsMasq resolver, we should only
// delete it if Herd is not installed.
if (! $this->files->exists('/Applications/Herd.app')) {
if (!$this->files->exists('/Applications/Herd.app')) {
$tld = $this->configuration->read()['tld'];
$this->files->unlink($this->resolverPath.'/'.$tld);
$this->files->unlink($this->resolverPath . '/' . $tld);
}
}

Expand Down Expand Up @@ -76,10 +78,10 @@ public function ensureUsingDnsmasqDForConfigs(): void
// set primary config to look for configs in /usr/local/etc/dnsmasq.d/*.conf
$contents = $this->files->get($this->dnsmasqMasterConfigFile);
// ensure the line we need to use is present, and uncomment it if needed
if (strpos($contents, 'conf-dir='.BREW_PREFIX.'/etc/dnsmasq.d/,*.conf') === false) {
$contents .= PHP_EOL.'conf-dir='.BREW_PREFIX.'/etc/dnsmasq.d/,*.conf'.PHP_EOL;
if (strpos($contents, 'conf-dir=' . BREW_PREFIX . '/etc/dnsmasq.d/,*.conf') === false) {
$contents .= PHP_EOL . 'conf-dir=' . BREW_PREFIX . '/etc/dnsmasq.d/,*.conf' . PHP_EOL;
}
$contents = str_replace('#conf-dir='.BREW_PREFIX.'/etc/dnsmasq.d/,*.conf', 'conf-dir='.BREW_PREFIX.'/etc/dnsmasq.d/,*.conf', $contents);
$contents = str_replace('#conf-dir=' . BREW_PREFIX . '/etc/dnsmasq.d/,*.conf', 'conf-dir=' . BREW_PREFIX . '/etc/dnsmasq.d/,*.conf', $contents);

// remove entries used by older Valet versions:
$contents = preg_replace('/^conf-file.*valet.*$/m', '', $contents);
Expand All @@ -88,17 +90,17 @@ public function ensureUsingDnsmasqDForConfigs(): void
$this->files->put($this->dnsmasqMasterConfigFile, $contents);

// remove old ~/.config/valet/dnsmasq.conf file because things are moved to the ~/.config/valet/dnsmasq.d/ folder now
if (file_exists($file = dirname($this->dnsmasqUserConfigDir()).'/dnsmasq.conf')) {
if (file_exists($file = dirname($this->dnsmasqUserConfigDir()) . '/dnsmasq.conf')) {
unlink($file);
}

// add a valet-specific config file to point to user's home directory valet config
$contents = $this->files->getStub('etc-dnsmasq-valet.conf');
$contents = str_replace('VALET_HOME_PATH', VALET_HOME_PATH, $contents);
$this->files->ensureDirExists($this->dnsmasqSystemConfDir, user());
$this->files->putAsUser($this->dnsmasqSystemConfDir.'/dnsmasq-valet.conf', $contents);
$this->files->putAsUser($this->dnsmasqSystemConfDir . '/dnsmasq-valet.conf', $contents);

$this->files->ensureDirExists(VALET_HOME_PATH.'/dnsmasq.d', user());
$this->files->ensureDirExists(VALET_HOME_PATH . '/dnsmasq.d', user());
}

/**
Expand All @@ -112,6 +114,38 @@ public function createDnsmasqTldConfigFile(string $tld): void
$this->files->putAsUser($tldConfigFile, 'address=/.'.$tld.'/'.$loopback.PHP_EOL.'listen-address='.$loopback.PHP_EOL);
}

/**
* Create host-specific dnsmasq config (address=/fqdn/loopback).
*/
public function createHostConfig(string $fqdn): void
{
$dir = $this->dnsmasqUserConfigDir();
$this->files->ensureDirExists($dir, user());
$loopback = $this->configuration->read()['loopback'];
$file = $dir . 'host-' . $fqdn . '.conf';
$contents = 'address=/' . $fqdn . '/' . $loopback . PHP_EOL . 'listen-address=' . $loopback . PHP_EOL;
$this->files->putAsUser($file, $contents);
}

/**
* Remove host-specific dnsmasq config.
*/
public function deleteHostConfig(string $fqdn): void
{
$file = $this->dnsmasqUserConfigDir() . 'host-' . $fqdn . '.conf';
if ($this->files->exists($file)) {
$this->files->unlink($file);
}
}

/**
* Restart dnsmasq (after changes to *.conf).
*/
public function reload(): void
{
$this->brew->restartService('dnsmasq');
}

/**
* Create the resolver file to point the configured TLD to configured loopback address.
*/
Expand All @@ -120,7 +154,7 @@ public function createTldResolver(string $tld): void
$this->files->ensureDirExists($this->resolverPath);
$loopback = $this->configuration->read()['loopback'];

$this->files->put($this->resolverPath.'/'.$tld, 'nameserver '.$loopback.PHP_EOL);
$this->files->put($this->resolverPath . '/' . $tld, 'nameserver ' . $loopback . PHP_EOL);
}

/**
Expand All @@ -131,7 +165,7 @@ public function updateTld(string $oldTld, string $newTld): void
$this->files->unlink($this->resolverPath.'/'.$oldTld);
$this->files->unlink($this->dnsmasqUserConfigDir().'tld-'.$oldTld.'.conf');

$this->install($newTld);
$this->reload();
}

/**
Expand All @@ -149,6 +183,45 @@ public function refreshConfiguration(): void
*/
public function dnsmasqUserConfigDir(): string
{
return $_SERVER['HOME'].'/.config/valet/dnsmasq.d/';
return $_SERVER['HOME'] . '/.config/valet/dnsmasq.d/';
}

/**
* Return all existing host entries for a given base name (without TLD),
* as "<name>.<tld>" strings, e.g. ["example.dev", "example.test"].
*
* It looks for files matching: host-<name>.*.conf in the dnsmasq user config dir.
*
* @param string $name Base host name without TLD (e.g. "example")
* @return array<string> List of "<name>.<tld>" strings (unique, naturally sorted)
*/
public function listSitesWithTld(string $name): array
{
// Normalize to lowercase to match how Valet typically writes FQDNs
$base = strtolower($name);

// Ensure we have a trailing slash
$dir = rtrim($this->dnsmasqUserConfigDir(), '/').'/';

// Pattern for files like: host-example.dev.conf, host-example.test.conf, ...
$pattern = $dir . 'host-' . $base . '.*.conf';

// glob() returns an array of paths or an empty array if none
$matches = glob($pattern, GLOB_NOSORT) ?: [];

$out = [];
foreach ($matches as $path) {
$filename = basename($path); // e.g. "host-example.dev.conf"

// Extract between "host-" and ".conf" -> "example.dev"
if (preg_match('/^host-(.+)\.conf$/i', $filename, $m)) {
$out[] = $m[1];
}
}

// Ensure uniqueness and natural case-insensitive sort for stable output
$out = array_values(array_unique($out, SORT_STRING));
natcasesort($out);
return array_values($out);
}
}
Loading