view mod_http_pep_avatar/README.markdown @ 5907:d194d1012fd3

Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parents 451514e2d369
children
line wrap: on
line source

---
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_pep_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