From e15289097af3b4724b7cbde3e6823305932edcc9 Mon Sep 17 00:00:00 2001 From: tastytea Date: Sun, 2 Dec 2018 11:24:18 +0100 Subject: [PATCH] Reformat readme --- README.md | 16 ++++++---------- doc/nginx-example.conf | 2 +- 2 files changed, 7 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index fb3941f..eba4faf 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,6 @@ specification for hosting profile images tied to email or OpenID addresses. * Variable image size (`s` or `size`) * Default fallbacks (`d` or `default`): 404, URL, mp/mm, identicon -The default behaviour for unknown users is to return a 404 error. You can change -that by setting the environment variable `LIBRAVATARSERV_DEFAULT_FALLBACK` to -any value accepted by `d` or `default`. If a default image is put in the avatar -directory, that is returned instead. The default image can not be overridden by -adding the parameter `d` or `default` to the URL. - Clients are asked to cache results for up to 1 day to reduce load. This can apply to negative results as well. @@ -54,10 +48,12 @@ libravatarserv looks in each of `${XDG_DATA_DIRS}` for a directory named `libravatarserv`. You can force a different directory by setting the environment variable `LIBRAVATARSERV_DIR` (until 0.3.0 `AVATAR_DIR`). -The image files are named like your email address, no file extension. If you -want to force a default image for unknown email addresses, name it `default`. -The default image overrides the specified fallback in the URL and in the -environment variable. +The image files are named like your email address, no file extension. The +default behaviour for unknown users is to return a 404 error. You can change +that by setting the environment variable `LIBRAVATARSERV_DEFAULT_FALLBACK` to +any value accepted by `d` or `default`. If you want to force a default image for +unknown email addresses, name it `default`. The default image overrides the +specified fallback in the URL and in the environment variable. If you want to support "Mystery persons" (mp/mm) as default avatars, place a file named `mp` in the avatar dir. You can use the [default libravatar mystery diff --git a/doc/nginx-example.conf b/doc/nginx-example.conf index 8bb7a27..d1bbb9b 100644 --- a/doc/nginx-example.conf +++ b/doc/nginx-example.conf @@ -3,7 +3,7 @@ server { listen [::]:443 ssl; server_name avatar.example.com; - #access_log /var/log/nginx/avatar main; + # access_log /var/log/nginx/avatar main; error_log /var/log/nginx/avatar warn; ssl_certificate /var/lib/dehydrated/certs/avatar.example.com/fullchain.pem;