docs: document that tc.host will return default docker socket path

testcontainers · Jun 13, 2023 · 181a7fa · 181a7fa
1 parent 43e9a8f
commit 181a7fa
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/docs/features/configuration.md b/docs/features/configuration.md
@@ -80,7 +80,8 @@ _Testcontainers for Go_ will attempt to detect the Docker socket path and config
 
 However, sometimes customization is required. _Testcontainers for Go_ will respect the following order:
 
-1. Read the **tc.host** property in the `~/.testcontainers.properties` file. E.g. `tc.host=tcp://my.docker.host:1234`
+1. Read the **tc.host** property in the `~/.testcontainers.properties` file. E.g. `tc.host=tcp://my.docker.host:1234`. If this property is set, the returned Docker socket path
+will be the default Docker socket path: `/var/run/docker.sock`.
 
 2. 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.