Mercurial > prosody-modules

annotate mod_atom/README.markdown @ 4546:cfe196f88e96

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_rest: Reorganise openapi spec to group stanza types Goal is to make openapi.yaml and schema-xmpp.json not differ too much.
author Kim Alvefur <zash@zash.se>
date Sun, 25 Apr 2021 16:20:32 +0200
parents f478e325529e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3257
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
3574
f478e325529e mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents: 3257
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: 3257
diff changeset
6
f478e325529e mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents: 3257
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: 3257
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: 3257
diff changeset
9
3257
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