tastytea/libravatarserv
1
0
Fork 1
Code Issues Pull Requests Releases 20 Wiki Activity

Reformat readme
All checks were successful
the build was successful
Details

Browse Source
This commit is contained in:
tastytea 2018-12-02 11:24:18 +01:00
parent 3bdcd7b120
commit e15289097a
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
2 changed files with 7 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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

2
doc/nginx-example.conf
View File

@ -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;