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

Annotate

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