mod_http_pep_avatar/README.markdown
author Kim Alvefur <zash@zash.se>
Sun, 19 Jan 2020 14:55:36 +0100
changeset 3848 c240934703bc
parent 3580 1396ce148073
child 4619 451514e2d369
permissions -rw-r--r--
mod_stats39: Add a README

---
summary: Serve PEP avatars from HTTP
---

# Introduction

This module serves avatars from local users who have published
[XEP-0084: User Avatar] via [PEP][doc:modules:mod_pep].

# Configuring

Simply load the module. Avatars are then available at
`http://<host>:5280/pep_avatar/<username>`

    modules_enabled = {
        ...
        "http_avatar";
    }

# Access

Users must [configure] their Avatar PEP nodes to be public, otherwise
access is denied.

# Compatibility

  ------- ---------------
  trunk   Works
  0.11    Works
  0.10    Does not work
  ------- ---------------

[configure]: https://xmpp.org/extensions/xep-0060.html#owner-configure