---

layout: config

title: Spectrum 2

---

> * [database](#databasedatabase)

> * [password](#databasepassword)

> * [port](#databaseport)

> * [prefix](#databaseprefix)

> * [server](#databaseserver)

> * [type](#databasetype)

> * [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.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

#### database.database

Key | val

----|----

Description:|Configures full path to database or the name of database.

Context:|server-mode and gateway-mode

Type:|string

Default:|/var/lib/spectrum2/$jid/database.sql

This option configures full path to database (in case of SQLite3) or the name of database.

#### database.password

Key | val

----|----

Description:|Configures password to connect the database.

Context:|server-mode and gateway-mode

Type:|string

Default:|empty string

For server-client databases, this option configures password to be used to connect the database.

#### database.port

Key | val

----|----

Description:|Configures port on which database listens for incoming connections.

Context:|server-mode and gateway-mode

Type:|string

Default:|empty string

For server-client databases, this option configures port on which database listens for incoming connections.

#### database.prefix

Key | val

----|----

Description:|Configures the prefix for the Spectrum 2 tables in database.

Context:|server-mode and gateway-mode

Type:|string

Default:|empty string

This option configures the prefix for the Spectrum 2 tables in database. When tables are created, they are prefixed

with this prefix.

#### database.server

Key | val

----|----

Description:|Configures the hostname of database server.

Context:|server-mode and gateway-mode

Type:|string

Default:|localhost

For server-client databases, this option configures the hostname of server.

#### database.type

Key | val

----|----

Description:|Configures type of database where Spectrum 2 stores its data.

Context:|server-mode and gateway-mode

Type:|string

Default:|none

This option configures type of database where Spectrum 2 stores its data. It can be `none`, `mysql`, `sqlite3` or `pqxx` for PostgreSQL.

#### database.user

Key | val

----|----

Description:|Configures username to connect the database.

Context:|server-mode and gateway-mode

Type:|string

Default:|empty string

For server-client databases, this option configures username to be used to connect the database.

#### identity.category

Key | val

----|----

Description:|Configures disco#info identity category.

Context:|gateway-mode

Type:|string

Default:|gateway

This option configures disco#info identity category.

#### identity.name

Key | val

----|----

Description:|Configures the name showed in service discovery.

Context:|gateway-mode

Type:|string

Default:|Spectrum 2 Transport

This option configures the name showed in service discovery.

#### identity.type

Key | val

----|----

Description:|Configures type of transport as showed in service discovery.

Context:|gateway-mode

Type:|string

Default:|empty string

This option configures type of transport as showed in service discovery. It is usually used by XMPP client to show proper

icons according to type of network. See [Disco Categories](http://xmpp.org/registrar/disco-categories.html#gateway) for

allowed values.

#### logging.config

Key | val

----|----

Description:|Configures full path to log4cxx config file which is used for Spectrum 2 instance logs.

Context:|server-mode and gateway-mode

Type:|string

Default:|empty string

This option configures full path to log4cxx config file which is used for Spectrum 2 instance logs.

#### logging.backend_config

Key | val

----|----

Description:|Configures full path to log4cxx config file which is used for backends logs.

Context:|server-mode and gateway-mode

Type:|string

Default:|empty string

This option configures full path to log4cxx config file which is used for backends logs.

#### registration.auto_register

Key | val

----|----

Description:|Configures automatic user registration.

Context:|gateway-mode

Type:|boolean

Default:|0

If this option is enabled and user sends available presence to Spectrum 2 instance (tries to login it), he is registered

automatically. If the available presence was join-the-room request, legacy network name used for registration is determined

according to resource of this presence. This basically means that if user wants to join for example IRC room #test%irc.freenode.org

as "HanzZ", then Spectrum 2 registers him as "HanzZ" automatically and he does not have to fill registration form manually.

#### registration.enable_public_registration

Key | val

----|----

Description:|Configures if registration is allowed publicly.

Context:|gateway-mode

Type:|boolean

Default:|1

This option configures if registration is allowed publicly. This option can be used to disable public

registration or, together with [service.allowed_servers](#serviceallowed_servers) to create white-list of

domains from which users can register.

#### registration.instructions

Key | val

----|----

Description:|Configures instructions string showed in registration form.

Context:|gateway-mode

Type:|string

Default:|Enter your legacy network username and password.

This option configures instructions string showed in registration form.

#### registration.username_label

Key | val

----|----

Description:|Configures label for username field in registration form.

Context:|gateway-mode

Type:|string

Default:|Legacy network username:

This option configures label for username field in registration form.

#### registration.username_mask

Key | val

----|----

Description:|Configures mask which is used to generate legacy network username from username field in registration form.

Context:|gateway-mode

Type:|string

Default:|emptry string

This option configures mask which is used to generate legacy network username from username field in registration form.

An example of this option could be `username_mask=$username@chat.facebook.com`. If the user registers account "my_name", Spectrum 2

will use "my_name@chat.facebook.com" as legacy network username.

#### service.admin_jid

Key | val

----|----

Description:|Configures list of Jabber IDs, which has ability to use Admin Interface.

Context:|server-mode and gateway-mode

Type:|list of Jabber IDs

Default:|empty list

This option configures list of Jabber IDs, which has ability to use Admin Interface. In server-mode, you also have to specify

service.admin_password to set password for Admin Interface. In gatewa-mode, you just specify the list of Jabber IDs, Spectrum 2 does

not check any password in gateway-mode.

#### service.admin_password

Key | val

----|----

Description:|Configures password which is used by clients defined in service.admin_jid to use Admin Interface.

Context:|server-mode

Type:|string

Default:|empty string

This option configures the password which is used by clients defined in service.admin_jid to use Admin Interface.

#### service.allowed_servers

Key | val

----|----

Description:|Configures list of servers from which users can connect and register Spectrum 2 transport.

Context:|gateway-mode

Type:|list of JIDs

Default:|empty list

Configures list of servers from which users can connect and register Spectrum 2 transport. This option is used together with

registration.enable_public_registration option. If registration.enable_public_registration is set to 0, you can use this option

as a white-list, to enable users from particular domain to use your Spectrum 2 instance, but disallow it to any other users.

Following part of config file disables public registrations and allows only users from xmpp.org and jabber.org to use this Spectrum 2 instance:

	[service]

	allowed_servers=xmpp.org

	allowed_servers=jabber.org

	[registration]

	enable_public_registration=0

#### service.backend

Key | val

----|----

Description:|Configures path to backend executable.

Context:|server-mode and gateway-mode

Type:|string

Default:|empty string

This option configures path to backend executable. When user connects, Spectrum 2 spawns new backend process to handle this user's

session. Usually single backend is shared by more users. This can be configured using service.users_per_backend.

#### service.backend_host

Key | val

----|----

Description:|Configures hostname or IP to which backend connects.

Context:|server-mode and gateway-mode

Type:|string

Default:|localhost

This option configures hostname or IP to which backend connects. When Spectrum 2 is started, it listens on service.backend_port

to communicate with backends. When new backend is started, it connects to the hostname configured by this option and starts handling

new users sessions.

#### service.backend_port

Key | val

----|----

Description:|Configures port on which Spectrum 2 listens on for backends connections.

Context:|server-mode and gateway-mode

Type:|integer

Default:|0

This option configures port on which Spectrum 2 listens on for backends connections. If the value of this option is 0, then Spectrum 2

uses randomly generated port number.

#### service.cert

Key | val

----|----

Description:|Configures certificate to be used for SSL encryption in server-mode.

Context:|server-mode

Type:|string

Default:|empty string

This option configures full path to PKCS#12 certificate which is used for SSL in server-mode. To find out, how to create

such certificate, please read [Using SSL in server mode](http://spectrum.im/documentation/configuration/server_ssl.html).

#### service.cert_password

Key | val

----|----

Description:|Configures password for certificate which is used for SSL encryption in server-mode.

Context:|server-mode

Type:|string

Default:|empty string

This option configures password which is used to decrypt PKCS#12 certificate (if it is encrypted). For more information about SSL

with Spectrum 2, read service.cert option description.

#### service.group

Key | val

----|----

Description:|Configures group under which Spectrum 2 instance runs.

Context:|server-mode and gateway-mode

Type:|string

Default:|empty string

This option configures name of group under which Spectrum 2 instance runs. When Spectrum 2 is started, it switches from current group

to this group.

#### 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).