From 798277dcf5b918937fb128b53bfd65912a9c5ed6 Mon Sep 17 00:00:00 2001 From: HanzZ Date: Thu, 29 Nov 2012 14:35:01 +0100 Subject: [PATCH] Docs --- css/style.css | 6 +-- documentation/tutorials/gateway_mode.md | 52 +++++++++++++++++++++++++ 2 files changed, 55 insertions(+), 3 deletions(-) create mode 100644 documentation/tutorials/gateway_mode.md diff --git a/css/style.css b/css/style.css index ac0b05d5..3c429ed0 100644 --- a/css/style.css +++ b/css/style.css @@ -241,19 +241,19 @@ hr { table { border: 1px solid #373737; - margin-bottom: 20px; + margin-bottom: 10px; text-align: left; } th { font-family: 'Lucida Grande', 'Helvetica Neue', Helvetica, Arial, sans-serif; - padding: 10px; + padding: 5px; background: #373737; color: #fff; } td { - padding: 10px; + padding: 3px; border: 1px solid #373737; } diff --git a/documentation/tutorials/gateway_mode.md b/documentation/tutorials/gateway_mode.md new file mode 100644 index 00000000..49b7f1a3 --- /dev/null +++ b/documentation/tutorials/gateway_mode.md @@ -0,0 +1,52 @@ +--- +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). + +### Configure your XMPP server + +XMPP server configuration is addressed on [Configure XMPP server page](configure_xmpp_server.html). + +### 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 +--------|------|---------------|-------- +service|server_mode|0| Spectrum 2 will act as gateway. +service|jid|Jabber ID of your Spectrum 2 transport|You have configured the Jabber ID in your Jabber server config file in previous step. +service|password|Password to connect the Jabber server|You have configured the password in your Jabber server config file in previous step. +service|server|Your Jabber server IP od hostname|Spectrum 2 will connect that IP/hostname. +service|port|Jabber server port to which Spectrum 2 connects|You have configured the port in your Jabber server config file in previous step. + +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). + +#### 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. + +### Start Spectrum 2 + +The following command should now start your first Spectrum 2 instance: + + spectrum2_manager start + + +### If something goes wrong + +Spectrum 2 logs important messages into `/var/log/spectrum2//spectrum2.log`. It's always good to check that log if something goes wrong.