Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix environmental variable typo #490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 4, 2025
Merged

Fix environmental variable typo #490

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The configuration file `config.yaml` (`\app\config.yaml` in docker the container

The main configuration is specified in the `main` section of `config.yaml`:

| Name | Enviromental Variable | Type | Default | Description |
| Name | Environmental Variable | Type | Default | Description |
| -----------------------: | :---------------------------: | :------- | :-----: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `containerCheckInterval` | `MAIN_CONTAINERCHECKINTERVAL` | `string` | `"5m"` | The interval at which container are checked and published/republished to the MQTT broker, must be in the format`[number][unit]`, where `[number]` is a positive integer and [`[unit]`](#unit). |
| `updateCheckInterval` | `MAIN_UPDATECHECKINTERVAL` | `string` | `""` | The interval at which updates are checked and published/republished to the MQTT broker, must be in the format`[number][unit]`, where `[number]` is a positive integer and [`[unit]`](#unit) <br> (same of containerCheckInterval if `""`). |
Expand All @@ -63,7 +63,7 @@ The main configuration is specified in the `main` section of `config.yaml`:

The MQTT configuration is specified in the `mqtt` section of `config.yaml`:

| Name | Enviromental Variable | Type | Default | Description |
| Name | Environmental Variable | Type | Default | Description |
| ----------------: | :--------------------: | :-------: | :---------------------: | :------------------------------------------------------------------------------------------------------ |
| `connectionUri` | `MQTT_CONNECTIONURI` | `string` | `mqtt://127.0.0.1:1883` | The URL of the MQTT broker to connect to. |
| `topic` | `MQTT_TOPIC` | `string` | `mqdockerup` | The MQTT topic to publish updates to. |
Expand All @@ -83,7 +83,7 @@ The MQTT configuration is specified in the `mqtt` section of `config.yaml`:

The access tokens configuration is specified in the `accessTokens` section of `config.yaml`:

| Name | Enviromental Variable | Type | Default | Description |
| Name | Environmental Variable | Type | Default | Description |
| ----------: | :----------------------: | :------: | :-----: | :----------------------------------------------------------------------------------------------------- |
| `dockerhub` | `ACCESSTOKENS_DOCKERHUB` | `string` | `""` | The Dockerhub token, used to avoid the limitations of the DockerHub API _‼️Still Work In Progress_. |
| `github` | `ACCESSTOKENS_GITHUB` | `string` | `""` | The Github token, used to manage images on GitHub (`ghcr.io`) _⚠️Needed for this type of images_. |
Expand All @@ -104,7 +104,7 @@ The access tokens configuration is specified in the `accessTokens` section of `c

The ignore configuration is specified in the `ignore` section of `config.yaml`:

| Name | Enviromental Variable | Type | Default | Description |
| Name | Environmental Variable | Type | Default | Description |
| -----------: | :-------------------: | :------: | :-----: | :------------------------------------------------------------------------------------------------------------------ |
| `containers` | `IGNORE_CONTAINERS` | `string` | `""` | A comma separated list of container to be ignored in the check, or `*` to ignore all containers . |
| `updates` | `IGNORE_UPDATES` | `string` | `""` | A comma separated list of container which updates should be ignored in the check, or `*` to ignore all containers . |
Expand All @@ -113,7 +113,7 @@ The ignore configuration is specified in the `ignore` section of `config.yaml`:

The ignore configuration is specified in the `logs` section of `config.yaml`:

| Name | Enviromental Variable | Type | Default | Description |
| Name | Environmental Variable | Type | Default | Description |
| ------: | :-------------------: | :------: | :------: | :-------------------------------------------------------------------------------------------------------------- |
| `level` | `LOGS_LEVEL` | `string` | `"info"` | Choose the maximum level of logs to show, in order `error`, `warn`, `info`, `http`, `verbose`, `debug`, `silly` |

Expand Down