github.com/drud/ddev@v1.21.5-alpha1.0.20230226034409-94fcc4b94453/pkg/ddevapp/templates.go (about) 1 package ddevapp 2 3 // ConfigInstructions is used to add example hooks usage 4 const ConfigInstructions = ` 5 # Key features of ddev's config.yaml: 6 7 # name: <projectname> # Name of the project, automatically provides 8 # http://projectname.ddev.site and https://projectname.ddev.site 9 10 # type: <projecttype> # drupal6/7/8, backdrop, typo3, wordpress, php 11 12 # docroot: <relative_path> # Relative path to the directory containing index.php. 13 14 # php_version: "7.4" # PHP version to use, "5.6", "7.0", "7.1", "7.2", "7.3", "7.4", "8.0", "8.1", "8.2" 15 16 # You can explicitly specify the webimage but this 17 # is not recommended, as the images are often closely tied to ddev's' behavior, 18 # so this can break upgrades. 19 20 # webimage: <docker_image> # nginx/php docker image. 21 22 # database: 23 # type: <dbtype> # mysql, mariadb 24 # version: <version> # database version, like "10.3" or "8.0" 25 # Note that mariadb_version or mysql_version from v1.18 and earlier 26 # will automatically be converted to this notation with just a "ddev config --auto" 27 28 # router_http_port: <port> # Port to be used for http (defaults to port 80) 29 # router_https_port: <port> # Port for https (defaults to 443) 30 31 # xdebug_enabled: false # Set to true to enable xdebug and "ddev start" or "ddev restart" 32 # Note that for most people the commands 33 # "ddev xdebug" to enable xdebug and "ddev xdebug off" to disable it work better, 34 # as leaving xdebug enabled all the time is a big performance hit. 35 36 # xhprof_enabled: false # Set to true to enable xhprof and "ddev start" or "ddev restart" 37 # Note that for most people the commands 38 # "ddev xhprof" to enable xhprof and "ddev xhprof off" to disable it work better, 39 # as leaving xhprof enabled all the time is a big performance hit. 40 41 # webserver_type: nginx-fpm # or apache-fpm 42 43 # timezone: Europe/Berlin 44 # This is the timezone used in the containers and by PHP; 45 # it can be set to any valid timezone, 46 # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones 47 # For example Europe/Dublin or MST7MDT 48 49 # composer_root: <relative_path> 50 # Relative path to the composer root directory from the project root. This is 51 # the directory which contains the composer.json and where all Composer related 52 # commands are executed. 53 54 # composer_version: "2" 55 # You can set it to "" or "2" (default) for Composer v2 or "1" for Composer v1 56 # to use the latest major version available at the time your container is built. 57 # It is also possible to use each other Composer version channel. This includes: 58 # - 2.2 (latest Composer LTS version) 59 # - stable 60 # - preview 61 # - snapshot 62 # Alternatively, an explicit Composer version may be specified, for example "2.2.18". 63 # To reinstall Composer after the image was built, run "ddev debug refresh". 64 65 # nodejs_version: "16" 66 # change from the default system Node.js version to another supported version, like 12, 14, 17, 18. 67 # Note that you can use 'ddev nvm' or nvm inside the web container to provide nearly any 68 # Node.js version, including v6, etc. 69 70 # additional_hostnames: 71 # - somename 72 # - someothername 73 # would provide http and https URLs for "somename.ddev.site" 74 # and "someothername.ddev.site". 75 76 # additional_fqdns: 77 # - example.com 78 # - sub1.example.com 79 # would provide http and https URLs for "example.com" and "sub1.example.com" 80 # Please take care with this because it can cause great confusion. 81 82 # upload_dir: custom/upload/dir 83 # would set the destination path for ddev import-files to <docroot>/custom/upload/dir 84 # When mutagen is enabled this path is bind-mounted so that all the files 85 # in the upload_dir don't have to be synced into mutagen 86 87 # working_dir: 88 # web: /var/www/html 89 # db: /home 90 # would set the default working directory for the web and db services. 91 # These values specify the destination directory for ddev ssh and the 92 # directory in which commands passed into ddev exec are run. 93 94 # omit_containers: [db, dba, ddev-ssh-agent] 95 # Currently only these containers are supported. Some containers can also be 96 # omitted globally in the ~/.ddev/global_config.yaml. Note that if you omit 97 # the "db" container, several standard features of ddev that access the 98 # database container will be unusable. In the global configuration it is also 99 # possible to omit ddev-router, but not here. 100 101 # nfs_mount_enabled: false 102 # Great performance improvement but requires host configuration first. 103 # See https://ddev.readthedocs.io/en/latest/users/install/performance/#nfs 104 105 # mutagen_enabled: false 106 # Performance improvement using mutagen asynchronous updates. 107 # See https://ddev.readthedocs.io/en/latest/users/install/performance/#mutagen 108 109 # fail_on_hook_fail: False 110 # Decide whether 'ddev start' should be interrupted by a failing hook 111 112 # host_https_port: "59002" 113 # The host port binding for https can be explicitly specified. It is 114 # dynamic unless otherwise specified. 115 # This is not used by most people, most people use the *router* instead 116 # of the localhost port. 117 118 # host_webserver_port: "59001" 119 # The host port binding for the ddev-webserver can be explicitly specified. It is 120 # dynamic unless otherwise specified. 121 # This is not used by most people, most people use the *router* instead 122 # of the localhost port. 123 124 # host_db_port: "59002" 125 # The host port binding for the ddev-dbserver can be explicitly specified. It is dynamic 126 # unless explicitly specified. 127 128 # phpmyadmin_port: "8036" 129 # phpmyadmin_https_port: "8037" 130 # The PHPMyAdmin ports can be changed from the default 8036 and 8037 131 132 # host_phpmyadmin_port: "8036" 133 # The phpmyadmin (dba) port is not normally bound on the host at all, instead being routed 134 # through ddev-router, but it can be specified and bound. 135 136 # mailhog_port: "8025" 137 # mailhog_https_port: "8026" 138 # The MailHog ports can be changed from the default 8025 and 8026 139 140 # host_mailhog_port: "8025" 141 # The mailhog port is not normally bound on the host at all, instead being routed 142 # through ddev-router, but it can be bound directly to localhost if specified here. 143 144 # webimage_extra_packages: [php7.4-tidy, php-bcmath] 145 # Extra Debian packages that are needed in the webimage can be added here 146 147 # dbimage_extra_packages: [telnet,netcat] 148 # Extra Debian packages that are needed in the dbimage can be added here 149 150 # use_dns_when_possible: true 151 # If the host has internet access and the domain configured can 152 # successfully be looked up, DNS will be used for hostname resolution 153 # instead of editing /etc/hosts 154 # Defaults to true 155 156 # project_tld: ddev.site 157 # The top-level domain used for project URLs 158 # The default "ddev.site" allows DNS lookup via a wildcard 159 # If you prefer you can change this to "ddev.local" to preserve 160 # pre-v1.9 behavior. 161 162 # ngrok_args: --basic-auth username:pass1234 163 # Provide extra flags to the "ngrok http" command, see 164 # https://ngrok.com/docs#http or run "ngrok http -h" 165 166 # disable_settings_management: false 167 # If true, ddev will not create CMS-specific settings files like 168 # Drupal's settings.php/settings.ddev.php or TYPO3's AdditionalConfiguration.php 169 # In this case the user must provide all such settings. 170 171 # You can inject environment variables into the web container with: 172 # web_environment: 173 # - SOMEENV=somevalue 174 # - SOMEOTHERENV=someothervalue 175 176 # no_project_mount: false 177 # (Experimental) If true, ddev will not mount the project into the web container; 178 # the user is responsible for mounting it manually or via a script. 179 # This is to enable experimentation with alternate file mounting strategies. 180 # For advanced users only! 181 182 # bind_all_interfaces: false 183 # If true, host ports will be bound on all network interfaces, 184 # not just the localhost interface. This means that ports 185 # will be available on the local network if the host firewall 186 # allows it. 187 188 # default_container_timeout: 120 189 # The default time that ddev waits for all containers to become ready can be increased from 190 # the default 120. This helps in importing huge databases, for example. 191 192 #web_extra_exposed_ports: 193 #- name: nodejs 194 # container_port: 3000 195 # http_port: 2999 196 # https_port: 3000 197 #- name: something 198 # container_port: 4000 199 # https_port: 4000 200 # http_port: 3999 201 # Allows a set of extra ports to be exposed via ddev-router 202 # The port behavior on the ddev-webserver must be arranged separately, for example 203 # using web_extra_daemons. 204 # For example, with a web app on port 3000 inside the container, this config would 205 # expose that web app on https://<project>.ddev.site:9999 and http://<project>.ddev.site:9998 206 # web_extra_exposed_ports: 207 # - container_port: 3000 208 # http_port: 9998 209 # https_port: 9999 210 211 #web_extra_daemons: 212 #- name: "http-1" 213 # command: "/var/www/html/node_modules/.bin/http-server -p 3000" 214 # directory: /var/www/html 215 #- name: "http-2" 216 # command: "/var/www/html/node_modules/.bin/http-server /var/www/html/sub -p 3000" 217 # directory: /var/www/html 218 219 # override_config: false 220 # By default, config.*.yaml files are *merged* into the configuration 221 # But this means that some things can't be overridden 222 # For example, if you have 'nfs_mount_enabled: true'' you can't override it with a merge 223 # and you can't erase existing hooks or all environment variables. 224 # However, with "override_config: true" in a particular config.*.yaml file, 225 # 'nfs_mount_enabled: false' can override the existing values, and 226 # hooks: 227 # post-start: [] 228 # or 229 # web_environment: [] 230 # or 231 # additional_hostnames: [] 232 # can have their intended affect. 'override_config' affects only behavior of the 233 # config.*.yaml file it exists in. 234 235 # Many ddev commands can be extended to run tasks before or after the 236 # ddev command is executed, for example "post-start", "post-import-db", 237 # "pre-composer", "post-composer" 238 # See https://ddev.readthedocs.io/en/stable/users/extend/custom-commands/ for more 239 # information on the commands that can be extended and the tasks you can define 240 # for them. Example: 241 #hooks: 242 ` 243 244 // SequelproTemplate is the template for Sequelpro config. 245 var SequelproTemplate = `<?xml version="1.0" encoding="UTF-8"?> 246 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> 247 <plist version="1.0"> 248 <dict> 249 <key>ContentFilters</key> 250 <dict/> 251 <key>auto_connect</key> 252 <true/> 253 <key>data</key> 254 <dict> 255 <key>connection</key> 256 <dict> 257 <key>database</key> 258 <string>%s</string> 259 <key>host</key> 260 <string>%s</string> 261 <key>name</key> 262 <string>drud/%s</string> 263 <key>password</key> 264 <string>%s</string> 265 <key>port</key> 266 <integer>%s</integer> 267 <key>rdbms_type</key> 268 <string>mysql</string> 269 <key>sslCACertFileLocation</key> 270 <string></string> 271 <key>sslCACertFileLocationEnabled</key> 272 <integer>0</integer> 273 <key>sslCertificateFileLocation</key> 274 <string></string> 275 <key>sslCertificateFileLocationEnabled</key> 276 <integer>0</integer> 277 <key>sslKeyFileLocation</key> 278 <string></string> 279 <key>sslKeyFileLocationEnabled</key> 280 <integer>0</integer> 281 <key>type</key> 282 <string>SPTCPIPConnection</string> 283 <key>useSSL</key> 284 <integer>0</integer> 285 <key>user</key> 286 <string>%s</string> 287 </dict> 288 </dict> 289 <key>encrypted</key> 290 <false/> 291 <key>format</key> 292 <string>connection</string> 293 <key>queryFavorites</key> 294 <array/> 295 <key>queryHistory</key> 296 <array/> 297 <key>rdbms_type</key> 298 <string>mysql</string> 299 <key>rdbms_version</key> 300 <string>5.5.44</string> 301 <key>version</key> 302 <integer>1</integer> 303 </dict> 304 </plist>`