[READ-ONLY] Mirror of https://github.com/FoxxMD/docker-proxy-filter. Filter the contents of Docker API responses
docker
docker-socket-proxy
filter
Improve readme
+9
-3
+9
-3
README.md
+9
-3
README.md
···
13
13
14
14
## Features
15
15
16
-
### `CONTAINER_NAMES`
16
+
### Container Filtering
17
+
18
+
#### `CONTAINER_NAMES`
17
19
18
20
Using this ENV changes Docker API responses:
19
21
20
22
* 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.
21
23
* 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`
22
24
23
-
### `SCRUB_ENVS`
25
+
#### `SCRUB_ENVS`
24
26
25
-
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.
27
+
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. This prevents leaking of sensitive `environment:`/`-e` variables that you passed to your container, over the network.
28
+
29
+
### More?
30
+
31
+
If I find use cases for filtering other endpoints they will be implemented in the future! Open a new Issue if you have ideas.
26
32
27
33
## Example
28
34