Method ValidateConfig

pkg/ddevapp/config.go:498–621

ValidateConfig ensures the configuration meets ddev's requirements.

()

// ValidateConfig ensures the configuration meets ddev's requirements.
func (app *DdevApp) ValidateConfig() error {
	// Skip project validation on request.
	if !RunValidateConfig {
		return nil
	}

	// Validate ddev version constraint, if any
	if app.DdevVersionConstraint != "" {
		err := CheckDdevVersionConstraint(app.DdevVersionConstraint, fmt.Sprintf("unable to start the '%s' project", app.Name), "or update the `ddev_version_constraint` in your .ddev/config.yaml file")
		if err != nil {
			return err
		}
	}

	// Validate project name
	if err := ValidateProjectName(app.Name); err != nil {
		return err
	}

	// Validate docroot
	if err := ValidateDocroot(app.Docroot); err != nil {
		return err
	}

	// Skip any validation below this check if there is nothing to validate
	if err := CheckForMissingProjectFiles(app); err != nil {
		// Do not return an error here because not all DDEV commands should be stopped by this check
		// It matters when you start a project, but not when you stop or delete it
		// This check is reused elsewhere where appropriate
		return nil
	}

	// Validate hostnames
	for _, hn := range app.GetHostnames() {
		// If they have provided "*.<hostname>" then ignore the *. part.
		hn = strings.TrimPrefix(hn, "*.")
		if hn == nodeps.DdevDefaultTLD {
			return fmt.Errorf("wildcarding the full hostname\nor using 'ddev.site' as FQDN for the project %s is not allowed\nbecause other projects would not work in that case", app.Name)
		}
		if !hostRegex.MatchString(hn) {
			return fmt.Errorf("the %s project has an invalid hostname: '%s', see https://en.wikipedia.org/wiki/Hostname#Syntax for valid hostname requirements", app.Name, hn).(invalidHostname)
		}
	}

	// Validate apptype
	if !IsValidAppType(app.Type) {
		return fmt.Errorf("the %s project has an invalid app type: %s", app.Name, app.Type).(invalidAppType)
	}

	// Validate PHP version
	if !nodeps.IsValidPHPVersion(app.PHPVersion) {
		return fmt.Errorf("the %s project has an unsupported PHP version: %s, DDEV only supports the following versions: %v", app.Name, app.PHPVersion, nodeps.GetValidPHPVersions()).(invalidPHPVersion)
	}

	// Validate webserver type
	if !nodeps.IsValidWebserverType(app.WebserverType) {
		return fmt.Errorf("the %s project has an unsupported webserver type: %s, DDEV (%s) only supports the following webserver types: %s", app.Name, app.WebserverType, runtime.GOARCH, nodeps.GetValidWebserverTypes()).(invalidWebserverType)
	}