libtransport.git Changeset - ef224eb34830

Changeset - ef224eb34830

Parent rev.

Child rev.

[Not reviewed]

0 4 0

Jan Kaluza - 10 years ago 2016-02-29 19:53:48
jkaluza@redhat.com

Docs update

4 files changed with 14 insertions and 6 deletions:

documentation/admin.md

documentation/backends/libcommuni.md

documentation/backends/libpurple.md

documentation/configuration/web_storage.md

0 comments (0 inline, 0 general)

documentation/admin.md

➞

Show inline comments

 #### Configuration
 * [Configuration file description](configuration/config_file.html)
 * [MySQL Support](configuration/mysql.html)
 * [PostgreSQL Support](configuration/postgresql.html)
 * [Logging](configuration/logging.html)
-* [Web storage](configuration/web_storage.html);
 * [Web storage](configuration/web_storage.html)
 #### Management
 * [spectrum2_manager tool](management/spectrum2_manager.html)
 * [Web Interface](management/web_interface.html)
 * [Getting a backtrace](management/getting_backtrace.html)

documentation/backends/libcommuni.md

➞

Show inline comments

 	irc_server=irc.freenode.org
 ### One transport for more IRC networks
 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.

documentation/backends/libpurple.md

➞

Show inline comments

@@ @@ -30,15 +30,15 @@ prpl-novell|Groupwise @@
 ### Third-party plugins
 Spectrum 2 should work with any third-party libpurple plugin which is properly installed. For example, popular plugins:
 Protocol variable| website | Description
 -----------------|------------
 prpl-facebook| [https://github.com/jgeboski/purple-facebook](website) | Facebook
 prpl-telegram| [https://github.com/majn/telegram-purple](website) | Telegram
 prpl-skypeweb| [https://github.com/EionRobb/skype4pidgin/tree/master/skypeweb](website) | Skype
 prpl-facebook| [https://github.com/jgeboski/purple-facebook](https://github.com/jgeboski/purple-facebook) | Facebook
 prpl-telegram| [https://github.com/majn/telegram-purple](https://github.com/majn/telegram-purple) | Telegram
 prpl-skypeweb| [https://github.com/EionRobb/skype4pidgin/tree/master/skypeweb](https://github.com/EionRobb/skype4pidgin/tree/master/skypeweb) | Skype
 These plugins are included by default in our Docker image.
 ### Support for Facebook stickers
 Facebook stickers are supported using [Web Storage](../configuration/web_storage.html).

documentation/configuration/web_storage.md

➞

Show inline comments

@@ @@ -8,6 +8,11 @@ title: Spectrum 2 @@
 Web storage is used to send images and files received by Spectrum 2 to end user. When new image or file is downloaded from the 3rd-party network, it is stored into `service.web_directory` directory
 and the link to that file, based on `service.web_url`, is sent to the user.
 That means that you should configure the web-server on the machine where you run Spectrum 2 to serve `service.web_directory`.
 If you for example use httpd, you can configure `service.web_directory=/var/www/html/spectrum2`. In that case, the matching `service.web_url` value will be `service.web_url=http://domain.tld/spectrum2`.
 ### Security
 You should not configure the webserver to allow listing files in the `service.web_directory`.

0 comments (0 inline, 0 general)