mod_atom/README.markdown
author Matthew Wild <mwild1@gmail.com>
Sat, 24 Sep 2022 09:26:26 +0100
changeset 5063 5f1120c284c5
parent 3578 f478e325529e
permissions -rw-r--r--
mod_cloud_notify_extensions: Add note about dependency Noting here because people might not click through to see it on the mod_cloud_notify_encrypted page.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3261
f09d92579158 mod_atom: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     1
# Introduction
f09d92579158 mod_atom: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     2
f09d92579158 mod_atom: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     3
This module exposes users [microblogging][xep277] on Prosodys built-in HTTP server.
f09d92579158 mod_atom: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     4
3578
f478e325529e mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents: 3261
diff changeset
     5
# Usage
f478e325529e mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents: 3261
diff changeset
     6
f478e325529e mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents: 3261
diff changeset
     7
With default HTTP settings, the microblog of `user@example.com` would be
f478e325529e mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents: 3261
diff changeset
     8
seen at `https://example.com:5281/atom/user`.
f478e325529e mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents: 3261
diff changeset
     9
3261
f09d92579158 mod_atom: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    10
# Configuration
f09d92579158 mod_atom: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    11
f09d92579158 mod_atom: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    12
The module itself has no options. However it uses the access control
f09d92579158 mod_atom: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    13
mechanisms in PubSub, so users must reconfigure their microblogging node
f09d92579158 mod_atom: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    14
to allow access, by setting `access_model` to `open`.
f09d92579158 mod_atom: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    15
E.g. Gajim has UI for this, look for "Personal Events" → "Configure
f09d92579158 mod_atom: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    16
services".
f09d92579158 mod_atom: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    17