libtransport.git Changeset - 7d4f7f2fddb4

Changeset - 7d4f7f2fddb4

Parent rev.

Child rev.

[Not reviewed]

0 1 0

Jan Kaluza - 9 years ago 2016-02-09 21:09:14
jkaluza@redhat.com

Update Slack frontend docs

1 file changed with 5 insertions and 10 deletions:

documentation/frontends/slack.md

0 comments (0 inline, 0 general)

documentation/frontends/slack.md

➞

Show inline comments

@@ @@ -5,7 +5,7 @@ title: Spectrum 2 @@
 ## Slack frontend Description
 Slack frontend allows users to use Slack as a frontend network for Spectrum 2.
+Slack frontend allows users to use Slack as a frontend network for Spectrum 2. This page describes how to setup your own Spectrum 2 instance with Slack frontend.
 ### Configuration
 	[service]
 	frontend=slack
 	client_id=42132532467.11232153249
 	client_secret=cfdw9erw9ew0gew9gds0sa9wqd9f8d6a
 To obtain the `client_id` and `client_secret` values, you have to create new Slack application on [Slack website](https://slack.com/apps/build). You also have to setup Spectrum 2 Web Interface to allow Slack users to register the transport and configure it. While creating new Slack application, you also have to setup the `Redirect URI`. Spectrum 2 Web Interface expects the `Redirect URI` to be configured as `http://domain.tld/oauth2`. You can choose whatever domain you are running at, but you have to preserve the `/oauth2` location.
 ## Usage
 To use Slack 2 frontend with Spectrum2, you have to add new bot to your Slack team and get the API token. After that, you can use `spectrum2_manager` to set the API token:
 	$ spectrum2_manager localhost set_oauth2_code API_TOKEN use_bot_token
 Use the real JID of your Spectrum 2 instance instead of `localhost`. Use the API token provided by the Slack instead of `API_TOKEN`.
 Once you do that, Spectrum 2 will contact the Slack team's primary owner with instructions how to configure it.
 Once you setup Spectrum 2 with proper `client_id` and `client_secret`, you can register as new user in the Spectrum 2 Web Interface.

0 comments (0 inline, 0 general)