You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/content/users/debugging-profiling/step-debugging.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ All IDEs basically work the same, listening on a port and reacting when they’r
11
11
12
12
**Key facts:**
13
13
14
-
* Enable Xdebug by running [`ddev xdebug`](../usage/commands.md#xdebug) or `ddev xdebug on` from your project directory.
14
+
* Enable Xdebug by running [`ddev xdebug`](../usage/commands.md#xdebug) or `ddev xdebug on` from your project directory.
15
15
It will remain enabled until you start or restart the project.
16
16
* Disable Xdebug for better performance when not debugging with `ddev xdebug off`.
17
17
*`ddev xdebug status` will show Xdebug’s current status.
@@ -57,7 +57,7 @@ When using this zero-configuration option:
57
57
PhpStorm [run/debug configurations](https://www.jetbrains.com/help/phpstorm/creating-and-editing-run-debug-configurations.html) require more setup but may be easier and more flexible for some people.
58
58
59
59
1. Under the *Run* menu select *Edit configurations*.
60
-
2. Click the *+* in the upper left and choose *PHP Web Application* to create a configuration.
60
+
2. Click the *+* in the upper left and choose *PHP Web Application* to create a configuration.
61
61
Give it a reasonable name.
62
62
3. Create a “server” for the project. Make sure *Name* is exactly the same as your host (e.g. `my-site.ddev.site`):
63
63

Copy file name to clipboardexpand all lines: docs/content/users/install/ddev-installation.md
+23-24
Original file line number
Diff line number
Diff line change
@@ -115,16 +115,16 @@ Installing and upgrading DDEV are nearly the same thing, because you're upgradin
115
115
116
116
### Important Considerations for WSL2 and DDEV
117
117
118
-
* WSL2 is supported on Windows 10 and 11.
119
-
All Windows 10/11 editions, including Windows 10 Home support WSL2.
120
-
* WSL2 offers a faster, smoother experience.
121
-
It’s vastly more performant, and you’re less likely to have obscure Windows problems.
122
-
* Projects should live in the Linux filesystem.
123
-
WSL2’s Linux filesystem (e.g. `/home/<your_username>`) is much faster, so keep your projects there and **not** in the slower Windows filesystem (`/mnt/c`).
124
-
* Custom hostnames are managed via the Windows hosts file, not within WSL2.
125
-
DDEV attempts to manage custom hostnames via the Windows-side hosts file—usually at `C:\Windows\system32\drivers\etc\hosts`—and it can only do this if it’s installed on the Windows side. (DDEV inside WSL2 uses `ddev.exe` on the Windows side as a proxy to update the Windows hosts file.) If `ddev.exe --version` shows the same version as `ddev --version` you’re all set up. Otherwise, install DDEV on Windows using `choco upgrade -y ddev` or by downloading and running the Windows installer. (The WSL2 scripts below install DDEV on the Windows side, taking care of that for you.) If you frequently run into Windows UAC Escalation, you can calm it down by running `gsudo.exe cache on` and `gsudo.exe config CacheMode auto`, see [gsudo docs](https://github.com/gerardog/gsudo#credentials-cache).
126
-
* WSL2 is not the same as Docker Desktop’s WSL2 engine.
127
-
Using WSL2 to install and run DDEV is not the same as using Docker Desktop’s WSL2 engine, which itself runs in WSL2, but can serve applications running in both traditional Windows and inside WSL2.
118
+
* WSL2 is supported on Windows 10 and 11.
119
+
All Windows 10/11 editions, including Windows 10 Home support WSL2.
120
+
* WSL2 offers a faster, smoother experience.
121
+
It’s vastly more performant, and you’re less likely to have obscure Windows problems.
122
+
* Projects should live in the Linux filesystem.
123
+
WSL2’s Linux filesystem (e.g. `/home/<your_username>`) is much faster, so keep your projects there and **not** in the slower Windows filesystem (`/mnt/c`).
124
+
* Custom hostnames are managed via the Windows hosts file, not within WSL2.
125
+
DDEV attempts to manage custom hostnames via the Windows-side hosts file—usually at `C:\Windows\system32\drivers\etc\hosts`—and it can only do this if it’s installed on the Windows side. (DDEV inside WSL2 uses `ddev.exe` on the Windows side as a proxy to update the Windows hosts file.) If `ddev.exe --version` shows the same version as `ddev --version` you’re all set up. Otherwise, install DDEV on Windows using `choco upgrade -y ddev` or by downloading and running the Windows installer. (The WSL2 scripts below install DDEV on the Windows side, taking care of that for you.) If you frequently run into Windows UAC Escalation, you can calm it down by running `gsudo.exe cache on` and `gsudo.exe config CacheMode auto`, see [gsudo docs](https://github.com/gerardog/gsudo#credentials-cache).
126
+
* WSL2 is not the same as Docker Desktop’s WSL2 engine.
127
+
Using WSL2 to install and run DDEV is not the same as using Docker Desktop’s WSL2 engine, which itself runs in WSL2, but can serve applications running in both traditional Windows and inside WSL2.
128
128
129
129
The WSL2 install process involves:
130
130
@@ -307,31 +307,30 @@ Installing and upgrading DDEV are nearly the same thing, because you're upgradin
tar -zxf ddev_shell_completion_scripts.${VERSION}.tar.gz
38
38
```
39
-
2. Then `sudo mkdir -p /usr/share/bash-completion/completions && sudo cp ddev_bash_completion.sh /usr/share/bash-completion/completions/ddev`. This deploys the `ddev_bash_completion.sh` script where it needs to be. Again, every Linux distro has a different technique, and you may have to figure yours out.
39
+
2. Run `sudo mkdir -p /usr/share/bash-completion/completions && sudo cp ddev_bash_completion.sh /usr/share/bash-completion/completions/ddev`. This deploys the `ddev_bash_completion.sh` script where it needs to be. Again, every Linux distro has a different technique, and you may have to figure yours out.
40
40
41
41
If you installed DDEV using `apt install` then the `ddev_bash_completion.sh` file is already available in `/usr/bin/ddev_bash_completion.sh`. Starting with DDEV v1.21.2 this will be automatically installed into `/usr/share/bash-completion/completions`.
3. Point DNS for the site you’re going to host to the server.
18
18
4. Before proceeding, your system and your project must be accessible on the internet on port 80 and your project DNS name (`myproject.example.com`) must resolve to the appropriate server.
@@ -29,7 +29,7 @@ Here’s how to try it for yourself:
Copy file name to clipboardexpand all lines: docs/content/users/usage/architecture.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# How DDEV Works
2
2
3
-
DDEV is a [Go](https://go.dev) application that stores its configuration in [files on your workstation](#directory-tour).
3
+
DDEV is a [Go](https://go.dev) application that stores its configuration in [files on your workstation](#directory-tour).
4
4
It uses those blueprints to mount your project files into [Docker containers](#container-architecture) that facilitate the operation of a local development environment.
5
5
6
6
DDEV writes and uses [docker-compose](https://docs.docker.com/compose/) files for you, which is a detail you can cheerfully ignore unless you’re Docker-curious or [defining your own services](../extend/custom-compose-files.md).
@@ -16,7 +16,7 @@ The [global configuration directory](#global-files) is used to keep track of you
16
16
A project’s `.ddev` directory can be intimidating at first, so let’s take a look at what lives in there.
17
17
18
18
!!!tip "Yours May Differ Slightly"
19
-
You may have some directories or files that aren’t listed here, likely added by custom services.
19
+
You may have some directories or files that aren’t listed here, likely added by custom services.
20
20
For example, if you see a `solr` directory, it probably pertains to a custom Solr [add-on service](../extend/additional-services.md).
Copy file name to clipboardexpand all lines: docs/content/users/usage/cms-settings.md
+23-23
Original file line number
Diff line number
Diff line change
@@ -14,19 +14,19 @@ While this reduces setup time for new users, makes it easier to try out a CMS, a
14
14
15
15
There are several ways to back off DDEV’s CMS settings management:
16
16
17
-
1.**Take control of files by removing the `#ddev-generated` comment.**
17
+
1.**Take control of files by removing the `#ddev-generated` comment.**
18
18
DDEV will automatically update any it’s added containing a `#ddev-generated` comment. This means you don’t need to touch that file, but also that any changes you make will be overwritten. As soon as you remove the comment, DDEV will ignore that file and leave you fully in control over it. (Don’t forget to check it into version control!)
19
19
20
20
!!!tip "Reversing the change"
21
21
If you change your mind and want DDEV to take over the file again, delete it and run [`ddev start`](../usage/commands.md#start). DDEV will recreate its own version, which you may want to remove from your Git project.
22
22
23
-
2.**Disable settings management.**
23
+
2.**Disable settings management.**
24
24
You can tell DDEV to use a specific project type without creating settings files by either setting [`disable_settings_management`](../configuration/config.md#disable_settings_management) to `true` or running [`ddev config --disable-settings-management`](../configuration/config.md#type).
25
25
26
-
3.**Switch to the generic PHP project type.**
26
+
3.**Switch to the generic PHP project type.**
27
27
If you don’t want DDEV’s CMS-specific settings, you can switch your project to the generic `php` type by editing [`type: php`](../configuration/config.md#type) in the project’s settings or running [`ddev config --project-type=php`](../usage/commands.md#config). DDEV will no longer create or tweak any settings files. You’ll lose any perks from the nginx configuration for the CMS, but you can always customize [nginx settings](../extend/customization-extendibility.md#custom-nginx-configuration) or [Apache settings](../extend/customization-extendibility.md#custom-apache-configuration) separately.
28
28
29
-
4.**Un-set the `$IS_DDEV_PROJECT` environment variable.**
29
+
4.**Un-set the `$IS_DDEV_PROJECT` environment variable.**
30
30
This environment variable is set `true` by default in DDEV’s environment, and can be used to fence off DDEV-specific behavior. When it’s empty, the important parts of `settings.ddev.php` and `AdditionalSettings.php` (for TYPO3) are not executed. This means that DDEV’s `settings.ddev.php` won’t be invoked if it somehow ends up in a production environment or in a non-DDEV local development environment.
Copy file name to clipboardexpand all lines: docs/content/users/usage/developer-tools.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -58,7 +58,7 @@ Use [`ddev composer`](../usage/commands.md#composer) (Composer inside the contai
58
58
* On some older configurations of Docker Desktop for Windows, symlinks are created in the container as “simulated symlinks”, or XSym files. These special text files behave as symlinks inside the container (on CIFS filesystem), but appear as simple text files on the Windows host. (On the CIFS filesystem used by Docker for Windows, inside the container, there is no capability to create real symlinks even though Windows now has this capability.)
59
59
* DDEV attempts to clean up for this situation. Since Windows 10/11+ (in developer mode) can create real symlinks, DDEV scans your repository after a `ddev composer` command and attempts to convert XSym files into real symlinks. On older versions of Windows 10, it can only do this if your Windows 10 workstation is set to “Developer Mode”.
60
60
* To enable developer mode on Windows 10/11+, search for “developer” in settings:
Copy file name to clipboardexpand all lines: docs/content/users/usage/troubleshooting.md
+1
Original file line number
Diff line number
Diff line change
@@ -174,6 +174,7 @@ If you get a 404 with “No input file specified” (nginx) or a 403 with “For
174
174
If `ddev start` fails, it’s most often because the `web` or `db` container fails to start. In this case, the error message from `ddev start` says something like “Failed to start <project>: db container failed: log=, err=container exited, please use 'ddev logs -s db' to find out why it failed”. You can`ddev logs -s db` to find out what happened.
175
175
176
176
If you see any variant of “no space left on device” in the logs when using Docker Desktop, it means you have to increase or clean up Docker’s file space. Increase the “Disk image size” setting under “Resources” in Docker’s Preferences:
177
+
177
178

178
179
179
180
If you see “no space left on device” on Linux, it most likely means your filesystem is full.
0 commit comments