Docs update

This commit is contained in:
Jan Kaluza 2016-02-29 19:53:48 +01:00
parent 54874f5f60
commit ef224eb348
4 changed files with 14 additions and 6 deletions

View file

@ -42,7 +42,7 @@ This is Admin documentation for Spectrum 2 transport. If you are user trying to
* [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

View file

@ -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.

View file

@ -33,9 +33,9 @@ Spectrum 2 should work with any third-party libpurple plugin which is properly i
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.

View file

@ -11,3 +11,8 @@ 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`.