ctop/_docs/connectors.md

27 lines
777 B
Markdown
Raw Permalink Normal View History

2019-01-24 13:50:59 +01:00
# Connectors
2017-06-14 14:17:44 +02:00
`ctop` comes with the below native connectors, enabled via the `--connector` option.
Default connector behavior can be changed by setting the relevant environment variables.
## Docker
Default connector, configurable via standard [Docker commandline varaibles](https://docs.docker.com/engine/reference/commandline/cli/#environment-variables)
2017-06-14 14:32:26 +02:00
#### Options
2017-06-14 14:17:44 +02:00
Var | Description
--- | ---
DOCKER_HOST | Daemon socket to connect to (default: `unix://var/run/docker.sock`)
## RunC
Using this connector requires full privileges to the local runC root dir of container state (default: `/run/runc`)
2017-06-14 14:17:44 +02:00
2017-06-14 14:32:26 +02:00
#### Options
2017-06-14 14:17:44 +02:00
Var | Description
--- | ---
RUNC_ROOT | path to runc root for container state (default: `/run/runc`)
2017-06-14 14:17:44 +02:00
RUNC_SYSTEMD_CGROUP | if set, enable systemd cgroups