ddev-project
DDEV project configuration file
| 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
Schema for DDEV project's config.yaml
Properties
List of FQDNs for the project.
List of hostnames for the project.
Bind host ports on all interfaces, not only on the localhost network interface.
The relative path, from the project root, to the directory containing composer.json. (This is where all Composer-related commands are executed.)
Composer version for the web container and the ddev composer command.
Whether to run "corepack enable" on Node.js configuration.
Specify the database type and version to use.
2 nested properties
Specify the database type to use.
Specify the database version to use.
List of Debian packages that should be added to db container when the project is started.
Validate that ddev version being used is valid within this constraint.
Seconds DDEV will wait for all containers to become ready.
Prevent ddev from creating or updating CMS settings files.
Whether to disable the standard warning issued when a project is using performance_mode: mutagen but upload_dirs is not configured.
Provide the relative docroot of the project, like 'docroot' or 'htdocs' or 'web', defaults to empty, the current directory.
Decide whether 'ddev start' should be interrupted by a failing hook.
Run tasks before or after main DDEV commands are executed.
28 nested properties
The db container's localhost-bound port.
The web container's localhost-bound https port.
XHGui localhost-bound port.
Mailpit localhost-bound port.
The web container's localhost-bound port.
Router port to be used for Mailpit HTTP access.
Router port to be used for Mailpit HTTPS access.
Provide the name of the project to configure (normally the same as the last part of directory name).
(Deprecated) Use share_provider_args instead, provide extra args to ngrok in "ddev share".
Whether to skip mounting project into web container.
Node.js version for the web container's "system" version.
A list of container types that should not be started when the project is started.
Whether to override config values instead of merging.
Define the performance optimization mode to be used. Currently Mutagen asynchronous caching is supported. Mutagen is enabled by default on Mac and Windows.
The PHP version the project should use.
Set the top-level domain to be used for projects, defaults to ddev.site (default "ddev.site").
Router HTTP port for this project.
Router HTTPS port for this project.
Specify timezone for containers and PHP. If unset, DDEV will attempt to derive it from the host system timezone.
Provide the project type.
Set multiple project upload directories, the first is taken as the destination directory of the "ddev import-files" command.
Use DNS for hostname resolution instead of /etc/hosts when possible.
Add environment variables to the web container.
Additional daemons that should automatically be started in the web container.
Additional named sets of ports to expose via ddev-router.
Set the web container image.
List of Debian packages that should be added to web container when the project is started.
Set the project's desired webserver type.
Override default project working directories for db and web service.
2 nested properties
Override the default working directory for the web service.
Override the default working directory for the db service.
Whether Xdebug is enabled in the web container.
Router port to be used for XHGui HTTP access.
Router port to be used for XHGui HTTPS access.
Define the XHProf usage mode used by the project.