mirrors/dozzle
1
0
Fork 0
mirror of https://github.com/amir20/dozzle.git synced 2025-12-24 06:28:42 +01:00
Code Issues Projects Releases Wiki Activity

docs: fixes grammar and spelling errors (#3413)

Browse Source
This commit is contained in:
Amir Raminfar
2024-11-20 09:41:58 -08:00
committed by GitHub
parent 9d244cf26b
commit 4c1f5b4062
17 changed files with 99 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/guide/swarm-mode.md
View File

@@ -4,15 +4,15 @@ 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). 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. But it does mean each host needs to be setup with Dozzle.
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?
## How Does It Work?
When deployed in Swarm Mode, Dozzle will create a secured mesh network between all the nodes in the swarm. This network is used to communicate between the different Dozzle instances. The mesh network is created using [mTLS](https://www.cloudflare.com/learning/access-management/what-is-mutual-tls) with a private TLS certificate. This means that all communication between the different Dozzle instances is encrypted and safe to deploy any where.
When deployed in Swarm Mode, Dozzle will create a secured mesh network between all the nodes in the swarm. This network is used to communicate between the different Dozzle instances. The mesh network is created using [mTLS](https://www.cloudflare.com/learning/access-management/what-is-mutual-tls) with a private TLS certificate. This means that all communication between the different Dozzle instances is encrypted and safe to deploy anywhere.
Dozzle supports Docker [stacks](https://docs.docker.com/reference/cli/docker/stack/deploy/), [services](https://docs.docker.com/engine/swarm/how-swarm-mode-works/services/) and custom groups for joining logs together. `com.docker.stack.namespace` and `com.docker.compose.project` labels are used for grouping containers. For services, Dozzle uses the service name as the group name which is `com.docker.swarm.service.name`.
## How to enable Swarm Mode?
## How to Enable Swarm Mode?
To deploy on every node in the swarm, you can use `mode: global`. This will deploy Dozzle on every node in the swarm. Here is an example using Docker Stack:
@@ -40,9 +40,9 @@ Note that the `DOZZLE_MODE` environment variable is set to `swarm`. This tells D
> [!NOTE]
> Due to implementation details, <strike>the name for the service must be exactly `dozzle`</strike>. This is no longer required starting with version `v8.2`. You can name the service anything you want. The service name is automatically detected by Dozzle using `com.docker.swarm.service.name` label.
## Setting up simple authentication in Swarm Mode
## Setting Up Simple Authentication in Swarm Mode
To setup simple authentication, you can use Docker secrets to store `users.yml` file. Here is an example using Docker Stack:
To set up simple authentication, you can use Docker secrets to store `users.yml` file. Here is an example using Docker Stack:
```yml
services:
@@ -75,7 +75,7 @@ secrets:
In this example, `users.yml` file is stored in a Docker secret. It is the same as the [simple authentication](/guide/authentication#generating-users-yml) example.
## Adding standalone Agents to Swarm Mode
## Adding Standalone Agents to Swarm Mode
From version v8.8.x, Dozzle supports adding standalone [Agents](/guide/agent) when running in Swarm Mode.