prosody-modules
fe081789f7b5
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 @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 2876:mod_alias/README.markdown@ea6b5321db50
child 6005:49e3289c145e
comparison
equal deleted inserted replaced
6002:5a65a632d5b9 6003:fe081789f7b5
1 ---
2 summary: Point alias accounts or domains to correct XMPP user
3 ...
4
5 Introduction
6 ============
7
8 This module allows you to set up aliases that alert people who try to
9 contact them or add them to their roster what your actual JID is. This
10 is useful for changing JIDs, or just in the case where you own both
11 example.com and example.net, and want people who contact you@example.com
12 to be alerted to contact you at you@example.net instead.
13
14 This type of aliasing is well supported in the email world, but very hard
15 to handle with XMPP, this module sidesteps all the hard problems by just
16 sending the user a helpful message, requiring humans to decide what they
17 actually want to do.
18
19 This doesn't require any special support on other clients or servers,
20 just the ability to receive messages.
21
22 Configuration
23 =============
24
25 Add the module to the `modules_enabled` list.
26
27 modules_enabled = {
28 ...
29 "alias";
30 }
31
32 Then set up your list of aliases, aliases can be full or bare JIDs,
33 or hosts:
34
35 aliases = {
36 ["old@example.net"] = "new@example.net";
37 ["you@example.com"] = "you@example.net";
38 ["conference.example.com"] = "conference.example.net";
39 }
40
41 You can also set up a custom response, by default it is:
42
43 alias_response = "User $alias can be contacted at $target";
44
45 A script named mod_alias_postfixadmin.sh is included in this directory to
46 generate the aliases array directly from a postfixadmin MySQL database.
47 Instructions for use are included in the script.
48
49 Compatibility
50 =============
51
52 ------- --------------
53 trunk Works
54 0.10 Works
55 0.9 Unknown
56 0.8 Unknown
57 ------- --------------