@stendahls/libravatar-server

Libravatar Server

A node implementation of the Libravatar API

Usage

$ npx @stendahls/libravatar-server

Without npx

npm i @stendahls/libravatar-server --only=production
./node_modules/.bin/libravatar-server

Configuration

Create a .env file in the folder you start the server from.
If you run from docker, create the .env file in the folder you build.

Available values

LISTEN_PORT
default: 4000
allowed values: Kinda whatever you want

DEFAULT_SIZE
default: 80
allowed values: 1 - 512

PROVIDER
DEPRECATED, use PROVIDER_ORDER instead default: file
allowed values: file elvis

PROVIDER_ORDER
Comma separated list of which providers should be used in which order.
default: file or value from PROVIDER if set
allowed values: file, elvis and libravatarOrg
example: file,elvis,libravatarOrg

There might also be some specific options for some providers

Providers

File

Loads avatars from a folder.
The folder should contain jpg images where the name of the file should be the email you want the avatar to be for. [e-mail]

FILE_PROVIDER_RAW_FOLDER
default: ./raw
allowed values: Any path

Elvis

Loads avatars from a "container" in Elvis DAM

ELVIS_PROVIDER_SERVER
Full url to Elvis server

ELVIS_PROVIDER_USER
Username to log in with

ELVIS_PROVIDER_PASSWORD
Password for the user to login with

ELVIS_PROVIDER_AVATAR_CONTAINER
What container-id to look for avatars in

ELVIS_PROVIDER_AVATAR_DOMAIN
Domain for the avatars found in Elvis, such as example.com

Libravatar Org

Gets avatars from https://libravatar.org which fallbacks to Gravatar