From b74dc9f58a8f718165af9fdd821b3c3b354b63ad Mon Sep 17 00:00:00 2001 From: Amir Raminfar Date: Thu, 11 Dec 2025 09:48:29 -0800 Subject: [PATCH] chore: updates docs --- docs/components.d.ts | 5 ++++- docs/guide/actions.md | 4 +++- docs/guide/agent.md | 4 +++- docs/guide/authentication.md | 2 +- docs/guide/filters.md | 3 +++ docs/guide/k8s.md | 2 +- docs/guide/remote-hosts.md | 2 ++ docs/guide/shell.md | 5 ++++- docs/guide/swarm-mode.md | 2 ++ 9 files changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/components.d.ts b/docs/components.d.ts index 6fd769c5..991ec137 100644 --- a/docs/components.d.ts +++ b/docs/components.d.ts @@ -1,8 +1,11 @@ /* eslint-disable */ // @ts-nocheck +// biome-ignore lint: disable +// oxlint-disable +// ------ // Generated by unplugin-vue-components // Read more: https://github.com/vuejs/core/pull/3399 -// biome-ignore lint: disable + export {} /* prettier-ignore */ diff --git a/docs/guide/actions.md b/docs/guide/actions.md index a7f8f99d..d4cf73c9 100644 --- a/docs/guide/actions.md +++ b/docs/guide/actions.md @@ -2,7 +2,9 @@ title: Container Actions --- -# Using Container Actions +# Container Actions + + Dozzle supports container actions, which allows you to `start`, `stop` and `restart` containers from the dropdown menu on the right next to the container stats. This feature is **disabled** by default and can be enabled by setting the environment variable `DOZZLE_ENABLE_ACTIONS` to `true`. diff --git a/docs/guide/agent.md b/docs/guide/agent.md index 72813263..b234af71 100644 --- a/docs/guide/agent.md +++ b/docs/guide/agent.md @@ -2,7 +2,9 @@ title: Agent Mode --- -# Agent Mode +# Agent Mode + + Dozzle can run in agent mode which can expose Docker hosts to other Dozzle instances. All communication is done over a secured connection using TLS. This means that you can deploy Dozzle on a remote host and connect to it from your local machine. diff --git a/docs/guide/authentication.md b/docs/guide/authentication.md index 887e6c0c..138849a2 100644 --- a/docs/guide/authentication.md +++ b/docs/guide/authentication.md @@ -2,7 +2,7 @@ title: Authentication --- -# Setting Up Authentication +# Authentication Dozzle supports two configurations for authentication. In the first configuration, you bring your own authentication method by protecting Dozzle through a proxy. Dozzle can read appropriate headers out of the box. diff --git a/docs/guide/filters.md b/docs/guide/filters.md index e445f154..467ff600 100644 --- a/docs/guide/filters.md +++ b/docs/guide/filters.md @@ -4,6 +4,9 @@ title: Filter # Filtering Containers + + + Dozzle supports conditional filtering similar to Docker's [--filter](https://docs.docker.com/reference/cli/docker/container/ls/#filter) with `DOZZLE_FILTER` or `--filter`. Filters are passed directly to Docker to limit what Dozzle can see. For example, filtering by label is supported with `--filter "label=color"`, which is similar to `docker ps` command with `docker ps --filter "label=color"`. ::: code-group diff --git a/docs/guide/k8s.md b/docs/guide/k8s.md index 658be50b..9fa405a8 100644 --- a/docs/guide/k8s.md +++ b/docs/guide/k8s.md @@ -2,7 +2,7 @@ title: Kubernetes Support --- -# Kubernetes Support +# Kubernetes Support Dozzle now supports Kubernetes, allowing you to view logs from your Kubernetes pods. This feature is available in `v8.11` version of Dozzle. diff --git a/docs/guide/remote-hosts.md b/docs/guide/remote-hosts.md index 3936a718..ba56bc20 100644 --- a/docs/guide/remote-hosts.md +++ b/docs/guide/remote-hosts.md @@ -4,6 +4,8 @@ title: Remote Host Setup # Remote Host Setup + + Dozzle supports connecting to remote Docker hosts. This is useful when running Dozzle in a container and you want to monitor a different Docker host. However, with Dozzle agents, you can connect to remote hosts without exposing the Docker socket. See the [agent](/guide/agent) page for more information. diff --git a/docs/guide/shell.md b/docs/guide/shell.md index 7794bc47..88b0155e 100644 --- a/docs/guide/shell.md +++ b/docs/guide/shell.md @@ -2,7 +2,10 @@ title: Container Shell Access --- -# Attaching and Executing Commands +# Attaching and Executing Shell Commands + + + Dozzle supports attaching or executing commands within containers. It provides a web-based interface to interact with Docker containers, allowing users to attach to running containers and execute commands directly from the browser. This feature is particularly useful for debugging and troubleshooting containerized applications. This feature is **disabled** by default as it may pose security risks. To enable it, set the `DOZZLE_ENABLE_SHELL` environment variable to `true`. diff --git a/docs/guide/swarm-mode.md b/docs/guide/swarm-mode.md index de5007fa..ca5b6297 100644 --- a/docs/guide/swarm-mode.md +++ b/docs/guide/swarm-mode.md @@ -4,6 +4,8 @@ title: Swarm Mode # Swarm Mode + + Dozzle supports Docker Swarm Mode starting from version 8. When using Swarm Mode, Dozzle will automatically discover services and custom groups. Dozzle does not use Swarm API internally as it is [limited](https://github.com/moby/moby/issues/33183). Instead, Dozzle implements its own grouping using swarm labels. Additionally, Dozzle merges stats for containers in a group. This means that you can see logs and stats for all containers in a group in one view. However, it does mean each host needs to be set up with Dozzle. ## How Does It Work?