11name : setup-ddev-proj1
22type : php
33docroot : " "
4- php_version : " 8.0 "
4+ php_version : " 8.3 "
55webserver_type : nginx-fpm
66router_http_port : " 80"
77router_https_port : " 443"
88xdebug_enabled : false
99additional_hostnames : []
1010additional_fqdns : []
11- mariadb_version : " 10.2"
12- provider : default
11+ database :
12+ type : mariadb
13+ version : " 10.2"
1314use_dns_when_possible : true
15+ composer_version : " 2"
16+ web_environment : []
17+ corepack_enable : false
1418
15-
16- # This config.yaml was created with ddev version v1.14.2
17- # webimage: drud/ddev-webserver:v1.14.2
18- # dbimage: drud/ddev-dbserver-mariadb-10.2:v1.14.1
19- # dbaimage: phpmyadmin/phpmyadmin:5
20- # However we do not recommend explicitly wiring these images into the
21- # config.yaml as they may break future versions of ddev.
22- # You can update this config.yaml using 'ddev config'.
23-
24- # Key features of ddev's config.yaml:
19+ # Key features of DDEV's config.yaml:
2520
2621# name: <projectname> # Name of the project, automatically provides
2722# http://projectname.ddev.site and https://projectname.ddev.site
2823
29- # type: <projecttype> # drupal6/7/8, backdrop, typo3, wordpress, php
24+ # type: <projecttype> # backdrop, craftcms, django4, drupal, drupal6, drupal7, laravel, magento, magento2, php, python, shopware6, silverstripe, typo3, wordpress
25+ # See https://ddev.readthedocs.io/en/stable/users/quickstart/ for more
26+ # information on the different project types
27+ # "drupal" covers recent Drupal 8+
3028
3129# docroot: <relative_path> # Relative path to the directory containing index.php.
3230
33- # php_version: "7.3 " # PHP version to use, "5.6", "7.0", "7.1", "7.2", "7.3", "7.4"
31+ # php_version: "8.2 " # PHP version to use, "5.6", "7.0", "7.1", "7.2", "7.3", "7.4", "8.0", "8.1", "8.2", "8.3 "
3432
35- # You can explicitly specify the webimage, dbimage, dbaimage lines but this
36- # is not recommended, as the images are often closely tied to ddev 's' behavior,
33+ # You can explicitly specify the webimage but this
34+ # is not recommended, as the images are often closely tied to DDEV 's' behavior,
3735# so this can break upgrades.
3836
3937# webimage: <docker_image> # nginx/php docker image.
40- # dbimage: <docker_image> # mariadb docker image.
41- # dbaimage: <docker_image>
4238
43- # mariadb_version and mysql_version
44- # ddev can use many versions of mariadb and mysql
45- # However these directives are mutually exclusive
46- # mariadb_version: 10.2
47- # mysql_version: 8.0
39+ # database:
40+ # type: <dbtype> # mysql, mariadb, postgres
41+ # version: <version> # database version, like "10.11" or "8.0"
42+ # MariaDB versions can be 5.5- 10.8 and 10.11, MySQL versions can be 5.5-8.0
43+ # PostgreSQL versions can be 9-16.
4844
49- # router_http_port: <port> # Port to be used for http (defaults to port 80)
50- # router_https_port: <port> # Port for https (defaults to 443)
45+ # router_http_port: <port> # Port to be used for http (defaults to global configuration, usually 80)
46+ # router_https_port: <port> # Port for https (defaults to global configuration, usually 443)
47+
48+ # xdebug_enabled: false # Set to true to enable Xdebug and "ddev start" or "ddev restart"
49+ # Note that for most people the commands
50+ # "ddev xdebug" to enable Xdebug and "ddev xdebug off" to disable it work better,
51+ # as leaving Xdebug enabled all the time is a big performance hit.
5152
52- # xdebug_enabled : false # Set to true to enable xdebug and "ddev start" or "ddev restart"
53+ # xhprof_enabled : false # Set to true to enable Xhprof and "ddev start" or "ddev restart"
5354# Note that for most people the commands
54- # "ddev exec enable_xdebug" and "ddev exec disable_xdebug" work better,
55- # as leaving xdebug enabled all the time is a big performance hit.
55+ # "ddev xhprof" to enable Xhprof and "ddev xhprof off" to disable it work better,
56+ # as leaving Xhprof enabled all the time is a big performance hit.
5657
57- # webserver_type: nginx-fpm # Can be set to apache-fpm or apache-cgi as well
58+ # webserver_type: nginx-fpm, apache-fpm, or nginx-gunicorn
5859
5960# timezone: Europe/Berlin
6061# This is the timezone used in the containers and by PHP;
6162# it can be set to any valid timezone,
6263# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
6364# For example Europe/Dublin or MST7MDT
6465
66+ # composer_root: <relative_path>
67+ # Relative path to the Composer root directory from the project root. This is
68+ # the directory which contains the composer.json and where all Composer related
69+ # commands are executed.
70+
71+ # composer_version: "2"
72+ # You can set it to "" or "2" (default) for Composer v2 or "1" for Composer v1
73+ # to use the latest major version available at the time your container is built.
74+ # It is also possible to use each other Composer version channel. This includes:
75+ # - 2.2 (latest Composer LTS version)
76+ # - stable
77+ # - preview
78+ # - snapshot
79+ # Alternatively, an explicit Composer version may be specified, for example "2.2.18".
80+ # To reinstall Composer after the image was built, run "ddev debug refresh".
81+
82+ # nodejs_version: "20"
83+ # change from the default system Node.js version to any other version.
84+ # Numeric version numbers can be complete (i.e. 18.15.0) or
85+ # incomplete (18, 17.2, 16). 'lts' and 'latest' can be used as well along with
86+ # other named releases.
87+ # see https://www.npmjs.com/package/n#specifying-nodejs-versions
88+ # Note that you can continue using 'ddev nvm' or nvm inside the web container
89+ # to change the project's installed node version if you need to.
90+
91+ # corepack_enable: false
92+ # Change to 'true' to 'corepack enable' and gain access to latest versions of yarn/pnpm
93+
6594# additional_hostnames:
6695# - somename
6796# - someothername
@@ -74,8 +103,26 @@ use_dns_when_possible: true
74103# would provide http and https URLs for "example.com" and "sub1.example.com"
75104# Please take care with this because it can cause great confusion.
76105
77- # upload_dir: custom/upload/dir
78- # would set the destination path for ddev import-files to custom/upload/dir.
106+ # upload_dirs: "custom/upload/dir"
107+ #
108+ # upload_dirs:
109+ # - custom/upload/dir
110+ # - ../private
111+ #
112+ # would set the destination paths for ddev import-files to <docroot>/custom/upload/dir
113+ # When Mutagen is enabled this path is bind-mounted so that all the files
114+ # in the upload_dirs don't have to be synced into Mutagen.
115+
116+ # disable_upload_dirs_warning: false
117+ # If true, turns off the normal warning that says
118+ # "You have Mutagen enabled and your 'php' project type doesn't have upload_dirs set"
119+
120+ # ddev_version_constraint: ""
121+ # Example:
122+ # ddev_version_constraint: ">= 1.22.4"
123+ # This will enforce that the running ddev version is within this constraint.
124+ # See https://github.com/Masterminds/semver#checking-version-constraints for
125+ # supported constraint formats
79126
80127# working_dir:
81128# web: /var/www/html
@@ -84,15 +131,28 @@ use_dns_when_possible: true
84131# These values specify the destination directory for ddev ssh and the
85132# directory in which commands passed into ddev exec are run.
86133
87- # omit_containers: ["db", dba", " ddev-ssh-agent" ]
134+ # omit_containers: [db, ddev-ssh-agent]
88135# Currently only these containers are supported. Some containers can also be
89136# omitted globally in the ~/.ddev/global_config.yaml. Note that if you omit
90- # the "db" container, several standard features of ddev that access the
91- # database container will be unusable.
137+ # the "db" container, several standard features of DDEV that access the
138+ # database container will be unusable. In the global configuration it is also
139+ # possible to omit ddev-router, but not here.
140+
141+ # performance_mode: "global"
142+ # DDEV offers performance optimization strategies to improve the filesystem
143+ # performance depending on your host system. Should be configured globally.
144+ #
145+ # If set, will override the global config. Possible values are:
146+ # - "global": uses the value from the global config.
147+ # - "none": disables performance optimization for this project.
148+ # - "mutagen": enables Mutagen for this project.
149+ # - "nfs": enables NFS for this project.
150+ #
151+ # See https://ddev.readthedocs.io/en/stable/users/install/performance/#nfs
152+ # See https://ddev.readthedocs.io/en/stable/users/install/performance/#mutagen
92153
93- # nfs_mount_enabled: false
94- # Great performance improvement but requires host configuration first.
95- # See https://ddev.readthedocs.io/en/stable/users/performance/#using-nfs-to-mount-the-project-into-the-container
154+ # fail_on_hook_fail: False
155+ # Decide whether 'ddev start' should be interrupted by a failing hook
96156
97157# host_https_port: "59002"
98158# The host port binding for https can be explicitly specified. It is
@@ -110,15 +170,15 @@ use_dns_when_possible: true
110170# The host port binding for the ddev-dbserver can be explicitly specified. It is dynamic
111171# unless explicitly specified.
112172
113- # phpmyadmin_port : "8036 "
114- # phpmyadmin_https_port : "8037 "
115- # The PHPMyAdmin ports can be changed from the default 8036 and 8037
173+ # mailpit_http_port : "8025 "
174+ # mailpit_https_port : "8026 "
175+ # The Mailpit ports can be changed from the default 8025 and 8026
116176
117- # mailhog_port : "8025"
118- # mailhog_https_port: "8026"
119- # The MailHog ports can be changed from the default 8025 and 8026
177+ # host_mailpit_port : "8025"
178+ # The mailpit port is not normally bound on the host at all, instead being routed
179+ # through ddev-router, but it can be bound directly to localhost if specified here.
120180
121- # webimage_extra_packages: [php-yaml, php7.3-ldap ]
181+ # webimage_extra_packages: [php7.4-tidy, php-bcmath ]
122182# Extra Debian packages that are needed in the webimage can be added here
123183
124184# dbimage_extra_packages: [telnet,netcat]
@@ -136,27 +196,87 @@ use_dns_when_possible: true
136196# If you prefer you can change this to "ddev.local" to preserve
137197# pre-v1.9 behavior.
138198
139- # ngrok_args: --subdomain mysite -- auth username:pass
199+ # ngrok_args: --basic- auth username:pass1234
140200# Provide extra flags to the "ngrok http" command, see
141- # https://ngrok.com/docs#http or run "ngrok http -h"
201+ # https://ngrok.com/docs/ngrok-agent/config or run "ngrok http -h"
142202
143203# disable_settings_management: false
144- # If true, ddev will not create CMS-specific settings files like
145- # Drupal's settings.php/settings.ddev.php or TYPO3's AdditionalSettings .php
204+ # If true, DDEV will not create CMS-specific settings files like
205+ # Drupal's settings.php/settings.ddev.php or TYPO3's AdditionalConfiguration .php
146206# In this case the user must provide all such settings.
147207
208+ # You can inject environment variables into the web container with:
209+ # web_environment:
210+ # - SOMEENV=somevalue
211+ # - SOMEOTHERENV=someothervalue
212+
148213# no_project_mount: false
149- # (Experimental) If true, ddev will not mount the project into the web container;
214+ # (Experimental) If true, DDEV will not mount the project into the web container;
150215# the user is responsible for mounting it manually or via a script.
151- # This is to enable experimentation with alternate file mounting strategies.
216+ # This is to enable experimentation with alternate file mounting strategies.
152217# For advanced users only!
153218
154- # provider: default # Currently either "default" or "pantheon"
219+ # bind_all_interfaces: false
220+ # If true, host ports will be bound on all network interfaces,
221+ # not the localhost interface only. This means that ports
222+ # will be available on the local network if the host firewall
223+ # allows it.
224+
225+ # default_container_timeout: 120
226+ # The default time that DDEV waits for all containers to become ready can be increased from
227+ # the default 120. This helps in importing huge databases, for example.
228+
229+ # web_extra_exposed_ports:
230+ # - name: nodejs
231+ # container_port: 3000
232+ # http_port: 2999
233+ # https_port: 3000
234+ # - name: something
235+ # container_port: 4000
236+ # https_port: 4000
237+ # http_port: 3999
238+ # Allows a set of extra ports to be exposed via ddev-router
239+ # Fill in all three fields even if you don’t intend to use the https_port!
240+ # If you don’t add https_port, then it defaults to 0 and ddev-router will fail to start.
155241#
156- # Many ddev commands can be extended to run tasks before or after the
157- # ddev command is executed, for example "post-start", "post-import-db",
242+ # The port behavior on the ddev-webserver must be arranged separately, for example
243+ # using web_extra_daemons.
244+ # For example, with a web app on port 3000 inside the container, this config would
245+ # expose that web app on https://<project>.ddev.site:9999 and http://<project>.ddev.site:9998
246+ # web_extra_exposed_ports:
247+ # - name: myapp
248+ # container_port: 3000
249+ # http_port: 9998
250+ # https_port: 9999
251+
252+ # web_extra_daemons:
253+ # - name: "http-1"
254+ # command: "/var/www/html/node_modules/.bin/http-server -p 3000"
255+ # directory: /var/www/html
256+ # - name: "http-2"
257+ # command: "/var/www/html/node_modules/.bin/http-server /var/www/html/sub -p 3000"
258+ # directory: /var/www/html
259+
260+ # override_config: false
261+ # By default, config.*.yaml files are *merged* into the configuration
262+ # But this means that some things can't be overridden
263+ # For example, if you have 'use_dns_when_possible: true'' you can't override it with a merge
264+ # and you can't erase existing hooks or all environment variables.
265+ # However, with "override_config: true" in a particular config.*.yaml file,
266+ # 'use_dns_when_possible: false' can override the existing values, and
267+ # hooks:
268+ # post-start: []
269+ # or
270+ # web_environment: []
271+ # or
272+ # additional_hostnames: []
273+ # can have their intended affect. 'override_config' affects only behavior of the
274+ # config.*.yaml file it exists in.
275+
276+ # Many DDEV commands can be extended to run tasks before or after the
277+ # DDEV command is executed, for example "post-start", "post-import-db",
158278# "pre-composer", "post-composer"
159- # See https://ddev.readthedocs.io/en/stable/users/extending -commands/ for more
279+ # See https://ddev.readthedocs.io/en/stable/users/extend/custom -commands/ for more
160280# information on the commands that can be extended and the tasks you can define
161281# for them. Example:
162282# hooks:
0 commit comments