Browse Source

Reformat readme

tastytea 2 weeks ago
parent
commit
e15289097a
Signed by: tastytea <tastytea@tastytea.de> GPG Key ID: CFC39497F1B26E07
2 changed files with 7 additions and 11 deletions
  1. 6
    10
      README.md
  2. 1
    1
      doc/nginx-example.conf

+ 6
- 10
README.md View File

@@ -14,12 +14,6 @@ specification for hosting profile images tied to email or OpenID addresses.
14 14
 * Variable image size (`s` or `size`)
15 15
 * Default fallbacks (`d` or `default`): 404, URL, mp/mm, identicon
16 16
 
17
-The default behaviour for unknown users is to return a 404 error. You can change
18
-that by setting the environment variable `LIBRAVATARSERV_DEFAULT_FALLBACK` to
19
-any value accepted by `d` or `default`. If a default image is put in the avatar
20
-directory, that is returned instead. The default image can not be overridden by
21
-adding the parameter `d` or `default` to the URL.
22
-
23 17
 Clients are asked to cache results for up to 1 day to reduce load. This can
24 18
 apply to negative results as well.
25 19
 
@@ -54,10 +48,12 @@ libravatarserv looks in each of `${XDG_DATA_DIRS}` for a directory named
54 48
 `libravatarserv`. You can force a different directory by setting the environment
55 49
 variable `LIBRAVATARSERV_DIR` (until 0.3.0 `AVATAR_DIR`).
56 50
 
57
-The image files are named like your email address, no file extension. If you
58
-want to force a default image for unknown email addresses, name it `default`.
59
-The default image overrides the specified fallback in the URL and in the
60
-environment variable.
51
+The image files are named like your email address, no file extension. The
52
+default behaviour for unknown users is to return a 404 error. You can change
53
+that by setting the environment variable `LIBRAVATARSERV_DEFAULT_FALLBACK` to
54
+any value accepted by `d` or `default`. If you want to force a default image for
55
+unknown email addresses, name it `default`. The default image overrides the
56
+specified fallback in the URL and in the environment variable.
61 57
 
62 58
 If you want to support "Mystery persons" (mp/mm) as default avatars, place a
63 59
 file named `mp` in the avatar dir. You can use the [default libravatar mystery

+ 1
- 1
doc/nginx-example.conf View File

@@ -3,7 +3,7 @@ server {
3 3
     listen [::]:443 ssl;
4 4
     server_name avatar.example.com;
5 5
 
6
-    #access_log /var/log/nginx/avatar main;
6
+    # access_log /var/log/nginx/avatar main;
7 7
     error_log /var/log/nginx/avatar warn;
8 8
 
9 9
     ssl_certificate /var/lib/dehydrated/certs/avatar.example.com/fullchain.pem;

Loading…
Cancel
Save