Skip to content

Commit

Permalink
chore: adds timeout
Browse files Browse the repository at this point in the history
  • Loading branch information
amir20 committed Sep 20, 2024
1 parent dfaa52e commit 6343629
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions docs/guide/supported-env-vars.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,13 @@ Configurations can be done with flags or environment variables. The table below
| `--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 |
| `--enable-actions` | `DOZZLE_ENABLE_ACTIONS` | `false` |
| `--filter` | `DOZZLE_FILTER` | `""` |
| `--no-analytics` | `DOZZLE_NO_ANALYTICS` | false |
| `--no-analytics` | `DOZZLE_NO_ANALYTICS` | `false` |
| `--mode` | `DOZZLE_MODE` | `server` |
| `--remote-host` | `DOZZLE_REMOTE_HOST` | |
| `--remote-agent` | `DOZZLE_REMOTE_AGENT` | |
| `--timeout` | `DOZZLE_TIMEOUT` | `3s` |

> [!TIP] Repeated Flags
> Some flags like `--remote-host` or `--remote-agent` can be used multiple times. For example, `--remote-agent tcp://167.99.1.1:7007 --remote-agent tcp://167.99.1.2:7007` or comma separated `DOZZLE_REMOTE_AGENT=tcp://167.99.1.1:7007,tcp://167.99.1.2:7007`.
Expand All @@ -36,11 +37,11 @@ docker run amir20/dozzle generate admin --password password --email test@email.n

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 | |
| Flag | Description | Default |
| ------------ | ---------------- | ------- |
| `--password` | User's password | |
| `--email` | User's email | |
| `--name` | User's full name | |

See [authentication](/guide/authentication) for more information.

Expand All @@ -58,7 +59,7 @@ docker run --volume=/var/run/docker.sock:/var/run/docker.sock -p 8080:8080 amir2

See [agent](/guide/agent) for more information.

## Healtcheck
## Healthcheck

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.

Expand Down

0 comments on commit 6343629

Please sign in to comment.