Mercurial > prosody-modules

comparison mod_seclabels/README.markdown @ 1803:4d73a1a6ba68

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents mod_seclabels/README.wiki@29f3d6b7ad16
children 8de50be756e5
comparison
equal deleted inserted replaced
1802:0ab737feada6 1803:4d73a1a6ba68
1 ---
2 labels:
3 - 'Stage-Alpha'
4 summary: Security Labels
5 ...
6
7 Introduction
8 ============
9
10 This module implements [XEP-0258: Security Labels in
11 XMPP](http://xmpp.org/extensions/xep-0258.htmla).
12
13 Configuration
14 =============
15
16 As with all modules, you enable it by adding it to the modules\_enabled
17 list.
18
19 modules_enabled = {
20 ...
21 "seclabels";
22 ...
23 }
24
25 These options exist:
26
27 Name Description Default
28 ------------------------- ----------------------- -------------
29 security\_catalog\_name Catalouge name "Default"
30 security\_catalog\_desc Catalouge description "My labels"
31
32 You can then add your labels in a table called security\_labels. They
33 can be both orderd and unorderd, but ordered comes first.
34
35 security_labels = {
36 { -- This label will come first
37 name = "Public",
38 label = true, -- This is a label, but without the actual label.
39 default = true -- This is the default label.
40 },
41 {
42 name = "Private",
43 label = "PRIVATE",
44 color = "white",
45 bgcolor = "blue"
46 },
47 Sensitive = { -- A Sub-selector
48 SECRET = { -- The index is used as name
49 label = true
50 },
51 TOPSECRET = { -- The order of this and the above is not guaranteed.
52 color = "red",
53 bgcolor = "black",
54 }
55 }
56 }
57
58 Each label can have the following properties:
59
60 Name Description Default
61 ---------------- --------------------------------------------------------- ----------------------------------------------------------
62 name The name of the label. Used for selector. Required.
63 label The actual label, ie `<esssecuritylabel/>` Required, can be boolean for a empty label, or a string.
64 display The text shown as display marking. Defaults to the name
65 color, bgcolor The fore- and background color of the display marking None
66 default Boolean, true for the default. Only one may be default. false