annotate mod_auto_moved/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 59fdda04b87e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4679
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
1 ---
4680
59fdda04b87e mod_auto_moved: Fix README rendering
Matthew Wild <mwild1@gmail.com>
parents: 4679
diff changeset
2 summary: "XEP-0283: Moved"
4679
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3 labels:
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
4 - 'Stage-Alpha'
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
5 ...
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
6
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
7 Introduction
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
8 ============
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
9
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
10 This module implements [XEP-0283: Moved](http://xmpp.org/extensions/xep-0283.html),
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
11 a way for contacts to notify you that they have moved to a new address.
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
12
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
13 This module is not necessary to generate such notifications - that can be done
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
14 by clients, for example. What this module does is automatically verify such
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
15 notifications and, if verification is successful, automatically update your
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16 roster (contact list).
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
17
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
18 Configuration
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
19 =============
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
20
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
21 There is no configuration for this module, just add it to
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
22 modules\_enabled as normal.
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
23
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
24 Compatibility
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
25 =============
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
26
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
27 ----- -------
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
28 0.11 Does not work
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
29 ----- -------
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
30 trunk Works
f95a1e197a07 mod_auto_moved: New module implementing XEP-0283 r0.2.0
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
31 ----- -------