prosody-modules
d611ed13df7e
mod_alias/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_alias/README.md @ 6209:d611ed13df7e draft

Merge
author Trần H. Trung <xmpp:trần.h.trung@trung.fun>
date Tue, 18 Mar 2025 00:16:25 +0700
child 6211:750d64c47ec6
comparison
equal deleted inserted replaced
6208:e20901443eae 6209:d611ed13df7e
1 ---
2 summary: "Point alias accounts or domains to correct XMPP user"
3 labels:
4 - 'Stage-Alpha'
5 ...
6
7 Introduction
8 ============
9
10 This module allows you to set up aliases that alert people who try to
11 contact them or add them to their roster what your actual JID is. This
12 is useful for changing JIDs, or just in the case where you own both
13 example.com and example.net, and want people who contact you@example.com
14 to be alerted to contact you at you@example.net instead.
15
16 This type of aliasing is well supported in the email world, but very hard
17 to handle with XMPP, this module sidesteps all the hard problems by just
18 sending the user a helpful message, requiring humans to decide what they
19 actually want to do.
20
21 This doesn't require any special support on other clients or servers,
22 just the ability to receive messages.
23
24 Configuration
25 =============
26
27 Add the module to the `modules_enabled` list.
28
29 modules_enabled = {
30 ...
31 "alias";
32 }
33
34 Then set up your list of aliases, aliases can be full or bare JIDs,
35 or hosts:
36
37 aliases = {
38 ["old@example.net"] = "new@example.net";
39 ["you@example.com"] = "you@example.net";
40 ["conference.example.com"] = "conference.example.net";
41 }
42
43 You can also set up a custom response, by default it is:
44
45 alias_response = "User $alias can be contacted at $target";
46
47 A script named mod_alias_postfixadmin.sh is included in this directory to
48 generate the aliases array directly from a postfixadmin MySQL database.
49 Instructions for use are included in the script.
50
51 Compatibility
52 =============
53
54 ------------–---------- --------------
55 trunk as of 2024-10-22 Works
56 0.12 Works
57 ----------------------- --------------
58