diff --git a/_docs/connectors.md b/_docs/connectors.md index 893b334..9b3247e 100644 --- a/_docs/connectors.md +++ b/_docs/connectors.md @@ -1,4 +1,4 @@ -# connectors +# Connectors `ctop` comes with the below native connectors, enabled via the `--connector` option. diff --git a/_docs/img/status.png b/_docs/img/status.png new file mode 100644 index 0000000..3343d49 Binary files /dev/null and b/_docs/img/status.png differ diff --git a/_docs/status.md b/_docs/status.md new file mode 100644 index 0000000..ce971fa --- /dev/null +++ b/_docs/status.md @@ -0,0 +1,18 @@ +# Status Indicator + +The `ctop` grid view provides a compact status indicator to convey container state +

ctop

+ +Appearance | Description +--- | --- +red | container is stopped +green | container is running +two vertical bars (▮▮) | container is paused + +If the container is configured with a health check, a `+` will appear next to the indicator + +Appearance | Description +--- | --- +red | health check in failed state +yellow | health check in starting state +green | health check in OK state