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

docs: updates env vars

Browse Source
This commit is contained in:
Amir Raminfar
2024-07-12 12:10:32 -07:00
parent 983c956ade
commit 71ff516779
1 changed files with 45 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/guide/supported-env-vars.md
View File

@@ -1,8 +1,8 @@
---
title: Environment variables and configuration
title: Environment variables and subcommands
---
# Environment variables and configuration
# Global Environment Variables
Configurations can be done with flags or environment variables. The table below outlines all supported options and their respective env vars.
@@ -19,4 +19,46 @@ Configurations can be done with flags or environment variables. The table below
| `--enable-actions` | `DOZZLE_ENABLE_ACTIONS` | false |
| `--filter` | `DOZZLE_FILTER` | `""` |
| `--no-analytics` | `DOZZLE_NO_ANALYTICS` | false |
| `--remote-host` | `DOZZLE_REMOTE_HOST` | |
| `--mode` | `DOZZLE_MODE` | `server` |
| `--remote-host` \* | `DOZZLE_REMOTE_HOST` | |
| `--remote-agent` \* | `DOZZLE_REMOTE_AGENT` | |
`*` These flags can be used multiple times. For example, `--remote-host tcp://167.99.1.1:2376 --remote-host tcp://167.99.1.2:2376` or comma separated `DOZZLE_REMOTE_HOST=tcp://167.99.1.1:2376,tcp://167.99.1.2:2376`
## Generate users.yml
Dozzle supports generating `users.yml` file. This file is used to authenticate users. Here is an example:
```sh
docker run amir20/dozzle generate admin --password password --email test@email.net --name "John Doe" > users.yml
```
In this example, `admin` is the username. Email and name are optional but recommended to display accurate avatars. `docker run amir20/dozzle generate --help` displays all options.
| Flag | Description | Default |
| ------------ | --------------- | ------- |
| `--password` | User's password | |
| `--email` | User's email | |
| `--name` | User's fullname | |
See [authentication](/guide/authentication) for more information.
## Agent Mode
Dozzle supports running in agent mode. Agent mode is useful when running Dozzle on a remote host and you want to monitor a different Docker host. Agent mode is enabled by setting the `--remote-agent` flag. Here is an example:
```sh
docker run --volume=/var/run/docker.sock:/var/run/docker.sock -p 8080:8080 amir20/dozzle --remote-agent remote-ip:7007
```
| Flag | Env Variable | Default |
| -------- | ------------------- | ------- |
| `--addr` | `DOZZLE_AGENT_ADDR` | `:7007` |
See [agent](/guide/agent) for more information.
## Healtcheck
Dozzle supports healthcheck using `dozzle healthcheck` command. It is not enabled by default as it adds extra CPU usage. To use `healthcheck` you need to configure it.
See [healthcheck](/guide/healthcheck) for more information.