gravatar/README.md

   1 # Gravatar 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 [Gravatar](http://www.gravatar.com). This will be used if there have not been found any other avatar images yet for example through OpenID.
   5
   6 Gravatar is a popular, but centralized and proprietary service where people can store an avatar image for their email-addresses. It is widely used on many pages, for example to display an avatar for comment functions, profile pages, etc.
   7
   8 * * *
   9
  10 # Configuration
  11 ## Default Avatar Image
  12 If no avatar was found for an email Gravatar can create some pseudo-random generated avatars based on an email hash. You can choose between these presets:
  13
  14 * __Gravatar__: default static Gravatar logo
  15 * __MM__: (mystery-man) a static image
  16 * __Identicon__: a generated geometric pattern based on email hash
  17 * __Monsterid__: a generated 'monster' with different colors, faces, etc. based on email hash
  18 * __Wavatar__: faces with different features and backgrounds based on email hash
  19 * __Retro__: 8-bit arcade-styled pixelated faces based on email hash
  20
  21 See examples at [Gravatar][1].
  22 ## Avatar Rating
  23 Gravatar lets users self-rate their images to be used at appropriate audiences. Choose which are appropriate for your friendica site:
  24
  25 * __g__: suitable for display on all wesites with any audience type
  26 * __pg__: may contain rude gestures, provocatively dressed individuals, the lesser swear words, or mild violence
  27 * __r__: may contain such things as harsh profanity, intense violence, nudity, or hard drug use
  28 * __x__: may contain hardcore sexual imagery or extremely disurbing violence
  29
  30 See more information at [Gravatar][1].
  31
  32 ## Alternative Configuration
  33 Open the `config/node.config.php` file and add "gravatar" to the list of activated addons:
  34
  35         'addons' => [
  36                 ...
  37                 'gravatar' => [
  38                         admin => true,
  39                 ],
  40         ]
  41
  42 You can add two configuration variables for the addon to the `config/gravatar.config.php` file:
  43
  44         return [
  45                 'gravatar' => [
  46                         'default_avatar' => 'identicon',
  47                         'rating' => 'g',
  48                 ],
  49         ];
  50
  51 [1]: http://www.gravatar.com/site/implement/images/ "See documentation at Gravatar for more information"