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
Note that when using environment variables, configuration property names should be set in upper case with underscore separators, preceded by `TESTCONTAINERS_` - e.g. `ryuk.disabled` becomes `TESTCONTAINERS_RYUK_DISABLED`.
15
+
Note that when using environment variables, configuration property names should be set in uppercase with underscore separators, preceded by `TESTCONTAINERS_` - e.g. `ryuk.disabled` becomes `TESTCONTAINERS_RYUK_DISABLED`.
16
16
17
-
### Supported properties
17
+
### Supported Properties
18
18
19
19
Testcontainers-Python provides a configuration class to represent the settings:
Testcontainers-Python will attempt to detect the Docker environment and configure everything to work automatically.
63
63
@@ -74,7 +74,7 @@ However, sometimes customization is required. Testcontainers-Python will respect
74
74
75
75
5. Read the **docker.host** property in the `~/.testcontainers.properties` file. E.g. `docker.host=tcp://my.docker.host:1234`
76
76
77
-
6. Read the rootless Docker socket path, checking in the following alternative locations:
77
+
6. Read the rootless Docker socket path, checking the following alternative locations:
78
78
79
79
1.`${XDG_RUNTIME_DIR}/.docker/run/docker.sock`
80
80
2.`${HOME}/.docker/run/docker.sock`
@@ -83,7 +83,7 @@ However, sometimes customization is required. Testcontainers-Python will respect
83
83
84
84
7. The library will raise a `DockerHostError` if none of the above are set, meaning that the Docker host was not detected.
85
85
86
-
## Docker socket path detection
86
+
## Docker Socket Path Detection
87
87
88
88
Testcontainers-Python will attempt to detect the Docker socket path and configure everything to work automatically.
89
89
@@ -92,13 +92,13 @@ However, sometimes customization is required. Testcontainers-Python will respect
92
92
1. Read the **TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE** environment variable. Path to Docker's socket. Used by Ryuk, Docker Compose, and a few other containers that need to perform Docker actions.
93
93
Example: `/var/run/docker-alt.sock`
94
94
95
-
2. If the Operating System retrieved by the Docker client is "Docker Desktop", and the host is running on Windows, it will return the `//var/run/docker.sock` UNC Path. Else return the default docker socket path for rootless docker.
95
+
2. If the operating system retrieved by the Docker client is "Docker Desktop", and the host is running on Windows, it will return the `//var/run/docker.sock` UNC path. Otherwise, it returns the default Docker socket path for rootless Docker.
96
96
97
-
3. Get the current Docker Host from the existing strategies: see Docker host detection.
97
+
3. Get the current Docker host from the existing strategies: see Docker host detection.
98
98
99
99
4. If the socket contains the unix schema, the schema is removed (e.g. `unix:///var/run/docker.sock` -> `/var/run/docker.sock`)
100
100
101
-
5.Else, the default location of the docker socket is used: `/var/run/docker.sock`
101
+
5.Otherwise, the default location of the Docker socket is used: `/var/run/docker.sock`
102
102
103
103
The library will raise a `DockerHostError` if the Docker host cannot be discovered.
104
104
@@ -112,7 +112,7 @@ Testcontainers-Python supports different connection modes that determine how con
112
112
113
113
You can set the connection mode using the `TESTCONTAINERS_CONNECTION_MODE` environment variable or the `connection.mode` property in `.testcontainers.properties`.
114
114
115
-
## Example configuration file
115
+
## Example Configuration File
116
116
117
117
Here's an example of a `.testcontainers.properties` file:
0 commit comments