libravatar/README.md

   1 # Libravatar Addon
   2 by [Klaus Weidenbach](http://friendica.dszdw.net/profile/klaus)
   3
   4 This addon allows you to look up an avatar image for new users and contacts at [Libravatar](http://www.libravatar.com). It will be used if there have not been found any other avatar images yet for example through OpenID.
   5
   6 Libravatar is a free and open replacement for Gravatar. It is a service where people can store an avatar image for their email-addresses. These avatar images can get looked up for example in comment functions, profile pages, etc. on other sites. There exists a central installation at [www.libravatar.com](http://www.libravatar.com), but you can also host it on your own server. If no avatar was found Libravatar will look up at Gravatar as a fallback.
   7 There is no rating available, as it is on Gravatar, so all avatar lookups are g-rated. (Suitable for all audiences.)
   8
   9 You can not use the Libravatar and Gravatar addon at the same time. You need to choose one. If you need other ratings than g you better stay with Gravatar, otherwise it is safe to use Libravatar, because it will fall back to Gravatar if nothing was found at Libravatar.
  10
  11 * * *
  12
  13 # Configuration
  14 ## Default Avatar Image
  15 If no avatar was found for an email Libravatar can create some pseudo-random generated avatars based on an email hash. You can choose between these presets:
  16
  17 * __MM__: (mystery-man) a static image
  18 * __Identicon__: a generated geometric pattern based on email hash
  19 * __Monsterid__: a generated 'monster' with different colors, faces, etc. based on email hash
  20 * __Wavatar__: faces with different features and backgrounds based on email hash
  21 * __Retro__: 8-bit arcade-styled pixelated faces based on email hash
  22
  23 See examples at [Libravatar][1].
  24
  25 ## Alternative Configuration
  26 Open the `config/local.config.php` file and add "libravatar" to the list of activated addons:
  27
  28     'system' => [
  29         ...
  30         'addon' => '...,libravatar'
  31         ...
  32     ]
  33
  34 You can add one configuration variables for the addon to the `config/addon.config.php` file:
  35
  36     'libravatar' => [
  37         'default_avatar' => 'identicon',
  38     ],
  39
  40 [1]: http://wiki.libravatar.org/api/ "See API documentation at Libravatar for more information"