|
2 | 2 |
|
3 | 3 | ## Overview |
4 | 4 |
|
5 | | -Testcontainers requires a Docker-API compatible container runtime. |
6 | | -During development, Testcontainers is actively tested against recent versions of Docker on Linux, as well as against Docker Desktop on Mac and Windows. |
| 5 | +Testcontainers requires a Docker-API compatible container runtime. |
| 6 | +During development, Testcontainers is actively tested against recent versions of Docker on Linux, as well as against Docker Desktop on Mac and Windows. |
7 | 7 | These Docker environments are automatically detected and used by Testcontainers without any additional configuration being necessary. |
8 | 8 |
|
9 | | -It is possible to configure Testcontainers to work for other Docker setups, such as a remote Docker host or Docker alternatives. |
10 | | -However, these are not actively tested in the main development workflow, so not all Testcontainers features might be available and additional manual configuration might be necessary. |
11 | | -If you have further questions about configuration details for your setup or whether it supports running Testcontainers-based tests, |
| 9 | +It is possible to configure Testcontainers to work for other Docker setups, such as a remote Docker host or Docker alternatives. |
| 10 | +However, these are not actively tested in the main development workflow, so not all Testcontainers features might be available and additional manual configuration might be necessary. |
| 11 | +If you have further questions about configuration details for your setup or whether it supports running Testcontainers-based tests, |
12 | 12 | please contact the Testcontainers team and other users from the Testcontainers community on [Slack](https://slack.testcontainers.org/). |
13 | 13 |
|
14 | | -| Host Operating System / Environment | Minimum recommended docker versions | Known issues / tips | |
15 | | -|-------------------------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
16 | | -| Linux - general | Docker v17.09 | After docker installation, follow [post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/). | |
17 | | -| Linux - CircleCI (LXC driver) | Docker v17.09 | The `exec` feature is not compatible with CircleCI. See CircleCI configuration [example](./continuous_integration/circle_ci.md) | |
18 | | -| Linux - within a Docker container | Docker v17.09 | See [Running inside Docker](continuous_integration/dind_patterns.md) for Docker-in-Docker and Docker wormhole patterns | |
19 | | -| Mac OS X - Docker Toolbox | Docker Machine v0.8.0 | | |
20 | | -| Mac OS X - Docker for Mac | v17.09 | Starting 4.13, run `sudo ln -s $HOME/.docker/run/docker.sock /var/run/docker.sock`<br>Support is best-efforts at present<br>`getTestHostIpAddress()` is [not currently supported](https://github.com/testcontainers/testcontainers-java/issues/166) due to limitations in Docker for Mac. | |
21 | | -| Windows - Docker Toolbox | | *Support is limited at present and this is not currently tested on a regular basis*. | |
22 | | -| Windows - Docker for Windows | | *Support is best-efforts at present.* Only Linux Containers (LCOW) are supported at the moment. See [Windows Support](windows.md) | |
23 | | -| Windows - Windows Subsystem for Linux (WSL) | Docker v17.09 | *Support is best-efforts at present.* Only Linux Containers (LCOW) are supported at the moment. See [Windows Support](windows.md). | |
24 | | - |
25 | | -## Using Colima? |
26 | | - |
27 | | -In order to run testcontainers against [colima](https://github.com/abiosoft/colima) the env vars bellow should be set |
28 | | - |
29 | | -```bash |
30 | | -export TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE=/var/run/docker.sock |
31 | | -export DOCKER_HOST="unix://${HOME}/.colima/docker.sock" |
32 | | -``` |
| 14 | +| Host Operating System / Environment | Minimum recommended docker versions | Known issues / tips | |
| 15 | +| ------------------------------------------- | ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| 16 | +| Linux - general | Docker v17.09 | After docker installation, follow [post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/). | |
| 17 | +| Linux - CircleCI (LXC driver) | Docker v17.09 | The `exec` feature is not compatible with CircleCI. See CircleCI configuration [example](./continuous_integration/circle_ci.md) | |
| 18 | +| Linux - within a Docker container | Docker v17.09 | See [Running inside Docker](continuous_integration/dind_patterns.md) for Docker-in-Docker and Docker wormhole patterns | |
| 19 | +| Mac OS X - Docker Toolbox | Docker Machine v0.8.0 | | |
| 20 | +| Mac OS X - Docker for Mac | v17.09 | Starting 4.13, run `sudo ln -s $HOME/.docker/run/docker.sock /var/run/docker.sock`<br>Support is best-efforts at present<br>`getTestHostIpAddress()` is [not currently supported](https://github.com/testcontainers/testcontainers-java/issues/166) due to limitations in Docker for Mac. | |
| 21 | +| Windows - Docker Toolbox | | _Support is limited at present and this is not currently tested on a regular basis_. | |
| 22 | +| Windows - Docker for Windows | | _Support is best-efforts at present._ Only Linux Containers (LCOW) are supported at the moment. See [Windows Support](windows.md) | |
| 23 | +| Windows - Windows Subsystem for Linux (WSL) | Docker v17.09 | _Support is best-efforts at present._ Only Linux Containers (LCOW) are supported at the moment. See [Windows Support](windows.md). | |
33 | 24 |
|
34 | 25 | ## Docker environment discovery |
35 | 26 |
|
36 | 27 | Testcontainers will try to connect to a Docker daemon using the following strategies in order: |
37 | 28 |
|
38 | | -* Environment variables: |
39 | | - * `DOCKER_HOST` |
40 | | - * `DOCKER_TLS_VERIFY` |
41 | | - * `DOCKER_CERT_PATH` |
42 | | -* Defaults: |
43 | | - * `DOCKER_HOST=https://localhost:2376` |
44 | | - * `DOCKER_TLS_VERIFY=1` |
45 | | - * `DOCKER_CERT_PATH=~/.docker` |
46 | | -* If Docker Machine is installed, the docker machine environment for the *first* machine found. Docker Machine needs to be on the PATH for this to succeed. |
47 | | -* If you're going to run your tests inside a container, please read [Patterns for running tests inside a docker container](continuous_integration/dind_patterns.md) first. |
| 29 | +- Environment variables: |
| 30 | + - `DOCKER_HOST` |
| 31 | + - `DOCKER_TLS_VERIFY` |
| 32 | + - `DOCKER_CERT_PATH` |
| 33 | +- Defaults: |
| 34 | + - `DOCKER_HOST=https://localhost:2376` |
| 35 | + - `DOCKER_TLS_VERIFY=1` |
| 36 | + - `DOCKER_CERT_PATH=~/.docker` |
| 37 | +- If Docker Machine is installed, the docker machine environment for the _first_ machine found. Docker Machine needs to be on the PATH for this to succeed. |
| 38 | +- If you're going to run your tests inside a container, please read [Patterns for running tests inside a docker container](continuous_integration/dind_patterns.md) first. |
48 | 39 |
|
49 | 40 | ## Docker registry authentication |
50 | 41 |
|
51 | 42 | Testcontainers will try to authenticate to registries with supplied config using the following strategies in order: |
52 | 43 |
|
53 | | -* Environment variables: |
54 | | - * `DOCKER_AUTH_CONFIG` |
55 | | -* Docker config |
56 | | - * At location specified in `DOCKER_CONFIG` or at `{HOME}/.docker/config.json` |
| 44 | +- Environment variables: |
| 45 | + - `DOCKER_AUTH_CONFIG` |
| 46 | +- Docker config |
| 47 | + - At location specified in `DOCKER_CONFIG` or at `{HOME}/.docker/config.json` |
0 commit comments