mod_http_pep_avatar/README.markdown

   1 ---
   2 summary: Serve PEP avatars from HTTP
   3 ---
   4
   5 # Introduction
   6
   7 This module serves avatars from local users who have published
   8 [XEP-0084: User Avatar] via [PEP][doc:modules:mod_pep].
   9
  10 # Configuring
  11
  12 Simply load the module. Avatars are then available at
  13 `http://<host>:5280/pep_avatar/<username>`
  14
  15     modules_enabled = {
  16         ...
  17         "http_avatar";
  18     }
  19
  20 # Access
  21
  22 Users must [configure] their Avatar PEP nodes to be public, otherwise
  23 access is denied.
  24
  25 # Compatibility
  26
  27   ------- ---------------
  28   trunk   Works
  29   0.11    Works
  30   0.10    Does not work
  31   ------- ---------------
  32
  33 [configure]: https://xmpp.org/extensions/xep-0060.html#owner-configure