diff --git a/README.md b/README.md index f1bedd6..67d4b1b 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,19 @@ It does not connect directly to the Docker socket: it designed to be used with a Combined with a socket-proxy container that provides granular endpoint access it's possible to expose only information about specific containers in a read-only context. +## Features + +### `CONTAINER_NAMES` + +Using this ENV changes Docker API responses: + +* Filters [List Containers](https://docs.docker.com/reference/api/engine/version/v1.48/#tag/Container/operation/ContainerList) responses so any container with a name that does not include a value from `CONTAINER_NAMES` is removed. +* Any other [Container](https://docs.docker.com/reference/api/engine/version/v1.48/#tag/Container) endpoints will return 404 if the container name does not include a value from `CONTAINER_NAMES` + +### `SCRUB_ENVS` + +When `true` any responses from the [Container Inspect](https://docs.docker.com/reference/api/engine/version/v1.48/#tag/Container/operation/ContainerInspect) endpoint will have `Config.Env` set to an empty array. + ## Example ```yaml