From 3af64202a0e4c68b9bb71adfd28f70960a370ebb Mon Sep 17 00:00:00 2001 From: Matthew Mellor Date: Fri, 29 May 2026 17:50:33 -0500 Subject: [PATCH] docs(cli-reference): document optional container-runtime .devrail.yml keys Adds env, docker_network, and docker_volumes to the .devrail.yml Configuration section as an "Optional container-runtime keys" block. These customize the toolchain container's `docker run` (extra env vars, sibling-container networking, additional volume mounts). docker_network and docker_volumes are new in devrail-dev/dev-toolchain#48 (v1.12.0); env was previously undocumented here. Links to the canonical schema reference for the full key list. Co-Authored-By: Claude Opus 4.7 (1M context) --- content/docs/getting-started/cli-reference.md | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/content/docs/getting-started/cli-reference.md b/content/docs/getting-started/cli-reference.md index e562175..4f18643 100644 --- a/content/docs/getting-started/cli-reference.md +++ b/content/docs/getting-started/cli-reference.md @@ -143,6 +143,29 @@ fail_fast: false log_format: json ``` +### Optional container-runtime keys + +These keys customize how the toolchain container runs. All are no-ops when omitted: + +```yaml +# Pass extra environment variables into the container. +env: + RAILS_ENV: test + DATABASE_HOST: myapp-pg + +# Attach the container to a user-defined Docker network so it can reach a +# sibling service container (e.g. a Postgres at hostname `myapp-pg` during +# `make test`). Single network name. +docker_network: myapp-test + +# Mount additional host paths or named volumes. List of `docker -v` specs. +docker_volumes: + - ./fixtures:/workspace/fixtures + - shared-cache:/cache +``` + +See the [.devrail.yml schema](https://github.com/devrail-dev/devrail-standards/blob/main/standards/devrail-yml-schema.md) for the full key reference. + ## Examples ```bash