diff --git a/docs/contributing.md b/docs/contributing.md index 70cd452b143..7d87945c704 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -4,9 +4,9 @@ * Join our [Slack group](http://slack.testcontainers.org) * [Post an issue](https://github.com/testcontainers/testcontainers-java/issues) if you find any bugs * Contribute improvements or fixes using a [Pull Request](https://github.com/testcontainers/testcontainers-java/pulls). If you're going to contribute, thank you! Please just be sure to: - * discuss with the authors on an issue ticket prior to doing anything big - * follow the style, naming and structure conventions of the rest of the project - * make commits atomic and easy to merge + * discuss with the authors on an issue ticket prior to doing anything big. + * follow the style, naming and structure conventions of the rest of the project. + * make commits atomic and easy to merge. * when updating documentation, please see [our guidance for documentation contributions](contributing_docs.md). * verify all tests are passing. Build the project with `./gradlew check` to do this. **N.B.** Gradle's Build Cache is enabled by default, but you can add `--no-build-cache` flag to disable it. diff --git a/docs/supported_docker_environment/index.md b/docs/supported_docker_environment/index.md index 3477275c2f2..7622a5051cd 100644 --- a/docs/supported_docker_environment/index.md +++ b/docs/supported_docker_environment/index.md @@ -12,6 +12,7 @@ | Mac OS X - Docker for Mac | 1.12.0 | *Support is best-efforts at present*. `getTestHostIpAddress()` is [not currently supported](https://github.com/testcontainers/testcontainers-java/issues/166) due to limitations in Docker for Mac. | | Windows - Docker Toolbox | | *Support is limited at present and this is not currently tested on a regular basis*. | | Windows - Docker for Windows | | *Support is best-efforts at present.* Only Linux Containers (LCOW) are supported at the moment. See [Windows Support](windows.md) | +| Windows - Windows Subsystem for Linux (WSL) | Docker v17.06 | *Support is best-efforts at present.* Only Linux Containers (LCOW) are supported at the moment. See [Windows Support](windows.md). | ## Docker environment discovery diff --git a/docs/supported_docker_environment/windows.md b/docs/supported_docker_environment/windows.md index b35ee1aa2ee..6365456b095 100644 --- a/docs/supported_docker_environment/windows.md +++ b/docs/supported_docker_environment/windows.md @@ -23,6 +23,25 @@ effort. * 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. +## Windows Subsystem for Linux + +Testcontainers supports communicating with Docker for Windows within the Windows Subsystem for Linux *([**WSL**](https://docs.microsoft.com/en-us/windows/wsl/about))*. +The following additional configurations steps are required: + ++ Expose the Docker for Windows daemon on tcp port `2375` without **TLS**. + *(Right-click the Docker for Windows icon on the task bar, click setting and go to `General`)*. + ++ Set the `DOCKER_HOST` environment variable inside the **WSL** shell to `tcp://localhost:2375`. + It is recommended to add this to your `~/.bashrc` file, so it’s available every time you open your terminal. + ++ **Optional** - Only if volumes are required: + Inside the **WSL** shell, modify the `/ect/wsl.conf` file to mount the Windows drives on `/` instead of on `/mnt/`. + *(Reboot required after this step)*. + Remember to share the drives, on which you will store your volumes, with Docker for Windows. + *(Right-click the Docker for Windows icon on the task bar, click setting and go to `Shared Drives`)*. + +More information about running Docker within the **WSL** can be found [here](https://nickjanetakis.com/blog/setting-up-docker-for-windows-and-wsl-to-work-flawlessly). + ## Reporting issues Please report any issues with the Windows build of Testcontainers [here](https://github.com/testcontainers/testcontainers-java/issues)