prosody-modules
8de50be756e5
mod_seclabels/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_seclabels/README.markdown @ 1820:8de50be756e5

Various README files: Correct indentation levels, fix syntax and other small fixes
author Kim Alvefur <zash@zash.se>
date Wed, 02 Sep 2015 17:30:33 +0200
parent 1803:4d73a1a6ba68
child 2340:a1d641e88918
comparison
equal deleted inserted replaced
1819:1b08597b5e6f 1820:8de50be756e5
14 ============= 14 =============
15 15
16 As with all modules, you enable it by adding it to the modules\_enabled 16 As with all modules, you enable it by adding it to the modules\_enabled
17 list. 17 list.
18 18
19 modules_enabled = {
20 ...
21 "seclabels";
22 ...
23 }
24
25 These options exist: 19 These options exist:
26 20
27 Name Description Default 21 Name Description Default
28 ------------------------- ----------------------- ------------- 22 ------------------------- ----------------------- -------------
29 security\_catalog\_name Catalouge name "Default" 23 security\_catalog\_name Catalouge name "Default"
30 security\_catalog\_desc Catalouge description "My labels" 24 security\_catalog\_desc Catalouge description "My labels"
31 25
32 You can then add your labels in a table called security\_labels. They 26 You can then add your labels in a table called security\_labels. They
33 can be both orderd and unorderd, but ordered comes first. 27 can be both orderd and unorderd, but ordered comes first.
34 28
35 security_labels = { 29 ``` {.lua}
36 { -- This label will come first 30 security_labels = {
37 name = "Public", 31 { -- This label will come first
38 label = true, -- This is a label, but without the actual label. 32 name = "Public",
39 default = true -- This is the default label. 33 label = true, -- This is a label, but without the actual label.
40 }, 34 default = true -- This is the default label.
41 { 35 },
42 name = "Private", 36 {
43 label = "PRIVATE", 37 name = "Private",
44 color = "white", 38 label = "PRIVATE",
45 bgcolor = "blue" 39 color = "white",
46 }, 40 bgcolor = "blue"
47 Sensitive = { -- A Sub-selector 41 },
48 SECRET = { -- The index is used as name 42 Sensitive = { -- A Sub-selector
49 label = true 43 SECRET = { -- The index is used as name
50 }, 44 label = true
51 TOPSECRET = { -- The order of this and the above is not guaranteed. 45 },
52 color = "red", 46 TOPSECRET = { -- The order of this and the above is not guaranteed.
53 bgcolor = "black", 47 color = "red",
54 } 48 bgcolor = "black",
55 } 49 }
56 } 50 }
51 }
52 ```
57 53
58 Each label can have the following properties: 54 Each label can have the following properties:
59 55
60 Name Description Default 56 Name Description Default
61 ---------------- --------------------------------------------------------- ---------------------------------------------------------- 57 ---------------- --------------------------------------------------------- ----------------------------------------------------------