Skip to content

Commit 5566597

Browse files
authored
Update Windows docs for WSL2 (#2816)
1 parent f353266 commit 5566597

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

docs/supported_docker_environment/windows.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,31 @@
44
* [Docker for Windows](https://docs.docker.com/docker-for-windows/) needs to be installed
55
* Docker version 17.06 is confirmed to work on Windows 10 with Hyper-V.
66
* Testcontainers supports communication with Docker on Docker for Windows using named pipes.
7+
* WSL2 backend is supported starting with Windows 10 2004. (**Beta**)
78

89
## Limitations
910
The following features are not available or do not work correctly so make sure you do not use them or use them with
1011
caution. The list may not be complete.
1112

12-
### Testing
13-
14-
Testcontainers is not regularly tested on Windows, so please consider it to be at an beta level of readiness.
15-
16-
If you wish to use Testcontainers on Windows, please confirm that it works correctly for you before investing significant
17-
effort.
18-
1913
### MySQL containers
2014
* MySQL server prevents custom configuration file (ini-script) from being loaded due to security measures ([link to feature description](../modules/databases/index.md#using-an-init-script-from-a-file))
2115

2216
### Windows Container on Windows (WCOW)
2317

2418
* WCOW is currently not supported, since Testcontainers uses auxiliary Linux containers for certain tasks and Docker for Windows does not support hybrid engine mode at the time of writing.
2519

26-
## Windows Subsystem for Linux
20+
## WSL2 backend
21+
22+
Using Docker for Windows with WSL2 backend should work out of the box.
23+
24+
However, there is an [existing issue](https://github.com/microsoft/WSL/issues/4694) in WSL/WSL2 that effects certain older Docker images.
25+
The currently proposed workaround is to enable vsyscall emulation in the WSL2 kernel:
26+
```
27+
[wsl2]
28+
kernelCommandLine = vsyscall=emulate
29+
```
30+
31+
## Windows Subsystem for Linux (WSL)
2732

2833
Testcontainers supports communicating with Docker for Windows within the Windows Subsystem for Linux *([**WSL**](https://docs.microsoft.com/en-us/windows/wsl/about))*.
2934
The following additional configurations steps are required:

0 commit comments

Comments
 (0)