Skip to content

docs: document detach as the transport option it is #498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tas50 merged 1 commit into from
Aug 30, 2026
Merged

docs: document detach as the transport option it is #498

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ platforms:
| `dockerfile` | *(none)* | Path to your own Dockerfile, used instead of the generated one. Rendered as [ERB](#using-a-custom-dockerfile). |
| `build_context` | `true` locally, `false` for a remote daemon | Send the working directory to the daemon as build context. Required for `ADD` and `COPY`; slow against a remote daemon. |
| `build_options` | *(none)* | Extra flags for `docker build`, as a string or a map. |
| `build_tempdir` | working directory | Where the generated Dockerfile is written, relative to `build_context`. |
| `build_tempdir` | working directory | Directory the generated Dockerfile is written to. A relative path is resolved against the working directory, and the path must be inside the build context, since `docker build -f` is given it relative to the working directory. |
| `use_cache` | `true` | Use Docker's build cache. `false` adds `--no-cache`. |
| `remove_images` | `false` | Remove the built image on `kitchen destroy`. |
| `package_name` | the instance name, tagged `latest` | Image `kitchen package` commits the container to. |
Expand Down Expand Up @@ -237,7 +237,9 @@ platforms:
| `tty` | `false` | Pass `-t`, allocating a pseudo-TTY. |
| `env_variables` | *(none)* | Environment variables set in the container, as a map. |
| `wait_for_transport` | `true` | Wait for the transport to answer before converging. Set `false` for containers that do not stay up. |
| `detach` | `false` | Run provisioner commands with `docker exec -d`, returning immediately instead of waiting for them. The container itself is always started detached, regardless of this setting, and `kitchen login` ignores it so the shell stays usable. |

The container itself is always started detached — see [`detach`](#transport-configuration)
under the transport for how provisioner commands are run.

### Networking

Expand Down Expand Up @@ -314,6 +316,7 @@ These options go under `transport:`, not `driver:`.
| `working_dir` | *(none)* | Working directory inside the container (`-w`). |
| `temp_dir` | `/tmp`, or `$env:TEMP` on Windows | Directory used to stage uploaded files. |
| `env_variables` | *(none)* | Environment variables for each command. |
| `detach` | `false` | Run provisioner commands with `docker exec -d`, returning immediately instead of waiting for them to finish. `kitchen login` ignores it, so the shell stays usable. |
| `privileged` | `false` | Run commands with `--privileged`. |
| `interactive` | `false` | Pass `-i`. |
| `tty` | `false` | Pass `-t`. |
Expand Down
Loading