diff --git a/documentation/backends/libcommuni.md b/documentation/backends/libcommuni.md index 2f417e6f35520c02741f8c528a2d6dc31d46c1a2..f0ff5b3d0a480498ea37a3f16b2a2793b0839562 100644 --- a/documentation/backends/libcommuni.md +++ b/documentation/backends/libcommuni.md @@ -36,10 +36,13 @@ To use this mode, you have to configure irc_server variable like this: In this mode users can connect more IRC networks, but they can't connect the network without being in the room. To connect the network, user has to join the room in following format: #room%irc.freenode.org@irc.domain.tld. The nickname used in the first join request is used as a nickname for the IRC connection. +The port of IRC server can be also used, but it in that case, the Jabber ID of the room has to be encoded using [JID Escaping](http://www.xmpp.org/extensions/xep-0106.html). For example to join the IRC network on port 6697, you have to use following Jabber ID: #room\40irc.freenode.org\3a6697@irc.domain.tld. + ### All configuration variables Key | Type | Default | Description ----|------|---------|------------ -irc_server | string | | IRC server hostname for "One transport per one IRC network" mode. -irc_identify | string | NickServ identify $name $password | The fiirst word is nickname of service used for identifying. After the nickname there's a message sent to that service. $name is replaced by the username defined by user in the registration. $password is replaced by password. +`service.irc_server` | string | | IRC server hostname for "One transport per one IRC network" mode. The port can be specified in the `service.irc_server` variable. If you use "+" character before the port number (For example "irc.freenode.org:+7000"), then the SSL is used. SSL is also used by default when port is configured to 6697. +`service.irc_identify` | string | NickServ identify $name $password | The fiirst word is nickname of service used for identifying. After the nickname there's a message sent to that service. $name is replaced by the username defined by user in the registration. $password is replaced by password. +`service.irc_send_pass` | bool | false | When set to true, the password used when registering the account is used as a server password when connecting the server.