Skip to content
Snippets Groups Projects
Normal view Permalink
xmpp.md 10.6 KiB
Newer Older
  • Learn to ignore specific revisions
    • Suvendhu Hansa's avatar
    doc: Align structure  
    Suvendhu Hansa committed
    1 2 
    # UCI Schema
<tbody><tr><td colspan="2"><div style="font-weight: bold">xmpp</div><table style="width:100%"><tbody><tr><td><div style="font-weight: bold; font-size: 14px">section</div></td><td><div style="font-weight: bold; font-size: 14px">description</div></td><td><div style="font-weight: bold; font-size: 14px">multi</div></td><td><div style="font-weight: bold; font-size: 14px">options</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">xmpp</div></td><td class="td_row_even"><div class="td_row_even">xmppc daemon Settings</div></td><td class="td_row_even"><div class="td_row_even">false</div></td><td class="td_row_even"><table style="width:100%"><tbody><tr><td><div style="font-weight: bold; font-size: 14px">name</div></td><td><div style="font-weight: bold; font-size: 14px">type</div></td><td><div style="font-weight: bold; font-size: 14px">required</div></td><td><div style="font-weight: bold; font-size: 14px">default</div></td><td><div style="font-weight: bold; font-size: 14px">description</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">enable</div></td><td class="td_row_even"><div class="td_row_even">boolean</div></td><td class="td_row_even"><div class="td_row_even">yes</div></td><td class="td_row_even"><div class="td_row_even">0</div></td><td class="td_row_even"><div class="td_row_even">Enable xmpp feature</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">conn_req_connection</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">yes</div></td><td class="td_row_odd"><div class="td_row_odd">0</div></td><td class="td_row_odd"><div class="td_row_odd">UCI name section for xmpp connection</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">allowed_jid</div></td><td class="td_row_even"><div class="td_row_even">string</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">The list of Jabber IDs or addresses that are allowed to initiate an XMPP Connection Request.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">loglevel</div></td><td class="td_row_odd"><div class="td_row_odd">uinteger</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">The log type to use, by default it is set to **'INFO'**. The possible types are **'EMERG', 'ALERT', 'CRITIC' ,'ERROR', 'WARNING', 'NOTICE', 'INFO' and 'DEBUG'**.</div></td></tr></tbody></table></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">connection</div></td><td class="td_row_odd"><div class="td_row_odd">Configure xmpp connections</div></td><td class="td_row_odd"><div class="td_row_odd">false</div></td><td class="td_row_odd"><table style="width:100%"><tbody><tr><td><div style="font-weight: bold; font-size: 14px">name</div></td><td><div style="font-weight: bold; font-size: 14px">type</div></td><td><div style="font-weight: bold; font-size: 14px">required</div></td><td><div style="font-weight: bold; font-size: 14px">default</div></td><td><div style="font-weight: bold; font-size: 14px">description</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">enable</div></td><td class="td_row_even"><div class="td_row_even">boolean</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">If set to **1**, it enables the XMPP connection.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">username</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">The username of the XMPP connection.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">password</div></td><td class="td_row_even"><div class="td_row_even">string</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">The password of the XMPP connection.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">domain</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">The proposed domain-part of the Jabber ID of the XMPP connection.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">resource</div></td><td class="td_row_even"><div class="td_row_even">string</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">The proposed resource-part of the Jabber ID of the XMPP connection.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">usetls</div></td><td class="td_row_odd"><div class="td_row_odd">boolean</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">If set to **1**, the CPE will initiate TLS negotiation.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">interval</div></td><td class="td_row_even"><div class="td_row_even">uinteger</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">The number of seconds, that keep alive events are sent by the XMPP connection.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">attempt</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">The number of times that the Connection attempts to connect to a given IP address.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">initial_retry_interval</div></td><td class="td_row_even"><div class="td_row_even">uinteger</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">The maximum first reconnection wait interval in seconds.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">retry_interval_multiplier</div></td><td class="td_row_odd"><div class="td_row_odd">uinteger</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">The reconnection interval multiplier.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">retry_max_interval</div></td><td class="td_row_even"><div class="td_row_even">uinteger</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">The maximum reconnection wait interval in seconds.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">serveralgorithm</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">The algorithm used when connecting with the XMPP server. Two algorithms are supported: **'DNS-SRV' and 'ServerTable'**.</div></td></tr></tbody></table></td></tr><tr><td class="td_row_even"><div class="td_row_even">connection_server</div></td><td class="td_row_even"><div class="td_row_even">xmpp connection server configuration</div></td><td class="td_row_even"><div class="td_row_even">false</div></td><td class="td_row_even"><table style="width:100%"><tbody><tr><td><div style="font-weight: bold; font-size: 14px">name</div></td><td><div style="font-weight: bold; font-size: 14px">type</div></td><td><div style="font-weight: bold; font-size: 14px">required</div></td><td><div style="font-weight: bold; font-size: 14px">default</div></td><td><div style="font-weight: bold; font-size: 14px">description</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">con_name</div></td><td class="td_row_even"><div class="td_row_even">string</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even">0</div></td><td class="td_row_even"><div class="td_row_even">UCI connection section name for XMPP connection</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">enable</div></td><td class="td_row_odd"><div class="td_row_odd">boolean</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd">0</div></td><td class="td_row_odd"><div class="td_row_odd">If set to **1**, it enables this XMPP server.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">port</div></td><td class="td_row_even"><div class="td_row_even">integer</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even">0</div></td><td class="td_row_even"><div class="td_row_even">The port of the XMPP connection.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">priority</div></td><td class="td_row_odd"><div class="td_row_odd">integer</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd">0</div></td><td class="td_row_odd"><div class="td_row_odd">The priority of this server instance of the XMPP connection.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">weight</div></td><td class="td_row_even"><div class="td_row_even">integer</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even">0</div></td><td class="td_row_even"><div class="td_row_even">The weight of this server instance of the XMPP connection.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">server_address</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd">0</div></td><td class="td_row_odd"><div class="td_row_odd">The server address of the XMPP connection.</div></td></tr></tbody></table></td></tr></tbody></table></td></tr></tbody>