Mercurial > prosody-modules

comparison mod_server_contact_info/README.markdown @ 2321:d9c19ee16f2e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_server_contact_info/README: Update
author Kim Alvefur <zash@zash.se>
date Sat, 01 Oct 2016 17:20:31 +0200
parents 8de50be756e5
children 44e5adbb6ac0
comparison
equal deleted inserted replaced
2320:d6a3362ca256 2321:d9c19ee16f2e
1 --- 1 ---
2 labels: 2 labels:
3 - 'Stage-Alpha' 3 - 'Stage-Beta'
4 summary: Contact Addresses for XMPP Services 4 summary: Contact Addresses for XMPP Services
5 ... 5 ---
6 6
7 Introduction 7 Introduction
8 ============ 8 ============
9 9
10 This module implements [XEP-0157: Contact Addresses for XMPP 10 This module lets you advertise various contact addresses for your XMPP
11 Services](http://xmpp.org/extensions/xep-0157.html). 11 service via [XEP-0157].
12 12
13 Configuration 13 Configuration
14 ============= 14 =============
15 15
16 ``` lua 16 Various types of contact addresses can be set via the single table
17 option `contact_info`. Each field is either a string or a list of
18 strings. Each string should be an URI.
19
20 An example showing all possible fields:
21
22 ``` {.lua}
17 contact_info = { 23 contact_info = {
18 abuse = { "mailto:abuse@shakespeare.lit", "xmpp:abuse@shakespeare.lit" }; 24 abuse = { "mailto:abuse@shakespeare.lit", "xmpp:abuse@shakespeare.lit" };
19 admin = { "mailto:admin@shakespeare.lit", "xmpp:admin@shakespeare.lit" }; 25 admin = { "mailto:admin@shakespeare.lit", "xmpp:admin@shakespeare.lit" };
20 feedback = { "http://shakespeare.lit/feedback.php", "mailto:feedback@shakespeare.lit", "xmpp:feedback@shakespeare.lit" }; 26 feedback = { "http://shakespeare.lit/feedback.php", "mailto:feedback@shakespeare.lit", "xmpp:feedback@shakespeare.lit" };
21 sales = "xmpp:bard@shakespeare.lit"; 27 sales = "xmpp:bard@shakespeare.lit";
22 security = "xmpp:security@shakespeare.lit"; 28 security = "xmpp:security@shakespeare.lit";
23 support = { "http://shakespeare.lit/support.php", "xmpp:support@shakespeare.lit" }; 29 support = { "http://shakespeare.lit/support.php", "xmpp:support@shakespeare.lit" };
24 }; 30 };
25 ``` 31 ```
26 32
27 The default is based on the `admins` config variable. 33 If not set, the `admins` option will be used.
28 34
29 Compatibility 35 Compatibility
30 ============= 36 =============
31 37
32 ------- ------- 38 ------ ---------------
33 trunk Works 39 0.10 works
34 ------- ------- 40 0.9 works
41 0.8 does not work
42 ------ ---------------