Changeset - ef224eb34830
[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:
0 comments (0 inline, 0 general)
documentation/admin.md
Show inline comments
 
@@ -21,37 +21,37 @@ This is Admin documentation for Spectrum 2 transport. If you are user trying to
 
* [XMPP Frontend](frontends/xmpp.html)
 
   * [Using SSL in server mode](configuration/server_ssl.html)
 
   * [Spectrum 2 as bouncer](configuration/bouncer.html)
 
* [Slack Frontend](frontends/slack.html)
 

	
 
#### Backends
 

	
 
* [Backends overview](backends/backends.html)
 
* [Libpurple backend](backends/libpurple.html)
 
* [Libcommuni backend](backends/libcommuni.html)
 
* [Twitter backend](backends/twitter.html)
 
* [Transwhat backend](backends/transwhat.html)
 

	
 
#### Tutorials
 

	
 
* [XMPP Frontend](frontends/xmpp.html)
 
   * [Spectrum 2 in gateway mode](tutorials/gateway_mode.html)
 

	
 
#### 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)
 
* [Munin integration](management/munin.html)
 

	
 
#### Development
 

	
 
* [Spectrum 2 architecture](development/architecture.html)
 
* [Writing backend in any language (or How the backend works inside)](development/protocol.html)
documentation/backends/libcommuni.md
Show inline comments
 
@@ -15,31 +15,34 @@ You have to choose this backend in Spectrum 2 configuration file to use it:
 
	backend=/usr/bin/spectrum2_libcommuni_backend
 

	
 
LibCommuni backend can then work in two modes.
 

	
 
### One transport per one IRC network
 

	
 
This is preferred way if you know that you or your users will need to connect just one IRC network. It's also good mode of you maintain IRC server and want to provide XMPP access to it.
 

	
 
In this mode users can:
 

	
 
* connect the IRC network without joining the IRC channel.
 
* identify to NickServ (or any other service like that) using username and password from transport registration.
 
* have IRC contacts in their rosters. (Not done yet, but it's planned)
 
* see channel list in the service discovery. (Not done yet, but it's planned)
 

	
 
To use this mode, you have to configure irc_server variable like this:
 

	
 
	[service]
 
	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
 
@@ -12,41 +12,41 @@ Libpurple backend is backend based on Librpurple library supporting all the netw
 
You have to choose this backend in Spectrum 2 configuration file to use it:
 

	
 
	[service]
 
	backend=/usr/bin/spectrum2_libpurple_backend
 
	protocol=prpl-jabber
 

	
 
As showed above, there is also special configuration variable in `[service]` section called `protocol` which decides which Libpurple's protocol will be used:
 

	
 
Protocol variable| Description
 
-----------------|------------
 
prpl-jabber| Jabber
 
prpl-aim|AIM
 
prpl-icq|ICQ
 
prpl-msn|MSN
 
prpl-yahoo|Yahoo
 
prpl-gg|Gadu Gadu
 
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).
 

	
 
### Setting libpurple plugins configurations
 

	
 
Some libpurple protocol plugins allow setting configuration variables. Spectrum 2 passes every variable set in `purple` section to libpurple library. If you need to set such options, you can do it for example like this in your configuration file:
 

	
 
	[purple]
 
	clientlogin=1
 
	ssl=0
documentation/configuration/web_storage.md
Show inline comments
 
---
 
layout: page
 
title: Spectrum 2
 
---
 

	
 
### Web Storage
 

	
 
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)