Diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_alias/README.markdown	Sat Nov 21 00:10:08 2015 -0500
@@ -0,0 +1,57 @@
+---
+summary: Point alias accounts or domains to correct XMPP user
+...
+
+Introduction
+============
+
+This module allows you to set up aliases that alert people who try to
+contact them or add them to their roster what your actual JID is.  This
+is useful for changing JIDs, or just in the case where you own both
+example.com and example.net, and want people who contact you@example.com
+to be alerted to contact you at you@example.net instead.
+
+This type of aliasing is well supported in the email world, but very hard
+to handle with XMPP, this module sidesteps all the hard problems by just
+sending the user a helpful message, requiring humans to decide what they
+actually want to do.
+
+This doesn't require any special support on other clients or servers,
+just the ability to recieve messages.
+
+Configuration
+=============
+
+Add the module to the `modules_enabled` list.
+
+    modules_enabled = {
+        ...
+        "alias";
+    }
+
+Then set up your list of aliases, aliases can be full or bare JIDs,
+or hosts:
+
+    aliases = {
+        ["old@example.net"] = "new@example.net";
+        ["you@example.com"] = "you@example.net";
+        ["conference.example.com"] = "conference.example.net";
+    }
+
+You can also set up a custom response, by default it is:
+
+    alias_response = "User $alias can be contacted at $target";
+
+A script named mod_alias_postfixadmin.sh is included in this directory to
+generate the aliases array directly from a postfixadmin MySQL database.
+Instructions for use are included in the script.
+
+Compatibility
+=============
+
+  ------- --------------
+  trunk   Works
+  0.10    Works
+  0.9     Unknown
+  0.8     Unknown
+  ------- --------------