Changeset - 2ee0d67877f1
[Not reviewed]
0 3 0
HanzZ - 13 years ago 2012-12-14 21:31:30
hanzz.k@gmail.com
Fixed links
3 files changed with 11 insertions and 8 deletions:
0 comments (0 inline, 0 general)
documentation/configuration/config_file.md
Show inline comments
 
@@ -10,13 +10,13 @@ Spectrum 2 config file is not compatible with Spectrum 1, although some importan
 
### [service] section
 

	
 
#### General settings
 

	
 
Key | Type | Default | Description
 
----|------|---------|------------
 
server_mode | boolean | 0 | True if Spectrum should run as server in [server-mode](http://spectrum.im/projects/spectrum/wiki/Spectrum_2_Admin_-_New_design#Server-mode).
 
server_mode | boolean | 0 | True if Spectrum should run as server in [server-mode](http://hanzz.github.com/libtransport/documentation/about.html#server_mode).
 
jid | string | | Jabber ID of Spectrum2 instance. For example "localhost", "icq.domain.tld".
 
server | string | | Hostname or IP address of server to which Spectrum connects in gateway-mode.
 
port | integer | 0 | Port on which Spectrum listens to in server-mode or to which connects in gateway-mode.
 
password | string | | Password used to connect Jabber server in gateway-mode.
 
cert | string | | Full path to PKCS#12 certificate which is used for TLS in server-mode.
 
cert_password | string | | PKCS#12 certificate password.
documentation/installation/from_source_code.md
Show inline comments
 
@@ -77,18 +77,18 @@ In Fedora, you just have to install following packages:
 
## Install Libpurple for libpurple backend
 

	
 
You should definitely have latest libpurple, so download Pidgin and compile it, because your distribution probably doesn't have the latest one.
 

	
 
## Install libCommuni for libCommuni IRC backend
 

	
 
The instructions are defined on "libCommuni wiki":https://github.com/communi/communi/wiki.
 
The instructions are defined on [libCommuni wiki](https://github.com/communi/communi/wiki).
 

	
 
## Install Spectrum 2
 

	
 
	git clone git://github.com/hanzz/libtransport.git
 
	cd libtransport
 
	cmake . -DCMAKE_BUILD_TYPE=Debug
 
	make
 

	
 
Before running make, check cmake output if the supported features are OK for you. If not, install libraries needed by Spectrum to provide specific feature.
 

	
 
You can also install spectrum using "sudo make install"
 
You can also install spectrum using `sudo make install`.
documentation/tutorials/gateway_mode.md
Show inline comments
 
@@ -2,18 +2,21 @@
 
layout: page
 
title: Spectrum 2
 
---
 

	
 
### Before you start
 

	
 
* Check that you really want to run Spectrum 2 in gateway mode and not in server mode. The difference is documentation on [What is Spectrum 2](about.html) page.
 
* Install Spectrum 2.  Installation is covered in [Installation section on the main page](index.html).
 
* Check that you really want to run Spectrum 2 in gateway mode and not in server mode. The difference is documentation on [What is Spectrum 2](http://hanzz.github.com/libtransport/documentation/about.html) page.
 
* Install Spectrum 2.  Installation is covered in [Installation section on the main page](http://hanzz.github.com/libtransport/documentation/).
 

	
 
### Configure your XMPP server
 

	
 
XMPP server configuration is addressed on [Configure XMPP server page](configure_xmpp_server.html).
 
You have to change your XMPP server configuration and set JID of the Spectrum 2 instance and the password it will use there.
 

	
 
* [Adding components with Prosody](http://prosody.im/doc/components)
 
* [Adding components with Ejabberd](http://www.ejabberd.im/node/5134)
 

	
 
### Configure Spectrum 2
 

	
 
Default config file is located at `/etc/spectrum2/transports/spectrum.cfg.example`. To successfully connect Spectrum 2 to your server, change the following options in the following categories and remove the .example suffix (you can name the file as you want, but it has to have .cfg suffix):
 

	
 
Category|Option|Change to value|Meaning
 
@@ -27,21 +30,21 @@ service|port|Jabber server port to which Spectrum 2 connects|You have configured
 
All config options with description are located at [Config file page](config_file.html).
 

	
 
#### Choose the Spectrum 2 backend and legacy network
 

	
 
You have to choose the Spectrum 2 backend and legacy network to which this Spectrum 2 gateway will connect the users.
 

	
 
The default backend is [Libpurple backend](backends/libpurple.html). Read the [Libpurple backend documentation](backends/libpurple.html) to see how to choose particular legacy network. If you want to use different backend, change the path to it according to [List of backends](backends.html).
 
The default backend is [Libpurple backend](http://hanzz.github.com/libtransport/documentation/backends/libpurple.html). Read the [Libpurple backend documentation](http://hanzz.github.com/libtransport/documentation/backends/libpurple.html) to see how to choose particular legacy network. If you want to use different backend, change the path to it according to [List of backends](http://hanzz.github.com/libtransport/documentation/backends/backends.html).
 

	
 
#### Choose the storage backend
 

	
 
Category| Option| Change to value| Meaning
 
-|-|-|-
 
database|type|sqlite3|Spectrum 2 will use SQLite3 as storage backend
 

	
 
You can also use [MySQL](mysql.html) or [PostgreSQL](postgresql.html) instead of SQLite3 backend.
 
You can also use [MySQL](http://hanzz.github.com/libtransport/documentation/configuration/mysql.html) or [PostgreSQL](http://hanzz.github.com/libtransport/documentation/configuration/postgresql.html) instead of SQLite3 backend.
 

	
 
### Start Spectrum 2
 

	
 
The following command should now start your first Spectrum 2 instance:
 

	
 
	spectrum2_manager start
0 comments (0 inline, 0 general)