From cdb7855578ab5f0a9905dc9c63bb0d22aa01b1de Mon Sep 17 00:00:00 2001 From: Amir Raminfar Date: Tue, 9 Jul 2024 15:43:40 -0700 Subject: [PATCH] docs: updates docs (#3083) --- docs/guide/supported-env-vars.md | 29 ++++++++++++++--------------- docs/guide/swarm-mode.md | 3 +++ 2 files changed, 17 insertions(+), 15 deletions(-) diff --git a/docs/guide/supported-env-vars.md b/docs/guide/supported-env-vars.md index 68d2ecd0..9ce57972 100644 --- a/docs/guide/supported-env-vars.md +++ b/docs/guide/supported-env-vars.md @@ -6,18 +6,17 @@ title: Environment variables and configuration Configurations can be done with flags or environment variables. The table below outlines all supported options and their respective env vars. -| Flag | Env Variable | Default | -| --------------------------- | -------------------------------- | -------------- | -| `--addr` | `DOZZLE_ADDR` | `:8080` | -| `--base` | `DOZZLE_BASE` | `/` | -| `--hostname` | `DOZZLE_HOSTNAME` | `""` | -| `--level` | `DOZZLE_LEVEL` | `info` | -| `--auth-provider` | `DOZZLE_AUTH_PROVIDER` | `none` | -| `--auth-header-user` | `DOZZLE_AUTH_HEADER_USER` | `Remote-User` | -| `--auth-header-email` | `DOZZLE_AUTH_HEADER_EMAIL` | `Remote-Email` | -| `--auth-header-name` | `DOZZLE_AUTH_HEADER_NAME` | `Remote-Name` | -| `--enable-actions` | `DOZZLE_ENABLE_ACTIONS` | false | -| `--wait-for-docker-seconds` | `DOZZLE_WAIT_FOR_DOCKER_SECONDS` | 0 | -| `--filter` | `DOZZLE_FILTER` | `""` | -| `--no-analytics` | `DOZZLE_NO_ANALYTICS` | false | -| `--remote-host` | `DOZZLE_REMOTE_HOST` | | +| Flag | Env Variable | Default | +| --------------------- | -------------------------- | -------------- | +| `--addr` | `DOZZLE_ADDR` | `:8080` | +| `--base` | `DOZZLE_BASE` | `/` | +| `--hostname` | `DOZZLE_HOSTNAME` | `""` | +| `--level` | `DOZZLE_LEVEL` | `info` | +| `--auth-provider` | `DOZZLE_AUTH_PROVIDER` | `none` | +| `--auth-header-user` | `DOZZLE_AUTH_HEADER_USER` | `Remote-User` | +| `--auth-header-email` | `DOZZLE_AUTH_HEADER_EMAIL` | `Remote-Email` | +| `--auth-header-name` | `DOZZLE_AUTH_HEADER_NAME` | `Remote-Name` | +| `--enable-actions` | `DOZZLE_ENABLE_ACTIONS` | false | +| `--filter` | `DOZZLE_FILTER` | `""` | +| `--no-analytics` | `DOZZLE_NO_ANALYTICS` | false | +| `--remote-host` | `DOZZLE_REMOTE_HOST` | | diff --git a/docs/guide/swarm-mode.md b/docs/guide/swarm-mode.md index 4281d049..826c4017 100644 --- a/docs/guide/swarm-mode.md +++ b/docs/guide/swarm-mode.md @@ -37,6 +37,9 @@ networks: Note that the `DOZZLE_MODE` environment variable is set to `swarm`. This tells Dozzle to automatically discover other Dozzle instances in the swarm. The `overlay` network is used to create the mesh network between the different Dozzle instances. +> [!NOTE] +> Due to implementation details, the name for the service must be exactly `dozzle`. This is because Dozzle uses the service name to discover other Dozzle instances in the swarm. In the future, it would make sense to query the Docker API for all services with the current container ID. + ## 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: