libtransport.git Changeset - 0bc74fa24da1

Changeset - 0bc74fa24da1

Parent rev.

Child rev.

[Not reviewed]

0 2 1

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

Describe Web Interface in docs

3 files changed with 31 insertions and 2 deletions:

_config.yml

documentation/frontends/slack.md

documentation/management/web_interface.md

0 comments (0 inline, 0 general)

_config.yml

➞

Show inline comments

@@ @@ -3,7 +3,7 @@ @@
 #permalink: /:categories/:year/:month/:day/:title
 exclude: [".rvmrc", ".rbenv-version", "README.md", "Rakefile", "changelog.md"]
 highlighter: pygments
+#highlighter: pygments
 # Themes are encouraged to use these universal variables
 # so be sure to set them if your theme uses them.

documentation/frontends/slack.md

➞

Show inline comments

 	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.
+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](../management/web_interface.html) 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

documentation/management/web_interface.md

➞

Show inline comments

@@ new file 100644 @@
 ---
 layout: page
 title: Spectrum 2
 ---
 Web Interface allows admins to control Spectrum 2 instances and users to register the transports and for example manage rooms they are connected to.
 ## Configuration
 The Web Interface is part of Spectrum 2 Manager tool, so it shares the same `/etc/spectrum2/spectrum_manager.cfg` configuration file. There are following configuration variables available:
 Section | Key | Type | Default | Description
 ----|------|---------|------------
 service | admin_username | string | | Admin username for the Web Interface.
 service | admin_password | string | | Admin password for the Web Interface.
 service | port | int | 8080 | Port on which the Web Interface will be accesible.
 service | base_location | string | / | Base location (directory) on which the Web interface is served. It must ends up with slash character. If you for example set it to "/spectrum/", then the Web interface will be served on http://localhost:$port/spectrum/.
 service | data_dir | string | /var/lib/spectrum2_manager/html | Path to the Web Interface static data.
 service | cert | string | | Web interface certificate in PEM format when TLS should be used. Empty otherwise.
 logging | config | string | /etc/spectrum2/manager_logging.cfg | Path to the logging configuration file in the same format as for the Spectrum 2.
 database | ... | ... | ... | Database to store the Web Interface data. The variables are the same as in the [Spectrum 2 config files](http://spectrum.im/documentation/configuration/config_file.html#databasedatabase).
 ## Starting the Web Interface
 For now the only way how to start Web Interface is running it on foreground using:
 `$ spectrum2_manager server`
 In the future, we plan to support Spectrum 2 Web Interface as standalone server.

0 comments (0 inline, 0 general)