comparison mod_pastebin/README.markdown @ 4316:4bba01ce2f98

mod_pastebin: Document tresholds inclusion in disco#info
author Kim Alvefur <zash@zash.se>
date Sat, 02 Jan 2021 15:38:15 +0100
parents 87e250409998
children
comparison
equal deleted inserted replaced
4315:87e250409998 4316:4bba01ce2f98
42 42
43 In 0.8 and older this can be changed with `pastebin_ports` (see below), 43 In 0.8 and older this can be changed with `pastebin_ports` (see below),
44 or you can forward another external URL from your web server to Prosody, 44 or you can forward another external URL from your web server to Prosody,
45 use `pastebin_url` to set that URL. 45 use `pastebin_url` to set that URL.
46 46
47 # Discovery
48
49 The line and character tresholds are advertised in
50 [service discovery][xep-0030] like this:
51
52 ``` {.xml}
53 <iq id="791d37e8-86d8-45df-adc2-9bcb17c45cb7" type="result" xml:lang="en" from="prosody@conference.prosody.im">
54 <query xmlns="http://jabber.org/protocol/disco#info">
55 <identity type="text" name="Prosŏdy IM Chatroom" category="conference"/>
56 <feature var="http://jabber.org/protocol/muc"/>
57 <feature var="https://modules.prosody.im/mod_pastebin"/>
58 <x xmlns="jabber:x:data" type="result">
59 <field type="hidden" var="FORM_TYPE">
60 <value>http://jabber.org/protocol/muc#roominfo</value>
61 </field>
62 <field label="Title" type="text-single" var="muc#roomconfig_roomname">
63 <value>Prosŏdy IM Chatroom</value>
64 </field>
65 <!-- etc... -->
66 <field type="text-single" var="{https://modules.prosody.im/mod_pastebin}max_lines">
67 <value>12</value>
68 </field>
69 <field type="text-single" var="{https://modules.prosody.im/mod_pastebin}max_characters">
70 <value>1584</value>
71 </field>
72 </x>
73 </query>
74 </iq>
75 ```
76
47 # Configuration 77 # Configuration
48 78
49 Option Description 79 Option Description
50 ------------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 80 ------------------------- -------------------------------------------------------------------------------------------------------------------------------------------------------------------------
51 pastebin_threshold Maximum length (in characters) of a message that is allowed to skip the pastebin. (default 500 characters) 81 pastebin_threshold Maximum length (in characters) of a message that is allowed to skip the pastebin. (default 500 characters)