diff --git a/README.md b/README.md index 9daff8f39bdb57109f9d970587f7384741df28ac..8fadf9d072262acfe8ef81b437d88fecb0d4575f 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ Libravatar-nginx === -Libravatar-nginx is a project that aims to provide an easy and static way to provide your avatars [following the libravatar](https://www.libravatar.org/) using not more than nginx. This provides a massively reduced attack surface and maxium performance since all images are pre-genrated and no further code has to run on the server-side. +Libravatar-nginx is a project that aims to provide an easy and static way to provide your avatars [following the libravatar](https://www.libravatar.org/) using not more than nginx. This provides a massively reduced attack surface and maximum performance since all images are pre-generated and no further code has to run on the server-side. -To achive this the image uses a shell script, imagemagick's `convert` command and an extended nginx config. +To achieve this the image uses a shell script, imagemagick's `convert` command and an extended nginx config. Supported features: @@ -73,6 +73,7 @@ The libravatar-nginx container image provides some config options for the avatar |Option |Default|Description| |-------------|-------|-----------| +|`DEBUG` | unset | If set, the entrypoint script will run with `set -x`. | |`SCALE_START`| `10` | Size of the minimal border length of an avatar. All avatars are square so the smallest avatar size available is `10x10` when using the default setting.| |`SCALE_STEP` | `2` | Change in pixel for the generation of avatars. When using default values `10x10` would be the smallest available avatar followed by `12x12`, `14x14`, and so on.| |`SCALE_STOP` | `512` | Maximum avatar size. All sizes from `SCALE_START` to `SCALE_STOP` will be generated using the `SCALE_STEP` as counter. With defaults this means `10x10`, `12x12`, `14x14`, … until `512x512`.|