Type object
File match **/.ddev/config*.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/ddev-project/latest.json
Source https://raw.githubusercontent.com/ddev/ddev/master/pkg/ddevapp/schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Schema for DDEV project's config.yaml

Properties

additional_fqdns string[]

List of FQDNs for the project.

uniqueItems=true
additional_hostnames string[]

List of hostnames for the project.

uniqueItems=true
bind_all_interfaces boolean

Bind host ports on all interfaces, not only on the localhost network interface.

composer_root string

The relative path, from the project root, to the directory containing composer.json. (This is where all Composer-related commands are executed.)

composer_version string

Composer version for the web container and the ddev composer command.

Any of: string string, string string
corepack_enable boolean

Whether to run "corepack enable" on Node.js configuration.

database object

Specify the database type and version to use.

2 nested properties
type string

Specify the database type to use.

Values: "mariadb" "mysql" "postgres"
version string

Specify the database version to use.

dbimage_extra_packages string[]

List of Debian packages that should be added to db container when the project is started.

uniqueItems=true
ddev_version_constraint string

Validate that ddev version being used is valid within this constraint.

default_container_timeout integer | string

Seconds DDEV will wait for all containers to become ready.

Any of: integer | string integer | string, integer | string integer | string
disable_settings_management boolean

Prevent ddev from creating or updating CMS settings files.

disable_upload_dirs_warning boolean

Whether to disable the standard warning issued when a project is using performance_mode: mutagen but upload_dirs is not configured.

docroot string

Provide the relative docroot of the project, like 'docroot' or 'htdocs' or 'web', defaults to empty, the current directory.

fail_on_hook_fail boolean

Decide whether 'ddev start' should be interrupted by a failing hook.

hooks object

Run tasks before or after main DDEV commands are executed.

28 nested properties
pre-start object[]
post-start object[]
pre-import-db object[]
post-import-db object[]
pre-import-files object[]
post-import-files object[]
pre-composer object[]
post-composer object[]
pre-stop object[]
pre-config object[]
post-config object[]
pre-exec object[]
post-exec object[]
pre-pause object[]
post-pause object[]
pre-pull object[]
post-pull object[]
pre-push object[]
post-push object[]
pre-share object[]
post-share object[]
pre-snapshot object[]
post-snapshot object[]
pre-delete-snapshot object[]
post-delete-snapshot object[]
pre-restore-snapshot object[]
post-restore-snapshot object[]
post-stop object[]
host_db_port string

The db container's localhost-bound port.

host_https_port string

The web container's localhost-bound https port.

host_xhgui_port string

XHGui localhost-bound port.

host_mailpit_port string

Mailpit localhost-bound port.

host_webserver_port string

The web container's localhost-bound port.

mailpit_http_port string

Router port to be used for Mailpit HTTP access.

Any of: string string, string string
mailpit_https_port string

Router port to be used for Mailpit HTTPS access.

Any of: string string, string string
name string

Provide the name of the project to configure (normally the same as the last part of directory name).

ngrok_args string

(Deprecated) Use share_provider_args instead, provide extra args to ngrok in "ddev share".

no_project_mount boolean

Whether to skip mounting project into web container.

nodejs_version string

Node.js version for the web container's "system" version.

Any of: string string, string string
omit_containers string[]

A list of container types that should not be started when the project is started.

uniqueItems=true
override_config boolean

Whether to override config values instead of merging.

performance_mode string

Define the performance optimization mode to be used. Currently Mutagen asynchronous caching is supported. Mutagen is enabled by default on Mac and Windows.

Values: "global" "none" "mutagen"
php_version string

The PHP version the project should use.

Values: "5.6" "7.0" "7.1" "7.2" "7.3" "7.4" "8.0" "8.1" "8.2" "8.3" "8.4" "8.5"
project_tld string

Set the top-level domain to be used for projects, defaults to ddev.site (default "ddev.site").

Any of: string string, string string
router_http_port string

Router HTTP port for this project.

Any of: string string, string string
router_https_port string

Router HTTPS port for this project.

Any of: string string, string string
share_default_provider string

Default share provider for the project. Overrides global configuration.

Any of: string string, string string
share_provider_args string

Arguments to pass to the share provider when starting a share session.

timezone string

Specify timezone for containers and PHP. If unset, DDEV will attempt to derive it from the host system timezone.

type string

Provide the project type.

Values: "backdrop" "cakephp" "codeigniter" "craftcms" "drupal" "drupal6" "drupal7" "drupal8" "drupal9" "drupal10" "drupal11" "drupal12" "generic" "laravel" "magento" "magento2" "php" "shopware6" "silverstripe" "symfony" "typo3" "wordpress"
upload_dirs string[]

Set multiple project upload directories, the first is taken as the destination directory of the "ddev import-files" command.

uniqueItems=true
use_dns_when_possible boolean

Use DNS for hostname resolution instead of /etc/hosts when possible.

web_environment string[]

Add environment variables to the web container.

uniqueItems=true
web_extra_daemons object[]

Additional daemons that should automatically be started in the web container.

web_extra_exposed_ports object[]

Additional named sets of ports to expose via ddev-router.

webimage string

Set the web container image.

webimage_extra_packages string[]

List of Debian packages that should be added to web container when the project is started.

uniqueItems=true
webserver_type string

Set the project's desired webserver type.

Values: "nginx-fpm" "apache-fpm" "generic"
working_dir object

Override default project working directories for db and web service.

2 nested properties
web string

Override the default working directory for the web service.

db string

Override the default working directory for the db service.

xdebug_enabled boolean

Whether Xdebug is enabled in the web container.

xhgui_http_port string

Router port to be used for XHGui HTTP access.

Any of: string string, string string
xhgui_https_port string

Router port to be used for XHGui HTTPS access.

Any of: string string, string string
xhprof_mode string

Define the XHProf usage mode used by the project.

Values: "global" "prepend" "xhgui"

Definitions

DdevTask object[]