libtransport.git Changeset - 235b9efa9d3c

Changeset - 235b9efa9d3c

Parent rev.

Child rev.

[Not reviewed]

0 1 0

Jan Kaluza - 13 years ago 2013-03-11 11:56:18
hanzz.k@gmail.com

docs update

1 file changed with 35 insertions and 3 deletions:

documentation/configuration/config_file.md

0 comments (0 inline, 0 general)

documentation/configuration/config_file.md

➞

Show inline comments

 ---
 layout: config
 title: Spectrum 2
 ---
 > * [service.server_mode](#serviceserver_mode)
 > * [database.database](databasedatabase)
 > * [database.password](databasepassword)
 > * [database.port](databaseport)
 > * [database.prefix](databaseprefix)
 > * [database.server](databaseserver)
 > * [database.type](databasetype)
 > * [database.user](databaseuser)
 > * [identity.category](#identitycategory)
 > * [identity.name](#identityname)
 > * [identity.type](#identitytype)
 > * [logging.backend_config](loggingbackend_config)
 > * [logging.config](loggingconfig)
 > * [registration.auto_register](#registrationauto_register)
 > * [registration.enable_public_registration](#registrationenable_public_registration)
 > * [registration.instructions](#registrationinstructions)
 > * [registration.username_label](#registrationusername_label)
 > * [registration.username_mask](#registrationusername_mask)
 > * [service.admin_jid](#serviceadmin_jid)
 > * [service.admin_password](#serviceadmin_password)
 > * [service.allowed_servers](#serviceallowed_servers)
 > * [service.backend](#servicebackend)
 > * [service.backend_host](#servicebackend_host)
 > * [service.backend_port](#servicebackend_port)
 > * [service.cert](#servicecert)
 > * [service.cert_password](#servicecert_password)
 > * [service.group](#servicegroup)
 > * [service.jid](#servicejid)
 > * [service.server](#serviceserver)
 > * [service.port](#serviceport)
 > * [service.password](#servicepassword)
 > * [service.pidfile](#servicepidfile)
 > * [service.port](#serviceport)
 > * [service.server](#serviceserver)
 > * [service.server_mode](#serviceserver_mode)
 > * [service.user](#serviceuser)
 > * [service.users_per_backend](#servicusers_per_backend)
 > * [service.working_dir](#serviceworking_dir)
 ### Types of configuration fields
 Following types are used:
 integer - Examples: key=0
 string - Examples: key=something
 boolean - Examples: key=0 or key=1
 list - List of strings (or Jabber IDs). You can specify this options more than once:
 	allowed_servers=domain.tld
 	allowed_servers=example.com
 #### service.server_mode
 Key | val
 ----|----
 Description:|Configures if Spectrum 2 works in server mode or gateway mode
 Context:|server-mode and gateway-mode
 Type:|boolean
 Default:|0
 If this option is true, Spectrum 2 works in server-mode and acts as standalone server.
 User then logins legacy networks by logging XMPP account like this one: `my_msn_name%hotmail.com@msn.domain.tld`.
 *Advantages:*
 * Passwords are not stored on server.
 * Roster synchronization is easy, because Spectrum 2 acts as normal server.
 * If you want to use Spectrum 2 as wrapper between different networks, you don't need database or Jabber server as another layer.
 * Using SRV records you can easily run Spectrum 2 on different machines to scale it.
 *Disadvantages:*
 * Clients have to support more accounts to connect more legacy networks (Therefore they will need have to use more TCP connections).
 If this option is false, Spectrum 2 acts as normal XMPP component (gateway).
 You then have to configure an external XMPP server (like Prosody or Ejabberd) to serve the subdomain you want to use for Spectrum 2 (for example "icq.domain.tld"). Spectrum 2 in gateway mode then connects the XMPP server as its component and users are able to find out "icq.domain.tld" in Service Discovery, register it and use it.
 *Advantages:*
 * Users can use more legacy networks using single XMPP account (and using single TCP connection).
 * It's easy to extend existing XMPP servers using gateway mode.
 *Disadvantages:*
 * Passwords are stored (even in encrypted form) on server.
 * Roster (contact list) synchronization can be problematic, because it depends on the client user uses. This can be improved by usage of Remote Roster protoXEP.
 * You have to setup XMPP server and use database even if you only want to use Spectrum 2 as a tool to connect legacy networks using XMPP protocol.
 #### service.jid
 Key | val
 ----|----
 Description:|Configures Jabber ID of Spectrum 2 instance
 Context:|server-mode and gateway-mode
 Type:|string
 Default:|empty string
 This option configures Jabber ID of particular Spectrum 2 instance. Usually it is a hostname on which this Spectrum 2 instance
 runs, so for example `icq.domain.tld`. Note that you have to have DNS records configured for this hostname, so clients will be able
 to find out your Jabber server (in case you are running Spectrum 2 in gateway-mode) or the Spectrum 2 itself (if you are running
 Spectrum 2 in server-mode).
 #### service.server
 Key | val
 ----|----
 Description:|Configures hostname or IP address of server to which Spectrum 2 connects to.
 Context:|gateway-mode
 Type:|string
 Default:|empty string
 This option configures hostname or IP address of server to which Spectrum 2 connects to. It is used only in gateway-mode and
 you should configure it to point to hostname or IP of your XMPP server.
 #### service.port
 Key | val
 ----|----
 Description:|Configures port on which Spectrum listens to in server-mode or to which connects in gateway-mode.
 Context:|server-mode and gateway-mode
 Type:|integer
 Default:|0
 This option configures port on which Spectrum listens to in server-mode or to which connects in gateway-mode. In server-mode
 the default port for XMPP servers is 5222, so you should use this port. In gateway-mode, you have to at first configure your
 server to allow Spectrum 2 to connect it as its component. On many servers, the default component port is 5347, but this option
 depends on particular XMPP server and its configuration.
 #### service.password
 Key | val

0 comments (0 inline, 0 general)